@nx/eslint 18.1.0 → 18.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/eslint",
-  "version": "18.1.0",
+  "version": "18.1.1",
   "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.1.0",
-    "@nx/js": "18.1.0",
+    "@nx/devkit": "18.1.1",
+    "@nx/js": "18.1.1",
     "eslint": "^8.0.0",
     "tslib": "^2.3.0",
     "typescript": "~5.3.2",
-    "@nx/linter": "18.1.0"
+    "@nx/linter": "18.1.1"
   },
   "peerDependenciesMeta": {
     "js-yaml": {

package/src/plugins/plugin.d.ts

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

package/src/plugins/plugin.js

@@ -1,78 +1,96 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createNodes = void 0;
-const path_1 = require("path");
-const fs_1 = require("fs");
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
 const globs_1 = require("nx/src/utils/globs");
+const workspace_context_1 = require("nx/src/utils/workspace-context");
 const config_file_1 = require("../utils/config-file");
+const DEFAULT_EXTENSIONS = ['ts', 'tsx', 'js', 'jsx', 'html', 'vue'];
 exports.createNodes = [
-    (0, globs_1.combineGlobPatterns)(['**/project.json', '**/package.json']),
+    (0, globs_1.combineGlobPatterns)([
+        ...config_file_1.ESLINT_CONFIG_FILENAMES.map((f) => `**/${f}`),
+        config_file_1.baseEsLintConfigFile,
+        config_file_1.baseEsLintFlatConfigFile,
+    ]),
     (configFilePath, options, context) => {
-        const projectRoot = (0, path_1.dirname)(configFilePath);
         options = normalizeOptions(options);
-        const eslintConfigs = getEslintConfigsForProject(projectRoot, context.workspaceRoot);
-        if (!eslintConfigs.length) {
-            return {};
-        }
+        // Ensure that configFiles are set, e2e-run fails due to them being undefined in CI (does not occur locally)
+        // TODO(JamesHenry): Further troubleshoot this in CI
+        context.configFiles = context.configFiles ?? [];
+        // Create a Set of all the directories containing eslint configs
+        const eslintRoots = new Set(context.configFiles.map(node_path_1.dirname));
+        const configDir = (0, node_path_1.dirname)(configFilePath);
+        const childProjectRoots = (0, workspace_context_1.globWithWorkspaceContext)(context.workspaceRoot, [
+            'project.json',
+            'package.json',
+            '**/project.json',
+            '**/package.json',
+        ].map((f) => (0, node_path_1.join)(configDir, f)))
+            .map((f) => (0, node_path_1.dirname)(f))
+            .filter((childProjectRoot) => {
+            // Filter out projects under other eslint configs
+            let root = childProjectRoot;
+            // Traverse up from the childProjectRoot to either the workspaceRoot or the dir of this config file
+            while (root !== (0, node_path_1.dirname)(root) && root !== (0, node_path_1.dirname)(configFilePath)) {
+                if (eslintRoots.has(root)) {
+                    return false;
+                }
+                root = (0, node_path_1.dirname)(root);
+            }
+            return true;
+        })
+            .filter((dir) => {
+            // Ignore project roots where the project does not contain any lintable files
+            const lintableFiles = (0, workspace_context_1.globWithWorkspaceContext)(context.workspaceRoot, [
+                (0, node_path_1.join)(dir, `**/*.{${options.extensions.join(',')}}`),
+            ]);
+            return lintableFiles.length > 0;
+        });
+        const uniqueChildProjectRoots = Array.from(new Set(childProjectRoots));
         return {
-            projects: {
-                [projectRoot]: {
-                    targets: buildEslintTargets(eslintConfigs, projectRoot, options),
-                },
-            },
+            projects: getProjectsUsingESLintConfig(configFilePath, uniqueChildProjectRoots, 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 [];
+function getProjectsUsingESLintConfig(configFilePath, childProjectRoots, options, context) {
+    const projects = {};
+    const rootEslintConfig = context.configFiles.find((f) => f === config_file_1.baseEsLintConfigFile ||
+        f === config_file_1.baseEsLintFlatConfigFile ||
+        config_file_1.ESLINT_CONFIG_FILENAMES.includes(f));
+    // Add a lint target for each child project without an eslint config, with the root level config as an input
+    for (const projectRoot of childProjectRoots) {
+        // If there's no src folder, it's not a standalone project, do not add the target at all
+        const isStandaloneWorkspace = projectRoot === '.' &&
+            (0, node_fs_1.existsSync)((0, node_path_1.join)(context.workspaceRoot, projectRoot, 'src')) &&
+            (0, node_fs_1.existsSync)((0, node_path_1.join)(context.workspaceRoot, projectRoot, 'package.json'));
+        if (projectRoot === '.' && !isStandaloneWorkspace) {
+            continue;
         }
-        // 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);
+        const eslintConfigs = [configFilePath];
+        if (rootEslintConfig && !eslintConfigs.includes(rootEslintConfig)) {
+            eslintConfigs.unshift(rootEslintConfig);
         }
-        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);
+        projects[projectRoot] = {
+            targets: buildEslintTargets(eslintConfigs, projectRoot, options, isStandaloneWorkspace),
+        };
     }
-    return [];
+    return projects;
 }
-function buildEslintTargets(eslintConfigs, projectRoot, options) {
+function buildEslintTargets(eslintConfigs, projectRoot, options, isStandaloneWorkspace = false) {
     const isRootProject = projectRoot === '.';
     const targets = {};
     const targetConfig = {
-        command: `eslint ${isRootProject ? './src' : '.'}`,
+        command: `eslint ${isRootProject && isStandaloneWorkspace ? './src' : '.'}`,
         cache: true,
         options: {
             cwd: projectRoot,
         },
         inputs: [
             'default',
-            ...eslintConfigs.map((config) => `{workspaceRoot}/${config}`),
+            // Certain lint rules can be impacted by changes to dependencies
+            '^default',
+            ...eslintConfigs.map((config) => `{workspaceRoot}/${config}`.replace(`{workspaceRoot}/${projectRoot}`, isRootProject ? '{projectRoot}/' : '{projectRoot}')),
             '{workspaceRoot}/tools/eslint-rules/**/*',
             { externalDependencies: ['eslint'] },
         ],
@@ -88,5 +106,12 @@ function buildEslintTargets(eslintConfigs, projectRoot, options) {
 function normalizeOptions(options) {
     options ??= {};
     options.targetName ??= 'lint';
+    // Normalize user input for extensions (strip leading . characters)
+    if (Array.isArray(options.extensions)) {
+        options.extensions = options.extensions.map((f) => f.replace(/^\.+/, ''));
+    }
+    else {
+        options.extensions = DEFAULT_EXTENSIONS;
+    }
     return options;
 }

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

@@ -1,5 +1,4 @@
 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

@@ -1,8 +1,6 @@
 "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.isFlatConfig = exports.baseEsLintFlatConfigFile = exports.baseEsLintConfigFile = exports.ESLINT_CONFIG_FILENAMES = void 0;
 exports.ESLINT_CONFIG_FILENAMES = [
     '.eslintrc',
     '.eslintrc.js',
@@ -14,21 +12,6 @@ exports.ESLINT_CONFIG_FILENAMES = [
 ];
 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');
 }