@nx/eslint-plugin 16.6.0 → 16.7.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/eslint-plugin",
-  "version": "16.6.0",
+  "version": "16.7.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,9 +33,9 @@
     }
   },
   "dependencies": {
-    "@nrwl/eslint-plugin-nx": "16.6.0",
-    "@nx/devkit": "16.6.0",
-    "@nx/js": "16.6.0",
+    "@nrwl/eslint-plugin-nx": "16.7.0-beta.1",
+    "@nx/devkit": "16.7.0-beta.1",
+    "@nx/js": "16.7.0-beta.1",
     "@typescript-eslint/type-utils": "^5.60.1",
     "@typescript-eslint/utils": "^5.60.1",
     "chalk": "^4.1.0",
@@ -51,5 +51,5 @@
     "migrations": "./migrations.json"
   },
   "types": "./src/index.d.ts",
-  "gitHead": "d02a8dbf06c85de78c0c76f64a17f10ae8085739"
+  "gitHead": "50a145bb64edcf76985184a9a83d1449dcd4f3d9"
 }

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

@@ -189,7 +189,7 @@ exports.default = (0, create_eslint_rule_1.createESLintRule)({
                         fix(fixer) {
                             // imp has form of @myorg/someproject/some/path
                             const indexTsPaths = (0, ast_utils_1.getBarrelEntryPointByImportScope)(imp);
-                            if (indexTsPaths && indexTsPaths.length > 0) {
+                            if (indexTsPaths.length > 0) {
                                 const specifiers = node.specifiers;
                                 if (!specifiers || specifiers.length === 0) {
                                     return;
@@ -206,10 +206,15 @@ exports.default = (0, create_eslint_rule_1.createESLintRule)({
                                         if (importPath) {
                                             // resolve the import path
                                             const relativePath = (0, path_1.relative)((0, path_1.dirname)(fileName), (0, path_1.dirname)(importPath));
+                                            // the string we receive from elsewhere might not have a leading './' here despite still being a relative path
+                                            // we'd like to ensure it's a normalized relative form starting from ./ or ../
+                                            const ensureRelativeForm = (path) => path.startsWith('./') || path.startsWith('../')
+                                                ? path
+                                                : `./${path}`;
                                             // if the string is empty, it's the current file
                                             const importPathResolved = relativePath === ''
                                                 ? `./${(0, path_1.basename)(importPath)}`
-                                                : (0, devkit_1.joinPathFragments)(relativePath, (0, path_1.basename)(importPath));
+                                                : ensureRelativeForm((0, devkit_1.joinPathFragments)(relativePath, (0, path_1.basename)(importPath)));
                                             importsToRemap.push({
                                                 member: importMember,
                                                 // remove .ts or .tsx from the end of the file path

package/src/utils/ast-utils.d.ts

@@ -4,7 +4,7 @@ import { ProjectGraphProjectNode } from '@nx/devkit';
  * @param importScope like `@myorg/somelib`
  * @returns
  */
-export declare function getBarrelEntryPointByImportScope(importScope: string): string[] | null;
+export declare function getBarrelEntryPointByImportScope(importScope: string): string[];
 export declare function getBarrelEntryPointProjectNode(projectNode: ProjectGraphProjectNode): {
     path: string;
     importScope: string;

package/src/utils/ast-utils.js

@@ -23,8 +23,33 @@ function tryReadBaseJson() {
  */
 function getBarrelEntryPointByImportScope(importScope) {
     var _a;
+    const tryPaths = (paths, importScope) => {
+        // TODO check and warn that the entries of paths[importScope] have no wildcards; that'd be user misconfiguration
+        if (paths[importScope])
+            return paths[importScope];
+        // accommodate wildcards (it's not glob) https://www.typescriptlang.org/docs/handbook/module-resolution.html#path-mapping
+        const result = new Set(); // set ensures there are no duplicates
+        for (const [alias, targets] of Object.entries(paths)) {
+            if (!alias.endsWith('*')) {
+                continue;
+            }
+            const strippedAlias = alias.slice(0, -1); // remove asterisk
+            if (!importScope.startsWith(strippedAlias)) {
+                continue;
+            }
+            const dynamicPart = importScope.slice(strippedAlias.length);
+            targets.forEach((target) => {
+                result.add(target.replace('*', dynamicPart)); // add interpolated value
+            });
+            // we found the entry for importScope; an import scope not supposed and has no sense having > 1 Aliases; TODO warn on duplicated entries
+            break;
+        }
+        return Array.from(result);
+    };
     const tsConfigBase = tryReadBaseJson();
-    return ((_a = tsConfigBase === null || tsConfigBase === void 0 ? void 0 : tsConfigBase.compilerOptions) === null || _a === void 0 ? void 0 : _a.paths[importScope]) || null;
+    if (!((_a = tsConfigBase === null || tsConfigBase === void 0 ? void 0 : tsConfigBase.compilerOptions) === null || _a === void 0 ? void 0 : _a.paths))
+        return [];
+    return tryPaths(tsConfigBase.compilerOptions.paths, importScope);
 }
 exports.getBarrelEntryPointByImportScope = getBarrelEntryPointByImportScope;
 function getBarrelEntryPointProjectNode(projectNode) {
@@ -66,6 +91,15 @@ function getRelativeImportPath(exportedMember, filePath, basePath) {
             return;
         }
     }
+    else if (!(0, fs_1.lstatSync)(filePath, {
+        throwIfNoEntry: false,
+    }) /*not folder, but probably not full file with an extension either*/) {
+        // try to find an extension that exists
+        const ext = ['.ts', '.tsx', '.js', '.jsx'].find((ext) => (0, fs_1.lstatSync)(filePath + ext, { throwIfNoEntry: false }));
+        if (ext) {
+            filePath += ext;
+        }
+    }
     const fileContent = (0, fs_1.readFileSync)(filePath, 'utf8');
     // use the TypeScript AST to find the path to the file where exportedMember is defined
     const sourceFile = ts.createSourceFile(filePath, fileContent, ts.ScriptTarget.Latest, true);