@nx/eslint 19.2.0-rc.0 → 19.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/eslint",
-  "version": "19.2.0-rc.0",
+  "version": "19.2.0",
   "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-rc.0",
-    "@nx/js": "19.2.0-rc.0",
+    "@nx/devkit": "19.2.0",
+    "@nx/js": "19.2.0",
     "semver": "^7.5.3",
     "tslib": "^2.3.0",
     "typescript": "~5.4.2",
-    "@nx/linter": "19.2.0-rc.0"
+    "@nx/linter": "19.2.0"
   },
   "peerDependenciesMeta": {
     "@zkochan/js-yaml": {

package/src/executors/lint/lint.impl.d.ts

@@ -1,4 +1,4 @@
-import { ExecutorContext } from '@nx/devkit';
+import { type ExecutorContext } from '@nx/devkit';
 import type { Schema } from './schema';
 export default function run(options: Schema, context: ExecutorContext): Promise<{
     success: boolean;

package/src/executors/lint/lint.impl.js

@@ -2,9 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const devkit_1 = require("@nx/devkit");
 const fs_1 = require("fs");
+const utils_1 = require("nx/src/tasks-runner/utils");
 const path_1 = require("path");
+const config_file_1 = require("../../utils/config-file");
 const eslint_utils_1 = require("./utility/eslint-utils");
-const utils_1 = require("nx/src/tasks-runner/utils");
 async function run(options, context) {
     // this is only used for the hasher
     delete options.hasTypeAwareRules;
@@ -23,19 +24,14 @@ async function run(options, context) {
         ? (0, devkit_1.joinPathFragments)(options.cacheLocation, projectName)
         : undefined;
     const { printConfig, errorOnUnmatchedPattern, ...normalizedOptions } = options;
-    /**
-     * Until ESLint v9 is released and the new so called flat config is the default
-     * we only want to support it if the user has explicitly opted into it by converting
-     * their root ESLint config to use eslint.config.js
-     */
-    const hasFlatConfig = (0, fs_1.existsSync)((0, devkit_1.joinPathFragments)(devkit_1.workspaceRoot, 'eslint.config.js'));
+    // locate the flat config file if it exists starting from the project root
+    const flatConfigFilePath = (0, config_file_1.findFlatConfigFile)(projectRoot, context.root);
+    const hasFlatConfig = flatConfigFilePath !== null;
     // while standard eslint uses by default closest config to the file, if otherwise not specified,
-    // the flat config would always use the root config, so we need to explicitly set it to the local one
+    // the flat config would be resolved starting from the cwd, which we changed to the workspace root
+    // so we explicitly set the config path to the flat config file path we previously found
     if (hasFlatConfig && !normalizedOptions.eslintConfig) {
-        const eslintConfigPath = (0, devkit_1.joinPathFragments)(projectRoot, 'eslint.config.js');
-        if ((0, fs_1.existsSync)(eslintConfigPath)) {
-            normalizedOptions.eslintConfig = eslintConfigPath;
-        }
+        normalizedOptions.eslintConfig = path_1.posix.relative(systemRoot, flatConfigFilePath);
     }
     /**
      * We want users to have the option of not specifying the config path, and let

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

@@ -1,11 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveAndInstantiateESLint = void 0;
+const config_file_1 = require("../../../utils/config-file");
 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')) {
+    if (useFlatConfig && eslintConfigPath && !(0, config_file_1.isFlatConfig)(eslintConfigPath)) {
         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 (0, resolve_eslint_class_1.resolveESLintClass)(useFlatConfig);

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

@@ -1,4 +1,8 @@
+export declare const ESLINT_FLAT_CONFIG_FILENAMES: string[];
+export declare const ESLINT_OLD_CONFIG_FILENAMES: string[];
 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 isFlatConfig(configFilePath: string): boolean;
+export declare function findFlatConfigFile(directory: string, workspaceRoot: string): string | null;
+export declare function findOldConfigFile(filePathOrDirectory: string, workspaceRoot: string): string | null;

package/src/utils/config-file.js

@@ -1,18 +1,68 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isFlatConfig = exports.baseEsLintFlatConfigFile = exports.baseEsLintConfigFile = exports.ESLINT_CONFIG_FILENAMES = void 0;
-exports.ESLINT_CONFIG_FILENAMES = [
+exports.findOldConfigFile = exports.findFlatConfigFile = exports.isFlatConfig = exports.baseEsLintFlatConfigFile = exports.baseEsLintConfigFile = exports.ESLINT_CONFIG_FILENAMES = exports.ESLINT_OLD_CONFIG_FILENAMES = exports.ESLINT_FLAT_CONFIG_FILENAMES = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+// TODO(leo): add support for eslint.config.mjs and eslint.config.cjs
+exports.ESLINT_FLAT_CONFIG_FILENAMES = ['eslint.config.js'];
+exports.ESLINT_OLD_CONFIG_FILENAMES = [
     '.eslintrc',
     '.eslintrc.js',
     '.eslintrc.cjs',
     '.eslintrc.yaml',
     '.eslintrc.yml',
     '.eslintrc.json',
-    'eslint.config.js',
+];
+exports.ESLINT_CONFIG_FILENAMES = [
+    ...exports.ESLINT_OLD_CONFIG_FILENAMES,
+    ...exports.ESLINT_FLAT_CONFIG_FILENAMES,
 ];
 exports.baseEsLintConfigFile = '.eslintrc.base.json';
 exports.baseEsLintFlatConfigFile = 'eslint.base.config.js';
 function isFlatConfig(configFilePath) {
-    return configFilePath.endsWith('.config.js');
+    const configFileName = (0, path_1.basename)(configFilePath);
+    return exports.ESLINT_FLAT_CONFIG_FILENAMES.includes(configFileName);
 }
 exports.isFlatConfig = isFlatConfig;
+// https://eslint.org/docs/latest/use/configure/configuration-files#configuration-file-resolution
+function findFlatConfigFile(directory, workspaceRoot) {
+    let currentDir = (0, path_1.resolve)(workspaceRoot, directory);
+    if (currentDir === workspaceRoot) {
+        return getConfigFileInDirectory(currentDir, exports.ESLINT_FLAT_CONFIG_FILENAMES);
+    }
+    while (currentDir !== workspaceRoot) {
+        const configFilePath = getConfigFileInDirectory(currentDir, exports.ESLINT_FLAT_CONFIG_FILENAMES);
+        if (configFilePath) {
+            return configFilePath;
+        }
+        currentDir = (0, path_1.dirname)(currentDir);
+    }
+    return null;
+}
+exports.findFlatConfigFile = findFlatConfigFile;
+function findOldConfigFile(filePathOrDirectory, workspaceRoot) {
+    let currentDir = (0, fs_1.statSync)(filePathOrDirectory).isDirectory()
+        ? filePathOrDirectory
+        : (0, path_1.dirname)(filePathOrDirectory);
+    if (currentDir === workspaceRoot) {
+        return getConfigFileInDirectory(currentDir, exports.ESLINT_OLD_CONFIG_FILENAMES);
+    }
+    while (currentDir !== workspaceRoot) {
+        const configFilePath = getConfigFileInDirectory(currentDir, exports.ESLINT_OLD_CONFIG_FILENAMES);
+        if (configFilePath) {
+            return configFilePath;
+        }
+        currentDir = (0, path_1.dirname)(currentDir);
+    }
+    return null;
+}
+exports.findOldConfigFile = findOldConfigFile;
+function getConfigFileInDirectory(directory, candidateFileNames) {
+    for (const filename of candidateFileNames) {
+        const filePath = (0, path_1.join)(directory, filename);
+        if ((0, fs_1.existsSync)(filePath)) {
+            return filePath;
+        }
+    }
+    return null;
+}