@nx/eslint-plugin 17.2.4 → 17.2.6

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": "17.2.4",
+  "version": "17.2.6",
   "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": "17.2.4",
-    "@nx/js": "17.2.4",
+    "@nx/devkit": "17.2.6",
+    "@nx/js": "17.2.6",
     "@typescript-eslint/type-utils": "^6.9.1",
     "@typescript-eslint/utils": "^6.9.1",
     "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": "17.2.4"
+    "@nrwl/eslint-plugin-nx": "17.2.6"
   },
   "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;
     }