@nx/eslint 19.0.0-canary.20240423-b37bfdb → 19.0.0-canary.20240426-ac9ad35

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/eslint",
-  "version": "19.0.0-canary.20240423-b37bfdb",
+  "version": "19.0.0-canary.20240426-ac9ad35",
   "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.20240423-b37bfdb",
-    "@nx/js": "19.0.0-canary.20240423-b37bfdb",
+    "@nx/devkit": "19.0.0-canary.20240426-ac9ad35",
+    "@nx/js": "19.0.0-canary.20240426-ac9ad35",
     "eslint": "^8.0.0",
     "tslib": "^2.3.0",
     "typescript": "~5.4.2",
-    "@nx/linter": "19.0.0-canary.20240423-b37bfdb"
+    "@nx/linter": "19.0.0-canary.20240426-ac9ad35"
   },
   "peerDependenciesMeta": {
     "js-yaml": {

package/src/plugins/plugin.js

@@ -13,41 +13,52 @@ exports.createNodes = [
         config_file_1.baseEsLintConfigFile,
         config_file_1.baseEsLintFlatConfigFile,
     ]),
-    (configFilePath, options, context) => {
+    async (configFilePath, options, context) => {
         options = normalizeOptions(options);
+        const configDir = (0, node_path_1.dirname)(configFilePath);
         // 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, [
+        // Create a Set of all the directories containing eslint configs, and a
+        // list of globs to exclude from child projects
+        const eslintRoots = new Set();
+        const nestedEslintRootPatterns = [];
+        for (const configFile of context.configFiles) {
+            const eslintRootDir = (0, node_path_1.dirname)(configFile);
+            eslintRoots.add(eslintRootDir);
+            if (eslintRootDir !== configDir && isSubDir(configDir, eslintRootDir)) {
+                nestedEslintRootPatterns.push(`${eslintRootDir}/**/*`);
+            }
+        }
+        const projectFiles = (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;
+        ].map((f) => (0, node_path_1.join)(configDir, f)), nestedEslintRootPatterns.length ? nestedEslintRootPatterns : undefined);
+        // dedupe and sort project roots by depth for more efficient traversal
+        const dedupedProjectRoots = Array.from(new Set(projectFiles.map((f) => (0, node_path_1.dirname)(f)))).sort((a, b) => (a !== b && isSubDir(a, b) ? -1 : 1));
+        const excludePatterns = dedupedProjectRoots.map((root) => `${root}/**/*`);
+        const ESLint = resolveESLintClass((0, config_file_1.isFlatConfig)(configFilePath));
+        const childProjectRoots = new Set();
+        await Promise.all(dedupedProjectRoots.map(async (childProjectRoot, index) => {
+            // anything after is either a nested project or a sibling project, can be excluded
+            const nestedProjectRootPatterns = excludePatterns.slice(index + 1);
+            // 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)(childProjectRoot, `**/*.{${options.extensions.join(',')}}`)], 
+            // exclude nested eslint roots and nested project roots
+            [...nestedEslintRootPatterns, ...nestedProjectRootPatterns]);
+            const eslint = new ESLint({
+                cwd: (0, node_path_1.join)(context.workspaceRoot, childProjectRoot),
+            });
+            for (const file of lintableFiles) {
+                if (!(await eslint.isPathIgnored((0, node_path_1.join)(context.workspaceRoot, file)))) {
+                    childProjectRoots.add(childProjectRoot);
+                    break;
                 }
-                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));
+        }));
+        const uniqueChildProjectRoots = Array.from(childProjectRoots);
         return {
             projects: getProjectsUsingESLintConfig(configFilePath, uniqueChildProjectRoots, options, context),
         };
@@ -72,12 +83,12 @@ function getProjectsUsingESLintConfig(configFilePath, childProjectRoots, options
             eslintConfigs.unshift(rootEslintConfig);
         }
         projects[projectRoot] = {
-            targets: buildEslintTargets(eslintConfigs, projectRoot, options, isStandaloneWorkspace),
+            targets: buildEslintTargets(eslintConfigs, projectRoot, context.workspaceRoot, options, isStandaloneWorkspace),
         };
     }
     return projects;
 }
-function buildEslintTargets(eslintConfigs, projectRoot, options, isStandaloneWorkspace = false) {
+function buildEslintTargets(eslintConfigs, projectRoot, workspaceRoot, options, isStandaloneWorkspace = false) {
     const isRootProject = projectRoot === '.';
     const targets = {};
     const targetConfig = {
@@ -91,6 +102,9 @@ function buildEslintTargets(eslintConfigs, projectRoot, options, isStandaloneWor
             // Certain lint rules can be impacted by changes to dependencies
             '^default',
             ...eslintConfigs.map((config) => `{workspaceRoot}/${config}`.replace(`{workspaceRoot}/${projectRoot}`, isRootProject ? '{projectRoot}/' : '{projectRoot}')),
+            ...((0, node_fs_1.existsSync)((0, node_path_1.join)(workspaceRoot, projectRoot, '.eslintignore'))
+                ? ['{projectRoot}/.eslintignore']
+                : []),
             '{workspaceRoot}/tools/eslint-rules/**/*',
             { externalDependencies: ['eslint'] },
         ],
@@ -115,3 +129,30 @@ function normalizeOptions(options) {
     }
     return options;
 }
+function resolveESLintClass(useFlatConfig = false) {
+    try {
+        if (!useFlatConfig) {
+            return require('eslint').ESLint;
+        }
+        return require('eslint/use-at-your-own-risk').FlatESLint;
+    }
+    catch {
+        throw new Error('Unable to find ESLint. Ensure ESLint is installed.');
+    }
+}
+/**
+ * Determines if `child` is a subdirectory of `parent`. This is a simplified
+ * version that takes into account that paths are always relative to the
+ * workspace root.
+ */
+function isSubDir(parent, child) {
+    if (parent === '.') {
+        return true;
+    }
+    parent = (0, node_path_1.normalize)(parent);
+    child = (0, node_path_1.normalize)(child);
+    if (!parent.endsWith(node_path_1.sep)) {
+        parent += node_path_1.sep;
+    }
+    return child.startsWith(parent);
+}