@nx/eslint 17.2.0-beta.3 → 17.2.0-beta.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/eslint",
-  "version": "17.2.0-beta.3",
+  "version": "17.2.0-beta.5",
   "private": false,
   "description": "The ESLint plugin for Nx contains executors, generators and utilities used for linting JavaScript/TypeScript projects within an Nx workspace.",
   "repository": {
@@ -30,18 +30,22 @@
   "executors": "./executors.json",
   "generators": "./generators.json",
   "peerDependencies": {
-    "eslint": "^8.0.0"
+    "eslint": "^8.0.0",
+    "js-yaml": "4.1.0"
   },
   "dependencies": {
     "tslib": "^2.3.0",
-    "@nx/devkit": "17.2.0-beta.3",
-    "@nx/js": "17.2.0-beta.3",
+    "@nx/devkit": "17.2.0-beta.5",
+    "@nx/js": "17.2.0-beta.5",
     "typescript": "~5.2.2",
-    "@nx/linter": "17.2.0-beta.3"
+    "@nx/linter": "17.2.0-beta.5"
   },
   "peerDependenciesMeta": {
     "eslint": {
       "optional": true
+    },
+    "js-yaml": {
+      "optional": true
     }
   },
   "publishConfig": {

package/src/generators/convert-to-flat-config/converters/json-converter.d.ts

@@ -1,6 +1,11 @@
 import { Tree } from '@nx/devkit';
+import { ESLint } from 'eslint';
 /**
  * Converts an ESLint JSON config to a flat config.
  * Deletes the original file along with .eslintignore if it exists.
  */
-export declare function convertEslintJsonToFlatConfig(tree: Tree, root: string, sourceFile: string, destinationFile: string, ignorePaths: string[]): void;
+export declare function convertEslintJsonToFlatConfig(tree: Tree, root: string, config: ESLint.ConfigData, ignorePaths: string[]): {
+    content: string;
+    addESLintRC: boolean;
+    addESLintJS: boolean;
+};

package/src/generators/convert-to-flat-config/converters/json-converter.js

@@ -2,25 +2,24 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.convertEslintJsonToFlatConfig = void 0;
 const devkit_1 = require("@nx/devkit");
-const path_1 = require("path");
 const ts = require("typescript");
-const versions_1 = require("../../../utils/versions");
 const ast_utils_1 = require("../../utils/flat-config/ast-utils");
 const eslint_file_1 = require("../../utils/eslint-file");
 /**
  * Converts an ESLint JSON config to a flat config.
  * Deletes the original file along with .eslintignore if it exists.
  */
-function convertEslintJsonToFlatConfig(tree, root, sourceFile, destinationFile, ignorePaths) {
+function convertEslintJsonToFlatConfig(tree, root, config, ignorePaths) {
     const importsMap = new Map();
     const exportElements = [];
     let isFlatCompatNeeded = false;
+    let isESLintJSNeeded = false;
     let combinedConfig = [];
     let languageOptions = [];
-    // read original config
-    const config = (0, devkit_1.readJson)(tree, `${root}/${sourceFile}`);
     if (config.extends) {
-        isFlatCompatNeeded = addExtends(importsMap, exportElements, config, tree);
+        const extendsResult = addExtends(importsMap, exportElements, config);
+        isFlatCompatNeeded = extendsResult.isFlatCompatNeeded;
+        isESLintJSNeeded = extendsResult.isESLintJSNeeded;
     }
     if (config.plugins) {
         addPlugins(importsMap, exportElements, config);
@@ -95,21 +94,19 @@ function convertEslintJsonToFlatConfig(tree, root, sourceFile, destinationFile,
             }
         }
     }
-    tree.delete((0, path_1.join)(root, sourceFile));
     // create the node list and print it to new file
     const nodeList = (0, ast_utils_1.createNodeList)(importsMap, exportElements, isFlatCompatNeeded);
-    const content = (0, ast_utils_1.stringifyNodeList)(nodeList, root, destinationFile);
-    tree.write((0, path_1.join)(root, destinationFile), content);
-    if (isFlatCompatNeeded) {
-        (0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
-            '@eslint/eslintrc': versions_1.eslintrcVersion,
-        });
-    }
+    return {
+        content: (0, ast_utils_1.stringifyNodeList)(nodeList, root),
+        addESLintRC: isFlatCompatNeeded,
+        addESLintJS: isESLintJSNeeded,
+    };
 }
 exports.convertEslintJsonToFlatConfig = convertEslintJsonToFlatConfig;
 // add parsed extends to export blocks and add import statements
-function addExtends(importsMap, configBlocks, config, tree) {
+function addExtends(importsMap, configBlocks, config) {
     let isFlatCompatNeeded = false;
+    let isESLintJSNeeded = false;
     const extendsConfig = Array.isArray(config.extends)
         ? config.extends
         : [config.extends];
@@ -138,9 +135,7 @@ function addExtends(importsMap, configBlocks, config, tree) {
             }
         });
         if (eslintPluginExtends.length) {
-            (0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
-                '@eslint/js': versions_1.eslintVersion,
-            });
+            isESLintJSNeeded = true;
             importsMap.set('@eslint/js', 'js');
             eslintPluginExtends.forEach((plugin) => {
                 configBlocks.push(ts.factory.createPropertyAccessExpression(ts.factory.createPropertyAccessExpression(ts.factory.createIdentifier('js'), ts.factory.createIdentifier('configs')), ts.factory.createIdentifier(plugin.slice(7)) // strip 'eslint:' prefix
@@ -150,12 +145,10 @@ function addExtends(importsMap, configBlocks, config, tree) {
     }
     if (eslintrcConfigs.length) {
         isFlatCompatNeeded = true;
-        (0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
-            '@eslint/js': versions_1.eslintVersion,
-        });
+        isESLintJSNeeded = true;
         configBlocks.push((0, ast_utils_1.generatePluginExtendsElement)(eslintrcConfigs));
     }
-    return isFlatCompatNeeded;
+    return { isFlatCompatNeeded, isESLintJSNeeded };
 }
 function addPlugins(importsMap, configBlocks, config) {
     const mappedPlugins = [];

package/src/generators/convert-to-flat-config/generator.js

@@ -3,14 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.convertToFlatConfigGenerator = void 0;
 const devkit_1 = require("@nx/devkit");
 const eslint_file_1 = require("../utils/eslint-file");
+const path_1 = require("path");
+const versions_1 = require("../../utils/versions");
 const json_converter_1 = require("./converters/json-converter");
+const js_yaml_1 = require("js-yaml");
 async function convertToFlatConfigGenerator(tree, options) {
     const eslintFile = (0, eslint_file_1.findEslintFile)(tree);
     if (!eslintFile) {
         throw new Error('Could not find root eslint file');
     }
-    if (!eslintFile.endsWith('.json')) {
-        throw new Error('Only json eslint config files are supported for conversion');
+    if (eslintFile.endsWith('.js')) {
+        throw new Error('Only json and yaml eslint config files are supported for conversion');
     }
     const eslintIgnoreFiles = new Set(['.eslintignore']);
     // convert root eslint config to eslint.config.js
@@ -34,13 +37,14 @@ async function convertToFlatConfigGenerator(tree, options) {
 exports.convertToFlatConfigGenerator = convertToFlatConfigGenerator;
 exports.default = convertToFlatConfigGenerator;
 function convertRootToFlatConfig(tree, eslintFile) {
-    if (eslintFile.endsWith('.base.json')) {
-        convertConfigToFlatConfig(tree, '', '.eslintrc.base.json', 'eslint.base.config.js');
+    if (/\.base\.(js|json|yml|yaml)$/.test(eslintFile)) {
+        convertConfigToFlatConfig(tree, '', eslintFile, 'eslint.base.config.js');
     }
-    convertConfigToFlatConfig(tree, '', '.eslintrc.json', 'eslint.config.js');
+    convertConfigToFlatConfig(tree, '', eslintFile.replace('.base.', '.'), 'eslint.config.js');
 }
 function convertProjectToFlatConfig(tree, project, projectConfig, nxJson, eslintIgnoreFiles) {
-    if (tree.exists(`${projectConfig.root}/.eslintrc.json`)) {
+    const eslintFile = (0, eslint_file_1.findEslintFile)(tree, projectConfig.root);
+    if (eslintFile && !eslintFile.endsWith('.js')) {
         if (projectConfig.targets) {
             const eslintTargets = Object.keys(projectConfig.targets || {}).filter((t) => projectConfig.targets[t].executor === '@nx/eslint:lint');
             let ignorePath;
@@ -59,7 +63,7 @@ function convertProjectToFlatConfig(tree, project, projectConfig, nxJson, eslint
                 nxJson.targetDefaults[t].executor === '@nx/eslint:lint') &&
                 projectConfig.targets?.[t]);
             if (nxHasLintTargets || eslintTargets.length > 0) {
-                convertConfigToFlatConfig(tree, projectConfig.root, '.eslintrc.json', 'eslint.config.js', ignorePath);
+                convertConfigToFlatConfig(tree, projectConfig.root, eslintFile, 'eslint.config.js', ignorePath);
                 eslintIgnoreFiles.add(`${projectConfig.root}/.eslintignore`);
                 if (ignorePath) {
                     eslintIgnoreFiles.add(ignorePath);
@@ -96,5 +100,35 @@ function convertConfigToFlatConfig(tree, root, source, target, ignorePath) {
     const ignorePaths = ignorePath
         ? [ignorePath, `${root}/.eslintignore`]
         : [`${root}/.eslintignore`];
-    (0, json_converter_1.convertEslintJsonToFlatConfig)(tree, root, source, target, ignorePaths);
+    if (source.endsWith('.json')) {
+        const config = (0, devkit_1.readJson)(tree, `${root}/${source}`);
+        const conversionResult = (0, json_converter_1.convertEslintJsonToFlatConfig)(tree, root, config, ignorePaths);
+        return processConvertedConfig(tree, root, source, target, conversionResult);
+    }
+    if (source.endsWith('.yaml') || source.endsWith('.yml')) {
+        const originalContent = tree.read(`${root}/${source}`, 'utf-8');
+        const config = (0, js_yaml_1.load)(originalContent, {
+            json: true,
+            filename: source,
+        });
+        const conversionResult = (0, json_converter_1.convertEslintJsonToFlatConfig)(tree, root, config, ignorePaths);
+        return processConvertedConfig(tree, root, source, target, conversionResult);
+    }
+}
+function processConvertedConfig(tree, root, source, target, { content, addESLintRC, addESLintJS, }) {
+    // remove original config file
+    tree.delete((0, path_1.join)(root, source));
+    // save new
+    tree.write((0, path_1.join)(root, target), content);
+    // add missing packages
+    if (addESLintRC) {
+        (0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
+            '@eslint/eslintrc': versions_1.eslintrcVersion,
+        });
+    }
+    if (addESLintJS) {
+        (0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
+            '@eslint/js': versions_1.eslintVersion,
+        });
+    }
 }

package/src/generators/init/global-eslint-config.js

@@ -80,7 +80,7 @@ const getGlobalEsLintConfiguration = (unitTestRunner, rootProject) => {
 exports.getGlobalEsLintConfiguration = getGlobalEsLintConfiguration;
 const getGlobalFlatEslintConfiguration = (unitTestRunner, rootProject) => {
     const nodeList = (0, ast_utils_1.createNodeList)(new Map(), [], true);
-    let content = (0, ast_utils_1.stringifyNodeList)(nodeList, '', 'eslint.config.js');
+    let content = (0, ast_utils_1.stringifyNodeList)(nodeList, '');
     content = (0, ast_utils_1.addImportToFlatConfig)(content, 'nxPlugin', '@nx/eslint-plugin');
     content = (0, ast_utils_1.addPluginsToExportsBlock)(content, [
         { name: '@nx', varName: 'nxPlugin', imp: '@nx/eslint-plugin' },

package/src/generators/lint-project/lint-project.js

@@ -58,7 +58,7 @@ async function lintProjectGenerator(tree, options) {
     // additionally, the companion e2e app would have `rootProject: true`
     // so we need to check for the root path as well
     if (!options.rootProject || projectConfig.root !== '.') {
-        createEsLintConfiguration(tree, projectConfig, options.setParserOptionsProject);
+        createEsLintConfiguration(tree, projectConfig, options.setParserOptionsProject, options.rootProject);
     }
     // Buildable libs need source analysis enabled for linting `package.json`.
     if (isBuildableLibraryProject(projectConfig) &&
@@ -77,10 +77,11 @@ async function lintProjectGenerator(tree, options) {
     return installTask;
 }
 exports.lintProjectGenerator = lintProjectGenerator;
-function createEsLintConfiguration(tree, projectConfig, setParserOptionsProject) {
-    const eslintConfig = (0, eslint_file_1.findEslintFile)(tree);
-    const pathToRootConfig = eslintConfig
-        ? `${(0, devkit_1.offsetFromRoot)(projectConfig.root)}${eslintConfig}`
+function createEsLintConfiguration(tree, projectConfig, setParserOptionsProject, rootProject) {
+    // we are only extending root for non-standalone projects or their complementary e2e apps
+    const extendedRootConfig = rootProject ? undefined : (0, eslint_file_1.findEslintFile)(tree);
+    const pathToRootConfig = extendedRootConfig
+        ? `${(0, devkit_1.offsetFromRoot)(projectConfig.root)}${extendedRootConfig}`
         : undefined;
     const addDependencyChecks = isBuildableLibraryProject(projectConfig);
     const overrides = [
@@ -132,7 +133,7 @@ function createEsLintConfiguration(tree, projectConfig, setParserOptionsProject)
         const isCompatNeeded = addDependencyChecks;
         const nodes = [];
         const importMap = new Map();
-        if (eslintConfig) {
+        if (extendedRootConfig) {
             importMap.set(pathToRootConfig, 'baseConfig');
             nodes.push((0, ast_utils_1.generateSpreadElement)('baseConfig'));
         }
@@ -140,12 +141,12 @@ function createEsLintConfiguration(tree, projectConfig, setParserOptionsProject)
             nodes.push((0, ast_utils_1.generateFlatOverride)(override, projectConfig.root));
         });
         const nodeList = (0, ast_utils_1.createNodeList)(importMap, nodes, isCompatNeeded);
-        const content = (0, ast_utils_1.stringifyNodeList)(nodeList, projectConfig.root, 'eslint.config.js');
+        const content = (0, ast_utils_1.stringifyNodeList)(nodeList, projectConfig.root);
         tree.write((0, path_1.join)(projectConfig.root, 'eslint.config.js'), content);
     }
     else {
         (0, devkit_1.writeJson)(tree, (0, path_1.join)(projectConfig.root, `.eslintrc.json`), {
-            extends: eslintConfig ? [pathToRootConfig] : undefined,
+            extends: extendedRootConfig ? [pathToRootConfig] : undefined,
             // Include project files to be linted since the global one excludes all files.
             ignorePatterns: ['!**/*'],
             overrides,

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

@@ -44,7 +44,7 @@ export declare function generatePluginExtendsElement(plugins: string[]): ts.Spre
 /**
  * Stringifies TS nodes to file content string
  */
-export declare function stringifyNodeList(nodes: ts.NodeArray<ts.VariableStatement | ts.Identifier | ts.ExpressionStatement | ts.SourceFile>, root: string, fileName: string): string;
+export declare function stringifyNodeList(nodes: ts.NodeArray<ts.VariableStatement | ts.Identifier | ts.ExpressionStatement | ts.SourceFile>, root: string): string;
 /**
  * generates AST require statement
  */

package/src/generators/utils/flat-config/ast-utils.js

@@ -470,10 +470,15 @@ exports.generatePluginExtendsElement = generatePluginExtendsElement;
 /**
  * Stringifies TS nodes to file content string
  */
-function stringifyNodeList(nodes, root, fileName) {
+function stringifyNodeList(nodes, root) {
     const printer = ts.createPrinter({ newLine: ts.NewLineKind.LineFeed });
-    const resultFile = ts.createSourceFile((0, devkit_1.joinPathFragments)(root, fileName), '', ts.ScriptTarget.Latest, true, ts.ScriptKind.JS);
-    return printer.printList(ts.ListFormat.MultiLine, nodes, resultFile);
+    const resultFile = ts.createSourceFile((0, devkit_1.joinPathFragments)(root, ''), '', ts.ScriptTarget.Latest, true, ts.ScriptKind.JS);
+    return (printer
+        .printList(ts.ListFormat.MultiLine, nodes, resultFile)
+        // add new line before compat initialization
+        .replace(/const compat = new FlatCompat/, '\nconst compat = new FlatCompat')
+        // add new line before module.exports = ...
+        .replace(/module\.exports/, '\nmodule.exports'));
 }
 exports.stringifyNodeList = stringifyNodeList;
 /**