@nx/eslint 23.0.0 → 23.1.0-beta.0

package/README.md

@@ -7,13 +7,12 @@
 
 <div style="text-align: center;">
 
-[![CircleCI](https://circleci.com/gh/nrwl/nx.svg?style=svg)](https://circleci.com/gh/nrwl/nx)
 [![License](https://img.shields.io/npm/l/@nx/workspace.svg?style=flat-square)]()
 [![NPM Version](https://badge.fury.io/js/nx.svg)](https://www.npmjs.com/package/nx)
 [![Semantic Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)]()
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
-[![Join the chat at https://gitter.im/nrwl-nx/community](https://badges.gitter.im/nrwl-nx/community.svg)](https://gitter.im/nrwl-nx/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Join us on the Official Nx Discord Server](https://img.shields.io/discord/1143497901675401286?label=discord)](https://go.nx.dev/community)
+[![Nx Sandboxing](https://staging.nx.app/workspaces/62d013ea0852fe0a2df74438/sandbox-badge.svg)](https://nx.dev/docs/features/ci-features/sandboxing)
 
 </div>
 

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

@@ -6,7 +6,6 @@ const internal_1 = require("@nx/devkit/internal");
 const fs_1 = require("fs");
 const utils_1 = require("nx/src/tasks-runner/utils");
 const path_1 = require("path");
-const semver_1 = require("semver");
 const config_file_1 = require("../../utils/config-file");
 const deprecation_1 = require("../../utils/deprecation");
 const versions_1 = require("../../utils/versions");
@@ -48,10 +47,6 @@ async function run(options, context) {
         : undefined;
     const { eslint, ESLint } = await (0, eslint_utils_1.resolveAndInstantiateESLint)(eslintConfigPath, normalizedOptions, hasFlatConfig);
     (0, internal_1.assertSupportedInstalledPackageVersion)('eslint', versions_1.minSupportedEslintVersion);
-    const installedEslintVersion = (0, internal_1.getInstalledPackageVersion)('eslint');
-    if (installedEslintVersion && (0, semver_1.major)(installedEslintVersion) === 8) {
-        (0, deprecation_1.warnEslintV8Deprecation)();
-    }
     if (printConfig) {
         try {
             const fileConfig = await eslint.calculateConfigForFile(printConfig);

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

@@ -29,17 +29,4 @@ export interface Schema extends JsonObject {
   suppressionsLocation?: string;
 }
 
-type Formatter =
-  | 'stylish'
-  | 'compact'
-  | 'codeframe'
-  | 'unix'
-  | 'visualstudio'
-  | 'table'
-  | 'checkstyle'
-  | 'html'
-  | 'jslint-xml'
-  | 'json'
-  | 'json-with-metadata'
-  | 'junit'
-  | 'tap';
+type Formatter = 'stylish' | 'html' | 'json' | 'json-with-metadata';

package/dist/src/executors/lint/schema.json

@@ -29,21 +29,7 @@
       "default": "stylish",
       "anyOf": [
         {
-          "enum": [
-            "stylish",
-            "compact",
-            "codeframe",
-            "unix",
-            "visualstudio",
-            "table",
-            "checkstyle",
-            "html",
-            "jslint-xml",
-            "json",
-            "json-with-metadata",
-            "junit",
-            "tap"
-          ]
+          "enum": ["stylish", "html", "json", "json-with-metadata"]
         },
         {
           "minLength": 1

package/dist/src/executors/lint/utility/eslint-utils.js

@@ -11,9 +11,10 @@ async function resolveAndInstantiateESLint(eslintConfigPath, options, useFlatCon
     const ESLint = await (0, resolve_eslint_class_1.resolveESLintClass)({
         useFlatConfigOverrideVal: useFlatConfig,
     });
-    // Use the broader legacy options shape so the v8 (legacy-only) fields assigned
-    // below type-check. Flat-only fields (ruleFilter, suppress*) are intersected
-    // in; they're ignored at runtime by legacy ESLint and are version-gated below.
+    // Use the broader legacy (eslintrc) options shape so the legacy-only fields
+    // assigned below type-check. The flat-only fields (ruleFilter, suppress*) are
+    // intersected in and set conditionally below, since LegacyESLint rejects
+    // unknown options.
     const eslintOptions = {
         overrideConfigFile: eslintConfigPath,
         fix: !!options.fix &&
@@ -60,8 +61,9 @@ async function resolveAndInstantiateESLint(eslintConfigPath, options, useFlatCon
         eslintOptions.reportUnusedDisableDirectives =
             options.reportUnusedDisableDirectives || undefined;
     }
-    // pass --quiet to eslint 9+ directly: filter only errors
-    if (options.quiet && (0, semver_1.gte)(ESLint.version, '9.0.0')) {
+    // `ruleFilter` is flat-config only; LegacyESLint (eslintrc) throws on unknown
+    // options, so only set it for flat config.
+    if (options.quiet && useFlatConfig) {
         eslintOptions.ruleFilter = (rule) => rule.severity === 2;
     }
     // Handle bulk suppression options (ESLint v9.24.0+)

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

@@ -7,9 +7,18 @@ const plugin_1 = require("../utils/plugin");
 const path_1 = require("path");
 const assert_supported_eslint_version_1 = require("../../utils/assert-supported-eslint-version");
 const versions_1 = require("../../utils/versions");
+const config_file_1 = require("../../utils/config-file");
 const json_converter_1 = require("./converters/json-converter");
 async function convertToFlatConfigGenerator(tree, options) {
     (0, assert_supported_eslint_version_1.assertSupportedEslintVersion)(tree);
+    // Already on flat config at the root? There is nothing to convert.
+    const hasRootFlatConfig = [
+        ...config_file_1.ESLINT_FLAT_CONFIG_FILENAMES,
+        ...config_file_1.BASE_ESLINT_CONFIG_FILENAMES,
+    ].some((file) => tree.exists(file));
+    if (hasRootFlatConfig) {
+        return;
+    }
     const eslintFile = (0, eslint_file_1.findEslintFile)(tree);
     if (!eslintFile) {
         throw new Error('Could not find root eslint file');
@@ -20,11 +29,11 @@ async function convertToFlatConfigGenerator(tree, options) {
     options.eslintConfigFormat ??= 'mjs';
     const eslintIgnoreFiles = new Set(['.eslintignore']);
     // convert root eslint config to eslint.config.cjs or eslint.base.config.mjs based on eslintConfigFormat
-    convertRootToFlatConfig(tree, eslintFile, options.eslintConfigFormat);
+    convertRootToFlatConfig(tree, eslintFile, options.eslintConfigFormat, options.keepExistingVersions);
     // convert project eslint files to eslint.config.cjs
     const projects = (0, devkit_1.getProjects)(tree);
     for (const [project, projectConfig] of projects) {
-        convertProjectToFlatConfig(tree, project, projectConfig, (0, devkit_1.readNxJson)(tree), eslintIgnoreFiles, options.eslintConfigFormat);
+        convertProjectToFlatConfig(tree, project, projectConfig, (0, devkit_1.readNxJson)(tree), eslintIgnoreFiles, options.eslintConfigFormat, options.keepExistingVersions);
     }
     // delete all .eslintignore files
     for (const ignoreFile of eslintIgnoreFiles) {
@@ -40,20 +49,33 @@ async function convertToFlatConfigGenerator(tree, options) {
     return () => (0, devkit_1.installPackagesTask)(tree);
 }
 exports.default = convertToFlatConfigGenerator;
-function convertRootToFlatConfig(tree, eslintFile, format) {
+function convertRootToFlatConfig(tree, eslintFile, format, keepExistingVersions) {
     if (/\.base\.(js|json|yml|yaml)$/.test(eslintFile)) {
-        convertConfigToFlatConfig(tree, '', eslintFile, `eslint.base.config.${format}`, format);
+        convertConfigToFlatConfig(tree, '', eslintFile, `eslint.base.config.${format}`, format, undefined, keepExistingVersions);
+    }
+    // A workspace can ship `.eslintrc.base.json` without a sibling root config, so
+    // only convert the non-base root config when it actually exists.
+    const rootEslintFile = eslintFile.replace('.base.', '.');
+    if (tree.exists(rootEslintFile)) {
+        convertConfigToFlatConfig(tree, '', rootEslintFile, `eslint.config.${format}`, format, undefined, keepExistingVersions);
     }
-    convertConfigToFlatConfig(tree, '', eslintFile.replace('.base.', '.'), `eslint.config.${format}`, format);
 }
 const ESLINT_LINT_EXECUTOR = '@nx/eslint:lint';
 function isEslintTarget(target) {
     return (target.executor === ESLINT_LINT_EXECUTOR ||
         target.command?.includes('eslint'));
 }
-function convertProjectToFlatConfig(tree, project, projectConfig, nxJson, eslintIgnoreFiles, format) {
+function convertProjectToFlatConfig(tree, project, projectConfig, nxJson, eslintIgnoreFiles, format, keepExistingVersions) {
     const eslintFile = (0, eslint_file_1.findEslintFile)(tree, projectConfig.root);
-    if (!eslintFile || eslintFile.endsWith('.js')) {
+    if (!eslintFile) {
+        return;
+    }
+    if (eslintFile === '.eslintrc.js' || eslintFile === '.eslintrc.cjs') {
+        devkit_1.logger.warn(`Skipping "${project}": ${eslintFile} is a JavaScript-based ESLint config, which cannot be converted automatically. Convert it to flat config manually.`);
+        return;
+    }
+    if (eslintFile.endsWith('.js')) {
+        // Already on a JavaScript-based flat config (eslint.config.js); nothing to convert.
         return;
     }
     // Clean up obsolete target options and detect explicit ESLint targets
@@ -83,7 +105,7 @@ function convertProjectToFlatConfig(tree, project, projectConfig, nxJson, eslint
         devkit_1.logger.warn(`Skipping "${project}": found ${eslintFile} but no ESLint lint target detected. Convert manually if needed.`);
         return;
     }
-    convertConfigToFlatConfig(tree, projectConfig.root, eslintFile, `eslint.config.${format}`, format, ignorePath);
+    convertConfigToFlatConfig(tree, projectConfig.root, eslintFile, `eslint.config.${format}`, format, ignorePath, keepExistingVersions);
     eslintIgnoreFiles.add(`${projectConfig.root}/.eslintignore`);
     if (ignorePath) {
         eslintIgnoreFiles.add(ignorePath);
@@ -185,7 +207,7 @@ function updateProjectConfigsInputs(tree, format) {
 function inputsEqual(a, b) {
     return a.length === b.length && a.every((entry, i) => entry === b[i]);
 }
-function convertConfigToFlatConfig(tree, root, source, target, format, ignorePath) {
+function convertConfigToFlatConfig(tree, root, source, target, format, ignorePath, keepExistingVersions) {
     const ignorePaths = ignorePath
         ? [ignorePath, `${root}/.eslintignore`]
         : [`${root}/.eslintignore`];
@@ -193,7 +215,7 @@ function convertConfigToFlatConfig(tree, root, source, target, format, ignorePat
     if (source.endsWith('.json') || (0, path_1.basename)(source) === '.eslintrc') {
         const config = (0, devkit_1.readJson)(tree, `${root}/${source}`);
         const conversionResult = (0, json_converter_1.convertEslintJsonToFlatConfig)(tree, root, config, ignorePaths, format);
-        return processConvertedConfig(tree, root, source, target, conversionResult);
+        return processConvertedConfig(tree, root, source, target, conversionResult, keepExistingVersions);
     }
     if (source.endsWith('.yaml') || source.endsWith('.yml')) {
         const originalContent = tree.read(`${root}/${source}`, 'utf-8');
@@ -203,18 +225,17 @@ function convertConfigToFlatConfig(tree, root, source, target, format, ignorePat
             filename: source,
         });
         const conversionResult = (0, json_converter_1.convertEslintJsonToFlatConfig)(tree, root, config, ignorePaths, format);
-        return processConvertedConfig(tree, root, source, target, conversionResult);
+        return processConvertedConfig(tree, root, source, target, conversionResult, keepExistingVersions);
     }
 }
-function processConvertedConfig(tree, root, source, target, { content, addESLintRC, addESLintJS, }) {
+function processConvertedConfig(tree, root, source, target, { content, addESLintRC, addESLintJS, }, keepExistingVersions) {
     // remove original config file
     tree.delete((0, path_1.join)(root, source));
     // save new
     tree.write((0, path_1.join)(root, target), content);
-    // Once converted to flat config, the workspace is on the v9 ESLint stack —
-    // install the latest typescript-eslint v8 lane explicitly rather than
-    // routing through `versions(tree)` which would pick the legacy lane based
-    // on the pre-conversion `eslintrc` workspace state.
+    // Once converted to flat config, the workspace should use the latest ESLint
+    // stack. Install the versions directly instead of routing through
+    // `versions(tree)`, which keys off the pre-conversion declared ESLint version.
     const devDependencies = {
         eslint: versions_1.eslintVersion,
         'eslint-config-prettier': versions_1.eslintConfigPrettierVersion,
@@ -235,7 +256,9 @@ function processConvertedConfig(tree, root, source, target, { content, addESLint
     if (addESLintJS) {
         devDependencies['@eslint/js'] = versions_1.eslintVersion;
     }
-    // Convert-to-flat-config is an opt-in "upgrade" — we intentionally overwrite
-    // existing pins to land the workspace on the latest flat-config-ready stack.
-    (0, devkit_1.addDependenciesToPackageJson)(tree, {}, devDependencies);
+    // Direct invocation is an opt-in upgrade, so by default existing pins are
+    // overwritten to land the workspace on the latest flat-config-ready stack.
+    // Migrations pass `keepExistingVersions` so the version bump stays owned by
+    // `packageJsonUpdates` and only newly added packages are installed here.
+    (0, devkit_1.addDependenciesToPackageJson)(tree, {}, devDependencies, 'package.json', keepExistingVersions);
 }

package/dist/src/generators/convert-to-flat-config/schema.d.ts

@@ -2,4 +2,7 @@ export interface ConvertToFlatConfigGeneratorSchema {
   skipFormat?: boolean;
   // Internal option
   eslintConfigFormat?: 'mjs' | 'cjs';
+  // Internal option. When true, existing ESLint-related pins in package.json are
+  // preserved and only newly added packages are installed.
+  keepExistingVersions?: boolean;
 }

package/dist/src/generators/convert-to-flat-config/schema.json

@@ -17,6 +17,12 @@
       "enum": ["mjs", "cjs"],
       "default": "mjs",
       "x-priority": "internal"
+    },
+    "keepExistingVersions": {
+      "type": "boolean",
+      "description": "Keep the existing versions of any ESLint-related packages already declared in `package.json` instead of overwriting them. Only newly added packages are installed at the latest supported versions.",
+      "default": false,
+      "x-priority": "internal"
     }
   },
   "additionalProperties": false,

package/dist/src/generators/init/global-eslint-config.d.ts

@@ -26,4 +26,4 @@ export declare const javaScriptOverride: {
     rules: {};
 };
 export declare const getGlobalEsLintConfiguration: (unitTestRunner?: string, rootProject?: boolean) => Linter.LegacyConfig;
-export declare const getGlobalFlatEslintConfiguration: (format: "cjs" | "mjs", rootProject?: boolean) => string;
+export declare const getGlobalFlatEslintConfiguration: (format: 'cjs' | 'mjs', rootProject?: boolean) => string;

package/dist/src/generators/utils/eslint-file.js

@@ -310,36 +310,28 @@ function addExtendsToLintConfig(tree, root, plugin, insertAtTheEnd = false) {
                     ? 'cjs'
                     : 'mjs';
         let shouldImportEslintCompat = false;
-        // assume eslint major is 9 if not found, as it's what we'd be generating by default
-        const eslintMajor = (0, versions_1.getInstalledEslintMajorVersion)(tree) ?? 9;
-        if (eslintMajor >= 9) {
-            // eslint v9 requires the incompatible plugins to be wrapped with a helper from @eslint/compat
-            const plugins = (Array.isArray(plugin) ? plugin : [plugin]).map((p) => typeof p === 'string' ? { name: p, needCompatFixup: false } : p);
-            let compatiblePluginsBatch = [];
-            plugins.forEach(({ name, needCompatFixup }) => {
-                if (needCompatFixup) {
-                    if (compatiblePluginsBatch.length > 0) {
-                        // flush the current batch of compatible plugins and reset it
-                        pluginExtends.push((0, ast_utils_1.generatePluginExtendsElement)(compatiblePluginsBatch));
-                        compatiblePluginsBatch = [];
-                    }
-                    // generate the extends for the incompatible plugin
-                    pluginExtends.push((0, ast_utils_1.generatePluginExtendsElementWithCompatFixup)(name));
-                    shouldImportEslintCompat = true;
+        // eslint v9 requires the incompatible plugins to be wrapped with a helper from @eslint/compat
+        const plugins = (Array.isArray(plugin) ? plugin : [plugin]).map((p) => typeof p === 'string' ? { name: p, needCompatFixup: false } : p);
+        let compatiblePluginsBatch = [];
+        plugins.forEach(({ name, needCompatFixup }) => {
+            if (needCompatFixup) {
+                if (compatiblePluginsBatch.length > 0) {
+                    // flush the current batch of compatible plugins and reset it
+                    pluginExtends.push((0, ast_utils_1.generatePluginExtendsElement)(compatiblePluginsBatch));
+                    compatiblePluginsBatch = [];
                 }
-                else {
-                    // add the compatible plugin to the current batch
-                    compatiblePluginsBatch.push(name);
-                }
-            });
-            if (compatiblePluginsBatch.length > 0) {
-                // flush the batch of compatible plugins
-                pluginExtends.push((0, ast_utils_1.generatePluginExtendsElement)(compatiblePluginsBatch));
+                // generate the extends for the incompatible plugin
+                pluginExtends.push((0, ast_utils_1.generatePluginExtendsElementWithCompatFixup)(name));
+                shouldImportEslintCompat = true;
             }
-        }
-        else {
-            const plugins = (Array.isArray(plugin) ? plugin : [plugin]).map((p) => typeof p === 'string' ? p : p.name);
-            pluginExtends.push((0, ast_utils_1.generatePluginExtendsElement)(plugins));
+            else {
+                // add the compatible plugin to the current batch
+                compatiblePluginsBatch.push(name);
+            }
+        });
+        if (compatiblePluginsBatch.length > 0) {
+            // flush the batch of compatible plugins
+            pluginExtends.push((0, ast_utils_1.generatePluginExtendsElement)(compatiblePluginsBatch));
         }
         let content = tree.read(fileName, 'utf8');
         if (shouldImportEslintCompat) {

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

@@ -1,4 +1,4 @@
-<% if (useFlatRuleTester) { %>import { RuleTester } from '@typescript-eslint/rule-tester';
+import { RuleTester } from '@typescript-eslint/rule-tester';
 import type { RuleTesterConfig } from '@typescript-eslint/rule-tester';
 import { rule, RULE_NAME } from './<%= name %>';
 
@@ -7,13 +7,7 @@ const ruleTester = new RuleTester({
     parser: require('@typescript-eslint/parser'),
   },
 } as RuleTesterConfig);
-<% } else { %>import { TSESLint } from '@typescript-eslint/utils';
-import { rule, RULE_NAME } from './<%= name %>';
 
-const ruleTester = new TSESLint.RuleTester({
-  parser: require.resolve('@typescript-eslint/parser'),
-});
-<% } %>
 ruleTester.run(RULE_NAME, rule, {
   valid: [`const example = true;`],
   invalid: [],

package/dist/src/generators/workspace-rule/workspace-rule.js

@@ -5,26 +5,18 @@ const tslib_1 = require("tslib");
 const internal_1 = require("@nx/devkit/internal");
 const devkit_1 = require("@nx/devkit");
 const path_1 = require("path");
-const semver_1 = require("semver");
 const ts = tslib_1.__importStar(require("typescript"));
 const workspace_lint_rules_1 = require("../../utils/workspace-lint-rules");
 const workspace_rules_project_1 = require("../workspace-rules-project/workspace-rules-project");
 const assert_supported_eslint_version_1 = require("../../utils/assert-supported-eslint-version");
-const flat_config_1 = require("../../utils/flat-config");
 const versions_1 = require("../../utils/versions");
 async function lintWorkspaceRuleGenerator(tree, options) {
     (0, assert_supported_eslint_version_1.assertSupportedEslintVersion)(tree);
     const tasks = [];
-    const flatConfig = (0, flat_config_1.useFlatConfig)(tree);
     // ESLint v9 dropped the eslintrc-style `RuleTester` API. typescript-eslint's
-    // recommended replacement for any v9 workspace (flat or eslintrc) is the
-    // separate `@typescript-eslint/rule-tester` package, which has a flat-style
-    // API that works with ESLint v8.57+ and v9 alike. We resolve the effective
-    // major from `versions(tree)` to cover both declared workspaces and fresh
-    // installs that will be bumped to v9.
-    const { eslintVersion, typescriptESLintVersion } = (0, versions_1.versions)(tree);
-    const effectiveEslintMajor = (0, semver_1.major)((0, semver_1.coerce)(eslintVersion));
-    const useFlatRuleTester = flatConfig || effectiveEslintMajor >= 9;
+    // recommended replacement is the separate `@typescript-eslint/rule-tester`
+    // package, whose flat-style API works for both flat and eslintrc workspaces.
+    const { typescriptESLintVersion } = (0, versions_1.versions)(tree);
     const nxJson = (0, devkit_1.readNxJson)(tree);
     // Ensure that the workspace rules project has been created
     tasks.push(await (0, workspace_rules_project_1.lintWorkspaceRulesProjectGenerator)(tree, {
@@ -32,15 +24,12 @@ async function lintWorkspaceRuleGenerator(tree, options) {
         addPlugin: process.env.NX_ADD_PLUGINS !== 'false' &&
             nxJson.useInferencePlugins !== false,
     }));
-    if (useFlatRuleTester) {
-        tasks.push((0, devkit_1.addDependenciesToPackageJson)(tree, {}, { '@typescript-eslint/rule-tester': typescriptESLintVersion }, undefined, true));
-    }
+    tasks.push((0, devkit_1.addDependenciesToPackageJson)(tree, {}, { '@typescript-eslint/rule-tester': typescriptESLintVersion }, undefined, true));
     const ruleDir = (0, devkit_1.joinPathFragments)(workspace_lint_rules_1.workspaceLintPluginDir, options.directory ?? '');
     // Generate the required files for the new rule
     (0, devkit_1.generateFiles)(tree, (0, path_1.join)(__dirname, 'files'), ruleDir, {
         tmpl: '',
         name: options.name,
-        useFlatRuleTester,
     });
     const nameCamelCase = (0, internal_1.camelize)(options.name);
     /**

package/dist/src/migrations/update-23-1-0/convert-to-flat-config.d.ts

@@ -0,0 +1,15 @@
+import { type Tree } from '@nx/devkit';
+/**
+ * Hybrid migration paired with `convert-to-flat-config.md`. The deterministic
+ * half reuses the `@nx/eslint:convert-to-flat-config` generator to convert
+ * JSON/YAML eslintrc configs to flat config (the version bump is owned by
+ * `packageJsonUpdates`, so it runs with `keepExistingVersions`). It then returns
+ * `agentContext` describing the work the generator could not do deterministically
+ * (JavaScript-based configs, removed output formatters, the passing-state
+ * baseline) so the paired prompt's agent can finish the job and keep the
+ * workspace lint-passing.
+ */
+export default function update(tree: Tree): Promise<{
+    agentContext: string[];
+    nextSteps: string[];
+} | void>;