@nx/eslint 17.1.0-beta.0 → 17.1.0-beta.3

package/migrations.json

@@ -27,6 +27,11 @@
       "version": "17.0.0-beta.7",
       "description": "update-17-0-0-rename-to-eslint",
       "implementation": "./src/migrations/update-17-0-0-rename-to-eslint/update-17-0-0-rename-to-eslint"
+    },
+    "update-typescript-eslint": {
+      "version": "17.1.0-beta.1",
+      "description": "Updates for @typescript-utils/utils v6.9.1+",
+      "implementation": "./src/migrations/update-17-1-0/update-typescript-eslint"
     }
   },
   "packageJsonUpdates": {
@@ -82,6 +87,20 @@
           "version": "^9.0.0"
         }
       }
+    },
+    "17.1.0": {
+      "version": "17.1.0-beta.1",
+      "packages": {
+        "@typescript-eslint/parser": {
+          "version": "^6.9.1"
+        },
+        "@typescript-eslint/eslint-plugin": {
+          "version": "^6.9.1"
+        },
+        "@typescript-eslint/utils": {
+          "version": "^6.9.1"
+        }
+      }
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/eslint",
-  "version": "17.1.0-beta.0",
+  "version": "17.1.0-beta.3",
   "private": false,
   "description": "The ESLint plugin for Nx contains executors, generators and utilities used for linting JavaScript/TypeScript projects within an Nx workspace.",
   "repository": {
@@ -34,10 +34,10 @@
   },
   "dependencies": {
     "tslib": "^2.3.0",
-    "@nx/devkit": "17.1.0-beta.0",
-    "@nx/js": "17.1.0-beta.0",
-    "typescript": "~5.1.3",
-    "@nx/linter": "17.1.0-beta.0"
+    "@nx/devkit": "17.1.0-beta.3",
+    "@nx/js": "17.1.0-beta.3",
+    "typescript": "~5.2.2",
+    "@nx/linter": "17.1.0-beta.3"
   },
   "peerDependenciesMeta": {
     "eslint": {

package/src/executors/lint/lint.impl.js

@@ -27,17 +27,13 @@ async function run(options, context) {
     options.cacheLocation = options.cacheLocation
         ? (0, devkit_1.joinPathFragments)(options.cacheLocation, projectName)
         : undefined;
-    const { printConfig, ...normalizedOptions } = options;
+    const { printConfig, errorOnUnmatchedPattern, ...normalizedOptions } = options;
     /**
      * Until ESLint v9 is released and the new so called flat config is the default
      * we only want to support it if the user has explicitly opted into it by converting
      * their root ESLint config to use eslint.config.js
      */
     const hasFlatConfig = (0, fs_1.existsSync)((0, devkit_1.joinPathFragments)(devkit_1.workspaceRoot, 'eslint.config.js'));
-    if (!eslintConfigPath && hasFlatConfig) {
-        const projectRoot = context.projectsConfigurations.projects[context.projectName].root;
-        eslintConfigPath = (0, devkit_1.joinPathFragments)(projectRoot, 'eslint.config.js');
-    }
     const { eslint, ESLint } = await (0, eslint_utils_1.resolveAndInstantiateESLint)(eslintConfigPath, normalizedOptions, hasFlatConfig);
     const version = ESLint.version?.split('.');
     if (!version ||
@@ -84,7 +80,7 @@ Please see https://nx.dev/guides/eslint for full guidance on how to resolve this
         // If some unexpected error, rethrow
         throw err;
     }
-    if (lintResults.length === 0) {
+    if (lintResults.length === 0 && errorOnUnmatchedPattern) {
         const ignoredPatterns = (await Promise.all(normalizedOptions.lintFilePatterns.map(async (pattern) => (await eslint.isPathIgnored(pattern)) ? pattern : null)))
             .filter((pattern) => !!pattern)
             .map((pattern) => `- '${pattern}'`);

package/src/executors/lint/schema.d.ts

@@ -21,6 +21,7 @@ export interface Schema extends JsonObject {
   resolvePluginsRelativeTo: string | null;
   reportUnusedDisableDirectives: Linter.StringSeverity | null;
   printConfig?: string | null;
+  errorOnUnmatchedPattern?: boolean;
 }
 
 type Formatter =

package/src/executors/lint/schema.json

@@ -137,6 +137,11 @@
       "type": "string",
       "description": "The equivalent of the `--print-config` flag on the ESLint CLI.",
       "x-completion-type": "file"
+    },
+    "errorOnUnmatchedPattern": {
+      "type": "boolean",
+      "description": "When set to false, equivalent of the `--no-error-on-unmatched-pattern` flag on the ESLint CLI.",
+      "default": true
     }
   },
   "required": ["lintFilePatterns"],

package/src/generators/convert-to-flat-config/converters/json-converter.d.ts

@@ -3,4 +3,4 @@ import { Tree } from '@nx/devkit';
  * Converts an ESLint JSON config to a flat config.
  * Deletes the original file along with .eslintignore if it exists.
  */
-export declare function convertEslintJsonToFlatConfig(tree: Tree, root: string, sourceFile: string, destinationFile: string): void;
+export declare function convertEslintJsonToFlatConfig(tree: Tree, root: string, sourceFile: string, destinationFile: string, ignorePaths: string[]): void;

package/src/generators/convert-to-flat-config/converters/json-converter.js

@@ -11,7 +11,7 @@ const eslint_file_1 = require("../../utils/eslint-file");
  * Converts an ESLint JSON config to a flat config.
  * Deletes the original file along with .eslintignore if it exists.
  */
-function convertEslintJsonToFlatConfig(tree, root, sourceFile, destinationFile) {
+function convertEslintJsonToFlatConfig(tree, root, sourceFile, destinationFile, ignorePaths) {
     const importsMap = new Map();
     const exportElements = [];
     let isFlatCompatNeeded = false;
@@ -83,18 +83,19 @@ function convertEslintJsonToFlatConfig(tree, root, sourceFile, destinationFile)
             }));
         }
     }
-    if (tree.exists(`${root}/.eslintignore`)) {
-        const patterns = tree
-            .read(`${root}/.eslintignore`, 'utf-8')
-            .split('\n')
-            .filter((line) => line.length > 0 && line !== 'node_modules')
-            .map((path) => (0, ast_utils_1.mapFilePath)(path, root));
-        if (patterns.length > 0) {
-            exportElements.push((0, ast_utils_1.generateAst)({ ignores: patterns }));
+    for (const ignorePath of ignorePaths) {
+        if (tree.exists(ignorePath)) {
+            const patterns = tree
+                .read(ignorePath, 'utf-8')
+                .split('\n')
+                .filter((line) => line.length > 0 && line !== 'node_modules')
+                .map((path) => (0, ast_utils_1.mapFilePath)(path, root));
+            if (patterns.length > 0) {
+                exportElements.push((0, ast_utils_1.generateAst)({ ignores: patterns }));
+            }
         }
     }
     tree.delete((0, path_1.join)(root, sourceFile));
-    tree.delete((0, path_1.join)(root, '.eslintignore'));
     // create the node list and print it to new file
     const nodeList = (0, ast_utils_1.createNodeList)(importsMap, exportElements, isFlatCompatNeeded);
     const content = (0, ast_utils_1.stringifyNodeList)(nodeList, root, destinationFile);

package/src/generators/convert-to-flat-config/generator.js

@@ -12,12 +12,17 @@ async function convertToFlatConfigGenerator(tree, options) {
     if (!eslintFile.endsWith('.json')) {
         throw new Error('Only json eslint config files are supported for conversion');
     }
-    // rename root eslint config to eslint.config.js
+    const eslintIgnoreFiles = new Set(['.eslintignore']);
+    // convert root eslint config to eslint.config.js
     convertRootToFlatConfig(tree, eslintFile);
-    // rename and map files
+    // convert project eslint files to eslint.config.js
     const projects = (0, devkit_1.getProjects)(tree);
     for (const [project, projectConfig] of projects) {
-        convertProjectToFlatConfig(tree, project, projectConfig, (0, devkit_1.readNxJson)(tree));
+        convertProjectToFlatConfig(tree, project, projectConfig, (0, devkit_1.readNxJson)(tree), eslintIgnoreFiles);
+    }
+    // delete all .eslintignore files
+    for (const ignoreFile of eslintIgnoreFiles) {
+        tree.delete(ignoreFile);
     }
     // replace references in nx.json
     updateNxJsonConfig(tree);
@@ -34,22 +39,31 @@ function convertRootToFlatConfig(tree, eslintFile) {
     }
     convertConfigToFlatConfig(tree, '', '.eslintrc.json', 'eslint.config.js');
 }
-function convertProjectToFlatConfig(tree, project, projectConfig, nxJson) {
+function convertProjectToFlatConfig(tree, project, projectConfig, nxJson, eslintIgnoreFiles) {
     if (tree.exists(`${projectConfig.root}/.eslintrc.json`)) {
         if (projectConfig.targets) {
             const eslintTargets = Object.keys(projectConfig.targets || {}).filter((t) => projectConfig.targets[t].executor === '@nx/eslint:lint');
+            let ignorePath;
             for (const target of eslintTargets) {
                 // remove any obsolete `eslintConfig` options pointing to the old config file
                 if (projectConfig.targets[target].options?.eslintConfig) {
                     delete projectConfig.targets[target].options.eslintConfig;
                 }
+                if (projectConfig.targets[target].options?.ignorePath) {
+                    ignorePath = projectConfig.targets[target].options.ignorePath;
+                    delete projectConfig.targets[target].options.ignorePath;
+                }
                 (0, devkit_1.updateProjectConfiguration)(tree, project, projectConfig);
             }
             const nxHasLintTargets = Object.keys(nxJson.targetDefaults || {}).some((t) => (t === '@nx/eslint:lint' ||
                 nxJson.targetDefaults[t].executor === '@nx/eslint:lint') &&
                 projectConfig.targets?.[t]);
             if (nxHasLintTargets || eslintTargets.length > 0) {
-                convertConfigToFlatConfig(tree, projectConfig.root, '.eslintrc.json', 'eslint.config.js');
+                convertConfigToFlatConfig(tree, projectConfig.root, '.eslintrc.json', 'eslint.config.js', ignorePath);
+                eslintIgnoreFiles.add(`${projectConfig.root}/.eslintignore`);
+                if (ignorePath) {
+                    eslintIgnoreFiles.add(ignorePath);
+                }
             }
         }
     }
@@ -78,6 +92,9 @@ function updateNxJsonConfig(tree) {
         });
     }
 }
-function convertConfigToFlatConfig(tree, root, source, target) {
-    (0, json_converter_1.convertEslintJsonToFlatConfig)(tree, root, source, target);
+function convertConfigToFlatConfig(tree, root, source, target, ignorePath) {
+    const ignorePaths = ignorePath
+        ? [ignorePath, `${root}/.eslintignore`]
+        : [`${root}/.eslintignore`];
+    (0, json_converter_1.convertEslintJsonToFlatConfig)(tree, root, source, target, ignorePaths);
 }

package/src/generators/init/init-migration.js

@@ -54,7 +54,6 @@ function migrateEslintFile(projectEslintPath, tree) {
                 'plugin:@nrwl/typescript',
                 'plugin:@nrwl/javascript',
             ]);
-            console.warn('Flat eslint config is not supported yet for migration');
             tree.write(projectEslintPath, config);
         }
         else {

package/src/generators/utils/flat-config/ast-utils.js

@@ -223,19 +223,23 @@ function addBlockToFlatConfigExport(content, config, options = {
     });
     const insert = printer.printNode(ts.EmitHint.Expression, config, source);
     if (options.insertAtTheEnd) {
+        const index = exportsArray.length > 0
+            ? exportsArray.at(exportsArray.length - 1).end
+            : exportsArray.pos;
         return (0, devkit_1.applyChangesToString)(content, [
             {
                 type: devkit_1.ChangeType.Insert,
-                index: exportsArray[exportsArray.length - 1].end,
+                index,
                 text: `,\n${insert}`,
             },
         ]);
     }
     else {
+        const index = exportsArray.length > 0 ? exportsArray.at(0).pos : exportsArray.pos;
         return (0, devkit_1.applyChangesToString)(content, [
             {
                 type: devkit_1.ChangeType.Insert,
-                index: exportsArray[0].pos,
+                index,
                 text: `\n${insert},`,
             },
         ]);

package/src/generators/workspace-rule/files/__name__.ts__tmpl__

@@ -25,7 +25,7 @@ export const rule = ESLintUtils.RuleCreator(() => __filename)({
     type: 'problem',
     docs: {
       description: ``,
-      recommended: 'error',
+      recommended: 'recommended',
     },
     schema: [],
     messages: {},

package/src/generators/workspace-rules-project/files/tsconfig.json__tmpl__

@@ -1,7 +1,8 @@
 {
   "extends": "<%= rootTsConfigPath %>",
   "compilerOptions": {
-    "module": "commonjs"
+    "moduleResolution": "node16",
+    "module": "node16"
   },
   "files": [],
   "include": [],

package/src/generators/workspace-rules-project/workspace-rules-project.d.ts

@@ -1,7 +1,7 @@
-import { Tree } from '@nx/devkit';
+import { GeneratorCallback, Tree } from '@nx/devkit';
 export declare const WORKSPACE_RULES_PROJECT_NAME = "eslint-rules";
 export declare const WORKSPACE_PLUGIN_DIR = "tools/eslint-rules";
 export interface LintWorkspaceRulesProjectGeneratorOptions {
     skipFormat?: boolean;
 }
-export declare function lintWorkspaceRulesProjectGenerator(tree: Tree, options?: LintWorkspaceRulesProjectGeneratorOptions): Promise<import("@nx/devkit").GeneratorCallback>;
+export declare function lintWorkspaceRulesProjectGenerator(tree: Tree, options?: LintWorkspaceRulesProjectGeneratorOptions): Promise<GeneratorCallback>;

package/src/generators/workspace-rules-project/workspace-rules-project.js

@@ -10,7 +10,8 @@ const workspace_lint_rules_1 = require("../../utils/workspace-lint-rules");
 exports.WORKSPACE_RULES_PROJECT_NAME = 'eslint-rules';
 exports.WORKSPACE_PLUGIN_DIR = 'tools/eslint-rules';
 async function lintWorkspaceRulesProjectGenerator(tree, options = {}) {
-    const { addPropertyToJestConfig, configurationGenerator } = (0, devkit_1.ensurePackage)('@nx/jest', versions_1.nxVersion);
+    const { configurationGenerator } = (0, devkit_1.ensurePackage)('@nx/jest', versions_1.nxVersion);
+    const tasks = [];
     // Noop if the workspace rules project already exists
     try {
         (0, devkit_1.readProjectConfiguration)(tree, exports.WORKSPACE_RULES_PROJECT_NAME);
@@ -39,15 +40,16 @@ async function lintWorkspaceRulesProjectGenerator(tree, options = {}) {
         (0, devkit_1.updateNxJson)(tree, nxJson);
     }
     // Add jest to the project and return installation task
-    const installTask = await configurationGenerator(tree, {
+    tasks.push(await configurationGenerator(tree, {
         project: exports.WORKSPACE_RULES_PROJECT_NAME,
         supportTsx: false,
         skipSerializers: true,
         setupFile: 'none',
         compiler: 'tsc',
         skipFormat: true,
-    });
+    }));
     (0, devkit_1.updateJson)(tree, (0, path_1.join)(workspace_lint_rules_1.workspaceLintPluginDir, 'tsconfig.spec.json'), (json) => {
+        delete json.compilerOptions?.module;
         if (json.include) {
             json.include = json.include.map((v) => {
                 if (v.startsWith('src/**')) {
@@ -67,14 +69,13 @@ async function lintWorkspaceRulesProjectGenerator(tree, options = {}) {
         return json;
     });
     // Add swc dependencies
-    (0, add_swc_dependencies_1.addSwcRegisterDependencies)(tree);
-    // Add extra config to the jest.config.ts file to allow ESLint 8 exports mapping to work with jest
-    addPropertyToJestConfig(tree, (0, devkit_1.joinPathFragments)(exports.WORKSPACE_PLUGIN_DIR, 'jest.config.ts'), 'moduleNameMapper', {
-        '@eslint/eslintrc': '@eslint/eslintrc/dist/eslintrc-universal.cjs',
-    });
+    tasks.push((0, add_swc_dependencies_1.addSwcRegisterDependencies)(tree));
+    tasks.push((0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
+        '@typescript-eslint/utils': versions_1.typescriptESLintVersion,
+    }));
     if (!options.skipFormat) {
         await (0, devkit_1.formatFiles)(tree);
     }
-    return installTask;
+    return (0, devkit_1.runTasksInSerial)(...tasks);
 }
 exports.lintWorkspaceRulesProjectGenerator = lintWorkspaceRulesProjectGenerator;

package/src/migrations/update-17-1-0/update-typescript-eslint.d.ts

@@ -0,0 +1,2 @@
+import { Tree } from '@nx/devkit';
+export default function update(tree: Tree): Promise<void>;

package/src/migrations/update-17-1-0/update-typescript-eslint.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const devkit_1 = require("@nx/devkit");
+const versions_1 = require("../../utils/versions");
+const path_1 = require("path");
+const typescript_1 = require("typescript");
+function updateJestConfig(tree) {
+    const jestConfigPath = 'tools/eslint-rules/jest.config.ts';
+    if (tree.exists(jestConfigPath)) {
+        const { removePropertyFromJestConfig } = (0, devkit_1.ensurePackage)('@nx/jest', versions_1.nxVersion);
+        removePropertyFromJestConfig(tree, jestConfigPath, [
+            'moduleNameMapper',
+            '@eslint/eslintrc',
+        ]);
+    }
+}
+function updateTsConfigs(tree) {
+    const tsConfigPath = 'tools/eslint-rules/tsconfig.json';
+    if (tree.exists(tsConfigPath)) {
+        (0, devkit_1.updateJson)(tree, tsConfigPath, (tsConfig) => {
+            tsConfig.compilerOptions ??= {};
+            tsConfig.compilerOptions.moduleResolution = 'node16';
+            tsConfig.compilerOptions.module = 'node16';
+            return tsConfig;
+        });
+    }
+    const tsConfigSpec = 'tools/eslint-rules/tsconfig.spec.json';
+    if (tree.exists(tsConfigSpec)) {
+        (0, devkit_1.updateJson)(tree, tsConfigSpec, (tsConfigSpec) => {
+            delete tsConfigSpec.compilerOptions?.module;
+            delete tsConfigSpec.compilerOptions?.moduleResolution;
+            return tsConfigSpec;
+        });
+    }
+}
+function updateRecommended(tree) {
+    (0, devkit_1.visitNotIgnoredFiles)(tree, 'tools/eslint-rules', (path) => {
+        if ((0, path_1.extname)(path) !== '.ts') {
+            return;
+        }
+        const contents = tree.read(path, 'utf-8');
+        const sourceFile = (0, typescript_1.createSourceFile)(path, contents, typescript_1.ScriptTarget.ESNext, true);
+        const changes = [];
+        const visit = (node) => {
+            if ((0, typescript_1.isPropertyAssignment)(node) &&
+                (0, typescript_1.isIdentifier)(node.name) &&
+                node.name.text === 'recommended' &&
+                (0, typescript_1.isStringLiteral)(node.initializer)) {
+                changes.push({
+                    type: devkit_1.ChangeType.Delete,
+                    start: node.initializer.getStart(sourceFile),
+                    length: node.initializer.getWidth(sourceFile),
+                });
+                changes.push({
+                    type: devkit_1.ChangeType.Insert,
+                    index: node.initializer.getStart(sourceFile),
+                    text: "'recommended'",
+                });
+            }
+            else {
+                (0, typescript_1.forEachChild)(node, visit);
+            }
+        };
+        (0, typescript_1.forEachChild)(sourceFile, visit);
+        tree.write(path, (0, devkit_1.applyChangesToString)(contents, changes));
+    });
+}
+async function update(tree) {
+    updateJestConfig(tree);
+    updateTsConfigs(tree);
+    updateRecommended(tree);
+    await (0, devkit_1.formatFiles)(tree);
+}
+exports.default = update;

package/src/utils/versions.d.ts

@@ -2,4 +2,4 @@ export declare const nxVersion: any;
 export declare const eslintVersion = "~8.46.0";
 export declare const eslintrcVersion = "^2.1.1";
 export declare const eslintConfigPrettierVersion = "^9.0.0";
-export declare const typescriptESLintVersion = "^5.60.1";
+export declare const typescriptESLintVersion = "^6.9.1";

package/src/utils/versions.js

@@ -5,4 +5,4 @@ exports.nxVersion = require('../../package.json').version;
 exports.eslintVersion = '~8.46.0';
 exports.eslintrcVersion = '^2.1.1';
 exports.eslintConfigPrettierVersion = '^9.0.0';
-exports.typescriptESLintVersion = '^5.60.1';
+exports.typescriptESLintVersion = '^6.9.1';