@nx/eslint-plugin 17.2.5 → 17.3.0-beta.1

package/migrations.json

@@ -5,6 +5,12 @@
       "version": "16.0.0-beta.1",
       "description": "Replace @nrwl/eslint-plugin-nx with @nx/eslint-plugin",
       "implementation": "./src/migrations/update-16-0-0-add-nx-packages/update-16-0-0-add-nx-packages"
+    },
+    "update-17-2-6-rename-workspace-rules": {
+      "cli": "nx",
+      "version": "17-2-6-beta.1",
+      "description": "Rename workspace rules from @nx/workspace/name to @nx/workspace-name",
+      "implementation": "./src/migrations/update-17-2-6-rename-workspace-rules/rename-workspace-rules"
     }
   },
   "packageJsonUpdates": {},

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/eslint-plugin",
-  "version": "v17.2.5",
+  "version": "17.3.0-beta.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": {
@@ -33,8 +33,8 @@
     }
   },
   "dependencies": {
-    "@nx/devkit": "v17.2.5",
-    "@nx/js": "v17.2.5",
+    "@nx/devkit": "17.3.0-beta.1",
+    "@nx/js": "17.3.0-beta.1",
     "@typescript-eslint/type-utils": "^6.13.2",
     "@typescript-eslint/utils": "^6.13.2",
     "chalk": "^4.1.0",
@@ -42,7 +42,7 @@
     "jsonc-eslint-parser": "^2.1.0",
     "semver": "7.5.3",
     "tslib": "^2.3.0",
-    "@nrwl/eslint-plugin-nx": "v17.2.5"
+    "@nrwl/eslint-plugin-nx": "17.3.0-beta.1"
   },
   "publishConfig": {
     "access": "public"

package/src/constants.d.ts

@@ -1,3 +1,4 @@
+export declare const WORKSPACE_RULES_PATH = "tools/eslint-rules";
 export declare const WORKSPACE_PLUGIN_DIR: string;
 /**
  * We add a namespace so that we mitigate the risk of rule name collisions as much as
@@ -7,6 +8,6 @@ export declare const WORKSPACE_PLUGIN_DIR: string;
  * E.g. if a user writes a rule called "foo", then they will include it in their ESLint
  * config files as:
  *
- * "@nx/workspace/foo": "error"
+ * "@nx/workspace-foo": "error"
  */
-export declare const WORKSPACE_RULE_NAMESPACE = "workspace";
+export declare const WORKSPACE_RULE_PREFIX = "workspace";

package/src/constants.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WORKSPACE_RULE_NAMESPACE = exports.WORKSPACE_PLUGIN_DIR = void 0;
+exports.WORKSPACE_RULE_PREFIX = exports.WORKSPACE_PLUGIN_DIR = exports.WORKSPACE_RULES_PATH = void 0;
 const devkit_1 = require("@nx/devkit");
 const path_1 = require("path");
-exports.WORKSPACE_PLUGIN_DIR = (0, path_1.join)(devkit_1.workspaceRoot, 'tools/eslint-rules');
+exports.WORKSPACE_RULES_PATH = 'tools/eslint-rules';
+exports.WORKSPACE_PLUGIN_DIR = (0, path_1.join)(devkit_1.workspaceRoot, exports.WORKSPACE_RULES_PATH);
 /**
  * We add a namespace so that we mitigate the risk of rule name collisions as much as
  * possible between what users might create in their workspaces and what we might want
@@ -12,6 +13,6 @@ exports.WORKSPACE_PLUGIN_DIR = (0, path_1.join)(devkit_1.workspaceRoot, 'tools/e
  * E.g. if a user writes a rule called "foo", then they will include it in their ESLint
  * config files as:
  *
- * "@nx/workspace/foo": "error"
+ * "@nx/workspace-foo": "error"
  */
-exports.WORKSPACE_RULE_NAMESPACE = 'workspace';
+exports.WORKSPACE_RULE_PREFIX = 'workspace';

package/src/migrations/update-17-2-6-rename-workspace-rules/rename-workspace-rules.d.ts

@@ -0,0 +1,2 @@
+import { Tree } from '@nx/devkit';
+export default function renameWorkspaceRule(tree: Tree): Promise<void>;

package/src/migrations/update-17-2-6-rename-workspace-rules/rename-workspace-rules.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const devkit_1 = require("@nx/devkit");
+const binary_extensions_1 = require("@nx/devkit/src/utils/binary-extensions");
+const constants_1 = require("../../constants");
+async function renameWorkspaceRule(tree) {
+    if (!tree.exists(constants_1.WORKSPACE_RULES_PATH)) {
+        return;
+    }
+    let ruleNames = [];
+    try {
+        ruleNames = Object.keys(require(constants_1.WORKSPACE_PLUGIN_DIR).rules);
+    }
+    catch (e) {
+        return;
+    }
+    (0, devkit_1.visitNotIgnoredFiles)(tree, '.', (path) => {
+        if ((0, binary_extensions_1.isBinaryPath)(path)) {
+            return;
+        }
+        let contents = tree.read(path, 'utf-8');
+        ruleNames.forEach((ruleName) => {
+            contents = contents.replace(new RegExp(`@nx/workspace/${ruleName}`, 'g'), `@nx/workspace-${ruleName}`);
+        });
+        tree.write(path, contents);
+    });
+    await (0, devkit_1.formatFiles)(tree);
+}
+exports.default = renameWorkspaceRule;

package/src/resolve-workspace-rules.js

@@ -21,7 +21,9 @@ exports.workspaceRules = (() => {
         // Apply the namespace to the resolved rules
         const namespacedRules = {};
         for (const [ruleName, ruleConfig] of Object.entries(rules)) {
-            namespacedRules[`${constants_1.WORKSPACE_RULE_NAMESPACE}/${ruleName}`] = ruleConfig;
+            namespacedRules[`${constants_1.WORKSPACE_RULE_PREFIX}-${ruleName}`] = ruleConfig;
+            // keep the old namespaced rules for backwards compatibility
+            namespacedRules[`${constants_1.WORKSPACE_RULE_PREFIX}/${ruleName}`] = ruleConfig;
         }
         return namespacedRules;
     }

package/src/rules/enforce-module-boundaries.js

@@ -225,7 +225,7 @@ exports.default = utils_2.ESLintUtils.RuleCreator(() => ``)({
             if (sourceProject === targetProject) {
                 if (!allowCircularSelfDependency &&
                     !(0, fileutils_1.isRelativePath)(imp) &&
-                    !(0, runtime_lint_utils_1.isAngularSecondaryEntrypoint)(imp, sourceFilePath, sourceProject.data.root)) {
+                    !(0, runtime_lint_utils_1.belongsToDifferentNgEntryPoint)(imp, sourceFilePath, sourceProject.data.root)) {
                     context.report({
                         node,
                         messageId: 'noSelfCircularDependencies',

package/src/utils/runtime-lint-utils.d.ts

@@ -77,12 +77,9 @@ export declare function groupImports(importsToRemap: {
     importPath: string;
 }[]): string;
 /**
- * Checks if import points to a secondary entry point in Angular project
- * @param targetProjectLocator
- * @param importExpr
- * @returns
+ * Checks if source file belongs to a secondary entry point different than the import one
  */
-export declare function isAngularSecondaryEntrypoint(importExpr: string, filePath: string, projectRoot: string): boolean;
+export declare function belongsToDifferentNgEntryPoint(importExpr: string, filePath: string, projectRoot: string): boolean;
 /**
  * Returns true if the given project contains MFE config with "exposes:" section
  */

package/src/utils/runtime-lint-utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.appIsMFERemote = exports.isAngularSecondaryEntrypoint = exports.groupImports = exports.isTerminalRun = exports.hasBuildExecutor = exports.isDirectDependency = exports.hasBannedDependencies = exports.findTransitiveExternalDependencies = exports.hasBannedImport = exports.getSourceFilePath = exports.onlyLoadChildren = exports.findConstraintsFor = exports.findProjectUsingImport = exports.isAbsoluteImportIntoAnotherProject = exports.findProject = exports.getTargetProjectBasedOnRelativeImport = exports.isRelative = exports.matchImportWithWildcard = exports.findDependenciesWithTags = exports.isComboDepConstraint = exports.hasNoneOfTheseTags = exports.stringifyTags = void 0;
+exports.appIsMFERemote = exports.belongsToDifferentNgEntryPoint = exports.groupImports = exports.isTerminalRun = exports.hasBuildExecutor = exports.isDirectDependency = exports.hasBannedDependencies = exports.findTransitiveExternalDependencies = exports.hasBannedImport = exports.getSourceFilePath = exports.onlyLoadChildren = exports.findConstraintsFor = exports.findProjectUsingImport = exports.isAbsoluteImportIntoAnotherProject = exports.findProject = exports.getTargetProjectBasedOnRelativeImport = exports.isRelative = exports.matchImportWithWildcard = exports.findDependenciesWithTags = exports.isComboDepConstraint = exports.hasNoneOfTheseTags = exports.stringifyTags = void 0;
 const tslib_1 = require("tslib");
 const path = tslib_1.__importStar(require("path"));
 const path_1 = require("path");
@@ -311,17 +311,21 @@ function groupImports(importsToRemap) {
 }
 exports.groupImports = groupImports;
 /**
- * Checks if import points to a secondary entry point in Angular project
- * @param targetProjectLocator
- * @param importExpr
- * @returns
+ * Checks if source file belongs to a secondary entry point different than the import one
  */
-function isAngularSecondaryEntrypoint(importExpr, filePath, projectRoot) {
-    const resolvedModule = (0, internal_1.resolveModuleByImport)(importExpr, filePath, (0, path_1.join)(devkit_1.workspaceRoot, (0, js_1.getRootTsConfigFileName)()));
-    return (!!resolvedModule && fileIsSecondaryEntryPoint(resolvedModule, projectRoot));
+function belongsToDifferentNgEntryPoint(importExpr, filePath, projectRoot) {
+    const resolvedImportFile = (0, internal_1.resolveModuleByImport)(importExpr, filePath, // not strictly necessary, but speeds up resolution
+    (0, path_1.join)(devkit_1.workspaceRoot, (0, js_1.getRootTsConfigFileName)()));
+    if (!resolvedImportFile) {
+        return false;
+    }
+    const importEntryPoint = getAngularEntryPoint(resolvedImportFile, projectRoot);
+    const srcEntryPoint = getAngularEntryPoint(filePath, projectRoot);
+    // check if the entry point of import expression is different than the source file's entry point
+    return importEntryPoint !== srcEntryPoint;
 }
-exports.isAngularSecondaryEntrypoint = isAngularSecondaryEntrypoint;
-function fileIsSecondaryEntryPoint(file, projectRoot) {
+exports.belongsToDifferentNgEntryPoint = belongsToDifferentNgEntryPoint;
+function getAngularEntryPoint(file, projectRoot) {
     let parent = (0, devkit_1.joinPathFragments)(file, '../');
     while (parent !== `${projectRoot}/`) {
         // we need to find closest existing ng-package.json
@@ -330,11 +334,11 @@ function fileIsSecondaryEntryPoint(file, projectRoot) {
         if (ngPackageContent) {
             // https://github.com/ng-packagr/ng-packagr/blob/23c718d04eea85e015b4c261310b7bd0c39e5311/src/ng-package.schema.json#L54
             const entryFile = (0, devkit_1.parseJson)(ngPackageContent)?.lib?.entryFile;
-            return entryFile && file === (0, devkit_1.joinPathFragments)(parent, entryFile);
+            return (0, devkit_1.joinPathFragments)(parent, entryFile);
         }
         parent = (0, devkit_1.joinPathFragments)(parent, '../');
     }
-    return false;
+    return undefined;
 }
 /**
  * Returns true if the given project contains MFE config with "exposes:" section