@nx/eslint-plugin 16.5.0-beta.2 → 16.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/eslint-plugin",
-  "version": "16.5.0-beta.2",
+  "version": "16.5.0",
   "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": {
@@ -24,7 +24,7 @@
   },
   "homepage": "https://nx.dev",
   "peerDependencies": {
-    "@typescript-eslint/parser": "^5.58.0",
+    "@typescript-eslint/parser": "^5.60.1",
     "eslint-config-prettier": "^8.1.0"
   },
   "peerDependenciesMeta": {
@@ -33,11 +33,11 @@
     }
   },
   "dependencies": {
-    "@nrwl/eslint-plugin-nx": "16.5.0-beta.2",
-    "@nx/devkit": "16.5.0-beta.2",
-    "@nx/js": "16.5.0-beta.2",
-    "@typescript-eslint/type-utils": "^5.58.0",
-    "@typescript-eslint/utils": "^5.58.0",
+    "@nrwl/eslint-plugin-nx": "16.5.0",
+    "@nx/devkit": "16.5.0",
+    "@nx/js": "16.5.0",
+    "@typescript-eslint/type-utils": "^5.60.1",
+    "@typescript-eslint/utils": "^5.60.1",
     "chalk": "^4.1.0",
     "confusing-browser-globals": "^1.0.9",
     "jsonc-eslint-parser": "^2.1.0",
@@ -50,5 +50,5 @@
     "migrations": "./migrations.json"
   },
   "types": "./src/index.d.ts",
-  "gitHead": "efdf140459e453c50f06cf287906c4bb3ac49d3d"
+  "gitHead": "eaebcc34f92db2200dab0bde2e2e1dde107a47bf"
 }

package/src/rules/dependency-checks.js

@@ -34,7 +34,7 @@ exports.default = (0, create_eslint_rule_1.createESLintRule)({
             },
         ],
         messages: {
-            missingDependency: `The "{{projectName}}" uses the package "{{packageName}}", but it is missing from the project's "package.json".`,
+            missingDependency: `The "{{projectName}}" uses the following packages, but they are missing from the "{{section}}":{{packageNames}}`,
             obsoleteDependency: `The "{{packageName}}" package is not used by "{{projectName}}".`,
             versionMismatch: `The version specifier does not contain the installed version of "{{packageName}}" package: {{version}}.`,
             missingDependencySection: `Dependency sections are missing from the "package.json" but following dependencies were detected:{{dependencies}}`,
@@ -91,27 +91,34 @@ exports.default = (0, create_eslint_rule_1.createESLintRule)({
             if (!checkMissingDependencies) {
                 return;
             }
-            const missingDeps = expectedDependencyNames.filter((d) => !projPackageJsonDeps[d]);
-            missingDeps.forEach((d) => {
-                if (!ignoredDependencies.includes(d)) {
-                    context.report({
-                        node: node,
-                        messageId: 'missingDependency',
-                        data: { packageName: d, projectName: sourceProject.name },
-                        fix(fixer) {
+            const missingDeps = expectedDependencyNames.filter((d) => !projPackageJsonDeps[d] && !ignoredDependencies.includes(d));
+            if (missingDeps.length) {
+                context.report({
+                    node: node,
+                    messageId: 'missingDependency',
+                    data: {
+                        packageNames: missingDeps.map((d) => `\n    - ${d}`).join(''),
+                        section: node.key.value,
+                        projectName: sourceProject.name,
+                    },
+                    fix(fixer) {
+                        missingDeps.forEach((d) => {
                             projPackageJsonDeps[d] =
                                 rootPackageJsonDeps[d] || projDependencies[d];
-                            const deps = node.value.properties;
-                            if (deps.length) {
-                                return fixer.insertTextAfter(deps[deps.length - 1], `,\n    "${d}": "${projPackageJsonDeps[d]}"`);
-                            }
-                            else {
-                                return fixer.replaceTextRange([node.value.range[0] + 1, node.value.range[1] - 1], `\n    "${d}": "${projPackageJsonDeps[d]}"\n  `);
-                            }
-                        },
-                    });
-                }
-            });
+                        });
+                        const deps = node.value.properties;
+                        const mappedDeps = missingDeps
+                            .map((d) => `\n    "${d}": "${projPackageJsonDeps[d]}"`)
+                            .join(',');
+                        if (deps.length) {
+                            return fixer.insertTextAfter(deps[deps.length - 1], `,${mappedDeps}`);
+                        }
+                        else {
+                            return fixer.insertTextAfterRange([node.value.range[0] + 1, node.value.range[1] - 1], `${mappedDeps}\n  `);
+                        }
+                    },
+                });
+            }
         }
         function validateVersionMatchesInstalled(node, packageName, packageRange) {
             if (!checkVersionMismatches) {
@@ -145,7 +152,7 @@ exports.default = (0, create_eslint_rule_1.createESLintRule)({
                     if (index > 0) {
                         const previousNode = node.parent.properties[index - 1];
                         return fixer.removeRange([
-                            previousNode.range[1] + 1,
+                            previousNode.range[1] + (isLastProperty ? 0 : 1),
                             node.range[1] + (isLastProperty ? 0 : 1),
                         ]);
                     }
@@ -165,13 +172,6 @@ exports.default = (0, create_eslint_rule_1.createESLintRule)({
                             ]);
                         }
                     }
-                    // remove 4 spaces, new line and potential comma from previous line
-                    const shouldRemoveSiblingComma = isLastProperty && node.parent.properties.length > 1;
-                    const leadingChars = 5 + (shouldRemoveSiblingComma ? 1 : 0);
-                    return fixer.removeRange([
-                        node.range[0] - leadingChars,
-                        node.range[1] + (isLastProperty ? 0 : 1),
-                    ]);
                 },
             });
         }

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

@@ -66,8 +66,8 @@ exports.default = (0, create_eslint_rule_1.createESLintRule)({
             noImportOfNonBuildableLibraries: 'Buildable libraries cannot import or export from non-buildable libraries',
             noImportsOfLazyLoadedLibraries: `Static imports of lazy-loaded libraries are forbidden.\n\nLibrary "{{targetProjectName}}" is lazy-loaded in these files:\n{{filePaths}}`,
             projectWithoutTagsCannotHaveDependencies: `A project without tags matching at least one constraint cannot depend on any libraries`,
-            bannedExternalImportsViolation: `A project tagged with "{{sourceTag}}" is not allowed to import the "{{package}}" package`,
-            nestedBannedExternalImportsViolation: `A project tagged with "{{sourceTag}}" is not allowed to import the "{{package}}" package. Nested import found at {{childProjectName}}`,
+            bannedExternalImportsViolation: `A project tagged with "{{sourceTag}}" is not allowed to import "{{imp}}"`,
+            nestedBannedExternalImportsViolation: `A project tagged with "{{sourceTag}}" is not allowed to import "{{imp}}". Nested import found at {{childProjectName}}`,
             noTransitiveDependencies: `Transitive dependencies are not allowed. Only packages defined in the "package.json" can be imported`,
             onlyTagsConstraintViolation: `A project tagged with "{{sourceTag}}" can only depend on libs tagged with {{tags}}`,
             emptyOnlyTagsConstraintViolation: 'A project tagged with "{{sourceTag}}" cannot depend on any libs with tags',
@@ -237,7 +237,7 @@ exports.default = (0, create_eslint_rule_1.createESLintRule)({
                         messageId: 'noTransitiveDependencies',
                     });
                 }
-                const constraint = (0, runtime_lint_utils_1.hasBannedImport)(sourceProject, targetProject, depConstraints);
+                const constraint = (0, runtime_lint_utils_1.hasBannedImport)(sourceProject, targetProject, depConstraints, imp);
                 if (constraint) {
                     context.report({
                         node,
@@ -246,7 +246,7 @@ exports.default = (0, create_eslint_rule_1.createESLintRule)({
                             sourceTag: (0, runtime_lint_utils_1.isComboDepConstraint)(constraint)
                                 ? constraint.allSourceTags.join('" and "')
                                 : constraint.sourceTag,
-                            package: targetProject.data.packageName,
+                            imp,
                         },
                     });
                 }
@@ -392,18 +392,18 @@ exports.default = (0, create_eslint_rule_1.createESLintRule)({
                     if (checkNestedExternalImports &&
                         constraint.bannedExternalImports &&
                         constraint.bannedExternalImports.length) {
-                        const matches = (0, runtime_lint_utils_1.hasBannedDependencies)(transitiveExternalDeps, projectGraph, constraint);
+                        const matches = (0, runtime_lint_utils_1.hasBannedDependencies)(transitiveExternalDeps, projectGraph, constraint, imp);
                         if (matches.length > 0) {
                             matches.forEach(([target, violatingSource, constraint]) => {
                                 context.report({
                                     node,
-                                    messageId: 'bannedExternalImportsViolation',
+                                    messageId: 'nestedBannedExternalImportsViolation',
                                     data: {
                                         sourceTag: (0, runtime_lint_utils_1.isComboDepConstraint)(constraint)
                                             ? constraint.allSourceTags.join('" and "')
                                             : constraint.sourceTag,
                                         childProjectName: violatingSource.name,
-                                        package: target.data.packageName,
+                                        imp,
                                     },
                                 });
                             });

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

@@ -41,7 +41,7 @@ export declare function findProjectUsingImport(projectGraph: ProjectGraph, targe
 export declare function findConstraintsFor(depConstraints: DepConstraint[], sourceProject: ProjectGraphProjectNode): DepConstraint[];
 export declare function onlyLoadChildren(graph: ProjectGraph, sourceProjectName: string, targetProjectName: string, visited: string[]): any;
 export declare function getSourceFilePath(sourceFileName: string, projectPath: string): string;
-export declare function hasBannedImport(source: ProjectGraphProjectNode, target: ProjectGraphExternalNode, depConstraints: DepConstraint[]): DepConstraint | undefined;
+export declare function hasBannedImport(source: ProjectGraphProjectNode, target: ProjectGraphExternalNode, depConstraints: DepConstraint[], imp: string): DepConstraint | undefined;
 /**
  * Find all unique (transitive) external dependencies of given project
  * @param graph
@@ -56,7 +56,7 @@ export declare function findTransitiveExternalDependencies(graph: ProjectGraph,
  * @param depConstraint
  * @returns
  */
-export declare function hasBannedDependencies(externalDependencies: ProjectGraphDependency[], graph: ProjectGraph, depConstraint: DepConstraint): Array<[ProjectGraphExternalNode, ProjectGraphProjectNode, DepConstraint]> | undefined;
+export declare function hasBannedDependencies(externalDependencies: ProjectGraphDependency[], graph: ProjectGraph, depConstraint: DepConstraint, imp: string): Array<[ProjectGraphExternalNode, ProjectGraphProjectNode, DepConstraint]> | undefined;
 export declare function isDirectDependency(source: ProjectGraphProjectNode, target: ProjectGraphExternalNode): boolean;
 /**
  * Verifies whether the given node has a builder target

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

@@ -150,17 +150,21 @@ exports.getSourceFilePath = getSourceFilePath;
  * @param depConstraints
  * @returns
  */
-function isConstraintBanningProject(externalProject, constraint) {
+function isConstraintBanningProject(externalProject, constraint, imp) {
     const { allowedExternalImports, bannedExternalImports } = constraint;
     const { packageName } = externalProject.data;
+    if (imp !== packageName && !imp.startsWith(`${packageName}/`)) {
+        return false;
+    }
     /* Check if import is banned... */
-    if (bannedExternalImports === null || bannedExternalImports === void 0 ? void 0 : bannedExternalImports.some((importDefinition) => mapGlobToRegExp(importDefinition).test(packageName))) {
+    if (bannedExternalImports === null || bannedExternalImports === void 0 ? void 0 : bannedExternalImports.some((importDefinition) => mapGlobToRegExp(importDefinition).test(imp))) {
         return true;
     }
     /* ... then check if there is a whitelist and if there is a match in the whitelist.  */
-    return allowedExternalImports === null || allowedExternalImports === void 0 ? void 0 : allowedExternalImports.every((importDefinition) => !mapGlobToRegExp(importDefinition).test(packageName));
+    return allowedExternalImports === null || allowedExternalImports === void 0 ? void 0 : allowedExternalImports.every((importDefinition) => !imp.startsWith(packageName) ||
+        !mapGlobToRegExp(importDefinition).test(imp));
 }
-function hasBannedImport(source, target, depConstraints) {
+function hasBannedImport(source, target, depConstraints, imp) {
     // return those constraints that match source project
     depConstraints = depConstraints.filter((c) => {
         let tags = [];
@@ -172,7 +176,7 @@ function hasBannedImport(source, target, depConstraints) {
         }
         return tags.every((t) => hasTag(source, t));
     });
-    return depConstraints.find((constraint) => isConstraintBanningProject(target, constraint));
+    return depConstraints.find((constraint) => isConstraintBanningProject(target, constraint, imp));
 }
 exports.hasBannedImport = hasBannedImport;
 /**
@@ -214,9 +218,9 @@ exports.findTransitiveExternalDependencies = findTransitiveExternalDependencies;
  * @param depConstraint
  * @returns
  */
-function hasBannedDependencies(externalDependencies, graph, depConstraint) {
+function hasBannedDependencies(externalDependencies, graph, depConstraint, imp) {
     return externalDependencies
-        .filter((dependency) => isConstraintBanningProject(graph.externalNodes[dependency.target], depConstraint))
+        .filter((dependency) => isConstraintBanningProject(graph.externalNodes[dependency.target], depConstraint, imp))
         .map((dep) => [
         graph.externalNodes[dep.target],
         graph.nodes[dep.source],