Standalone (#727)

* 2 standalone tests were breaking.

* bundling the library for browser usage

* Test passing and actually using our the standalone file

* add tests for the bundle on CI

* fix jest config

* fix github action

* removing prettier from the bundle

* only require the necessary functions from semver

* running standalone tests in isolation

* Umd configuration closer to the one used by prettier.

* commonjs exported name changed to `prettierPluginSolidity` from `solidity`

* Supress warnings about assets size

* correct resolution of 'emoji-regex'

* package.json changes for browser support

* including source maps in the package

* cleaning up the usage of private utils that we borrowed from Prettier. 30k leaner build

* moving utils away from prettier-comments folder since now is slim and understandable enough to be maintained.

* Adding documentation for the standalone build

* using ## instead - to avoid a bug in the markdown standalone plugin

* moduleMapper doesn't work with jest-light-runner but we don't need it since we build everything before running tests

* cleaning up the standalone tests that have problems

* Use source-map instead of cheap-module-source-map

Co-authored-by: Franco Victorio <victorio.franco@gmail.com>

Author: Janther

.eslintignore

@@ -1,4 +1,5 @@
 coverage/**/*.js
+dist/**/*.js
 tests/format/**/*.sol
 tests/format/Markdown/Markdown.md
 tests/format/RespectDefaultOptions/respect-default-options.js

.github/workflows/CI.yml

@@ -28,6 +28,27 @@ jobs:
       - name: lint
         run: npm run lint
 
+  test_bundle:
+    name: Test production
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 14
+      - uses: actions/checkout@v2
+      - uses: actions/cache@v2
+        id: cache
+        with:
+          path: |
+            node_modules
+          key: ${{ runner.os }}-${{ hashFiles('package-lock.json') }}
+      - name: Install
+        run: npm install
+      - name: Build
+        run: npm run build
+      - name: Run tests
+        run: npm run test:standalone
+
   test_linux:
     name: Test on Linux with Node ${{ matrix.node }}
     runs-on: ubuntu-latest

.gitignore

@@ -31,6 +31,7 @@ bower_components
 
 # Compiled binary addons (https://nodejs.org/api/addons.html)
 build/Release
+dist
 
 # Dependency directories
 node_modules/

.prettierignore

@@ -1,4 +1,5 @@
 coverage/**/*.js
+dist/**/*.js
 tests/format/**/*.sol
 tests/format/Markdown/Markdown.md
 tests/format/RespectDefaultOptions/respect-default-options.js

README.md

@@ -13,6 +13,8 @@ If you like this project, please consider contributing to our [Gitcoin grant](ht
 
 ## Installation and usage
 
+### Using in NodeJS
+
 Install both `prettier` and `prettier-plugin-solidity`:
 
 ```Bash
@@ -39,6 +41,35 @@ Or you can use it as part of your linting to check that all your code is prettif
 
 > Prettier Solidity only works with valid code. If there is a syntax error, nothing will be done and a parser error will be thrown.
 
+### Using in the Browser
+
+_Added in v1.0.1_
+
+To use this package in the browser, you need to load Prettier's standalone bundle before loading the build provided in this package.
+
+```html
+<script src="https://unpkg.com/prettier@latest"></script>
+<script src="https://unpkg.com/prettier-plugin-solidity@latest"></script>
+```
+
+Prettier's unpkg field points to `https://unpkg.com/prettier/standalone.js`, in a similar way this plugin points to `https://unpkg.com/prettier-plugin-solidity/dist/standalone.js`.
+
+Once the scripts are loaded you will have access the globals `prettier` and `prettierPlugins`.
+
+We follow Prettier's strategy for populating their plugins in the object `prettierPlugins`, you can load other plugins like `https://unpkg.com/prettier@2.8.0/parser-markdown.js` and Prettier will have access to multiple parsers.
+
+```html
+<script>
+  const originalCode = 'contract Foo {}';
+  const formattedCode = prettier.format(originalCode, {
+    parser: 'solidity-parse',
+    plugins: prettierPlugins
+  });
+</script>
+```
+
+For more details and please have a look at [Prettier's documentation](https://prettier.io/docs/en/browser.html).
+
 ## Configuration File
 
 Prettier provides a flexible system to configure the formatting rules of a project. For more information please refer to the [documentation](https://prettier.io/docs/en/configuration.html).

jest.config.js

@@ -1,18 +1,22 @@
 const TEST_STANDALONE = Boolean(process.env.TEST_STANDALONE);
 
 module.exports = {
-  moduleNameMapper: {
-    '^prettier$': TEST_STANDALONE
-      ? '<rootDir>/node_modules/prettier/standalone'
-      : '<rootDir>/node_modules/prettier'
-  },
   runner: 'jest-light-runner',
   setupFiles: ['<rootDir>/tests/config/setup.js'],
   snapshotSerializers: [
     'jest-snapshot-serializer-raw',
     'jest-snapshot-serializer-ansi'
   ],
   testEnvironment: 'node',
+  // ignore console warnings in TEST_STANDALONE
+  silent: TEST_STANDALONE,
+  testPathIgnorePatterns: TEST_STANDALONE
+    ? [
+        // Standalone mode doesn't have default options.
+        // This has been reported https://github.com/prettier/prettier/issues/11107
+        'tests/format/RespectDefaultOptions'
+      ]
+    : [],
   testMatch: [
     '<rootDir>/tests/format/**/jsfmt.spec.js',
     '<rootDir>/tests/unit/**/*.js'