@nx/eslint 0.0.0-pr-30715-a5f5e3b → 0.0.0-pr-31222-862e973

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

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.findEslintFile = findEslintFile;
 exports.isEslintConfigSupported = isEslintConfigSupported;
 exports.updateRelativePathsInConfig = updateRelativePathsInConfig;
-exports.determineEslintConfigFormat = determineEslintConfigFormat;
 exports.addOverrideToLintConfig = addOverrideToLintConfig;
 exports.updateOverrideInLintConfig = updateOverrideInLintConfig;
 exports.lintConfigHasOverride = lintConfigHasOverride;
@@ -21,18 +20,12 @@ const version_utils_1 = require("../../utils/version-utils");
 const versions_1 = require("../../utils/versions");
 const ast_utils_1 = require("./flat-config/ast-utils");
 const path_utils_1 = require("./flat-config/path-utils");
-const ts = require("typescript");
-const posix_1 = require("node:path/posix");
 function findEslintFile(tree, projectRoot) {
-    if (projectRoot === undefined) {
-        for (const file of [
-            config_file_1.baseEsLintConfigFile,
-            ...config_file_1.BASE_ESLINT_CONFIG_FILENAMES,
-        ]) {
-            if (tree.exists(file)) {
-                return file;
-            }
-        }
+    if (projectRoot === undefined && tree.exists(config_file_1.baseEsLintConfigFile)) {
+        return config_file_1.baseEsLintConfigFile;
+    }
+    if (projectRoot === undefined && tree.exists(config_file_1.baseEsLintFlatConfigFile)) {
+        return config_file_1.baseEsLintFlatConfigFile;
     }
     projectRoot ??= '';
     for (const file of config_file_1.ESLINT_CONFIG_FILENAMES) {
@@ -47,10 +40,7 @@ function isEslintConfigSupported(tree, projectRoot = '') {
     if (!eslintFile) {
         return false;
     }
-    return (eslintFile.endsWith('.json') ||
-        eslintFile.endsWith('.config.js') ||
-        eslintFile.endsWith('.config.cjs') ||
-        eslintFile.endsWith('.config.mjs'));
+    return eslintFile.endsWith('.json') || eslintFile.endsWith('.config.js');
 }
 function updateRelativePathsInConfig(tree, sourcePath, destinationPath) {
     if (sourcePath === destinationPath ||
@@ -94,17 +84,6 @@ function replaceFlatConfigPaths(config, sourceRoot, offset, destinationRoot, tre
                 `require('${newPath}')` +
                 newConfig.slice(match.index + match[0].length);
     }
-    // Handle import statements
-    const importRegex = RegExp(/import\s+.*?\s+from\s+['"](.*)['"]/g);
-    while ((match = importRegex.exec(newConfig)) !== null) {
-        const oldPath = match[1];
-        const newPath = offsetFilePath(sourceRoot, oldPath, offset, tree);
-        // Replace the old path with the updated path
-        newConfig =
-            newConfig.slice(0, match.index + match[0].indexOf(oldPath)) +
-                newPath +
-                newConfig.slice(match.index + match[0].indexOf(oldPath) + oldPath.length);
-    }
     // replace projects
     const projectRegex = RegExp(/project:\s?\[?['"](.*)['"]\]?/g);
     while ((match = projectRegex.exec(newConfig)) !== null) {
@@ -130,37 +109,14 @@ function offsetFilePath(projectRoot, pathToFile, offset, tree) {
     }
     return (0, devkit_1.joinPathFragments)(offset, projectRoot, pathToFile);
 }
-function determineEslintConfigFormat(content) {
-    const sourceFile = ts.createSourceFile('', content, ts.ScriptTarget.Latest, true);
-    // Check if there's an `export default` in the AST
-    const hasExportDefault = sourceFile.statements.some((statement) => ts.isExportAssignment(statement) && !statement.isExportEquals);
-    return hasExportDefault ? 'mjs' : 'cjs';
-}
 function addOverrideToLintConfig(tree, root, override, options = {
     insertAtTheEnd: true,
 }) {
     const isBase = options.checkBaseConfig && findEslintFile(tree, root).includes('.base');
     if ((0, flat_config_1.useFlatConfig)(tree)) {
-        let fileName;
-        if (isBase) {
-            for (const file of config_file_1.BASE_ESLINT_CONFIG_FILENAMES) {
-                if (tree.exists((0, devkit_1.joinPathFragments)(root, file))) {
-                    fileName = (0, devkit_1.joinPathFragments)(root, file);
-                    break;
-                }
-            }
-        }
-        else {
-            for (const f of flat_config_1.eslintFlatConfigFilenames) {
-                if (tree.exists((0, devkit_1.joinPathFragments)(root, f))) {
-                    fileName = (0, devkit_1.joinPathFragments)(root, f);
-                    break;
-                }
-            }
-        }
+        const fileName = (0, devkit_1.joinPathFragments)(root, isBase ? config_file_1.baseEsLintFlatConfigFile : (0, flat_config_1.getRootESLintFlatConfigFilename)(tree));
+        const flatOverride = (0, ast_utils_1.generateFlatOverride)(override);
         let content = tree.read(fileName, 'utf8');
-        const format = content.includes('export default') ? 'mjs' : 'cjs';
-        const flatOverride = (0, ast_utils_1.generateFlatOverride)(override, format);
         // Check if the provided override using legacy eslintrc properties or plugins, if so we need to add compat
         if ((0, ast_utils_1.overrideNeedsCompat)(override)) {
             content = (0, ast_utils_1.addFlatCompatToFlatConfig)(content);
@@ -181,28 +137,15 @@ function addOverrideToLintConfig(tree, root, override, options = {
         });
     }
 }
-function updateOverrideInLintConfig(tree, rootOrFile, lookup, update) {
-    let fileName;
-    let root = rootOrFile;
-    if (tree.exists(rootOrFile) && tree.isFile(rootOrFile)) {
-        fileName = rootOrFile;
-        root = (0, posix_1.dirname)(rootOrFile);
-    }
+function updateOverrideInLintConfig(tree, root, lookup, update) {
     if ((0, flat_config_1.useFlatConfig)(tree)) {
-        if (!fileName) {
-            for (const f of flat_config_1.eslintFlatConfigFilenames) {
-                if (tree.exists((0, devkit_1.joinPathFragments)(root, f))) {
-                    fileName = (0, devkit_1.joinPathFragments)(root, f);
-                    break;
-                }
-            }
-        }
+        const fileName = (0, devkit_1.joinPathFragments)(root, (0, flat_config_1.getRootESLintFlatConfigFilename)(tree));
         let content = tree.read(fileName, 'utf8');
         content = (0, ast_utils_1.replaceOverride)(content, root, lookup, update);
         tree.write(fileName, content);
     }
     else {
-        fileName ??= (0, devkit_1.joinPathFragments)(root, '.eslintrc.json');
+        const fileName = (0, devkit_1.joinPathFragments)(root, '.eslintrc.json');
         if (!tree.exists(fileName)) {
             return;
         }
@@ -225,62 +168,32 @@ function updateOverrideInLintConfig(tree, rootOrFile, lookup, update) {
         });
     }
 }
-function lintConfigHasOverride(tree, rootOrFile, lookup, checkBaseConfig = false) {
-    let fileName;
-    let root = rootOrFile;
-    if (tree.exists(rootOrFile) && tree.isFile(rootOrFile)) {
-        fileName = rootOrFile;
-        root = (0, posix_1.dirname)(rootOrFile);
-    }
-    if (!fileName && !isEslintConfigSupported(tree, root)) {
+function lintConfigHasOverride(tree, root, lookup, checkBaseConfig = false) {
+    if (!isEslintConfigSupported(tree, root)) {
         return false;
     }
-    const isBase = !fileName &&
-        checkBaseConfig &&
-        findEslintFile(tree, root).includes('.base');
-    if (isBase) {
-        for (const file of config_file_1.BASE_ESLINT_CONFIG_FILENAMES) {
-            if (tree.exists((0, devkit_1.joinPathFragments)(root, file))) {
-                fileName = (0, devkit_1.joinPathFragments)(root, file);
-                break;
-            }
-        }
-    }
+    const isBase = checkBaseConfig && findEslintFile(tree, root).includes('.base');
     if ((0, flat_config_1.useFlatConfig)(tree)) {
-        if (!fileName) {
-            for (const f of flat_config_1.eslintFlatConfigFilenames) {
-                if (tree.exists((0, devkit_1.joinPathFragments)(root, f))) {
-                    fileName = (0, devkit_1.joinPathFragments)(root, f);
-                    break;
-                }
-            }
-        }
+        const fileName = (0, devkit_1.joinPathFragments)(root, isBase ? config_file_1.baseEsLintFlatConfigFile : (0, flat_config_1.getRootESLintFlatConfigFilename)(tree));
         const content = tree.read(fileName, 'utf8');
         return (0, ast_utils_1.hasOverride)(content, lookup);
     }
     else {
-        fileName ??= (0, devkit_1.joinPathFragments)(root, isBase ? config_file_1.baseEsLintConfigFile : '.eslintrc.json');
+        const fileName = (0, devkit_1.joinPathFragments)(root, isBase ? config_file_1.baseEsLintConfigFile : '.eslintrc.json');
         return (0, devkit_1.readJson)(tree, fileName).overrides?.some(lookup) || false;
     }
 }
 function replaceOverridesInLintConfig(tree, root, overrides) {
     if ((0, flat_config_1.useFlatConfig)(tree)) {
-        let fileName;
-        for (const f of flat_config_1.eslintFlatConfigFilenames) {
-            if (tree.exists((0, devkit_1.joinPathFragments)(root, f))) {
-                fileName = (0, devkit_1.joinPathFragments)(root, f);
-                break;
-            }
-        }
+        const fileName = (0, devkit_1.joinPathFragments)(root, (0, flat_config_1.getRootESLintFlatConfigFilename)(tree));
         let content = tree.read(fileName, 'utf8');
-        const format = content.includes('export default') ? 'mjs' : 'cjs';
         // Check if any of the provided overrides using legacy eslintrc properties or plugins, if so we need to add compat
         if (overrides.some(ast_utils_1.overrideNeedsCompat)) {
             content = (0, ast_utils_1.addFlatCompatToFlatConfig)(content);
         }
         content = (0, ast_utils_1.removeOverridesFromLintConfig)(content);
         overrides.forEach((override) => {
-            const flatOverride = (0, ast_utils_1.generateFlatOverride)(override, format);
+            const flatOverride = (0, ast_utils_1.generateFlatOverride)(override);
             content = (0, ast_utils_1.addBlockToFlatConfigExport)(content, flatOverride);
         });
         tree.write(fileName, content);
@@ -296,21 +209,7 @@ function replaceOverridesInLintConfig(tree, root, overrides) {
 function addExtendsToLintConfig(tree, root, plugin, insertAtTheEnd = false) {
     if ((0, flat_config_1.useFlatConfig)(tree)) {
         const pluginExtends = [];
-        let fileName;
-        for (const f of flat_config_1.eslintFlatConfigFilenames) {
-            if (tree.exists((0, devkit_1.joinPathFragments)(root, f))) {
-                fileName = (0, devkit_1.joinPathFragments)(root, f);
-                break;
-            }
-        }
-        // Check the file extension to determine the format of the config if it is .js we look for the export
-        const eslintConfigFormat = fileName.endsWith('.mjs')
-            ? 'mjs'
-            : fileName.endsWith('.cjs')
-                ? 'cjs'
-                : tree.read(fileName, 'utf-8').includes('module.exports')
-                    ? 'cjs'
-                    : 'mjs';
+        const fileName = (0, devkit_1.joinPathFragments)(root, (0, flat_config_1.getRootESLintFlatConfigFilename)(tree));
         let shouldImportEslintCompat = false;
         // assume eslint version is 9 if not found, as it's what we'd be generating by default
         const eslintVersion = (0, version_utils_1.getInstalledEslintVersion)(tree) ?? versions_1.eslint9__eslintVersion;
@@ -357,9 +256,9 @@ function addExtendsToLintConfig(tree, root, plugin, insertAtTheEnd = false) {
         }
         tree.write(fileName, content);
         if (shouldImportEslintCompat) {
-            return (0, devkit_1.addDependenciesToPackageJson)(tree, {}, { '@eslint/compat': versions_1.eslintCompat, '@eslint/eslintrc': versions_1.eslintrcVersion }, undefined, true);
+            return (0, devkit_1.addDependenciesToPackageJson)(tree, {}, { '@eslint/compat': versions_1.eslintCompat }, undefined, true);
         }
-        return (0, devkit_1.addDependenciesToPackageJson)(tree, {}, { '@eslint/eslintrc': versions_1.eslintrcVersion }, undefined, true);
+        return () => { };
     }
     else {
         const plugins = (Array.isArray(plugin) ? plugin : [plugin]).map((p) => typeof p === 'string' ? p : p.name);
@@ -378,13 +277,7 @@ function addExtendsToLintConfig(tree, root, plugin, insertAtTheEnd = false) {
 function addPredefinedConfigToFlatLintConfig(tree, root, predefinedConfigName, moduleName = 'nx', moduleImportPath = '@nx/eslint-plugin', spread = true, insertAtTheEnd = true) {
     if (!(0, flat_config_1.useFlatConfig)(tree))
         throw new Error('Predefined configs can only be used with flat configs');
-    let fileName;
-    for (const f of flat_config_1.eslintFlatConfigFilenames) {
-        if (tree.exists((0, devkit_1.joinPathFragments)(root, f))) {
-            fileName = (0, devkit_1.joinPathFragments)(root, f);
-            break;
-        }
-    }
+    const fileName = (0, devkit_1.joinPathFragments)(root, (0, flat_config_1.getRootESLintFlatConfigFilename)(tree));
     let content = tree.read(fileName, 'utf8');
     content = (0, ast_utils_1.addImportToFlatConfig)(content, moduleName, moduleImportPath);
     content = (0, ast_utils_1.addBlockToFlatConfigExport)(content, (0, ast_utils_1.generateFlatPredefinedConfig)(predefinedConfigName, moduleName, spread), { insertAtTheEnd });
@@ -393,13 +286,7 @@ function addPredefinedConfigToFlatLintConfig(tree, root, predefinedConfigName, m
 function addPluginsToLintConfig(tree, root, plugin) {
     const plugins = Array.isArray(plugin) ? plugin : [plugin];
     if ((0, flat_config_1.useFlatConfig)(tree)) {
-        let fileName;
-        for (const f of flat_config_1.eslintFlatConfigFilenames) {
-            if (tree.exists((0, devkit_1.joinPathFragments)(root, f))) {
-                fileName = (0, devkit_1.joinPathFragments)(root, f);
-                break;
-            }
-        }
+        const fileName = (0, devkit_1.joinPathFragments)(root, (0, flat_config_1.getRootESLintFlatConfigFilename)(tree));
         let content = tree.read(fileName, 'utf8');
         const mappedPlugins = [];
         plugins.forEach((name) => {
@@ -423,33 +310,14 @@ function addPluginsToLintConfig(tree, root, plugin) {
 }
 function addIgnoresToLintConfig(tree, root, ignorePatterns) {
     if ((0, flat_config_1.useFlatConfig)(tree)) {
-        let fileName;
-        for (const f of flat_config_1.eslintFlatConfigFilenames) {
-            if (tree.exists((0, devkit_1.joinPathFragments)(root, f))) {
-                fileName = (0, devkit_1.joinPathFragments)(root, f);
-                break;
-            }
-        }
-        if (!fileName) {
-            return;
-        }
-        let content = tree.read(fileName, 'utf8');
-        if ((0, ast_utils_1.hasFlatConfigIgnoresBlock)(content)) {
-            content = (0, ast_utils_1.addPatternsToFlatConfigIgnoresBlock)(content, ignorePatterns);
-            tree.write(fileName, content);
-        }
-        else {
-            const block = (0, ast_utils_1.generateAst)({
-                ignores: ignorePatterns.map((path) => (0, path_utils_1.mapFilePath)(path)),
-            });
-            tree.write(fileName, (0, ast_utils_1.addBlockToFlatConfigExport)(content, block));
-        }
+        const fileName = (0, devkit_1.joinPathFragments)(root, (0, flat_config_1.getRootESLintFlatConfigFilename)(tree));
+        const block = (0, ast_utils_1.generateAst)({
+            ignores: ignorePatterns.map((path) => (0, path_utils_1.mapFilePath)(path)),
+        });
+        tree.write(fileName, (0, ast_utils_1.addBlockToFlatConfigExport)(tree.read(fileName, 'utf8'), block));
     }
     else {
         const fileName = (0, devkit_1.joinPathFragments)(root, '.eslintrc.json');
-        if (!tree.exists(fileName)) {
-            return;
-        }
         (0, devkit_1.updateJson)(tree, fileName, (json) => {
             const ignoreSet = new Set([
                 ...(json.ignorePatterns ?? []),

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

@@ -4,20 +4,13 @@ import * as ts from 'typescript';
  * Remove all overrides from the config file
  */
 export declare function removeOverridesFromLintConfig(content: string): string;
-export declare function addPatternsToFlatConfigIgnoresBlock(content: string, ignorePatterns: string[]): string;
-export declare function hasFlatConfigIgnoresBlock(content: string): boolean;
 export declare function hasOverride(content: string, lookup: (override: Linter.ConfigOverride<Linter.RulesRecord>) => boolean): boolean;
 /**
  * Finds an override matching the lookup function and applies the update function to it
  */
 export declare function replaceOverride(content: string, root: string, lookup: (override: Linter.ConfigOverride<Linter.RulesRecord>) => boolean, update?: (override: Partial<Linter.ConfigOverride<Linter.RulesRecord>>) => Partial<Linter.ConfigOverride<Linter.RulesRecord>>): string;
 /**
- * Adding import statement to the top of the file
- * The imports are added based on a few rules:
- * 1. If it's a default import and matches the variable, return content unchanged.
- * 2. If it's a named import and the variables are not part of the import object, add them.
- * 3. If no existing import and variable is a string, add a default import.
- * 4. If no existing import and variable is an array, add it as an object import.
+ * Adding require statement to the top of the file
  */
 export declare function addImportToFlatConfig(content: string, variable: string | string[], imp: string): string;
 /**
@@ -25,7 +18,7 @@ export declare function addImportToFlatConfig(content: string, variable: string
  */
 export declare function removeImportFromFlatConfig(content: string, variable: string, imp: string): string;
 /**
- * Injects new ts.expression to the end of the module.exports or export default array.
+ * Injects new ts.expression to the end of the module.exports array.
  */
 export declare function addBlockToFlatConfigExport(content: string, config: ts.Expression | ts.SpreadElement, options?: {
     insertAtTheEnd?: boolean;
@@ -50,7 +43,7 @@ export declare function addFlatCompatToFlatConfig(content: string): string;
  * Generate node list representing the imports and the exports blocks
  * Optionally add flat compat initialization
  */
-export declare function createNodeList(importsMap: Map<string, string>, exportElements: ts.Expression[], format: 'mjs' | 'cjs'): ts.NodeArray<ts.VariableStatement | ts.Identifier | ts.ExpressionStatement | ts.SourceFile>;
+export declare function createNodeList(importsMap: Map<string, string>, exportElements: ts.Expression[]): ts.NodeArray<ts.VariableStatement | ts.Identifier | ts.ExpressionStatement | ts.SourceFile>;
 export declare function generateSpreadElement(name: string): ts.SpreadElement;
 export declare function generatePluginExtendsElement(plugins: string[]): ts.SpreadElement;
 export declare function generatePluginExtendsElementWithCompatFixup(plugin: string): ts.SpreadElement;
@@ -62,7 +55,6 @@ export declare function stringifyNodeList(nodes: ts.NodeArray<ts.VariableStateme
  * generates AST require statement
  */
 export declare function generateRequire(variableName: string | ts.ObjectBindingPattern, imp: string): ts.VariableStatement;
-export declare function generateESMImport(variableName: string | ts.ObjectBindingPattern, imp: string): ts.ImportDeclaration;
 export declare function overrideNeedsCompat(override: Partial<Linter.ConfigOverride<Linter.RulesRecord>>): string | string[] | {
     [name: string]: boolean;
 };
@@ -72,7 +64,7 @@ export declare function overrideNeedsCompat(override: Partial<Linter.ConfigOverr
  */
 export declare function generateFlatOverride(_override: Partial<Linter.ConfigOverride<Linter.RulesRecord>> & {
     ignores?: Linter.FlatConfig['ignores'];
-}, format: 'mjs' | 'cjs'): ts.ObjectLiteralExpression | ts.SpreadElement;
+}): ts.ObjectLiteralExpression | ts.SpreadElement;
 export declare function generateFlatPredefinedConfig(predefinedConfigName: string, moduleName?: string, spread?: boolean): ts.ObjectLiteralExpression | ts.SpreadElement | ts.ElementAccessExpression;
 export declare function mapFilePaths<T extends Partial<Linter.ConfigOverride<Linter.RulesRecord>>>(_override: T): T;
 /**