@nx/eslint 19.0.5 → 19.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/eslint",
-  "version": "19.0.5",
+  "version": "19.0.7",
   "private": false,
   "description": "The ESLint plugin for Nx contains executors, generators and utilities used for linting JavaScript/TypeScript projects within an Nx workspace.",
   "repository": {
@@ -13,9 +13,10 @@
     "Web",
     "Lint",
     "ESLint",
-    "CLI"
+    "CLI",
+    "Testing"
   ],
-  "main": "./index.js",
+  "main": "./index",
   "typings": "./index.d.ts",
   "author": "Victor Savkin",
   "license": "MIT",
@@ -33,12 +34,13 @@
     "js-yaml": "npm:@zkochan/js-yaml@0.0.7"
   },
   "dependencies": {
-    "@nx/devkit": "19.0.5",
-    "@nx/js": "19.0.5",
+    "@nx/devkit": "19.0.7",
+    "@nx/js": "19.0.7",
     "eslint": "^8.0.0",
+    "semver": "^7.5.3",
     "tslib": "^2.3.0",
     "typescript": "~5.4.2",
-    "@nx/linter": "19.0.5"
+    "@nx/linter": "19.0.7"
   },
   "peerDependenciesMeta": {
     "js-yaml": {

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

@@ -1,26 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveAndInstantiateESLint = void 0;
-async function resolveESLintClass(useFlatConfig = false) {
-    try {
-        if (!useFlatConfig) {
-            return (await Promise.resolve().then(() => require('eslint'))).ESLint;
-        }
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
-        const { FlatESLint } = require('eslint/use-at-your-own-risk');
-        return FlatESLint;
-    }
-    catch {
-        throw new Error('Unable to find ESLint. Ensure ESLint is installed.');
-    }
-}
+const resolve_eslint_class_1 = require("../../../utils/resolve-eslint-class");
 async function resolveAndInstantiateESLint(eslintConfigPath, options, useFlatConfig = false) {
     if (useFlatConfig &&
         eslintConfigPath &&
         !eslintConfigPath?.endsWith('eslint.config.js')) {
         throw new Error('When using the new Flat Config with ESLint, all configs must be named eslint.config.js and .eslintrc files may not be used. See https://eslint.org/docs/latest/use/configure/configuration-files-new');
     }
-    const ESLint = await resolveESLintClass(useFlatConfig);
+    const ESLint = await (0, resolve_eslint_class_1.resolveESLintClass)(useFlatConfig);
     const eslintOptions = {
         overrideConfigFile: eslintConfigPath,
         fix: !!options.fix,

package/src/plugins/plugin.js

@@ -6,6 +6,8 @@ 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 resolve_eslint_class_1 = require("../utils/resolve-eslint-class");
+const semver_1 = require("semver");
 const DEFAULT_EXTENSIONS = ['ts', 'tsx', 'js', 'jsx', 'html', 'vue'];
 exports.createNodes = [
     (0, globs_1.combineGlobPatterns)([
@@ -39,7 +41,8 @@ exports.createNodes = [
         // 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 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
@@ -60,11 +63,11 @@ exports.createNodes = [
         }));
         const uniqueChildProjectRoots = Array.from(childProjectRoots);
         return {
-            projects: getProjectsUsingESLintConfig(configFilePath, uniqueChildProjectRoots, options, context),
+            projects: getProjectsUsingESLintConfig(configFilePath, uniqueChildProjectRoots, eslintVersion, options, context),
         };
     },
 ];
-function getProjectsUsingESLintConfig(configFilePath, childProjectRoots, options, context) {
+function getProjectsUsingESLintConfig(configFilePath, childProjectRoots, eslintVersion, options, context) {
     const projects = {};
     const rootEslintConfig = [
         config_file_1.baseEsLintConfigFile,
@@ -85,12 +88,12 @@ function getProjectsUsingESLintConfig(configFilePath, childProjectRoots, options
             eslintConfigs.unshift(rootEslintConfig);
         }
         projects[projectRoot] = {
-            targets: buildEslintTargets(eslintConfigs, projectRoot, context.workspaceRoot, options, isStandaloneWorkspace),
+            targets: buildEslintTargets(eslintConfigs, eslintVersion, projectRoot, context.workspaceRoot, options, isStandaloneWorkspace),
         };
     }
     return projects;
 }
-function buildEslintTargets(eslintConfigs, projectRoot, workspaceRoot, options, isStandaloneWorkspace = false) {
+function buildEslintTargets(eslintConfigs, eslintVersion, projectRoot, workspaceRoot, options, isStandaloneWorkspace = false) {
     const isRootProject = projectRoot === '.';
     const targets = {};
     const targetConfig = {
@@ -112,9 +115,13 @@ function buildEslintTargets(eslintConfigs, projectRoot, workspaceRoot, options,
         ],
         outputs: ['{options.outputFile}'],
     };
-    if (eslintConfigs.some((config) => (0, config_file_1.isFlatConfig)(config))) {
+    // Always set the environment variable to ensure that the ESLint CLI can run on eslint v8 and v9
+    const useFlatConfig = eslintConfigs.some((config) => (0, config_file_1.isFlatConfig)(config));
+    // Flat config is default for 9.0.0+
+    const defaultSetting = (0, semver_1.gte)(eslintVersion, '9.0.0');
+    if (useFlatConfig !== defaultSetting) {
         targetConfig.options.env = {
-            ESLINT_USE_FLAT_CONFIG: 'true',
+            ESLINT_USE_FLAT_CONFIG: useFlatConfig ? 'true' : 'false',
         };
     }
     targets[options.targetName] = targetConfig;
@@ -132,17 +139,6 @@ 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

package/src/utils/resolve-eslint-class.d.ts

@@ -0,0 +1,2 @@
+import type { ESLint } from 'eslint';
+export declare function resolveESLintClass(useFlatConfig?: boolean): Promise<typeof ESLint>;

package/src/utils/resolve-eslint-class.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveESLintClass = void 0;
+async function resolveESLintClass(useFlatConfig = false) {
+    try {
+        // In eslint 8.57.0 (the final v8 version), a dedicated API was added for resolving the correct ESLint class.
+        const eslint = await Promise.resolve().then(() => require('eslint'));
+        if (typeof eslint.loadESLint === 'function') {
+            return await eslint.loadESLint({ useFlatConfig });
+        }
+        // If that API is not available (an older version of v8), we need to use the old way of resolving the ESLint class.
+        if (!useFlatConfig) {
+            return eslint.ESLint;
+        }
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        const { FlatESLint } = require('eslint/use-at-your-own-risk');
+        return FlatESLint;
+    }
+    catch {
+        throw new Error('Unable to find ESLint. Ensure ESLint is installed.');
+    }
+}
+exports.resolveESLintClass = resolveESLintClass;