@nx/eslint 20.4.0-beta.1 → 20.4.0-beta.2

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

@@ -3,6 +3,7 @@ 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;
@@ -20,17 +21,18 @@ 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 && 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;
-    }
-    if (projectRoot === undefined &&
-        tree.exists(config_file_1.legacyBaseEsLintFlatConfigFile)) {
-        return config_file_1.legacyBaseEsLintFlatConfigFile;
+    if (projectRoot === undefined) {
+        for (const file of [
+            config_file_1.baseEsLintConfigFile,
+            ...config_file_1.BASE_ESLINT_CONFIG_FILENAMES,
+        ]) {
+            if (tree.exists(file)) {
+                return file;
+            }
+        }
     }
     projectRoot ??= '';
     for (const file of config_file_1.ESLINT_CONFIG_FILENAMES) {
@@ -47,7 +49,8 @@ function isEslintConfigSupported(tree, projectRoot = '') {
     }
     return (eslintFile.endsWith('.json') ||
         eslintFile.endsWith('.config.js') ||
-        eslintFile.endsWith('.config.cjs'));
+        eslintFile.endsWith('.config.cjs') ||
+        eslintFile.endsWith('.config.mjs'));
 }
 function updateRelativePathsInConfig(tree, sourcePath, destinationPath) {
     if (sourcePath === destinationPath ||
@@ -91,6 +94,17 @@ 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) {
@@ -116,6 +130,12 @@ 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,
 }) {
@@ -123,7 +143,12 @@ function addOverrideToLintConfig(tree, root, override, options = {
     if ((0, flat_config_1.useFlatConfig)(tree)) {
         let fileName;
         if (isBase) {
-            fileName = (0, devkit_1.joinPathFragments)(root, config_file_1.baseEsLintFlatConfigFile);
+            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) {
@@ -133,8 +158,9 @@ function addOverrideToLintConfig(tree, root, override, options = {
                 }
             }
         }
-        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);
@@ -213,7 +239,12 @@ function lintConfigHasOverride(tree, rootOrFile, lookup, checkBaseConfig = false
         checkBaseConfig &&
         findEslintFile(tree, root).includes('.base');
     if (isBase) {
-        fileName = (0, devkit_1.joinPathFragments)(root, config_file_1.baseEsLintFlatConfigFile);
+        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;
+            }
+        }
     }
     if ((0, flat_config_1.useFlatConfig)(tree)) {
         if (!fileName) {
@@ -242,13 +273,14 @@ function replaceOverridesInLintConfig(tree, root, overrides) {
             }
         }
         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);
+            const flatOverride = (0, ast_utils_1.generateFlatOverride)(override, format);
             content = (0, ast_utils_1.addBlockToFlatConfigExport)(content, flatOverride);
         });
         tree.write(fileName, content);
@@ -271,6 +303,14 @@ function addExtendsToLintConfig(tree, root, plugin, insertAtTheEnd = false) {
                 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';
         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;

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

@@ -10,7 +10,12 @@ export declare function hasOverride(content: string, lookup: (override: Linter.C
  */
 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 require statement to the top of the file
+ * 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.
  */
 export declare function addImportToFlatConfig(content: string, variable: string | string[], imp: string): string;
 /**
@@ -18,7 +23,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 array.
+ * Injects new ts.expression to the end of the module.exports or export default array.
  */
 export declare function addBlockToFlatConfigExport(content: string, config: ts.Expression | ts.SpreadElement, options?: {
     insertAtTheEnd?: boolean;
@@ -43,7 +48,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[]): ts.NodeArray<ts.VariableStatement | ts.Identifier | ts.ExpressionStatement | ts.SourceFile>;
+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 generateSpreadElement(name: string): ts.SpreadElement;
 export declare function generatePluginExtendsElement(plugins: string[]): ts.SpreadElement;
 export declare function generatePluginExtendsElementWithCompatFixup(plugin: string): ts.SpreadElement;
@@ -55,6 +60,7 @@ 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;
 };
@@ -64,7 +70,7 @@ export declare function overrideNeedsCompat(override: Partial<Linter.ConfigOverr
  */
 export declare function generateFlatOverride(_override: Partial<Linter.ConfigOverride<Linter.RulesRecord>> & {
     ignores?: Linter.FlatConfig['ignores'];
-}): ts.ObjectLiteralExpression | ts.SpreadElement;
+}, format: 'mjs' | 'cjs'): 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;
 /**