@nx/eslint 19.0.0-canary.20240503-dbad02a → 19.0.0-rc.0

package/generators.json

@@ -23,6 +23,11 @@
       "factory": "./src/generators/convert-to-flat-config/generator",
       "schema": "./src/generators/convert-to-flat-config/schema.json",
       "description": "Convert an Nx workspace's ESLint configs to use Flat Config."
+    },
+    "convert-to-inferred": {
+      "factory": "./src/generators/convert-to-inferred/convert-to-inferred",
+      "schema": "./src/generators/convert-to-inferred/schema.json",
+      "description": "Convert existing ESLint project(s) using `@nx/eslint:lint` executor to use `@nx/eslint/plugin`."
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/eslint",
-  "version": "19.0.0-canary.20240503-dbad02a",
+  "version": "19.0.0-rc.0",
   "private": false,
   "description": "The ESLint plugin for Nx contains executors, generators and utilities used for linting JavaScript/TypeScript projects within an Nx workspace.",
   "repository": {
@@ -33,12 +33,12 @@
     "js-yaml": "4.1.0"
   },
   "dependencies": {
-    "@nx/devkit": "19.0.0-canary.20240503-dbad02a",
-    "@nx/js": "19.0.0-canary.20240503-dbad02a",
+    "@nx/devkit": "19.0.0-rc.0",
+    "@nx/js": "19.0.0-rc.0",
     "eslint": "^8.0.0",
     "tslib": "^2.3.0",
     "typescript": "~5.4.2",
-    "@nx/linter": "19.0.0-canary.20240503-dbad02a"
+    "@nx/linter": "19.0.0-rc.0"
   },
   "peerDependenciesMeta": {
     "js-yaml": {

package/src/generators/convert-to-inferred/convert-to-inferred.d.ts

@@ -0,0 +1,7 @@
+import { type Tree } from '@nx/devkit';
+interface Schema {
+    project?: string;
+    skipFormat?: boolean;
+}
+export declare function convertToInferred(tree: Tree, options: Schema): Promise<void>;
+export default convertToInferred;

package/src/generators/convert-to-inferred/convert-to-inferred.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertToInferred = void 0;
+const devkit_1 = require("@nx/devkit");
+const plugin_1 = require("../../plugins/plugin");
+const executor_to_plugin_migrator_1 = require("@nx/devkit/src/generators/plugin-migrations/executor-to-plugin-migrator");
+const target_options_map_1 = require("./lib/target-options-map");
+const utils_1 = require("nx/src/tasks-runner/utils");
+async function convertToInferred(tree, options) {
+    const projectGraph = await (0, devkit_1.createProjectGraphAsync)();
+    const migratedProjectsModern = await (0, executor_to_plugin_migrator_1.migrateExecutorToPlugin)(tree, projectGraph, '@nx/eslint:lint', '@nx/eslint/plugin', (targetName) => ({ targetName }), postTargetTransformer, plugin_1.createNodes, options.project);
+    const migratedProjectsLegacy = await (0, executor_to_plugin_migrator_1.migrateExecutorToPlugin)(tree, projectGraph, '@nrwl/linter:eslint', '@nx/eslint/plugin', (targetName) => ({ targetName }), postTargetTransformer, plugin_1.createNodes, options.project);
+    const migratedProjects = migratedProjectsModern.size + migratedProjectsLegacy.size;
+    if (migratedProjects === 0) {
+        throw new Error('Could not find any targets to migrate.');
+    }
+    if (!options.skipFormat) {
+        await (0, devkit_1.formatFiles)(tree);
+    }
+}
+exports.convertToInferred = convertToInferred;
+function postTargetTransformer(target, tree, projectDetails) {
+    if (target.inputs) {
+        target.inputs = target.inputs.filter((input) => typeof input === 'string' &&
+            ![
+                'default',
+                '{workspaceRoot}/.eslintrc.json',
+                '{workspaceRoot}/.eslintignore',
+                '{workspaceRoot}/eslint.config.js',
+            ].includes(input));
+        if (target.inputs.length === 0) {
+            delete target.inputs;
+        }
+    }
+    if (target.options) {
+        if ('eslintConfig' in target.options) {
+            delete target.options.eslintConfig;
+        }
+        if ('force' in target.options) {
+            delete target.options.force;
+        }
+        if ('silent' in target.options) {
+            delete target.options.silent;
+        }
+        if ('hasTypeAwareRules' in target.options) {
+            delete target.options.hasTypeAwareRules;
+        }
+        if ('errorOnUnmatchedPattern' in target.options) {
+            if (!target.options.errorOnUnmatchedPattern) {
+                target.options['no-error-on-unmatched-pattern'] = true;
+            }
+            delete target.options.errorOnUnmatchedPattern;
+        }
+        if ('outputFile' in target.options) {
+            target.outputs ??= [];
+            target.outputs.push(target.options.outputFile);
+        }
+        for (const key in target_options_map_1.targetOptionsToCliMap) {
+            if (target.options[key]) {
+                target.options[target_options_map_1.targetOptionsToCliMap[key]] = target.options[key];
+                delete target.options[key];
+            }
+        }
+        if ('lintFilePatterns' in target.options) {
+            const normalizedLintFilePatterns = target.options.lintFilePatterns.map((pattern) => {
+                return (0, utils_1.interpolate)(pattern, {
+                    workspaceRoot: '',
+                    projectRoot: projectDetails.root,
+                    projectName: projectDetails.projectName,
+                });
+            });
+            target.options.args = normalizedLintFilePatterns.map((pattern) => pattern.startsWith(projectDetails.root)
+                ? pattern.replace(new RegExp(`^${projectDetails.root}/`), './')
+                : pattern);
+            delete target.options.lintFilePatterns;
+        }
+    }
+    return target;
+}
+exports.default = convertToInferred;

package/src/generators/convert-to-inferred/lib/target-options-map.d.ts

@@ -0,0 +1,16 @@
+export declare const targetOptionsToCliMap: {
+    fix: string;
+    format: string;
+    cache: string;
+    cacheLocation: string;
+    cacheStrategy: string;
+    noEslintrc: string;
+    outputFile: string;
+    maxWarnings: string;
+    quiet: string;
+    ignorePath: string;
+    rulesdir: string;
+    resolvePluginsRelativeTo: string;
+    reportUnusedDisableDirectives: string;
+    printConfig: string;
+};

package/src/generators/convert-to-inferred/lib/target-options-map.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.targetOptionsToCliMap = void 0;
+exports.targetOptionsToCliMap = {
+    fix: 'fix',
+    format: 'format',
+    cache: 'cache',
+    cacheLocation: 'cache-location',
+    cacheStrategy: 'cache-strategy',
+    noEslintrc: 'no-eslintrc',
+    outputFile: 'output-file',
+    maxWarnings: 'max-warnings',
+    quiet: 'quiet',
+    ignorePath: 'ignore-path',
+    rulesdir: 'rulesdir',
+    resolvePluginsRelativeTo: 'resolve-plugins-relative-to',
+    reportUnusedDisableDirectives: 'report-unused-disable-directives',
+    printConfig: 'print-config',
+};

package/src/generators/convert-to-inferred/schema.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "$id": "NxEslintConvertToInferred",
+  "description": "Convert existing Eslint project(s) using `@nx/eslint:lint` executor to use `@nx/eslint/plugin`. Defaults to migrating all projects. Pass '--project' to migrate only one target.",
+  "title": "Convert Eslint project from executor to plugin",
+  "type": "object",
+  "properties": {
+    "project": {
+      "type": "string",
+      "description": "The project to convert from using the `@nx/eslint:lint` executor to use `@nx/eslint/plugin`.",
+      "x-priority": "important"
+    },
+    "skipFormat": {
+      "type": "boolean",
+      "description": "Whether to format files at the end of the migration.",
+      "default": false
+    }
+  }
+}