@nx/eslint 19.4.1 → 19.4.2

package/package.json

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

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

@@ -5,7 +5,9 @@ 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 && !(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');
+        throw new Error(
+        // todo: add support for eslint.config.mjs,
+        'When using the new Flat Config with ESLint, all configs must be named eslint.config.js or eslint.config.cjs and .eslintrc files may not be used. See https://eslint.org/docs/latest/use/configure/configuration-files');
     }
     const ESLint = await (0, resolve_eslint_class_1.resolveESLintClass)(useFlatConfig);
     const eslintOptions = {

package/src/generators/utils/eslint-file.js

@@ -103,7 +103,7 @@ function addOverrideToLintConfig(tree, root, override, options = {
 }) {
     const isBase = options.checkBaseConfig && findEslintFile(tree, root).includes('.base');
     if ((0, flat_config_1.useFlatConfig)(tree)) {
-        const fileName = (0, devkit_1.joinPathFragments)(root, isBase ? config_file_1.baseEsLintFlatConfigFile : 'eslint.config.js');
+        const fileName = (0, devkit_1.joinPathFragments)(root, isBase ? config_file_1.baseEsLintFlatConfigFile : (0, flat_config_1.flatConfigEslintFilename)(tree));
         const flatOverride = (0, ast_utils_1.generateFlatOverride)(override);
         let content = tree.read(fileName, 'utf8');
         // we will be using compat here so we need to make sure it's added
@@ -132,7 +132,7 @@ function overrideNeedsCompat(override) {
 }
 function updateOverrideInLintConfig(tree, root, lookup, update) {
     if ((0, flat_config_1.useFlatConfig)(tree)) {
-        const fileName = (0, devkit_1.joinPathFragments)(root, 'eslint.config.js');
+        const fileName = (0, devkit_1.joinPathFragments)(root, (0, flat_config_1.flatConfigEslintFilename)(tree));
         let content = tree.read(fileName, 'utf8');
         content = (0, ast_utils_1.replaceOverride)(content, root, lookup, update);
         tree.write(fileName, content);
@@ -168,7 +168,7 @@ function lintConfigHasOverride(tree, root, lookup, checkBaseConfig = false) {
     }
     const isBase = checkBaseConfig && findEslintFile(tree, root).includes('.base');
     if ((0, flat_config_1.useFlatConfig)(tree)) {
-        const fileName = (0, devkit_1.joinPathFragments)(root, isBase ? config_file_1.baseEsLintFlatConfigFile : 'eslint.config.js');
+        const fileName = (0, devkit_1.joinPathFragments)(root, isBase ? config_file_1.baseEsLintFlatConfigFile : (0, flat_config_1.flatConfigEslintFilename)(tree));
         const content = tree.read(fileName, 'utf8');
         return (0, ast_utils_1.hasOverride)(content, lookup);
     }
@@ -180,7 +180,7 @@ function lintConfigHasOverride(tree, root, lookup, checkBaseConfig = false) {
 exports.lintConfigHasOverride = lintConfigHasOverride;
 function replaceOverridesInLintConfig(tree, root, overrides) {
     if ((0, flat_config_1.useFlatConfig)(tree)) {
-        const fileName = (0, devkit_1.joinPathFragments)(root, 'eslint.config.js');
+        const fileName = (0, devkit_1.joinPathFragments)(root, (0, flat_config_1.flatConfigEslintFilename)(tree));
         let content = tree.read(fileName, 'utf8');
         // we will be using compat here so we need to make sure it's added
         if (overrides.some(overrideNeedsCompat)) {
@@ -205,7 +205,7 @@ exports.replaceOverridesInLintConfig = replaceOverridesInLintConfig;
 function addExtendsToLintConfig(tree, root, plugin) {
     const plugins = Array.isArray(plugin) ? plugin : [plugin];
     if ((0, flat_config_1.useFlatConfig)(tree)) {
-        const fileName = (0, devkit_1.joinPathFragments)(root, 'eslint.config.js');
+        const fileName = (0, devkit_1.joinPathFragments)(root, (0, flat_config_1.flatConfigEslintFilename)(tree));
         const pluginExtends = (0, ast_utils_1.generatePluginExtendsElement)(plugins);
         let content = tree.read(fileName, 'utf8');
         content = (0, ast_utils_1.addCompatToFlatConfig)(content);
@@ -229,7 +229,7 @@ exports.addExtendsToLintConfig = addExtendsToLintConfig;
 function addPluginsToLintConfig(tree, root, plugin) {
     const plugins = Array.isArray(plugin) ? plugin : [plugin];
     if ((0, flat_config_1.useFlatConfig)(tree)) {
-        const fileName = (0, devkit_1.joinPathFragments)(root, 'eslint.config.js');
+        const fileName = (0, devkit_1.joinPathFragments)(root, (0, flat_config_1.flatConfigEslintFilename)(tree));
         let content = tree.read(fileName, 'utf8');
         const mappedPlugins = [];
         plugins.forEach((name) => {
@@ -254,7 +254,7 @@ function addPluginsToLintConfig(tree, root, plugin) {
 exports.addPluginsToLintConfig = addPluginsToLintConfig;
 function addIgnoresToLintConfig(tree, root, ignorePatterns) {
     if ((0, flat_config_1.useFlatConfig)(tree)) {
-        const fileName = (0, devkit_1.joinPathFragments)(root, 'eslint.config.js');
+        const fileName = (0, devkit_1.joinPathFragments)(root, (0, flat_config_1.flatConfigEslintFilename)(tree));
         const block = (0, ast_utils_1.generateAst)({
             ignores: ignorePatterns.map((path) => (0, path_utils_1.mapFilePath)(path)),
         });

package/src/utils/config-file.js

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 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'];
+const flat_config_1 = require("./flat-config");
+exports.ESLINT_FLAT_CONFIG_FILENAMES = flat_config_1.eslintFlatConfigFilenames;
 exports.ESLINT_OLD_CONFIG_FILENAMES = [
     '.eslintrc',
     '.eslintrc.js',
@@ -30,6 +30,7 @@ function findFlatConfigFile(directory, workspaceRoot) {
     while (true) {
         const configFilePath = getConfigFileInDirectory(currentDir, exports.ESLINT_FLAT_CONFIG_FILENAMES);
         if (configFilePath) {
+            console.log(`Found eslint flat config file at: ${configFilePath}`);
             return configFilePath;
         }
         if (currentDir === workspaceRoot) {

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

@@ -1,2 +1,4 @@
 import { Tree } from '@nx/devkit';
+export declare const eslintFlatConfigFilenames: string[];
+export declare function flatConfigEslintFilename(tree: Tree): string;
 export declare function useFlatConfig(tree: Tree): boolean;

package/src/utils/flat-config.js

@@ -1,7 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useFlatConfig = void 0;
+exports.useFlatConfig = exports.flatConfigEslintFilename = exports.eslintFlatConfigFilenames = void 0;
+// todo: add support for eslint.config.mjs,
+exports.eslintFlatConfigFilenames = [
+    'eslint.config.js',
+    'eslint.config.cjs',
+];
+function flatConfigEslintFilename(tree) {
+    for (const file of exports.eslintFlatConfigFilenames) {
+        if (tree.exists(file)) {
+            return file;
+        }
+    }
+    throw new Error('Could not find flat config file');
+}
+exports.flatConfigEslintFilename = flatConfigEslintFilename;
 function useFlatConfig(tree) {
-    return tree.exists('eslint.config.js');
+    try {
+        return !!flatConfigEslintFilename(tree);
+    }
+    catch {
+        return false;
+    }
 }
 exports.useFlatConfig = useFlatConfig;