feat(eslint): rename eslint.config.js to eslint.config.cjs to they ar…

…e resolved as CommonJS
nrwl · Dec 12, 2024 · 144e881 · 144e881
1 parent a8de7df
commit 144e881
Show file tree

Hide file tree

Showing 48 changed files with 254 additions and 301 deletions.
diff --git a/docs/shared/packages/eslint/dependency-checks.md b/docs/shared/packages/eslint/dependency-checks.md
@@ -69,7 +69,7 @@ Sometimes we intentionally want to add or remove a dependency from our `package.
       "checkObsoleteDependencies": true, // toggle to disable
       "checkVersionMismatches": true, // toggle to disable
       "ignoredDependencies": ["lodash"], // these libs will be omitted from checks
-      "ignoredFiles": ["webpack.config.js", "eslint.config.js"], // list of files that should be skipped for check
+      "ignoredFiles": ["webpack.config.js", "eslint.config.cjs"], // list of files that should be skipped for check
       "includeTransitiveDependencies": true, // collect dependencies transitively from children
       "useLocalPathsForWorkspaceDependencies": true // toggle to disable
     }

diff --git a/docs/shared/recipes/tips-n-tricks/migrating-to-flat-eslint.md b/docs/shared/recipes/tips-n-tricks/migrating-to-flat-eslint.md
@@ -10,12 +10,12 @@ See below a direct comparison between `JSON`, `JS` and `Flat` config:
 {% tabs %}
 {% tab label="Flat" %}
 
-```js {% fileName="eslint.config.js" %}
+```js {% fileName="eslint.config.cjs" %}
 // the older versions were magically interpreting all the imports
 // in flat config we do it explicitly
 const nxPlugin = require('@nx/eslint-plugin');
 const js = require('@eslint/js');
-const baseConfig = require('./eslint.base.config.js');
+const baseConfig = require('./eslint.base.config.cjs');
 const globals = require('globals');
 const jsoncParser = require('jsonc-eslint-parser');
 const tsParser = require('@typescript-eslint/parser');

diff --git a/e2e/angular/src/misc.test.ts b/e2e/angular/src/misc.test.ts
@@ -39,7 +39,7 @@ describe('Move Angular Project', () => {
     expect(moveOutput).toContain(`CREATE ${newPath}/tsconfig.app.json`);
     expect(moveOutput).toContain(`CREATE ${newPath}/tsconfig.json`);
     expect(moveOutput).toContain(`CREATE ${newPath}/tsconfig.spec.json`);
-    expect(moveOutput).toContain(`CREATE ${newPath}/eslint.config.js`);
+    expect(moveOutput).toContain(`CREATE ${newPath}/eslint.config.cjs`);
     expect(moveOutput).toContain(`CREATE ${newPath}/public/favicon.ico`);
     expect(moveOutput).toContain(`CREATE ${newPath}/src/index.html`);
     expect(moveOutput).toContain(`CREATE ${newPath}/src/main.ts`);

diff --git a/e2e/angular/src/projects.test.ts b/e2e/angular/src/projects.test.ts
@@ -164,13 +164,13 @@ describe('Angular Projects', () => {
 
   it('should lint correctly with eslint and handle external HTML files and inline templates', async () => {
     // disable the prefer-standalone rule for app1 which is not standalone
-    let app1EslintConfig = readFile(`${app1}/eslint.config.js`);
+    let app1EslintConfig = readFile(`${app1}/eslint.config.cjs`);
     app1EslintConfig = app1EslintConfig.replace(
       `'@angular-eslint/directive-selector': [`,
       `'@angular-eslint/prefer-standalone': 'off',
       '@angular-eslint/directive-selector': [`
     );
-    updateFile(`${app1}/eslint.config.js`, app1EslintConfig);
+    updateFile(`${app1}/eslint.config.cjs`, app1EslintConfig);
 
     // check apps and lib pass linting for initial generated code
     runCLI(`run-many --target lint --projects=${app1},${lib1} --parallel`);

diff --git a/e2e/eslint/src/linter-legacy.test.ts b/e2e/eslint/src/linter-legacy.test.ts
@@ -150,10 +150,10 @@ describe('Linter (legacy)', () => {
         env: { NX_ADD_PLUGINS: 'false' },
       });
       checkFilesExist(
-        'eslint.config.js',
-        `apps/${myapp}/eslint.config.js`,
-        `libs/${mylib}/eslint.config.js`,
-        `libs/${mylib2}/eslint.config.js`
+        'eslint.config.cjs',
+        `apps/${myapp}/eslint.config.cjs`,
+        `libs/${mylib}/eslint.config.cjs`,
+        `libs/${mylib2}/eslint.config.cjs`
       );
       checkFilesDoNotExist(
         '.eslintrc.json',
@@ -164,12 +164,12 @@ describe('Linter (legacy)', () => {
 
       // move eslint.config one step up
       // to test the absence of the flat eslint config in the project root folder
-      renameFile(`libs/${mylib2}/eslint.config.js`, `libs/eslint.config.js`);
+      renameFile(`libs/${mylib2}/eslint.config.cjs`, `libs/eslint.config.cjs`);
       updateFile(
-        `libs/eslint.config.js`,
-        readFile(`libs/eslint.config.js`).replace(
-          `../../eslint.config.js`,
-          `../eslint.config.js`
+        `libs/eslint.config.cjs`,
+        readFile(`libs/eslint.config.cjs`).replace(
+          `../../eslint.config.cjs`,
+          `../eslint.config.cjs`
         )
       );
 
@@ -202,9 +202,9 @@ describe('Linter (legacy)', () => {
         env: { NX_ADD_PLUGINS: 'false' },
       });
       checkFilesExist(
-        'eslint.config.js',
-        `${mylib}/eslint.config.js`,
-        'eslint.base.config.js'
+        'eslint.config.cjs',
+        `${mylib}/eslint.config.cjs`,
+        'eslint.base.config.cjs'
       );
       checkFilesDoNotExist(
         '.eslintrc.json',

diff --git a/e2e/eslint/src/linter.test.ts b/e2e/eslint/src/linter.test.ts
@@ -615,8 +615,8 @@ describe('Linter', () => {
         runCLI(`generate @nx/js:lib ${jsLib} --linter eslint`);
 
         checkFilesExist(
-          `${reactLib}/eslint.config.js`,
-          `${jsLib}/eslint.config.js`
+          `${reactLib}/eslint.config.cjs`,
+          `${jsLib}/eslint.config.cjs`
         );
         checkFilesDoNotExist(
           `${reactLib}/.eslintrc.json`,

diff --git a/e2e/js/src/js-packaging.test.ts b/e2e/js/src/js-packaging.test.ts
@@ -178,16 +178,6 @@ describe('packaging libs', () => {
       `libs/${swcEsmLib}/src/index.ts`,
       `export * from './lib/${swcEsmLib}.js';`
     );
-    // We also need to update the eslint config file extensions to be explicitly commonjs
-    // TODO: re-evaluate this once we support ESM eslint configs
-    renameFile(
-      `libs/${tscEsmLib}/eslint.config.js`,
-      `libs/${tscEsmLib}/eslint.config.cjs`
-    );
-    renameFile(
-      `libs/${swcEsmLib}/eslint.config.js`,
-      `libs/${swcEsmLib}/eslint.config.cjs`
-    );
 
     // Add additional entry points for `exports` field
     updateJson(join('libs', tscLib, 'project.json'), (json) => {

diff --git a/e2e/nx/src/__snapshots__/extras.test.ts.snap b/e2e/nx/src/__snapshots__/extras.test.ts.snap
@@ -26,7 +26,7 @@ exports[`Extra Nx Misc Tests task graph inputs should correctly expand dependent
   ],
   "lib-base-123": [
     "libs/lib-base-123/README.md",
-    "libs/lib-base-123/eslint.config.js",
+    "libs/lib-base-123/eslint.config.cjs",
     "libs/lib-base-123/jest.config.ts",
     "libs/lib-base-123/package.json",
     "libs/lib-base-123/project.json",
@@ -39,7 +39,7 @@ exports[`Extra Nx Misc Tests task graph inputs should correctly expand dependent
   ],
   "lib-dependent-123": [
     "libs/lib-dependent-123/README.md",
-    "libs/lib-dependent-123/eslint.config.js",
+    "libs/lib-dependent-123/eslint.config.cjs",
     "libs/lib-dependent-123/jest.config.ts",
     "libs/lib-dependent-123/package.json",
     "libs/lib-dependent-123/project.json",

diff --git a/packages/angular/src/generators/library/library.spec.ts b/packages/angular/src/generators/library/library.spec.ts
@@ -1204,14 +1204,14 @@ describe('lib', () => {
   describe('--linter', () => {
     describe('eslint', () => {
       it('should add valid eslint JSON configuration which extends from Nx presets (flat config)', async () => {
-        tree.write('eslint.config.js', '');
+        tree.write('eslint.config.cjs', '');
 
         await runLibraryGeneratorWithOpts({ linter: Linter.EsLint });
 
-        const eslintConfig = tree.read('my-lib/eslint.config.js', 'utf-8');
+        const eslintConfig = tree.read('my-lib/eslint.config.cjs', 'utf-8');
         expect(eslintConfig).toMatchInlineSnapshot(`
           "const nx = require("@nx/eslint-plugin");
-          const baseConfig = require("../eslint.config.js");
+          const baseConfig = require("../eslint.config.cjs");
 
           module.exports = [
               ...baseConfig,

diff --git a/packages/angular/src/generators/ng-add/__snapshots__/migrate-from-angular-cli.spec.ts.snap b/packages/angular/src/generators/ng-add/__snapshots__/migrate-from-angular-cli.spec.ts.snap
@@ -93,7 +93,7 @@ exports[`workspace move to nx layout should create nx.json 1`] = `
       "!{projectRoot}/**/*.spec.[jt]s",
       "!{projectRoot}/karma.conf.js",
       "!{projectRoot}/.eslintrc.json",
-      "!{projectRoot}/eslint.config.js",
+      "!{projectRoot}/eslint.config.cjs",
     ],
     "sharedGlobals": [],
   },
@@ -104,7 +104,7 @@ exports[`workspace move to nx layout should create nx.json 1`] = `
         "default",
         "{workspaceRoot}/.eslintrc.json",
         "{workspaceRoot}/.eslintignore",
-        "{workspaceRoot}/eslint.config.js",
+        "{workspaceRoot}/eslint.config.cjs",
       ],
     },
     "build": {
@@ -129,7 +129,7 @@ exports[`workspace move to nx layout should create nx.json 1`] = `
       "inputs": [
         "default",
         "{workspaceRoot}/.eslintrc.json",
-        "{workspaceRoot}/eslint.config.js",
+        "{workspaceRoot}/eslint.config.cjs",
       ],
     },
     "test": {

diff --git a/packages/angular/src/generators/ng-add/utilities/workspace.ts b/packages/angular/src/generators/ng-add/utilities/workspace.ts
@@ -64,7 +64,7 @@ export function createNxJson(
             ]
           : []),
         ...(targets.lint
-          ? ['!{projectRoot}/.eslintrc.json', '!{projectRoot}/eslint.config.js']
+          ? ['!{projectRoot}/.eslintrc.json', '!{projectRoot}/eslint.config.cjs']
           : []),
       ].filter(Boolean),
     },
@@ -85,7 +85,7 @@ export function createNxJson(
             inputs: [
               'default',
               '{workspaceRoot}/.eslintrc.json',
-              '{workspaceRoot}/eslint.config.js',
+              '{workspaceRoot}/eslint.config.cjs',
             ],
             cache: true,
           }

diff --git a/...ges/angular/src/migrations/update-20-2-0/disable-angular-eslint-prefer-standalone.spec.ts b/...ges/angular/src/migrations/update-20-2-0/disable-angular-eslint-prefer-standalone.spec.ts
@@ -241,9 +241,9 @@ describe('disable-angular-eslint-prefer-standalone', () => {
 
   describe('flat config', () => {
     it('should not disable @angular-eslint/prefer-standalone when it is set', async () => {
-      tree.write('eslint.config.js', 'module.exports = [];');
+      tree.write('eslint.config.cjs', 'module.exports = [];');
       tree.write(
-        'apps/app1/eslint.config.js',
+        'apps/app1/eslint.config.cjs',
         `module.exports = [
           {
             files: ['*.ts'],
@@ -255,7 +255,7 @@ describe('disable-angular-eslint-prefer-standalone', () => {
 
       await migration(tree);
 
-      expect(tree.read('apps/app1/eslint.config.js', 'utf8'))
+      expect(tree.read('apps/app1/eslint.config.cjs', 'utf8'))
         .toMatchInlineSnapshot(`
         "module.exports = [
           {
@@ -268,9 +268,9 @@ describe('disable-angular-eslint-prefer-standalone', () => {
     });
 
     it('should not disable @angular-eslint/prefer-standalone when there are multiple overrides for angular eslint and the rule is set in one of them', async () => {
-      tree.write('eslint.config.js', 'module.exports = [];');
+      tree.write('eslint.config.cjs', 'module.exports = [];');
       tree.write(
-        'apps/app1/eslint.config.js',
+        'apps/app1/eslint.config.cjs',
         `module.exports = [
           {
             files: ['*.ts'],
@@ -291,7 +291,7 @@ describe('disable-angular-eslint-prefer-standalone', () => {
 
       await migration(tree);
 
-      expect(tree.read('apps/app1/eslint.config.js', 'utf8'))
+      expect(tree.read('apps/app1/eslint.config.cjs', 'utf8'))
         .toMatchInlineSnapshot(`
         "module.exports = [
           {
@@ -313,9 +313,9 @@ describe('disable-angular-eslint-prefer-standalone', () => {
     });
 
     it('should disable @angular-eslint/prefer-standalone in an existing override for angular eslint', async () => {
-      tree.write('eslint.config.js', 'module.exports = [];');
+      tree.write('eslint.config.cjs', 'module.exports = [];');
       tree.write(
-        'apps/app1/eslint.config.js',
+        'apps/app1/eslint.config.cjs',
         `module.exports = [
           {
             files: ['*.ts'],
@@ -336,7 +336,7 @@ describe('disable-angular-eslint-prefer-standalone', () => {
 
       await migration(tree);
 
-      expect(tree.read('apps/app1/eslint.config.js', 'utf8'))
+      expect(tree.read('apps/app1/eslint.config.cjs', 'utf8'))
         .toMatchInlineSnapshot(`
         "module.exports = [
           {
@@ -363,9 +363,9 @@ describe('disable-angular-eslint-prefer-standalone', () => {
     });
 
     it('should disable @angular-eslint/prefer-standalone in an existing override for ts files', async () => {
-      tree.write('eslint.config.js', 'module.exports = [];');
+      tree.write('eslint.config.cjs', 'module.exports = [];');
       tree.write(
-        'apps/app1/eslint.config.js',
+        'apps/app1/eslint.config.cjs',
         `module.exports = [
           {
             files: ['*.ts'],
@@ -377,7 +377,7 @@ describe('disable-angular-eslint-prefer-standalone', () => {
 
       await migration(tree);
 
-      expect(tree.read('apps/app1/eslint.config.js', 'utf8'))
+      expect(tree.read('apps/app1/eslint.config.cjs', 'utf8'))
         .toMatchInlineSnapshot(`
         "module.exports = [
           {
@@ -393,9 +393,9 @@ describe('disable-angular-eslint-prefer-standalone', () => {
     });
 
     it('should disable @angular-eslint/prefer-standalone in a new override', async () => {
-      tree.write('eslint.config.js', 'module.exports = [];');
+      tree.write('eslint.config.cjs', 'module.exports = [];');
       tree.write(
-        'apps/app1/eslint.config.js',
+        'apps/app1/eslint.config.cjs',
         `module.exports = [
           {
             files: ['*.html'],
@@ -407,7 +407,7 @@ describe('disable-angular-eslint-prefer-standalone', () => {
 
       await migration(tree);
 
-      expect(tree.read('apps/app1/eslint.config.js', 'utf8'))
+      expect(tree.read('apps/app1/eslint.config.cjs', 'utf8'))
         .toMatchInlineSnapshot(`
         "module.exports = [
           {