@nx/eslint-plugin 22.1.0 → 22.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/eslint-plugin",
-  "version": "22.1.0",
+  "version": "22.1.1",
   "private": false,
   "description": "The eslint-plugin package is an ESLint plugin that contains a collection of recommended ESLint rule configurations which you can extend from in your own ESLint configs, as well as an Nx-specific lint rule called enforce-module-boundaries.",
   "repository": {
@@ -34,8 +34,8 @@
     }
   },
   "dependencies": {
-    "@nx/devkit": "22.1.0",
-    "@nx/js": "22.1.0",
+    "@nx/devkit": "22.1.1",
+    "@nx/js": "22.1.1",
     "@phenomnomnominal/tsquery": "~5.0.1",
     "@typescript-eslint/type-utils": "^8.0.0",
     "@typescript-eslint/utils": "^8.0.0",

package/src/index.d.ts

@@ -1,3 +1,4 @@
+import { loadWorkspaceRules } from './resolve-workspace-rules';
 declare const configs: {
     typescript: {
         parser: string;
@@ -557,5 +558,5 @@ declare const _default: {
     };
 };
 export default _default;
-export { configs, rules };
+export { configs, rules, loadWorkspaceRules };
 //# sourceMappingURL=index.d.ts.map

package/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../packages/eslint-plugin/src/index.ts"],"names":[],"mappings":"AA0BA,QAAA,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gCAcgB,cAAc,2BAA2B,EAAE,OAAO;gCAGlD,cAAc,2BAA2B,EAAE,OAAO;2BAGvD,cAAc,0BAA0B,EAAE,OAAO;gCAG5C,cAAc,2BAA2B,EAAE,OAAO;sCAG5C,cAAc,iCAAiC,EAAE,OAAO;+BAG/D,cAAc,0BAA0B,EAAE,OAAO;6BAGnD,cAAc,wBAAwB,EAAE,OAAO;sCAGtC,cAAc,iCAAiC,EAAE,OAAO;CAG1F,CAAC;AAEF,QAAA,MAAM,KAAK;;;;CAKV,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oCA/B2B,cAAc,2BAA2B,EAAE,OAAO;oCAGlD,cAAc,2BAA2B,EAAE,OAAO;+BAGvD,cAAc,0BAA0B,EAAE,OAAO;oCAG5C,cAAc,2BAA2B,EAAE,OAAO;0CAG5C,cAAc,iCAAiC,EAAE,OAAO;mCAG/D,cAAc,0BAA0B,EAAE,OAAO;iCAGnD,cAAc,wBAAwB,EAAE,OAAO;0CAGtC,cAAc,iCAAiC,EAAE,OAAO;;;;;;;;AAY3F,wBAAkC;AAClC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../packages/eslint-plugin/src/index.ts"],"names":[],"mappings":"AAwBA,OAAO,EAAkB,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAE/E,QAAA,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gCAcgB,cAAc,2BAA2B,EAAE,OAAO;gCAGlD,cAAc,2BAA2B,EAAE,OAAO;2BAGvD,cAAc,0BAA0B,EAAE,OAAO;gCAG5C,cAAc,2BAA2B,EAAE,OAAO;sCAG5C,cAAc,iCAAiC,EAAE,OAAO;+BAG/D,cAAc,0BAA0B,EAAE,OAAO;6BAGnD,cAAc,wBAAwB,EAAE,OAAO;sCAGtC,cAAc,iCAAiC,EAAE,OAAO;CAG1F,CAAC;AAEF,QAAA,MAAM,KAAK;;;;CAKV,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oCA/B2B,cAAc,2BAA2B,EAAE,OAAO;oCAGlD,cAAc,2BAA2B,EAAE,OAAO;+BAGvD,cAAc,0BAA0B,EAAE,OAAO;oCAG5C,cAAc,2BAA2B,EAAE,OAAO;0CAG5C,cAAc,iCAAiC,EAAE,OAAO;mCAG/D,cAAc,0BAA0B,EAAE,OAAO;iCAGnD,cAAc,wBAAwB,EAAE,OAAO;0CAGtC,cAAc,iCAAiC,EAAE,OAAO;;;;;;;;AAY3F,wBAAkC;AAClC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAC"}

package/src/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rules = exports.configs = void 0;
+exports.loadWorkspaceRules = exports.rules = exports.configs = void 0;
 const tslib_1 = require("tslib");
 const typescript_1 = tslib_1.__importDefault(require("./configs/typescript"));
 const javascript_1 = tslib_1.__importDefault(require("./configs/javascript"));
@@ -16,6 +16,7 @@ const nx_plugin_checks_1 = tslib_1.__importStar(require("./rules/nx-plugin-check
 const dependency_checks_1 = tslib_1.__importStar(require("./rules/dependency-checks"));
 // Resolve any custom rules that might exist in the current workspace
 const resolve_workspace_rules_1 = require("./resolve-workspace-rules");
+Object.defineProperty(exports, "loadWorkspaceRules", { enumerable: true, get: function () { return resolve_workspace_rules_1.loadWorkspaceRules; } });
 const configs = {
     // eslintrc configs
     typescript: typescript_1.default,

package/src/resolve-workspace-rules.d.ts

@@ -1,5 +1,39 @@
 import type { TSESLint } from '@typescript-eslint/utils';
 type ESLintRules = Record<string, TSESLint.RuleModule<string, unknown[]>>;
+/**
+ * Load ESLint rules from a directory.
+ *
+ * This utility allows loading custom ESLint rules from any directory within the workspace,
+ * not just the default `tools/eslint-rules` location. It's useful for:
+ * - Loading rules from a custom directory structure
+ * - Loading rules from npm workspace packages (e.g., linked packages via npm/yarn/pnpm workspaces)
+ * - Loading rules from multiple directories with different configurations
+ *
+ * The directory must contain an index file (index.ts, index.js, etc.) that exports the rules.
+ *
+ * @param directory - The directory path to load rules from. Can be absolute or relative to workspace root.
+ * @param tsConfigPath - Optional path to tsconfig.json for TypeScript compilation.
+ *                       If not provided, will search for tsconfig.json starting from
+ *                       the directory and traversing up to the workspace root.
+ * @returns An object containing the loaded ESLint rules (without any prefix).
+ *          Returns an empty object if the directory doesn't exist or loading fails.
+ *
+ * @example
+ * ```typescript
+ * // Load rules from a custom directory (relative to workspace root)
+ * const customRules = await loadWorkspaceRules('packages/my-eslint-plugin/rules');
+ *
+ * // Load rules with a specific tsconfig
+ * const customRules = await loadWorkspaceRules(
+ *   'packages/my-eslint-plugin/rules',
+ *   'packages/my-eslint-plugin/tsconfig.json'
+ * );
+ *
+ * // Or use absolute paths
+ * const customRules = loadWorkspaceRules('/absolute/path/to/rules');
+ * ```
+ */
+export declare function loadWorkspaceRules(directory: string, tsConfigPath?: string): Promise<ESLintRules>;
 export declare const workspaceRules: ESLintRules;
 export {};
 //# sourceMappingURL=resolve-workspace-rules.d.ts.map

package/src/resolve-workspace-rules.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resolve-workspace-rules.d.ts","sourceRoot":"","sources":["../../../../packages/eslint-plugin/src/resolve-workspace-rules.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAMzD,KAAK,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,UAAU,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;AAE1E,eAAO,MAAM,cAAc,aAgCvB,CAAC"}
+{"version":3,"file":"resolve-workspace-rules.d.ts","sourceRoot":"","sources":["../../../../packages/eslint-plugin/src/resolve-workspace-rules.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAKzD,KAAK,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,UAAU,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;AAiF1E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAsB,kBAAkB,CACtC,SAAS,EAAE,MAAM,EACjB,YAAY,CAAC,EAAE,MAAM,GACpB,OAAO,CAAC,WAAW,CAAC,CA2CtB;AAED,eAAO,MAAM,cAAc,aAgCvB,CAAC"}

package/src/resolve-workspace-rules.js

@@ -1,10 +1,136 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.workspaceRules = void 0;
-const fs_1 = require("fs");
+exports.loadWorkspaceRules = loadWorkspaceRules;
+const devkit_1 = require("@nx/devkit");
+const config_utils_1 = require("@nx/devkit/src/utils/config-utils");
 const internal_1 = require("@nx/js/src/internal");
-const constants_1 = require("./constants");
+const fs_1 = require("fs");
 const path_1 = require("path");
+const constants_1 = require("./constants");
+// ESM import() cannot resolve directories to index files like require() can
+const INDEX_FILE_EXTENSIONS = [
+    '.ts',
+    '.mts',
+    '.cts',
+    '.js',
+    '.mjs',
+    '.cjs',
+];
+function resolveDirectoryEntryFile(directory) {
+    for (const ext of INDEX_FILE_EXTENSIONS) {
+        const candidatePath = (0, path_1.join)(directory, `index${ext}`);
+        if ((0, fs_1.existsSync)(candidatePath)) {
+            return candidatePath;
+        }
+    }
+    throw new Error(`No index file found in directory: ${directory}. ` +
+        `Expected one of: ${INDEX_FILE_EXTENSIONS.map((ext) => `index${ext}`).join(', ')}`);
+}
+function normalizePath(path) {
+    return `${(0, path_1.normalize)(path).replace(/[\/\\]$/g, '')}${path_1.sep}`;
+}
+function findTsConfig(directory, tsConfigPath) {
+    let effectiveTsConfigPath = tsConfigPath;
+    const normalizedWorkspaceRoot = normalizePath(devkit_1.workspaceRoot);
+    if (effectiveTsConfigPath) {
+        if (!(0, path_1.isAbsolute)(effectiveTsConfigPath)) {
+            effectiveTsConfigPath = (0, path_1.resolve)(devkit_1.workspaceRoot, effectiveTsConfigPath);
+        }
+        if (!effectiveTsConfigPath.startsWith(normalizedWorkspaceRoot)) {
+            console.warn(`TypeScript config "${effectiveTsConfigPath}" is outside the workspace root "${devkit_1.workspaceRoot}". Falling back to automatic tsconfig detection.`);
+            effectiveTsConfigPath = undefined;
+        }
+    }
+    if (!effectiveTsConfigPath) {
+        let currentDir = directory;
+        while (currentDir.startsWith(normalizedWorkspaceRoot)) {
+            const candidatePath = (0, path_1.join)(currentDir, 'tsconfig.json');
+            if ((0, fs_1.existsSync)(candidatePath)) {
+                effectiveTsConfigPath = candidatePath;
+                break;
+            }
+            const parentDir = (0, path_1.dirname)(currentDir);
+            if (normalizePath(parentDir) === normalizedWorkspaceRoot) {
+                break;
+            }
+            currentDir = parentDir;
+        }
+    }
+    if (!tsConfigPath && !effectiveTsConfigPath) {
+        console.warn(`No TypeScript config found. Crawled up to workspace root "${devkit_1.workspaceRoot}" ` +
+            `from directory "${directory}" without finding a tsconfig.json file. Provide ` +
+            `a tsconfig.json file path to the loadWorkspaceRules function.`);
+    }
+    return effectiveTsConfigPath;
+}
+/**
+ * Load ESLint rules from a directory.
+ *
+ * This utility allows loading custom ESLint rules from any directory within the workspace,
+ * not just the default `tools/eslint-rules` location. It's useful for:
+ * - Loading rules from a custom directory structure
+ * - Loading rules from npm workspace packages (e.g., linked packages via npm/yarn/pnpm workspaces)
+ * - Loading rules from multiple directories with different configurations
+ *
+ * The directory must contain an index file (index.ts, index.js, etc.) that exports the rules.
+ *
+ * @param directory - The directory path to load rules from. Can be absolute or relative to workspace root.
+ * @param tsConfigPath - Optional path to tsconfig.json for TypeScript compilation.
+ *                       If not provided, will search for tsconfig.json starting from
+ *                       the directory and traversing up to the workspace root.
+ * @returns An object containing the loaded ESLint rules (without any prefix).
+ *          Returns an empty object if the directory doesn't exist or loading fails.
+ *
+ * @example
+ * ```typescript
+ * // Load rules from a custom directory (relative to workspace root)
+ * const customRules = await loadWorkspaceRules('packages/my-eslint-plugin/rules');
+ *
+ * // Load rules with a specific tsconfig
+ * const customRules = await loadWorkspaceRules(
+ *   'packages/my-eslint-plugin/rules',
+ *   'packages/my-eslint-plugin/tsconfig.json'
+ * );
+ *
+ * // Or use absolute paths
+ * const customRules = loadWorkspaceRules('/absolute/path/to/rules');
+ * ```
+ */
+async function loadWorkspaceRules(directory, tsConfigPath) {
+    const resolvedDirectory = (0, path_1.isAbsolute)(directory)
+        ? directory
+        : (0, path_1.resolve)(devkit_1.workspaceRoot, directory);
+    if (!resolvedDirectory.startsWith(normalizePath(devkit_1.workspaceRoot))) {
+        console.warn(`Directory "${resolvedDirectory}" is outside the workspace root "${devkit_1.workspaceRoot}". ESLint rules can only be loaded from within the workspace.`);
+        return {};
+    }
+    if (!(0, fs_1.existsSync)(resolvedDirectory)) {
+        console.warn(`Directory "${resolvedDirectory}" does not exist. Skipping loading ESLint rules from this directory.`);
+        return {};
+    }
+    let registrationCleanup = null;
+    try {
+        const effectiveTsConfigPath = findTsConfig(resolvedDirectory, tsConfigPath);
+        if (effectiveTsConfigPath) {
+            registrationCleanup = (0, internal_1.registerTsProject)(effectiveTsConfigPath);
+        }
+        const entryFile = resolveDirectoryEntryFile(resolvedDirectory);
+        // Only rules are supported (not configs, processors, etc.)
+        const module = await (0, config_utils_1.loadConfigFile)(entryFile);
+        const rules = module.rules || module;
+        return rules;
+    }
+    catch (err) {
+        console.error(err);
+        return {};
+    }
+    finally {
+        if (registrationCleanup) {
+            registrationCleanup();
+        }
+    }
+}
 exports.workspaceRules = (() => {
     // If `tools/eslint-rules` folder doesn't exist, there is no point trying to register and load it
     if (!(0, fs_1.existsSync)(constants_1.WORKSPACE_PLUGIN_DIR)) {