Migrating to ECMAScript modules (#894)

* ESM configs

* binary operators printers to ESM

* nodes to ESM

* common utilities to ESM

* comments to ESM

* main files to ESM

* test configuration to ESM

* format tests to new config

* unit tests to ESM

* prettier 2.8.8 is incompatible with ESM so only running standalone tests

* cleanup: dir-to-object doesn't work with ESM

* updating dependencies compatible with ESM

* fixing lint

* testing prettier-version on cjs and esm

* adding conditional exports for environments using cjs or prettier v2

* using cache strategy to load solc and improving testing times

* updating `parse` signature for standalone tests

* Include the whole dist/ directory when publishing

* since we are publishing the whole `dist` folder, we make sure to clean it before building

---------

Co-authored-by: Franco Victorio <[email protected]>

.c8rc

@@ -4,7 +4,7 @@
   "lines": 100,
   "functions": 100,
   "statements": 100,
-  "exclude": ["/node_modules/", "/scripts/", "/src/prettier-comments/"],
+  "exclude": ["/node_modules/", "/src/prettier-comments/"],
   "include": ["src/**/*.js", "!src/prettier-comments/**/*.js"],
   "reporter": ["lcov", "text"],
   "temp-dir": "./coverage/"

.eslintignore

@@ -3,5 +3,5 @@ dist/**/*.js
 tests/format/**/*.sol
 tests/format/Markdown/Markdown.md
 tests/format/RespectDefaultOptions/respect-default-options.js
-tests/config/**/*.js
+tests/config/**/*.*js
 src/prettier-comments/**/*.js

.eslintrc

@@ -5,5 +5,13 @@
   "extends": ["airbnb-base", "prettier"],
   "globals": {
     "run_spec": false
+  },
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "rules": {
+    "import/extensions": "off",
+    "import/prefer-default-export": "off"
   }
 }

.github/workflows/CI.yml

@@ -54,10 +54,8 @@ jobs:
         run: npm run build
       - name: Downgrade Prettier to V2
         run: npm install [email protected]
-      - name: Run tests
-        run: npm run test:all
       - name: Run standalone tests
-        run: npm run test:standalone
+        run: npm run test:standalone tests/format tests/unit/prettier-version
 
   test_linux:
     name: Test on Linux with Node ${{ matrix.node }}

.npmignore

@@ -1,7 +1,6 @@
 # -*- mode: gitignore; -*-
 .github/
 tests/
-scripts/
 assets/
 *.md/
 !README.md

jest.config.js

@@ -1,6 +1,6 @@
 const TEST_STANDALONE = Boolean(process.env.TEST_STANDALONE);
 
-module.exports = {
+export default {
   runner: 'jest-light-runner',
   setupFiles: ['<rootDir>/tests/config/setup.js'],
   snapshotSerializers: [
@@ -19,7 +19,7 @@ module.exports = {
     : [],
   testMatch: [
     '<rootDir>/tests/format/**/jsfmt.spec.js',
-    '<rootDir>/tests/unit/**/*.js'
+    '<rootDir>/tests/unit/**/*.test.js'
   ],
   transform: {},
   watchPlugins: [