@angular-eslint/builder 15.2.2-alpha.8 → 16.0.0-alpha.0

package/dist/lint.impl.d.ts

@@ -1,3 +1,2 @@
-import type { Schema } from './schema';
-declare const _default: import("@angular-devkit/architect/src/internal").Builder<Schema & import("@angular-devkit/core").JsonObject>;
+declare const _default: any;
 export default _default;

package/dist/lint.impl.js

@@ -1,54 +1,62 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const architect_1 = require("@angular-devkit/architect");
+const devkit_1 = require("@nx/devkit");
 const fs_1 = require("fs");
 const path_1 = require("path");
-const create_directory_1 = require("./utils/create-directory");
 const eslint_utils_1 = require("./utils/eslint-utils");
-exports.default = (0, architect_1.createBuilder)(async (options, context) => {
-    var _a, _b, _c;
-    const workspaceRoot = context.workspaceRoot;
-    process.chdir(workspaceRoot);
-    const projectName = ((_a = context.target) === null || _a === void 0 ? void 0 : _a.project) || '<???>';
+exports.default = (0, devkit_1.convertNxExecutor)(async (options, context) => {
+    var _a, _b, _c, _d;
+    const systemRoot = context.root;
+    // eslint resolves files relative to the current working directory.
+    // We want these paths to always be resolved relative to the workspace
+    // root to be able to run the lint executor from any subfolder.
+    process.chdir(systemRoot);
+    const projectName = context.projectName || '<???>';
     const printInfo = options.format && !options.silent;
-    const reportOnlyErrors = options.quiet;
-    const maxWarnings = options.maxWarnings;
     if (printInfo) {
         console.info(`\nLinting ${JSON.stringify(projectName)}...`);
     }
-    const projectESLint = await (0, eslint_utils_1.loadESLint)();
-    const version = (_c = (_b = projectESLint.ESLint) === null || _b === void 0 ? void 0 : _b.version) === null || _c === void 0 ? void 0 : _c.split('.');
+    /**
+     * We want users to have the option of not specifying the config path, and let
+     * eslint automatically resolve the `.eslintrc.json` files in each folder.
+     */
+    const eslintConfigPath = options.eslintConfig
+        ? (0, path_1.resolve)(systemRoot, options.eslintConfig)
+        : undefined;
+    options.cacheLocation = options.cacheLocation
+        ? (0, path_1.join)(options.cacheLocation, projectName)
+        : null;
+    /**
+     * 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 useFlatConfig = (0, fs_1.existsSync)((0, devkit_1.joinPathFragments)(devkit_1.workspaceRoot, 'eslint.config.js'));
+    const { eslint, ESLint } = await (0, eslint_utils_1.resolveAndInstantiateESLint)(eslintConfigPath, options, useFlatConfig);
+    const version = (_a = ESLint === null || ESLint === void 0 ? void 0 : ESLint.version) === null || _a === void 0 ? void 0 : _a.split('.');
     if (!version ||
         version.length < 2 ||
         Number(version[0]) < 7 ||
         (Number(version[0]) === 7 && Number(version[1]) < 6)) {
         throw new Error('ESLint must be version 7.6 or higher.');
     }
-    const eslint = new projectESLint.ESLint({});
-    /**
-     * We want users to have the option of not specifying the config path, and let
-     * eslint automatically resolve the `.eslintrc` files in each folder.
-     */
-    const eslintConfigPath = options.eslintConfig
-        ? (0, path_1.resolve)(workspaceRoot, options.eslintConfig)
-        : undefined;
     let lintResults = [];
     try {
-        lintResults = await (0, eslint_utils_1.lint)(workspaceRoot, eslintConfigPath, options);
+        lintResults = await eslint.lintFiles(options.lintFilePatterns);
     }
     catch (err) {
         if (err instanceof Error &&
             err.message.includes('You must therefore provide a value for the "parserOptions.project" property for @typescript-eslint/parser')) {
             let eslintConfigPathForError = `for ${projectName}`;
-            const projectMetadata = await context.getProjectMetadata(projectName);
-            if (projectMetadata) {
-                eslintConfigPathForError = `\`${projectMetadata.root}/.eslintrc.json\``;
+            if ((_d = (_c = (_b = context.projectsConfigurations) === null || _b === void 0 ? void 0 : _b.projects) === null || _c === void 0 ? void 0 : _c[projectName]) === null || _d === void 0 ? void 0 : _d.root) {
+                const { root } = context.projectsConfigurations.projects[projectName];
+                eslintConfigPathForError = `\`${root}/.eslintrc.json\``;
             }
             console.error(`
-    Error: You have attempted to use a lint rule which requires the full TypeScript type-checker to be available, but you do not have \`parserOptions.project\` configured to point at your project tsconfig.json files in the relevant TypeScript file "overrides" block of your ESLint config ${eslintConfigPath || eslintConfigPathForError}
-    
-    For full guidance on how to resolve this issue, please see https://github.com/angular-eslint/angular-eslint/blob/main/docs/RULES_REQUIRING_TYPE_INFORMATION.md
-    `);
+Error: You have attempted to use a lint rule which requires the full TypeScript type-checker to be available, but you do not have \`parserOptions.project\` configured to point at your project tsconfig.json files in the relevant TypeScript file "overrides" block of your project ESLint config ${eslintConfigPath || eslintConfigPathForError}
+
+For full guidance on how to resolve this issue, please see https://github.com/angular-eslint/angular-eslint/blob/main/docs/RULES_REQUIRING_TYPE_INFORMATION.md
+`);
             return {
                 success: false,
             };
@@ -57,13 +65,21 @@ exports.default = (0, architect_1.createBuilder)(async (options, context) => {
         throw err;
     }
     if (lintResults.length === 0) {
-        throw new Error('Invalid lint configuration. Nothing to lint.');
+        const ignoredPatterns = (await Promise.all(options.lintFilePatterns.map(async (pattern) => (await eslint.isPathIgnored(pattern)) ? pattern : null)))
+            .filter((pattern) => !!pattern)
+            .map((pattern) => `- '${pattern}'`);
+        if (ignoredPatterns.length) {
+            throw new Error(`All files matching the following patterns are ignored:\n${ignoredPatterns.join('\n')}\n\nPlease check your '.eslintignore' file.`);
+        }
+        throw new Error('Invalid lint configuration. Nothing to lint. Please check your lint target pattern(s).');
     }
+    // output fixes to disk, if applicable based on the options
+    await ESLint.outputFixes(lintResults);
     const formatter = await eslint.loadFormatter(options.format);
     let totalErrors = 0;
     let totalWarnings = 0;
-    // output fixes to disk, if applicable based on the options
-    await projectESLint.ESLint.outputFixes(lintResults);
+    const reportOnlyErrors = options.quiet;
+    const maxWarnings = options.maxWarnings;
     /**
      * Depending on user configuration we may not want to report on all the
      * results, so we need to adjust them before formatting.
@@ -96,8 +112,8 @@ exports.default = (0, architect_1.createBuilder)(async (options, context) => {
      */
     const formattedResults = await formatter.format(finalLintResults);
     if (options.outputFile) {
-        const pathToOutputFile = (0, path_1.join)(context.workspaceRoot, options.outputFile);
-        (0, create_directory_1.createDirectory)((0, path_1.dirname)(pathToOutputFile));
+        const pathToOutputFile = (0, path_1.join)(context.root, options.outputFile);
+        (0, fs_1.mkdirSync)((0, path_1.dirname)(pathToOutputFile), { recursive: true });
         (0, fs_1.writeFileSync)(pathToOutputFile, formattedResults);
     }
     else {

package/dist/schema.json

@@ -54,7 +54,7 @@
     },
     "lintFilePatterns": {
       "type": "array",
-      "description": "One or more files/dirs/globs to pass directly to ESLint's lintFiles() method.",
+      "description": "One or more files/dirs/globs to pass directly to ESLint's `lintFiles()` method.",
       "default": [],
       "items": {
         "type": "string"
@@ -87,16 +87,16 @@
     },
     "ignorePath": {
       "type": "string",
-      "description": "The path of the .eslintignore file."
+      "description": "The path of the `.eslintignore` file."
     },
     "noEslintrc": {
       "type": "boolean",
-      "description": "The equivalent of the --no-eslintrc flag on the ESLint CLI, it is false by default",
+      "description": "The equivalent of the `--no-eslintrc` flag on the ESLint CLI, it is false by default",
       "default": false
     },
     "rulesdir": {
       "type": "array",
-      "description": "The equivalent of the --rulesdir flag on the ESLint CLI, it is an empty array by default",
+      "description": "The equivalent of the `--rulesdir` flag on the ESLint CLI, it is an empty array by default",
       "default": [],
       "items": {
         "type": "string"
@@ -104,7 +104,12 @@
     },
     "resolvePluginsRelativeTo": {
       "type": "string",
-      "description": "The equivalent of the --resolve-plugins-relative-to flag on the ESLint CLI"
+      "description": "The equivalent of the `--resolve-plugins-relative-to` flag on the ESLint CLI"
+    },
+    "reportUnusedDisableDirectives": {
+      "type": "string",
+      "enum": ["off", "warn", "error"],
+      "description": "The equivalent of the `--report-unused-disable-directives` flag on the ESLint CLI."
     }
   },
   "additionalProperties": false,

package/dist/utils/eslint-utils.d.ts

@@ -1,4 +1,6 @@
-import type * as ESLintLibrary from 'eslint';
+import type { ESLint } from 'eslint';
 import type { Schema } from '../schema';
-export declare function loadESLint(): Promise<typeof ESLintLibrary>;
-export declare function lint(workspaceRoot: string, eslintConfigPath: string | undefined, options: Schema): Promise<ESLintLibrary.ESLint.LintResult[]>;
+export declare function resolveAndInstantiateESLint(eslintConfigPath: string | undefined, options: Schema, useFlatConfig?: boolean): Promise<{
+    ESLint: typeof import("eslint").ESLint;
+    eslint: ESLint;
+}>;

package/dist/utils/eslint-utils.js

@@ -23,46 +23,72 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.lint = exports.loadESLint = void 0;
-const path_1 = require("path");
-async function loadESLint() {
-    let eslint;
+exports.resolveAndInstantiateESLint = void 0;
+async function resolveESLintClass(useFlatConfig = false) {
     try {
-        eslint = await Promise.resolve().then(() => __importStar(require('eslint')));
-        return eslint;
+        if (!useFlatConfig) {
+            return (await Promise.resolve().then(() => __importStar(require('eslint')))).ESLint;
+        }
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        const { FlatESLint } = require('eslint/use-at-your-own-risk');
+        return FlatESLint;
     }
     catch (_a) {
         throw new Error('Unable to find ESLint. Ensure ESLint is installed.');
     }
 }
-exports.loadESLint = loadESLint;
-async function lint(workspaceRoot, eslintConfigPath, options) {
-    const projectESLint = await loadESLint();
-    const eslint = new projectESLint.ESLint({
-        /**
-         * If "noEslintrc" is set to `true` (and therefore here "useEslintrc" will be `false`), then ESLint will not
-         * merge the provided config with others it finds automatically.
-         */
-        useEslintrc: !options.noEslintrc,
+async function resolveAndInstantiateESLint(eslintConfigPath, options, useFlatConfig = false) {
+    if (useFlatConfig &&
+        eslintConfigPath &&
+        !(eslintConfigPath === null || eslintConfigPath === void 0 ? void 0 : eslintConfigPath.endsWith('eslint.config.js'))) {
+        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 resolveESLintClass(useFlatConfig);
+    const eslintOptions = {
         overrideConfigFile: eslintConfigPath,
-        ignorePath: options.ignorePath || undefined,
         fix: !!options.fix,
         cache: !!options.cache,
         cacheLocation: options.cacheLocation || undefined,
         cacheStrategy: options.cacheStrategy || undefined,
-        resolvePluginsRelativeTo: options.resolvePluginsRelativeTo || undefined,
-        rulePaths: options.rulesdir || [],
         /**
          * Default is `true` and if not overridden the eslint.lintFiles() method will throw an error
          * when no target files are found.
          *
          * We don't want ESLint to throw an error if a user has only just created
          * a project and therefore doesn't necessarily have matching files, for example.
+         *
+         * Also, the angular generator creates a lint pattern for `html` files, but there may
+         * not be any html files in the project, so keeping it true would break linting every time
          */
         errorOnUnmatchedPattern: false,
-    });
-    return await eslint.lintFiles(
-    // lintFilePatterns are defined relative to the root of the Angular-CLI workspace
-    options.lintFilePatterns.map((p) => (0, path_1.join)(workspaceRoot, p)));
+        reportUnusedDisableDirectives: options.reportUnusedDisableDirectives || undefined,
+    };
+    if (useFlatConfig) {
+        if (typeof options.useEslintrc !== 'undefined') {
+            throw new Error('For Flat Config, the `useEslintrc` option is not applicable. See https://eslint.org/docs/latest/use/configure/configuration-files-new');
+        }
+        if (options.resolvePluginsRelativeTo !== undefined) {
+            throw new Error('For Flat Config, ESLint removed `resolvePluginsRelativeTo` and so it is not supported as an option. See https://eslint.org/docs/latest/use/configure/configuration-files-new');
+        }
+        if (options.ignorePath !== undefined) {
+            throw new Error('For Flat Config, ESLint removed `ignorePath` and so it is not supported as an option. See https://eslint.org/docs/latest/use/configure/configuration-files-new');
+        }
+    }
+    else {
+        eslintOptions.rulePaths = options.rulesdir || [];
+        eslintOptions.resolvePluginsRelativeTo =
+            options.resolvePluginsRelativeTo || undefined;
+        eslintOptions.ignorePath = options.ignorePath || undefined;
+        /**
+         * If "noEslintrc" is set to `true` (and therefore here "useEslintrc" will be `false`), then ESLint will not
+         * merge the provided config with others it finds automatically.
+         */
+        eslintOptions.useEslintrc = !options.noEslintrc;
+    }
+    const eslint = new ESLint(eslintOptions);
+    return {
+        ESLint,
+        eslint,
+    };
 }
-exports.lint = lint;
+exports.resolveAndInstantiateESLint = resolveAndInstantiateESLint;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@angular-eslint/builder",
-  "version": "15.2.2-alpha.8+865ee07",
+  "version": "16.0.0-alpha.0",
   "description": "Angular CLI builder for ESLint",
   "license": "MIT",
   "main": "dist/index.js",
@@ -17,10 +17,14 @@
     "LICENSE",
     "builders.json"
   ],
+  "dependencies": {
+    "@nx/devkit": "16.0.2",
+    "nx": "16.0.2"
+  },
   "builders": "./builders.json",
   "peerDependencies": {
     "eslint": "^7.20.0 || ^8.0.0",
     "typescript": "*"
   },
-  "gitHead": "865ee07e31b3ee355b24dccdc46db4bc67eb0d81"
+  "gitHead": "4bb6da6362f6625bffe7430d5117bbfb66e38d2b"
 }

package/dist/utils/create-directory.d.ts

@@ -1 +0,0 @@
-export declare function createDirectory(directoryPath: string): void;

package/dist/utils/create-directory.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDirectory = void 0;
-const path_1 = require("path");
-const fs_1 = require("fs");
-function createDirectory(directoryPath) {
-    const parentPath = (0, path_1.dirname)(directoryPath);
-    if (!directoryExists(parentPath)) {
-        createDirectory(parentPath);
-    }
-    if (!directoryExists(directoryPath)) {
-        (0, fs_1.mkdirSync)(directoryPath);
-    }
-}
-exports.createDirectory = createDirectory;
-function directoryExists(name) {
-    try {
-        return (0, fs_1.statSync)(name).isDirectory();
-    }
-    catch (_a) {
-        return false;
-    }
-}