Breaking: provide ESM export (refs eslint/rfcs#72) (#469)

* Build: generate es and cjs modules. Fixes #457 * Build: add note explaining lib/version.js and lint * Build: update unit and lint testing commands * Update .eslintrc.cjs Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com> * Update package.json Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com> * Chore: add commonjs unit tests and lint (fixes #469) * Chore: fix acorn unit test and lint (fixes #469) * Build: remove node 10.x from the test matrix (fixes #469) * Build: add commonjs build step for CI (fixes #469) * Build: add node 10.x test as separate job * Breaking: acorn 8.0.5 * Build: remove unnecessary tests * Build: disable rollup treeshake * Update package.json Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com> * Update tests/lib/commonjs.cjs Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com> * Update tests/lib/commonjs.cjs Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com> * Update tests/lib/commonjs.cjs Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com> * Build: fix linting and remove unneeded ignore file * Update tests/lib/commonjs.cjs Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com> * Build: update eslint config * Chore: replace String.indexOf with String.includes * Chore: use pathToFileURL to hopefully fix esm based tests on windows * Chore: use pathToFileURL to hopefully fix esm based tests on windows * Chore: use pathToFileURL to hopefully fix esm based tests on windows * replace tap with mocha and minor dep updates * Fix Node 15 peer deps issue * Update package.json Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com> * fix linting problems * add basic jsx test for commonjs build Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
eslint · Apr 16, 2021 · 8234c48 · 8234c48
1 parent 2080ce6
commit 8234c48
Show file tree

Hide file tree

Showing 826 changed files with 1,202 additions and 1,093 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -1,4 +1,3 @@
-!.eslintrc.js
 /node_modules
 /tests/fixtures
 /tools
diff --git a/.eslintrc.js → .eslintrc.cjs b/.eslintrc.js → .eslintrc.cjs
@@ -4,12 +4,14 @@ module.exports = {
     root: true,
     extends: "eslint",
     env: {
-        node: true,
         es6: true
     },
     overrides: [
         {
-            files: ["tests/lib/*"],
+            files: ["tests/lib/**"],
+            parserOptions: {
+                ecmaVersion: 2020
+            },
             env: {
                 mocha: true
             }

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -18,14 +18,16 @@ jobs:
           node-version: '12.x'
       - name: Install dependencies
         run: npm install
+      - name: Build commonjs
+        run: npm run rollup
       - name: Lint files
-        run: node Makefile.js lint
+        run: npm run lint
   test:
     name: Test
     strategy:
       matrix:
         os: [ubuntu-latest]
-        node: [15.x, 14.x, 13.x, 12.x, 10.x, "10.12.0"]
+        node: [15.x, 14.x, 13.x, 12.x]
         include:
         - os: windows-latest
           node: "12.x"
@@ -39,5 +41,29 @@ jobs:
         node-version: ${{ matrix.node }}
     - name: Install dependencies
       run: npm install
+      if: ${{ !startswith(matrix.node, '15') }}
+    - name: Install dependencies
+      run: npm install --legacy-peer-deps
+      if: ${{ startswith(matrix.node, '15') }}  
+    - name: Build commonjs
+      run: npm run rollup
+    - name: Run tests
+      run: npm run unit
+  testNode10:
+    name: Test Node 10.x
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        node: [10.x, "10.12.0"]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node }}
+    - name: Install dependencies
+      run: npm install
+    - name: Build commonjs
+      run: npm run rollup
     - name: Run tests
-      run: node Makefile.js test
+      run: npm run unit:cjs
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,8 @@
 build
 coverage
 node_modules
+.DS_Store
+dist
 npm-debug.log
 _test.js
 .idea

diff --git a/Makefile.js b/Makefile.js
diff --git a/espree.js b/espree.js
@@ -56,13 +56,14 @@
  */
 /* eslint no-undefined:0, no-use-before-define: 0 */
 
-"use strict";
+import * as acorn from "acorn";
+import jsx from "acorn-jsx";
+import astNodeTypes from "./lib/ast-node-types.js";
+import espree from "./lib/espree.js";
+import espreeVersion from "./lib/version.js";
+import visitorKeys from "eslint-visitor-keys";
+import { getLatestEcmaVersion, getSupportedEcmaVersions } from "./lib/options.js";
 
-const acorn = require("acorn");
-const jsx = require("acorn-jsx");
-const astNodeTypes = require("./lib/ast-node-types");
-const espree = require("./lib/espree");
-const { getLatestEcmaVersion, getSupportedEcmaVersions } = require("./lib/options");
 
 // To initialize lazily.
 const parsers = {
@@ -106,7 +107,7 @@ const parsers = {
  * @throws {SyntaxError} If the input code is invalid.
  * @private
  */
-function tokenize(code, options) {
+export function tokenize(code, options) {
     const Parser = parsers.get(options);
 
     // Ensure to collect tokens.
@@ -128,7 +129,7 @@ function tokenize(code, options) {
  * @returns {ASTNode} The "Program" AST node.
  * @throws {SyntaxError} If the input code is invalid.
  */
-function parse(code, options) {
+export function parse(code, options) {
     const Parser = parsers.get(options);
 
     return new Parser(options, code).parse();
@@ -138,15 +139,12 @@ function parse(code, options) {
 // Public
 //------------------------------------------------------------------------------
 
-exports.version = require("./package.json").version;
+export const version = espreeVersion;
 
-exports.tokenize = tokenize;
-
-exports.parse = parse;
 
 // Deep copy.
 /* istanbul ignore next */
-exports.Syntax = (function() {
+export const Syntax = (function() {
     let name,
         types = {};
 
@@ -168,10 +166,10 @@ exports.Syntax = (function() {
 }());
 
 /* istanbul ignore next */
-exports.VisitorKeys = (function() {
-    return require("eslint-visitor-keys").KEYS;
+export const VisitorKeys = (function() {
+    return visitorKeys.KEYS;
 }());
 
-exports.latestEcmaVersion = getLatestEcmaVersion();
+export const latestEcmaVersion = getLatestEcmaVersion();
 
-exports.supportedEcmaVersions = getSupportedEcmaVersions();
+export const supportedEcmaVersions = getSupportedEcmaVersions();
diff --git a/lib/ast-node-types.js b/lib/ast-node-types.js
@@ -3,8 +3,6 @@
  * @author Nicholas C. Zakas
  */
 
-"use strict";
-
 //------------------------------------------------------------------------------
 // Requirements
 //------------------------------------------------------------------------------
@@ -15,7 +13,7 @@
 // Public
 //------------------------------------------------------------------------------
 
-module.exports = {
+export default {
     AssignmentExpression: "AssignmentExpression",
     AssignmentPattern: "AssignmentPattern",
     ArrayExpression: "ArrayExpression",

diff --git a/lib/espree.js b/lib/espree.js
@@ -1,8 +1,7 @@
-"use strict";
-
 /* eslint-disable no-param-reassign*/
-const TokenTranslator = require("./token-translator");
-const { normalizeOptions } = require("./options");
+import TokenTranslator from "./token-translator.js";
+import { normalizeOptions } from "./options.js";
+
 
 const STATE = Symbol("espree's internal state");
 const ESPRIMA_FINISH_NODE = Symbol("espree's esprimaFinishNode");
@@ -41,7 +40,7 @@ function convertAcornCommentToEsprimaComment(block, text, start, end, startLoc,
     return comment;
 }
 
-module.exports = () => Parser => {
+export default () => Parser => {
     const tokTypes = Object.assign({}, Parser.acorn.tokTypes);
 
     if (Parser.acornJsx) {
@@ -276,7 +275,7 @@ module.exports = () => Parser => {
                 }
             }
 
-            if (result.type.indexOf("Function") > -1 && !result.generator) {
+            if (result.type.includes("Function") && !result.generator) {
                 result.generator = false;
             }
 

diff --git a/lib/features.js b/lib/features.js
@@ -4,8 +4,6 @@
  * @author Nicholas C. Zakas
  */
 
-"use strict";
-
 //------------------------------------------------------------------------------
 // Requirements
 //------------------------------------------------------------------------------
@@ -16,7 +14,7 @@
 // Public
 //------------------------------------------------------------------------------
 
-module.exports = {
+export default {
 
     // React JSX parsing
     jsx: false,

diff --git a/lib/options.js b/lib/options.js
@@ -3,8 +3,6 @@
  * @author Kai Cataldo
  */
 
-"use strict";
-
 //------------------------------------------------------------------------------
 // Helpers
 //------------------------------------------------------------------------------
@@ -67,7 +65,7 @@ function normalizeSourceType(sourceType = "script") {
  * @throws {Error} throw an error if found invalid option.
  * @returns {Object} normalized options
  */
-function normalizeOptions(options) {
+export function normalizeOptions(options) {
     const ecmaVersion = normalizeEcmaVersion(options.ecmaVersion);
     const sourceType = normalizeSourceType(options.sourceType);
     const ranges = options.range === true;
@@ -83,24 +81,14 @@ function normalizeOptions(options) {
  * Get the latest ECMAScript version supported by Espree.
  * @returns {number} The latest ECMAScript version.
  */
-function getLatestEcmaVersion() {
+export function getLatestEcmaVersion() {
     return SUPPORTED_VERSIONS[SUPPORTED_VERSIONS.length - 1];
 }
 
 /**
  * Get the list of ECMAScript versions supported by Espree.
  * @returns {number[]} An array containing the supported ECMAScript versions.
  */
-function getSupportedEcmaVersions() {
+export function getSupportedEcmaVersions() {
     return [...SUPPORTED_VERSIONS];
 }
-
-//------------------------------------------------------------------------------
-// Public
-//------------------------------------------------------------------------------
-
-module.exports = {
-    normalizeOptions,
-    getLatestEcmaVersion,
-    getSupportedEcmaVersions
-};
diff --git a/lib/token-translator.js b/lib/token-translator.js
@@ -4,8 +4,6 @@
  */
 /* eslint no-underscore-dangle: 0 */
 
-"use strict";
-
 //------------------------------------------------------------------------------
 // Requirements
 //------------------------------------------------------------------------------
@@ -260,4 +258,4 @@ TokenTranslator.prototype = {
 // Public
 //------------------------------------------------------------------------------
 
-module.exports = TokenTranslator;
+export default TokenTranslator;
diff --git a/lib/version.js b/lib/version.js
@@ -0,0 +1,3 @@
+const version = "7.3.1";
+
+export default version;