@nx/eslint 18.0.0-canary.20240201-8762c38 → 18.0.0-canary.20240203-7623471

package/generators.json

@@ -3,7 +3,7 @@
   "version": "0.1",
   "generators": {
     "init": {
-      "factory": "./src/generators/init/init#lintInitGenerator",
+      "factory": "./src/generators/init/init#initEsLint",
       "schema": "./src/generators/init/schema.json",
       "description": "Set up the ESLint plugin.",
       "hidden": true

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/eslint",
-  "version": "18.0.0-canary.20240201-8762c38",
+  "version": "18.0.0-canary.20240203-7623471",
   "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": "18.0.0-canary.20240201-8762c38",
-    "@nx/js": "18.0.0-canary.20240201-8762c38",
+    "@nx/devkit": "18.0.0-canary.20240203-7623471",
+    "@nx/js": "18.0.0-canary.20240203-7623471",
     "eslint": "^8.0.0",
     "tslib": "^2.3.0",
     "typescript": "~5.3.2",
-    "@nx/linter": "18.0.0-canary.20240201-8762c38"
+    "@nx/linter": "18.0.0-canary.20240203-7623471"
   },
   "peerDependenciesMeta": {
     "js-yaml": {

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

@@ -118,14 +118,6 @@ Please see https://nx.dev/guides/eslint for full guidance on how to resolve this
         lintResults = ESLint.getErrorResults(lintResults);
     }
     const formatter = await eslint.loadFormatter(normalizedOptions.format);
-    let totalErrors = 0;
-    let totalWarnings = 0;
-    for (const result of lintResults) {
-        if (result.errorCount || result.warningCount) {
-            totalErrors += result.errorCount;
-            totalWarnings += result.warningCount;
-        }
-    }
     const formattedResults = await formatter.format(lintResults);
     if (normalizedOptions.outputFile) {
         const pathToOutputFile = (0, devkit_1.joinPathFragments)(context.root, normalizedOptions.outputFile);
@@ -135,20 +127,48 @@ Please see https://nx.dev/guides/eslint for full guidance on how to resolve this
     else {
         console.info(formattedResults);
     }
-    if (totalWarnings > 0 && printInfo) {
-        console.warn('Lint warnings found in the listed files.\n');
-    }
-    if (totalErrors > 0 && printInfo) {
-        console.error('Lint errors found in the listed files.\n');
-    }
-    if (totalWarnings === 0 && totalErrors === 0 && printInfo) {
-        console.info('All files pass linting.\n');
+    const totals = getTotals(lintResults);
+    if (printInfo) {
+        outputPrintInfo(totals);
     }
     return {
         success: normalizedOptions.force ||
-            (totalErrors === 0 &&
+            (totals.errors === 0 &&
                 (normalizedOptions.maxWarnings === -1 ||
-                    totalWarnings <= normalizedOptions.maxWarnings)),
+                    totals.warnings <= normalizedOptions.maxWarnings)),
     };
 }
 exports.default = run;
+function getTotals(lintResults) {
+    let errors = 0;
+    let warnings = 0;
+    let fixableErrors = 0;
+    let fixableWarnings = 0;
+    for (const result of lintResults) {
+        errors += result.errorCount || 0;
+        warnings += result.warningCount || 0;
+        fixableErrors += result.fixableErrorCount || 0;
+        fixableWarnings += result.fixableWarningCount || 0;
+    }
+    return {
+        errors,
+        warnings,
+        fixableErrors,
+        fixableWarnings,
+    };
+}
+function pluralizedOutput(word, count) {
+    return `${count} ${word}${count === 1 ? '' : 's'}`;
+}
+function outputPrintInfo({ errors, warnings, fixableErrors, fixableWarnings, }) {
+    const total = warnings + errors;
+    const totalFixable = fixableErrors + fixableWarnings;
+    if (total <= 0) {
+        console.info('\u2714 All files pass linting\n');
+        return;
+    }
+    console.info(`\u2716 ${pluralizedOutput('problem', total)} (${pluralizedOutput('error', errors)}, ${pluralizedOutput('warning', warnings)})\n`);
+    if (totalFixable <= 0)
+        return;
+    console.info(`  ${pluralizedOutput('error', fixableErrors)} and ${pluralizedOutput('warning', fixableWarnings)} are potentially fixable with the \`--fix\` option.\n`);
+}

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

@@ -38,7 +38,6 @@ async function resolveAndInstantiateESLint(eslintConfigPath, options, useFlatCon
          * not be any html files in the project, so keeping it true would break linting every time
          */
         errorOnUnmatchedPattern: false,
-        reportUnusedDisableDirectives: options.reportUnusedDisableDirectives || undefined,
     };
     if (useFlatConfig) {
         if (typeof options.useEslintrc !== 'undefined') {
@@ -50,6 +49,9 @@ async function resolveAndInstantiateESLint(eslintConfigPath, options, useFlatCon
         if (options.ignorePath !== undefined) {
             throw new Error('For Flat Config, ESLint removed `ignorePath` and so it is not supported as an option. See https://eslint.org/docs/latest/use/configure/configuration-files-new');
         }
+        if (options.reportUnusedDisableDirectives) {
+            throw new Error('For Flat Config, ESLint removed `reportedUnusedDisableDirectives` and so it is not supported as an option. See https://eslint.org/docs/latest/use/configure/configuration-files-new');
+        }
     }
     else {
         eslintOptions.rulePaths = options.rulesdir || [];
@@ -61,6 +63,8 @@ async function resolveAndInstantiateESLint(eslintConfigPath, options, useFlatCon
          * merge the provided config with others it finds automatically.
          */
         eslintOptions.useEslintrc = !options.noEslintrc;
+        eslintOptions.reportUnusedDisableDirectives =
+            options.reportUnusedDisableDirectives || undefined;
     }
     const eslint = new ESLint(eslintOptions);
     return {

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

@@ -46,7 +46,8 @@ function convertProjectToFlatConfig(tree, project, projectConfig, nxJson, eslint
     const eslintFile = (0, eslint_file_1.findEslintFile)(tree, projectConfig.root);
     if (eslintFile && !eslintFile.endsWith('.js')) {
         if (projectConfig.targets) {
-            const eslintTargets = Object.keys(projectConfig.targets || {}).filter((t) => projectConfig.targets[t].executor === '@nx/eslint:lint');
+            const eslintTargets = Object.keys(projectConfig.targets || {}).filter((t) => projectConfig.targets[t].executor === '@nx/eslint:lint' ||
+                projectConfig.targets[t].command?.includes('eslint'));
             let ignorePath;
             for (const target of eslintTargets) {
                 // remove any obsolete `eslintConfig` options pointing to the old config file
@@ -59,10 +60,14 @@ function convertProjectToFlatConfig(tree, project, projectConfig, nxJson, eslint
                 }
                 (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') &&
+            const nxHasEsLintTargets = Object.keys(nxJson.targetDefaults || {}).some((t) => (t === '@nx/eslint:lint' ||
+                nxJson.targetDefaults[t].executor === '@nx/eslint:lint' ||
+                nxJson.targetDefaults[t].command?.includes('eslint')) &&
                 projectConfig.targets?.[t]);
-            if (nxHasLintTargets || eslintTargets.length > 0) {
+            const nxHasEsLintPlugin = (nxJson.plugins || []).some((p) => typeof p === 'string'
+                ? p === '@nx/eslint/plugin'
+                : p.plugin === '@nx/eslint/plugin');
+            if (nxHasEsLintTargets || nxHasEsLintPlugin || eslintTargets.length > 0) {
                 convertConfigToFlatConfig(tree, projectConfig.root, eslintFile, 'eslint.config.js', ignorePath);
                 eslintIgnoreFiles.add(`${projectConfig.root}/.eslintignore`);
                 if (ignorePath) {

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

@@ -8,6 +8,8 @@ const global_eslint_config_1 = require("./global-eslint-config");
 const flat_config_1 = require("../../utils/flat-config");
 const versions_1 = require("../../utils/versions");
 const ast_utils_1 = require("../utils/flat-config/ast-utils");
+const plugin_1 = require("../utils/plugin");
+const config_file_1 = require("../../utils/config-file");
 function migrateConfigToMonorepoStyle(projects, tree, unitTestRunner, keepExistingVersions) {
     const rootEslintConfig = (0, eslint_file_1.findEslintFile)(tree);
     let skipCleanup = false;
@@ -35,20 +37,32 @@ function migrateConfigToMonorepoStyle(projects, tree, unitTestRunner, keepExisti
     }
     // update extends in all projects' eslint configs
     projects.forEach((project) => {
+        let eslintFile;
         const lintTarget = findLintTarget(project);
         if (lintTarget) {
-            const eslintFile = lintTarget.options?.eslintConfig || (0, eslint_file_1.findEslintFile)(tree, project.root);
-            if (eslintFile) {
-                const projectEslintPath = (0, devkit_1.joinPathFragments)(project.root, eslintFile);
-                if (skipCleanup) {
-                    const content = tree.read(projectEslintPath, 'utf-8');
-                    tree.write(projectEslintPath, content.replace(rootEslintConfig, rootEslintConfig.replace('.base.', '.')));
-                }
-                else {
-                    migrateEslintFile(projectEslintPath, tree);
+            // If target is configured in project.json, read file from target options.
+            eslintFile =
+                lintTarget.options?.eslintConfig || (0, eslint_file_1.findEslintFile)(tree, project.root);
+        }
+        else if ((0, plugin_1.hasEslintPlugin)(tree)) {
+            // Otherwise, if `@nx/eslint/plugin` is used, match any of the known config files.
+            for (const f of config_file_1.ESLINT_CONFIG_FILENAMES) {
+                if (tree.exists((0, devkit_1.joinPathFragments)(project.root, f))) {
+                    eslintFile = f;
+                    break;
                 }
             }
         }
+        if (eslintFile) {
+            const projectEslintPath = (0, devkit_1.joinPathFragments)(project.root, eslintFile);
+            if (skipCleanup) {
+                const content = tree.read(projectEslintPath, 'utf-8');
+                tree.write(projectEslintPath, content.replace(rootEslintConfig, rootEslintConfig.replace('.base.', '.')));
+            }
+            else {
+                migrateEslintFile(projectEslintPath, tree);
+            }
+        }
     });
 }
 exports.migrateConfigToMonorepoStyle = migrateConfigToMonorepoStyle;

package/src/generators/init/init.d.ts

@@ -3,5 +3,7 @@ export interface LinterInitOptions {
     skipPackageJson?: boolean;
     keepExistingVersions?: boolean;
     updatePackageScripts?: boolean;
+    addPlugin?: boolean;
 }
+export declare function initEsLint(tree: Tree, options: LinterInitOptions): Promise<GeneratorCallback>;
 export declare function lintInitGenerator(tree: Tree, options: LinterInitOptions): Promise<GeneratorCallback>;

package/src/generators/init/init.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.lintInitGenerator = void 0;
+exports.lintInitGenerator = exports.initEsLint = void 0;
 const devkit_1 = require("@nx/devkit");
 const update_package_scripts_1 = require("@nx/devkit/src/utils/update-package-scripts");
 const versions_1 = require("../../utils/versions");
@@ -50,10 +50,10 @@ function addPlugin(tree) {
     (0, devkit_1.updateNxJson)(tree, nxJson);
 }
 async function initEsLint(tree, options) {
-    const addPlugins = process.env.NX_PCV3 === 'true';
+    options.addPlugin ??= process.env.NX_ADD_PLUGINS !== 'false';
     const hasPlugin = (0, plugin_2.hasEslintPlugin)(tree);
     const rootEslintFile = (0, eslint_file_1.findEslintFile)(tree);
-    if (rootEslintFile && addPlugins && !hasPlugin) {
+    if (rootEslintFile && options.addPlugin && !hasPlugin) {
         addPlugin(tree);
         if (options.updatePackageScripts) {
             await (0, update_package_scripts_1.updatePackageScripts)(tree, plugin_1.createNodes);
@@ -64,7 +64,7 @@ async function initEsLint(tree, options) {
         return () => { };
     }
     updateProductionFileset(tree);
-    if (addPlugins) {
+    if (options.addPlugin) {
         addPlugin(tree);
     }
     else {
@@ -83,7 +83,8 @@ async function initEsLint(tree, options) {
     }
     return (0, devkit_1.runTasksInSerial)(...tasks);
 }
+exports.initEsLint = initEsLint;
 async function lintInitGenerator(tree, options) {
-    return await initEsLint(tree, options);
+    return await initEsLint(tree, { addPlugin: false, ...options });
 }
 exports.lintInitGenerator = lintInitGenerator;

package/src/generators/lint-project/lint-project.d.ts

@@ -11,6 +11,8 @@ interface LintProjectOptions {
     unitTestRunner?: string;
     rootProject?: boolean;
     keepExistingVersions?: boolean;
+    addPlugin?: boolean;
 }
 export declare function lintProjectGenerator(tree: Tree, options: LintProjectOptions): Promise<GeneratorCallback>;
+export declare function lintProjectGeneratorInternal(tree: Tree, options: LintProjectOptions): Promise<GeneratorCallback>;
 export {};

package/src/generators/lint-project/lint-project.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.lintProjectGenerator = void 0;
+exports.lintProjectGeneratorInternal = exports.lintProjectGenerator = void 0;
 const devkit_1 = require("@nx/devkit");
 const eslint_file_1 = require("../utils/eslint-file");
 const path_1 = require("path");
@@ -12,10 +12,16 @@ const ast_utils_1 = require("../utils/flat-config/ast-utils");
 const config_file_1 = require("../../utils/config-file");
 const plugin_1 = require("../utils/plugin");
 const setup_root_eslint_1 = require("./setup-root-eslint");
-async function lintProjectGenerator(tree, options) {
+function lintProjectGenerator(tree, options) {
+    return lintProjectGeneratorInternal(tree, { addPlugin: false, ...options });
+}
+exports.lintProjectGenerator = lintProjectGenerator;
+async function lintProjectGeneratorInternal(tree, options) {
+    options.addPlugin ??= process.env.NX_ADD_PLUGINS !== 'false';
     const tasks = [];
     const initTask = await (0, init_1.lintInitGenerator)(tree, {
         skipPackageJson: options.skipPackageJson,
+        addPlugin: options.addPlugin,
     });
     tasks.push(initTask);
     const rootEsLintTask = (0, setup_root_eslint_1.setupRootEsLint)(tree, {
@@ -97,7 +103,7 @@ async function lintProjectGenerator(tree, options) {
     }
     return (0, devkit_1.runTasksInSerial)(...tasks);
 }
-exports.lintProjectGenerator = lintProjectGenerator;
+exports.lintProjectGeneratorInternal = lintProjectGeneratorInternal;
 function createEsLintConfiguration(tree, projectConfig, setParserOptionsProject, rootProject) {
     // we are only extending root for non-standalone projects or their complementary e2e apps
     const extendedRootConfig = rootProject ? undefined : (0, eslint_file_1.findEslintFile)(tree);
@@ -204,10 +210,15 @@ function isMigrationToMonorepoNeeded(projects, tree) {
     if (!rootProject || !rootProject.targets) {
         return false;
     }
+    // check if we're inferring lint target from `@nx/eslint/plugin`
+    if ((0, plugin_1.hasEslintPlugin)(tree)) {
+        for (const f of config_file_1.ESLINT_CONFIG_FILENAMES) {
+            if (tree.exists(f)) {
+                return true;
+            }
+        }
+    }
     // find if root project has lint target
     const lintTarget = (0, init_migration_1.findLintTarget)(rootProject);
-    if (!lintTarget) {
-        return false;
-    }
-    return true;
+    return !!lintTarget;
 }

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

@@ -9,7 +9,7 @@ const workspace_lint_rules_1 = require("../../utils/workspace-lint-rules");
 const workspace_rules_project_1 = require("../workspace-rules-project/workspace-rules-project");
 async function lintWorkspaceRuleGenerator(tree, options) {
     // Ensure that the workspace rules project has been created
-    const projectGeneratorCallback = await (0, workspace_rules_project_1.lintWorkspaceRulesProjectGenerator)(tree, { skipFormat: true });
+    const projectGeneratorCallback = await (0, workspace_rules_project_1.lintWorkspaceRulesProjectGenerator)(tree, { skipFormat: true, addPlugin: process.env.NX_ADD_PLUGINS !== 'false' });
     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, {

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

@@ -3,5 +3,6 @@ export declare const WORKSPACE_RULES_PROJECT_NAME = "eslint-rules";
 export declare const WORKSPACE_PLUGIN_DIR = "tools/eslint-rules";
 export interface LintWorkspaceRulesProjectGeneratorOptions {
     skipFormat?: boolean;
+    addPlugin?: boolean;
 }
 export declare function lintWorkspaceRulesProjectGenerator(tree: Tree, options?: LintWorkspaceRulesProjectGeneratorOptions): Promise<GeneratorCallback>;

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

@@ -41,6 +41,7 @@ async function lintWorkspaceRulesProjectGenerator(tree, options = {}) {
     }
     // Add jest to the project and return installation task
     tasks.push(await configurationGenerator(tree, {
+        ...options,
         project: exports.WORKSPACE_RULES_PROJECT_NAME,
         supportTsx: false,
         skipSerializers: true,