@nx/eslint 17.2.0-beta.10 → 17.2.0-beta.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/eslint",
-  "version": "17.2.0-beta.10",
+  "version": "17.2.0-beta.12",
   "private": false,
   "description": "The ESLint plugin for Nx contains executors, generators and utilities used for linting JavaScript/TypeScript projects within an Nx workspace.",
   "repository": {
@@ -27,18 +27,18 @@
     "requirements": {},
     "migrations": "./migrations.json"
   },
-  "executors": "./executors.json",
   "generators": "./generators.json",
+  "executors": "./executors.json",
   "peerDependencies": {
     "eslint": "^8.0.0",
     "js-yaml": "4.1.0"
   },
   "dependencies": {
+    "@nx/devkit": "17.2.0-beta.12",
+    "@nx/js": "17.2.0-beta.12",
     "tslib": "^2.3.0",
-    "@nx/devkit": "17.2.0-beta.10",
-    "@nx/js": "17.2.0-beta.10",
     "typescript": "~5.2.2",
-    "@nx/linter": "17.2.0-beta.10"
+    "@nx/linter": "17.2.0-beta.12"
   },
   "peerDependenciesMeta": {
     "eslint": {

package/plugin.d.ts

@@ -0,0 +1 @@
+export { createNodes, EslintPluginOptions } from './src/plugins/plugin';

package/plugin.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createNodes = void 0;
+var plugin_1 = require("./src/plugins/plugin");
+Object.defineProperty(exports, "createNodes", { enumerable: true, get: function () { return plugin_1.createNodes; } });

package/src/generators/init/init.js

@@ -5,18 +5,22 @@ const devkit_1 = require("@nx/devkit");
 const versions_1 = require("../../utils/versions");
 const eslint_file_1 = require("../utils/eslint-file");
 const global_eslint_config_1 = require("./global-eslint-config");
-function addTargetDefaults(tree) {
+function updateProductionFileset(tree) {
     const nxJson = (0, devkit_1.readNxJson)(tree);
     const productionFileSet = nxJson.namedInputs?.production;
     if (productionFileSet) {
-        // Remove .eslintrc.json
         productionFileSet.push('!{projectRoot}/.eslintrc.json');
         productionFileSet.push('!{projectRoot}/eslint.config.js');
         // Dedupe and set
         nxJson.namedInputs.production = Array.from(new Set(productionFileSet));
     }
+    (0, devkit_1.updateNxJson)(tree, nxJson);
+}
+function addTargetDefaults(tree) {
+    const nxJson = (0, devkit_1.readNxJson)(tree);
     nxJson.targetDefaults ??= {};
     nxJson.targetDefaults.lint ??= {};
+    nxJson.targetDefaults.lint.cache ??= true;
     nxJson.targetDefaults.lint.inputs ??= [
         'default',
         `{workspaceRoot}/.eslintrc.json`,
@@ -25,6 +29,36 @@ function addTargetDefaults(tree) {
     ];
     (0, devkit_1.updateNxJson)(tree, nxJson);
 }
+function addPlugin(tree) {
+    const nxJson = (0, devkit_1.readNxJson)(tree);
+    nxJson.plugins ??= [];
+    for (const plugin of nxJson.plugins) {
+        if (typeof plugin === 'string'
+            ? plugin === '@nx/eslint/plugin'
+            : plugin.plugin === '@nx/eslint/plugin') {
+            return;
+        }
+    }
+    nxJson.plugins.push({
+        plugin: '@nx/eslint/plugin',
+        options: {
+            targetName: 'lint',
+        },
+    });
+    (0, devkit_1.updateNxJson)(tree, nxJson);
+}
+function updateVSCodeExtensions(tree) {
+    if (tree.exists('.vscode/extensions.json')) {
+        (0, devkit_1.updateJson)(tree, '.vscode/extensions.json', (json) => {
+            json.recommendations ||= [];
+            const extension = 'dbaeumer.vscode-eslint';
+            if (!json.recommendations.includes(extension)) {
+                json.recommendations.push(extension);
+            }
+            return json;
+        });
+    }
+}
 /**
  * Initializes ESLint configuration in a workspace and adds necessary dependencies.
  */
@@ -37,17 +71,15 @@ function initEsLint(tree, options) {
     }
     (0, devkit_1.writeJson)(tree, '.eslintrc.json', (0, global_eslint_config_1.getGlobalEsLintConfiguration)(options.unitTestRunner, options.rootProject));
     tree.write('.eslintignore', 'node_modules\n');
-    addTargetDefaults(tree);
-    if (tree.exists('.vscode/extensions.json')) {
-        (0, devkit_1.updateJson)(tree, '.vscode/extensions.json', (json) => {
-            json.recommendations ||= [];
-            const extension = 'dbaeumer.vscode-eslint';
-            if (!json.recommendations.includes(extension)) {
-                json.recommendations.push(extension);
-            }
-            return json;
-        });
+    updateProductionFileset(tree);
+    const addPlugins = process.env.NX_PCV3 === 'true';
+    if (addPlugins) {
+        addPlugin(tree);
+    }
+    else {
+        addTargetDefaults(tree);
     }
+    updateVSCodeExtensions(tree);
     return !options.skipPackageJson
         ? (0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
             '@nx/eslint': versions_1.nxVersion,

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

@@ -9,6 +9,7 @@ const init_migration_1 = require("../init/init-migration");
 const project_configuration_1 = require("nx/src/generators/utils/project-configuration");
 const flat_config_1 = require("../../utils/flat-config");
 const ast_utils_1 = require("../utils/flat-config/ast-utils");
+const config_file_1 = require("../../utils/config-file");
 async function lintProjectGenerator(tree, options) {
     const installTask = (0, init_1.lintInitGenerator)(tree, {
         linter: options.linter,
@@ -17,23 +18,42 @@ async function lintProjectGenerator(tree, options) {
         rootProject: options.rootProject,
     });
     const projectConfig = (0, devkit_1.readProjectConfiguration)(tree, options.project);
-    projectConfig.targets['lint'] = {
-        executor: '@nx/eslint:lint',
-        outputs: ['{options.outputFile}'],
-    };
     let lintFilePatterns = options.eslintFilePatterns;
     if (!lintFilePatterns && options.rootProject && projectConfig.root === '.') {
         lintFilePatterns = ['./src'];
     }
-    if (lintFilePatterns && lintFilePatterns.length) {
-        if (isBuildableLibraryProject(projectConfig) &&
-            !lintFilePatterns.includes('{projectRoot}')) {
-            lintFilePatterns.push(`{projectRoot}/package.json`);
+    if (lintFilePatterns &&
+        lintFilePatterns.length &&
+        !lintFilePatterns.includes('{projectRoot}') &&
+        isBuildableLibraryProject(projectConfig)) {
+        lintFilePatterns.push(`{projectRoot}/package.json`);
+    }
+    const nxJson = (0, devkit_1.readNxJson)(tree);
+    const hasPlugin = nxJson.plugins?.some((p) => typeof p === 'string'
+        ? p === '@nx/eslint/plugin'
+        : p.plugin === '@nx/eslint/plugin');
+    if (hasPlugin) {
+        if (lintFilePatterns &&
+            lintFilePatterns.length &&
+            lintFilePatterns.some((p) => !['./src', '{projectRoot}', projectConfig.root].includes(p))) {
+            projectConfig.targets['lint'] = {
+                command: `eslint ${lintFilePatterns
+                    .join(' ')
+                    .replace('{projectRoot}', projectConfig.root)}`,
+            };
         }
-        // only add lintFilePatterns if they are explicitly defined
-        projectConfig.targets['lint'].options = {
-            lintFilePatterns,
+    }
+    else {
+        projectConfig.targets['lint'] = {
+            executor: '@nx/eslint:lint',
+            outputs: ['{options.outputFile}'],
         };
+        if (lintFilePatterns && lintFilePatterns.length) {
+            // only add lintFilePatterns if they are explicitly defined
+            projectConfig.targets['lint'].options = {
+                lintFilePatterns,
+            };
+        }
     }
     // we are adding new project which is not the root project or
     // companion e2e app so we should check if migration to
@@ -168,8 +188,8 @@ function isBuildableLibraryProject(projectConfig) {
  */
 function isMigrationToMonorepoNeeded(projects, tree) {
     // the base config is already created, migration has been done
-    if (tree.exists(eslint_file_1.baseEsLintConfigFile) ||
-        tree.exists(eslint_file_1.baseEsLintFlatConfigFile)) {
+    if (tree.exists(config_file_1.baseEsLintConfigFile) ||
+        tree.exists(config_file_1.baseEsLintFlatConfigFile)) {
         return false;
     }
     const configs = Object.values(projects);

package/src/generators/utils/eslint-file.d.ts

@@ -1,8 +1,5 @@
 import { Tree } from '@nx/devkit';
 import { Linter } from 'eslint';
-export declare const eslintConfigFileWhitelist: string[];
-export declare const baseEsLintConfigFile = ".eslintrc.base.json";
-export declare const baseEsLintFlatConfigFile = "eslint.base.config.js";
 export declare function findEslintFile(tree: Tree, projectRoot?: string): string | null;
 export declare function isEslintConfigSupported(tree: Tree, projectRoot?: string): boolean;
 export declare function updateRelativePathsInConfig(tree: Tree, sourcePath: string, destinationPath: string): void;

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

@@ -1,29 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPluginImport = exports.addIgnoresToLintConfig = exports.addPluginsToLintConfig = exports.addExtendsToLintConfig = exports.replaceOverridesInLintConfig = exports.lintConfigHasOverride = exports.updateOverrideInLintConfig = exports.addOverrideToLintConfig = exports.updateRelativePathsInConfig = exports.isEslintConfigSupported = exports.findEslintFile = exports.baseEsLintFlatConfigFile = exports.baseEsLintConfigFile = exports.eslintConfigFileWhitelist = void 0;
+exports.getPluginImport = exports.addIgnoresToLintConfig = exports.addPluginsToLintConfig = exports.addExtendsToLintConfig = exports.replaceOverridesInLintConfig = exports.lintConfigHasOverride = exports.updateOverrideInLintConfig = exports.addOverrideToLintConfig = exports.updateRelativePathsInConfig = exports.isEslintConfigSupported = exports.findEslintFile = void 0;
 const devkit_1 = require("@nx/devkit");
 const flat_config_1 = require("../../utils/flat-config");
 const ast_utils_1 = require("./flat-config/ast-utils");
 const path_utils_1 = require("./flat-config/path-utils");
-exports.eslintConfigFileWhitelist = [
-    '.eslintrc',
-    '.eslintrc.js',
-    '.eslintrc.cjs',
-    '.eslintrc.yaml',
-    '.eslintrc.yml',
-    '.eslintrc.json',
-    'eslint.config.js',
-];
-exports.baseEsLintConfigFile = '.eslintrc.base.json';
-exports.baseEsLintFlatConfigFile = 'eslint.base.config.js';
-function findEslintFile(tree, projectRoot = '') {
-    if (projectRoot === '' && tree.exists(exports.baseEsLintConfigFile)) {
-        return exports.baseEsLintConfigFile;
+const config_file_1 = require("../../utils/config-file");
+function findEslintFile(tree, projectRoot) {
+    if (projectRoot === undefined && tree.exists(config_file_1.baseEsLintConfigFile)) {
+        return config_file_1.baseEsLintConfigFile;
     }
-    if (projectRoot === '' && tree.exists(exports.baseEsLintFlatConfigFile)) {
-        return exports.baseEsLintFlatConfigFile;
+    if (projectRoot === undefined && tree.exists(config_file_1.baseEsLintFlatConfigFile)) {
+        return config_file_1.baseEsLintFlatConfigFile;
     }
-    for (const file of exports.eslintConfigFileWhitelist) {
+    projectRoot ??= '';
+    for (const file of config_file_1.ESLINT_CONFIG_FILENAMES) {
         if (tree.exists((0, devkit_1.joinPathFragments)(projectRoot, file))) {
             return file;
         }
@@ -94,7 +85,7 @@ function replaceFlatConfigPaths(config, sourceRoot, offset, destinationRoot, tre
     return newConfig;
 }
 function offsetFilePath(projectRoot, pathToFile, offset, tree) {
-    if (exports.eslintConfigFileWhitelist.some((eslintFile) => pathToFile.includes(eslintFile))) {
+    if (config_file_1.ESLINT_CONFIG_FILENAMES.some((eslintFile) => pathToFile.includes(eslintFile))) {
         // if the file is point to base eslint
         const rootEslint = findEslintFile(tree);
         if (rootEslint) {
@@ -112,7 +103,7 @@ function addOverrideToLintConfig(tree, root, override, options = {
 }) {
     const isBase = options.checkBaseConfig && findEslintFile(tree, root).includes('.base');
     if ((0, flat_config_1.useFlatConfig)(tree)) {
-        const fileName = (0, devkit_1.joinPathFragments)(root, isBase ? exports.baseEsLintFlatConfigFile : 'eslint.config.js');
+        const fileName = (0, devkit_1.joinPathFragments)(root, isBase ? config_file_1.baseEsLintFlatConfigFile : 'eslint.config.js');
         const flatOverride = (0, ast_utils_1.generateFlatOverride)(override);
         let content = tree.read(fileName, 'utf8');
         // we will be using compat here so we need to make sure it's added
@@ -122,7 +113,7 @@ function addOverrideToLintConfig(tree, root, override, options = {
         tree.write(fileName, (0, ast_utils_1.addBlockToFlatConfigExport)(content, flatOverride, options));
     }
     else {
-        const fileName = (0, devkit_1.joinPathFragments)(root, isBase ? exports.baseEsLintConfigFile : '.eslintrc.json');
+        const fileName = (0, devkit_1.joinPathFragments)(root, isBase ? config_file_1.baseEsLintConfigFile : '.eslintrc.json');
         (0, devkit_1.updateJson)(tree, fileName, (json) => {
             json.overrides ??= [];
             if (options.insertAtTheEnd) {
@@ -164,12 +155,12 @@ function lintConfigHasOverride(tree, root, lookup, checkBaseConfig = false) {
     }
     const isBase = checkBaseConfig && findEslintFile(tree, root).includes('.base');
     if ((0, flat_config_1.useFlatConfig)(tree)) {
-        const fileName = (0, devkit_1.joinPathFragments)(root, isBase ? exports.baseEsLintFlatConfigFile : 'eslint.config.js');
+        const fileName = (0, devkit_1.joinPathFragments)(root, isBase ? config_file_1.baseEsLintFlatConfigFile : 'eslint.config.js');
         const content = tree.read(fileName, 'utf8');
         return (0, ast_utils_1.hasOverride)(content, lookup);
     }
     else {
-        const fileName = (0, devkit_1.joinPathFragments)(root, isBase ? exports.baseEsLintConfigFile : '.eslintrc.json');
+        const fileName = (0, devkit_1.joinPathFragments)(root, isBase ? config_file_1.baseEsLintConfigFile : '.eslintrc.json');
         return (0, devkit_1.readJson)(tree, fileName).overrides?.some(lookup) || false;
     }
 }

package/src/migrations/update-15-0-0/add-eslint-inputs.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const devkit_1 = require("@nx/devkit");
-const eslint_file_1 = require("../../generators/utils/eslint-file");
 const eslint_targets_1 = require("../../generators/utils/eslint-targets");
+const config_file_1 = require("../../utils/config-file");
 async function addEslintInputs(tree) {
     const nxJson = (0, devkit_1.readNxJson)(tree);
-    const globalEslintFile = eslint_file_1.eslintConfigFileWhitelist.find((file) => tree.exists(file));
+    const globalEslintFile = config_file_1.ESLINT_CONFIG_FILENAMES.find((file) => tree.exists(file));
     if (globalEslintFile && nxJson.namedInputs?.production) {
         const productionFileset = new Set(nxJson.namedInputs.production);
         productionFileset.add(`!{projectRoot}/${globalEslintFile}`);

package/src/migrations/update-15-7-1/add-eslint-ignore.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const devkit_1 = require("@nx/devkit");
-const eslint_file_1 = require("../../generators/utils/eslint-file");
 const eslint_targets_1 = require("../../generators/utils/eslint-targets");
+const config_file_1 = require("../../utils/config-file");
 async function addEslintIgnore(tree) {
     const nxJson = (0, devkit_1.readJson)(tree, 'nx.json');
-    const globalEslintFile = eslint_file_1.eslintConfigFileWhitelist.find((file) => tree.exists(file));
+    const globalEslintFile = config_file_1.ESLINT_CONFIG_FILENAMES.find((file) => tree.exists(file));
     if (globalEslintFile) {
         if (tree.exists('.eslintignore')) {
             const content = tree.read('.eslintignore', 'utf-8');

package/src/plugins/plugin.d.ts

@@ -0,0 +1,5 @@
+import { CreateNodes } from '@nx/devkit';
+export interface EslintPluginOptions {
+    targetName?: string;
+}
+export declare const createNodes: CreateNodes<EslintPluginOptions>;

package/src/plugins/plugin.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createNodes = void 0;
+const path_1 = require("path");
+const project_configuration_utils_1 = require("nx/src/project-graph/utils/project-configuration-utils");
+const fs_1 = require("fs");
+const globs_1 = require("nx/src/utils/globs");
+const config_file_1 = require("../utils/config-file");
+exports.createNodes = [
+    (0, globs_1.combineGlobPatterns)(['**/project.json', '**/package.json']),
+    (configFilePath, options, context) => {
+        const projectRoot = (0, path_1.dirname)(configFilePath);
+        options = normalizeOptions(options);
+        const eslintConfigs = getEslintConfigsForProject(projectRoot, context.workspaceRoot);
+        if (!eslintConfigs.length) {
+            return {};
+        }
+        return {
+            projects: {
+                [projectRoot]: {
+                    targets: buildEslintTargets(eslintConfigs, projectRoot, options, context),
+                },
+            },
+        };
+    },
+];
+function getEslintConfigsForProject(projectRoot, workspaceRoot) {
+    const detectedConfigs = new Set();
+    const baseConfig = (0, config_file_1.findBaseEslintFile)(workspaceRoot);
+    if (baseConfig) {
+        detectedConfigs.add(baseConfig);
+    }
+    let siblingFiles = (0, fs_1.readdirSync)((0, path_1.join)(workspaceRoot, projectRoot));
+    if (projectRoot === '.') {
+        // If there's no src folder, it's not a standalone project
+        if (!siblingFiles.includes('src')) {
+            return [];
+        }
+        // If it's standalone but doesn't have eslint config, it's not a lintable
+        const config = siblingFiles.find((f) => config_file_1.ESLINT_CONFIG_FILENAMES.includes(f));
+        if (!config) {
+            return [];
+        }
+        detectedConfigs.add(config);
+        return Array.from(detectedConfigs);
+    }
+    while (projectRoot !== '.') {
+        // if it has an eslint config it's lintable
+        const config = siblingFiles.find((f) => config_file_1.ESLINT_CONFIG_FILENAMES.includes(f));
+        if (config) {
+            detectedConfigs.add(`${projectRoot}/${config}`);
+            return Array.from(detectedConfigs);
+        }
+        projectRoot = (0, path_1.dirname)(projectRoot);
+        siblingFiles = (0, fs_1.readdirSync)((0, path_1.join)(workspaceRoot, projectRoot));
+    }
+    // check whether the root has an eslint config
+    const config = (0, fs_1.readdirSync)(workspaceRoot).find((f) => config_file_1.ESLINT_CONFIG_FILENAMES.includes(f));
+    if (config) {
+        detectedConfigs.add(config);
+        return Array.from(detectedConfigs);
+    }
+    return [];
+}
+function buildEslintTargets(eslintConfigs, projectRoot, options, context) {
+    const targetDefaults = (0, project_configuration_utils_1.readTargetDefaultsForTarget)(options.targetName, context.nxJsonConfiguration.targetDefaults, '@nx/eslint:lint');
+    const isRootProject = projectRoot === '.';
+    const targets = {};
+    const baseTargetConfig = {
+        command: `eslint ${isRootProject ? './src' : '.'}`,
+        options: {
+            cwd: projectRoot,
+        },
+    };
+    if (eslintConfigs.some((config) => (0, config_file_1.isFlatConfig)(config))) {
+        baseTargetConfig.options.env = {
+            ESLINT_USE_FLAT_CONFIG: 'true',
+        };
+    }
+    targets[options.targetName] = {
+        ...baseTargetConfig,
+        cache: targetDefaults?.cache ?? true,
+        inputs: targetDefaults?.inputs ?? [
+            'default',
+            ...eslintConfigs.map((config) => `{workspaceRoot}/${config}`),
+            '{workspaceRoot}/tools/eslint-rules/**/*',
+            { externalDependencies: ['eslint'] },
+        ],
+        options: {
+            ...baseTargetConfig.options,
+        },
+    };
+    return targets;
+}
+function normalizeOptions(options) {
+    options ??= {};
+    options.targetName ??= 'lint';
+    return options;
+}

package/src/utils/config-file.d.ts

@@ -0,0 +1,5 @@
+export declare const ESLINT_CONFIG_FILENAMES: string[];
+export declare const baseEsLintConfigFile = ".eslintrc.base.json";
+export declare const baseEsLintFlatConfigFile = "eslint.base.config.js";
+export declare function findBaseEslintFile(workspaceRoot?: string): string | null;
+export declare function isFlatConfig(configFilePath: string): boolean;

package/src/utils/config-file.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isFlatConfig = exports.findBaseEslintFile = exports.baseEsLintFlatConfigFile = exports.baseEsLintConfigFile = exports.ESLINT_CONFIG_FILENAMES = void 0;
+const devkit_1 = require("@nx/devkit");
+const fs_1 = require("fs");
+exports.ESLINT_CONFIG_FILENAMES = [
+    '.eslintrc',
+    '.eslintrc.js',
+    '.eslintrc.cjs',
+    '.eslintrc.yaml',
+    '.eslintrc.yml',
+    '.eslintrc.json',
+    'eslint.config.js',
+];
+exports.baseEsLintConfigFile = '.eslintrc.base.json';
+exports.baseEsLintFlatConfigFile = 'eslint.base.config.js';
+function findBaseEslintFile(workspaceRoot = '') {
+    if ((0, fs_1.existsSync)((0, devkit_1.joinPathFragments)(workspaceRoot, exports.baseEsLintConfigFile))) {
+        return exports.baseEsLintConfigFile;
+    }
+    if ((0, fs_1.existsSync)((0, devkit_1.joinPathFragments)(workspaceRoot, exports.baseEsLintFlatConfigFile))) {
+        return exports.baseEsLintFlatConfigFile;
+    }
+    for (const file of exports.ESLINT_CONFIG_FILENAMES) {
+        if ((0, fs_1.existsSync)((0, devkit_1.joinPathFragments)(workspaceRoot, file))) {
+            return file;
+        }
+    }
+    return null;
+}
+exports.findBaseEslintFile = findBaseEslintFile;
+function isFlatConfig(configFilePath) {
+    return configFilePath.endsWith('.config.js');
+}
+exports.isFlatConfig = isFlatConfig;