@nx/eslint 19.2.0-canary.20240531-2cb7ecb → 19.2.0-canary.20240604-0594deb

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/eslint",
-  "version": "19.2.0-canary.20240531-2cb7ecb",
+  "version": "19.2.0-canary.20240604-0594deb",
   "private": false,
   "description": "The ESLint plugin for Nx contains executors, generators and utilities used for linting JavaScript/TypeScript projects within an Nx workspace.",
   "repository": {
@@ -35,12 +35,12 @@
     "eslint": "^8.0.0 || ^9.0.0"
   },
   "dependencies": {
-    "@nx/devkit": "19.2.0-canary.20240531-2cb7ecb",
-    "@nx/js": "19.2.0-canary.20240531-2cb7ecb",
+    "@nx/devkit": "19.2.0-canary.20240604-0594deb",
+    "@nx/js": "19.2.0-canary.20240604-0594deb",
     "semver": "^7.5.3",
     "tslib": "^2.3.0",
     "typescript": "~5.4.2",
-    "@nx/linter": "19.2.0-canary.20240531-2cb7ecb"
+    "@nx/linter": "19.2.0-canary.20240604-0594deb"
   },
   "peerDependenciesMeta": {
     "@zkochan/js-yaml": {

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

@@ -1,4 +1,4 @@
-import { Tree } from '@nx/devkit';
+import { GeneratorCallback, Tree } from '@nx/devkit';
 import { ConvertToFlatConfigGeneratorSchema } from './schema';
-export declare function convertToFlatConfigGenerator(tree: Tree, options: ConvertToFlatConfigGeneratorSchema): Promise<void>;
+export declare function convertToFlatConfigGenerator(tree: Tree, options: ConvertToFlatConfigGeneratorSchema): Promise<void | GeneratorCallback>;
 export default convertToFlatConfigGenerator;

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

@@ -6,6 +6,7 @@ const eslint_file_1 = require("../utils/eslint-file");
 const path_1 = require("path");
 const versions_1 = require("../../utils/versions");
 const json_converter_1 = require("./converters/json-converter");
+let shouldInstallDeps = false;
 async function convertToFlatConfigGenerator(tree, options) {
     const eslintFile = (0, eslint_file_1.findEslintFile)(tree);
     if (!eslintFile) {
@@ -32,6 +33,9 @@ async function convertToFlatConfigGenerator(tree, options) {
     if (!options.skipFormat) {
         await (0, devkit_1.formatFiles)(tree);
     }
+    if (shouldInstallDeps) {
+        return () => (0, devkit_1.installPackagesTask)(tree);
+    }
 }
 exports.convertToFlatConfigGenerator = convertToFlatConfigGenerator;
 exports.default = convertToFlatConfigGenerator;
@@ -127,11 +131,13 @@ function processConvertedConfig(tree, root, source, target, { content, addESLint
     tree.write((0, path_1.join)(root, target), content);
     // add missing packages
     if (addESLintRC) {
+        shouldInstallDeps = true;
         (0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
             '@eslint/eslintrc': versions_1.eslintrcVersion,
         });
     }
     if (addESLintJS) {
+        shouldInstallDeps = true;
         (0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
             '@eslint/js': versions_1.eslintVersion,
         });

package/src/generators/convert-to-inferred/convert-to-inferred.js

@@ -8,8 +8,8 @@ const target_options_map_1 = require("./lib/target-options-map");
 const utils_1 = require("nx/src/tasks-runner/utils");
 async function convertToInferred(tree, options) {
     const projectGraph = await (0, devkit_1.createProjectGraphAsync)();
-    const migratedProjectsModern = await (0, executor_to_plugin_migrator_1.migrateExecutorToPlugin)(tree, projectGraph, '@nx/eslint:lint', '@nx/eslint/plugin', (targetName) => ({ targetName }), postTargetTransformer, plugin_1.createNodes, options.project);
-    const migratedProjectsLegacy = await (0, executor_to_plugin_migrator_1.migrateExecutorToPlugin)(tree, projectGraph, '@nrwl/linter:eslint', '@nx/eslint/plugin', (targetName) => ({ targetName }), postTargetTransformer, plugin_1.createNodes, options.project);
+    const migratedProjectsModern = await (0, executor_to_plugin_migrator_1.migrateExecutorToPlugin)(tree, projectGraph, '@nx/eslint:lint', '@nx/eslint/plugin', (targetName) => ({ targetName }), postTargetTransformer, plugin_1.createNodesV2, options.project);
+    const migratedProjectsLegacy = await (0, executor_to_plugin_migrator_1.migrateExecutorToPlugin)(tree, projectGraph, '@nrwl/linter:eslint', '@nx/eslint/plugin', (targetName) => ({ targetName }), postTargetTransformer, plugin_1.createNodesV2, options.project);
     const migratedProjects = migratedProjectsModern.size + migratedProjectsLegacy.size;
     if (migratedProjects === 0) {
         throw new Error('Could not find any targets to migrate.');
@@ -21,14 +21,14 @@ async function convertToInferred(tree, options) {
 exports.convertToInferred = convertToInferred;
 function postTargetTransformer(target, tree, projectDetails) {
     if (target.inputs) {
-        target.inputs = target.inputs.filter((input) => typeof input === 'string' &&
+        const inputs = target.inputs.filter((input) => typeof input === 'string' &&
             ![
                 'default',
                 '{workspaceRoot}/.eslintrc.json',
                 '{workspaceRoot}/.eslintignore',
                 '{workspaceRoot}/eslint.config.js',
             ].includes(input));
-        if (target.inputs.length === 0) {
+        if (inputs.length === 0) {
             delete target.inputs;
         }
     }

package/src/generators/init/init.js

@@ -48,7 +48,7 @@ async function initEsLint(tree, options) {
         '_eslint-lint',
     ];
     if (rootEslintFile && options.addPlugin && !hasPlugin) {
-        await (0, add_plugin_1.addPlugin)(tree, graph, '@nx/eslint/plugin', plugin_1.createNodes, {
+        await (0, add_plugin_1.addPlugin)(tree, graph, '@nx/eslint/plugin', plugin_1.createNodesV2, {
             targetName: lintTargetNames,
         }, options.updatePackageScripts);
         return () => { };
@@ -58,7 +58,7 @@ async function initEsLint(tree, options) {
     }
     updateProductionFileset(tree);
     if (options.addPlugin) {
-        await (0, add_plugin_1.addPlugin)(tree, graph, '@nx/eslint/plugin', plugin_1.createNodes, {
+        await (0, add_plugin_1.addPlugin)(tree, graph, '@nx/eslint/plugin', plugin_1.createNodesV2, {
             targetName: lintTargetNames,
         }, options.updatePackageScripts);
     }

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

@@ -16,6 +16,7 @@ interface LintProjectOptions {
      * @internal
      */
     addExplicitTargets?: boolean;
+    addPackageJsonDependencyChecks?: boolean;
 }
 export declare function lintProjectGenerator(tree: Tree, options: LintProjectOptions): Promise<GeneratorCallback>;
 export declare function lintProjectGeneratorInternal(tree: Tree, options: LintProjectOptions): Promise<GeneratorCallback>;

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

@@ -89,7 +89,7 @@ async function lintProjectGeneratorInternal(tree, options) {
     // additionally, the companion e2e app would have `rootProject: true`
     // so we need to check for the root path as well
     if (!options.rootProject || projectConfig.root !== '.') {
-        createEsLintConfiguration(tree, projectConfig, options.setParserOptionsProject, options.rootProject);
+        createEsLintConfiguration(tree, options, projectConfig, options.setParserOptionsProject, options.rootProject);
     }
     // Buildable libs need source analysis enabled for linting `package.json`.
     if (isBuildableLibraryProject(projectConfig) &&
@@ -108,7 +108,7 @@ async function lintProjectGeneratorInternal(tree, options) {
     return (0, devkit_1.runTasksInSerial)(...tasks);
 }
 exports.lintProjectGeneratorInternal = lintProjectGeneratorInternal;
-function createEsLintConfiguration(tree, projectConfig, setParserOptionsProject, rootProject) {
+function createEsLintConfiguration(tree, options, 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);
     const pathToRootConfig = extendedRootConfig
@@ -151,7 +151,8 @@ function createEsLintConfiguration(tree, projectConfig, setParserOptionsProject,
             rules: {},
         },
     ];
-    if (isBuildableLibraryProject(projectConfig)) {
+    if (options.addPackageJsonDependencyChecks ||
+        isBuildableLibraryProject(projectConfig)) {
         overrides.push({
             files: ['*.json'],
             parser: 'jsonc-eslint-parser',

package/src/plugins/plugin.d.ts

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

package/src/plugins/plugin.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createNodes = void 0;
+exports.createNodes = exports.createNodesV2 = void 0;
+const devkit_1 = require("@nx/devkit");
 const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
 const globs_1 = require("nx/src/utils/globs");
@@ -8,63 +9,100 @@ const workspace_context_1 = require("nx/src/utils/workspace-context");
 const config_file_1 = require("../utils/config-file");
 const resolve_eslint_class_1 = require("../utils/resolve-eslint-class");
 const semver_1 = require("semver");
+const cache_directory_1 = require("nx/src/utils/cache-directory");
+const file_hasher_1 = require("nx/src/hasher/file-hasher");
+const calculate_hash_for_create_nodes_1 = require("@nx/devkit/src/utils/calculate-hash-for-create-nodes");
 const DEFAULT_EXTENSIONS = ['ts', 'tsx', 'js', 'jsx', 'html', 'vue'];
-exports.createNodes = [
-    (0, globs_1.combineGlobPatterns)([
-        ...config_file_1.ESLINT_CONFIG_FILENAMES.map((f) => `**/${f}`),
-        config_file_1.baseEsLintConfigFile,
-        config_file_1.baseEsLintFlatConfigFile,
-    ]),
-    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, 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 ESLINT_CONFIG_GLOB = (0, globs_1.combineGlobPatterns)([
+    ...config_file_1.ESLINT_CONFIG_FILENAMES.map((f) => `**/${f}`),
+    config_file_1.baseEsLintConfigFile,
+    config_file_1.baseEsLintFlatConfigFile,
+]);
+function readTargetsCache(cachePath) {
+    return (0, node_fs_1.existsSync)(cachePath) ? (0, devkit_1.readJsonFile)(cachePath) : {};
+}
+function writeTargetsToCache(cachePath, results) {
+    (0, devkit_1.writeJsonFile)(cachePath, results);
+}
+const internalCreateNodes = async (configFilePath, options, context, projectsCache) => {
+    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, 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)), 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 = await (0, resolve_eslint_class_1.resolveESLintClass)((0, config_file_1.isFlatConfig)(configFilePath));
-        const eslintVersion = ESLint.version;
-        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;
-                }
+    }
+    const projectFiles = await (0, workspace_context_1.globWithWorkspaceContext)(context.workspaceRoot, ['project.json', 'package.json', '**/project.json', '**/package.json'].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 = await (0, resolve_eslint_class_1.resolveESLintClass)((0, config_file_1.isFlatConfig)(configFilePath));
+    const eslintVersion = ESLint.version;
+    const childProjectRoots = new Set();
+    const projects = {};
+    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 = await (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 parentConfigs = context.configFiles.filter((eslintConfig) => isSubDir(childProjectRoot, (0, node_path_1.dirname)(eslintConfig)));
+        const hash = await (0, calculate_hash_for_create_nodes_1.calculateHashForCreateNodes)(childProjectRoot, options, context, [...parentConfigs, (0, node_path_1.join)(childProjectRoot, '.eslintignore')]);
+        if (projectsCache[hash]) {
+            // We can reuse the projects in the cache.
+            Object.assign(projects, projectsCache[hash]);
+            return;
+        }
+        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;
             }
-        }));
+        }
         const uniqueChildProjectRoots = Array.from(childProjectRoots);
-        return {
-            projects: getProjectsUsingESLintConfig(configFilePath, uniqueChildProjectRoots, eslintVersion, options, context),
-        };
+        const projectsForRoot = getProjectsUsingESLintConfig(configFilePath, uniqueChildProjectRoots, eslintVersion, options, context);
+        if (Object.keys(projectsForRoot).length > 0) {
+            Object.assign(projects, projectsForRoot);
+            // Store those projects into the cache;
+            projectsCache[hash] = projectsForRoot;
+        }
+    }));
+    return {
+        projects,
+    };
+};
+exports.createNodesV2 = [
+    ESLINT_CONFIG_GLOB,
+    async (configFiles, options, context) => {
+        const optionsHash = (0, file_hasher_1.hashObject)(options);
+        const cachePath = (0, node_path_1.join)(cache_directory_1.projectGraphCacheDirectory, `eslint-${optionsHash}.hash`);
+        const targetsCache = readTargetsCache(cachePath);
+        try {
+            return await (0, devkit_1.createNodesFromFiles)((configFile, options, context) => internalCreateNodes(configFile, options, context, targetsCache), configFiles, options, context);
+        }
+        finally {
+            writeTargetsToCache(cachePath, targetsCache);
+        }
+    },
+];
+exports.createNodes = [
+    ESLINT_CONFIG_GLOB,
+    (configFilePath, options, context) => {
+        devkit_1.logger.warn('`createNodes` is deprecated. Update your plugin to utilize createNodesV2 instead. In Nx 20, this will change to the createNodesV2 API.');
+        return internalCreateNodes(configFilePath, options, context, {});
     },
 ];
 function getProjectsUsingESLintConfig(configFilePath, childProjectRoots, eslintVersion, options, context) {
@@ -76,11 +114,17 @@ function getProjectsUsingESLintConfig(configFilePath, childProjectRoots, eslintV
     ].find((f) => (0, node_fs_1.existsSync)((0, node_path_1.join)(context.workspaceRoot, 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) {
+        let standaloneSrcPath;
+        if (projectRoot === '.' &&
+            (0, node_fs_1.existsSync)((0, node_path_1.join)(context.workspaceRoot, projectRoot, 'package.json'))) {
+            if ((0, node_fs_1.existsSync)((0, node_path_1.join)(context.workspaceRoot, projectRoot, 'src'))) {
+                standaloneSrcPath = 'src';
+            }
+            else if ((0, node_fs_1.existsSync)((0, node_path_1.join)(context.workspaceRoot, projectRoot, 'lib'))) {
+                standaloneSrcPath = 'lib';
+            }
+        }
+        if (projectRoot === '.' && !standaloneSrcPath) {
             continue;
         }
         const eslintConfigs = [configFilePath];
@@ -88,16 +132,16 @@ function getProjectsUsingESLintConfig(configFilePath, childProjectRoots, eslintV
             eslintConfigs.unshift(rootEslintConfig);
         }
         projects[projectRoot] = {
-            targets: buildEslintTargets(eslintConfigs, eslintVersion, projectRoot, context.workspaceRoot, options, isStandaloneWorkspace),
+            targets: buildEslintTargets(eslintConfigs, eslintVersion, projectRoot, context.workspaceRoot, options, standaloneSrcPath),
         };
     }
     return projects;
 }
-function buildEslintTargets(eslintConfigs, eslintVersion, projectRoot, workspaceRoot, options, isStandaloneWorkspace = false) {
+function buildEslintTargets(eslintConfigs, eslintVersion, projectRoot, workspaceRoot, options, standaloneSrcPath) {
     const isRootProject = projectRoot === '.';
     const targets = {};
     const targetConfig = {
-        command: `eslint ${isRootProject && isStandaloneWorkspace ? './src' : '.'}`,
+        command: `eslint ${isRootProject && standaloneSrcPath ? `./${standaloneSrcPath}` : '.'}`,
         cache: true,
         options: {
             cwd: projectRoot,