@nx/eslint-plugin 23.0.0-beta.18 → 23.0.0-beta.19

package/dist/src/rules/nx-plugin-checks.d.ts

@@ -1,5 +1,6 @@
 import type { TSESLint } from '@typescript-eslint/utils';
 import type { AST } from 'jsonc-eslint-parser';
+import { ProjectConfiguration } from '@nx/devkit';
 export type Options = [
     {
         generatorsJson?: string;
@@ -10,21 +11,17 @@ export type Options = [
         tsConfig?: string;
     }
 ];
-type NormalizedOptions = Options[0] & {
-    rootDir?: string;
-    outDir?: string;
-};
 export type MessageIds = 'missingRequiredSchema' | 'invalidSchemaPath' | 'missingImplementation' | 'invalidImplementationPath' | 'invalidImplementationModule' | 'unableToReadImplementationExports' | 'invalidPromptPath' | 'invalidVersion' | 'missingVersion' | 'noGeneratorsOrSchematicsFound' | 'noExecutorsOrBuildersFound' | 'valueShouldBeObject';
 export declare const RULE_NAME = "nx-plugin-checks";
 declare const _default: TSESLint.RuleModule<MessageIds, Options, unknown, TSESLint.RuleListener> & {
     name: string;
 };
 export default _default;
-export declare function checkCollectionFileNode(baseNode: AST.JSONObjectExpression, mode: 'migration' | 'generator' | 'executor', context: TSESLint.RuleContext<MessageIds, Options>, options: NormalizedOptions): void;
-export declare function checkCollectionNode(baseNode: AST.JSONObjectExpression, mode: 'migration' | 'generator' | 'executor', context: TSESLint.RuleContext<MessageIds, Options>, options: NormalizedOptions): void;
-export declare function validateEntry(baseNode: AST.JSONObjectExpression, key: string, mode: 'migration' | 'generator' | 'executor', context: TSESLint.RuleContext<MessageIds, Options>, options: NormalizedOptions): void;
-export declare function validateImplementationNode(implementationNode: AST.JSONProperty, key: string, context: TSESLint.RuleContext<MessageIds, Options>, options: NormalizedOptions): void;
-export declare function validatePromptNode(promptNode: AST.JSONProperty, key: string, context: TSESLint.RuleContext<MessageIds, Options>, options: NormalizedOptions): void;
+export declare function checkCollectionFileNode(baseNode: AST.JSONObjectExpression, mode: 'migration' | 'generator' | 'executor', context: TSESLint.RuleContext<MessageIds, Options>, projects: Record<string, ProjectConfiguration>): void;
+export declare function checkCollectionNode(baseNode: AST.JSONObjectExpression, mode: 'migration' | 'generator' | 'executor', context: TSESLint.RuleContext<MessageIds, Options>, projects: Record<string, ProjectConfiguration>): void;
+export declare function validateEntry(baseNode: AST.JSONObjectExpression, key: string, mode: 'migration' | 'generator' | 'executor', context: TSESLint.RuleContext<MessageIds, Options>, projects: Record<string, ProjectConfiguration>): void;
+export declare function validateImplementationNode(implementationNode: AST.JSONProperty, key: string, context: TSESLint.RuleContext<MessageIds, Options>, projects: Record<string, ProjectConfiguration>): void;
+export declare function validatePromptNode(promptNode: AST.JSONProperty, key: string, context: TSESLint.RuleContext<MessageIds, Options>): void;
 export declare function validatePackageGroup(baseNode: AST.JSONObjectExpression, context: TSESLint.RuleContext<MessageIds, Options>): void;
 export declare function validateVersionJsonExpression(node: AST.JSONExpression, context: TSESLint.RuleContext<MessageIds, Options>): string | boolean;
 export declare function checkIfIdentifierIsFunction(filePath: string, identifier: string): boolean;

package/dist/src/rules/nx-plugin-checks.js

@@ -15,6 +15,7 @@ const fs_1 = require("fs");
 const tsquery_1 = require("@phenomnomnominal/tsquery");
 const devkit_1 = require("@nx/devkit");
 const internal_1 = require("@nx/js/internal");
+const internal_2 = require("@nx/devkit/internal");
 const path = tslib_1.__importStar(require("path"));
 const semver_1 = require("semver");
 const project_graph_utils_1 = require("../utils/project-graph-utils");
@@ -90,6 +91,10 @@ exports.default = utils_1.ESLintUtils.RuleCreator(() => ``)({
             return {};
         }
         const { projectGraph, projectRootMappings } = (0, project_graph_utils_1.readProjectGraph)(exports.RULE_NAME);
+        const projects = {};
+        for (const [projectName, node] of Object.entries(projectGraph.nodes)) {
+            projects[projectName] = node.data;
+        }
         const sourceFilePath = (0, runtime_lint_utils_1.getSourceFilePath)(context.filename ?? context.getFilename(), devkit_1.workspaceRoot);
         const sourceProject = (0, runtime_lint_utils_1.findProject)(projectGraph, projectRootMappings, sourceFilePath);
         // If source is not part of an nx workspace, return.
@@ -105,13 +110,13 @@ exports.default = utils_1.ESLintUtils.RuleCreator(() => ``)({
         return {
             ['JSONExpressionStatement > JSONObjectExpression'](node) {
                 if (sourceFilePath === generatorsJson) {
-                    checkCollectionFileNode(node, 'generator', context, options);
+                    checkCollectionFileNode(node, 'generator', context, projects);
                 }
                 else if (sourceFilePath === migrationsJson) {
-                    checkCollectionFileNode(node, 'migration', context, options);
+                    checkCollectionFileNode(node, 'migration', context, projects);
                 }
                 else if (sourceFilePath === executorsJson) {
-                    checkCollectionFileNode(node, 'executor', context, options);
+                    checkCollectionFileNode(node, 'executor', context, projects);
                 }
                 else if (sourceFilePath === packageJson) {
                     validatePackageGroup(node, context);
@@ -121,29 +126,7 @@ exports.default = utils_1.ESLintUtils.RuleCreator(() => ``)({
     },
 });
 function normalizeOptions(sourceProject, options) {
-    let rootDir;
-    let outDir;
     const base = { ...DEFAULT_OPTIONS, ...options };
-    let runtimeTsConfig;
-    if (sourceProject.data.targets?.build?.executor === '@nx/js:tsc') {
-        rootDir = sourceProject.data.targets.build.options.rootDir;
-        outDir = sourceProject.data.targets.build.options.outputPath;
-    }
-    if (!rootDir && !outDir) {
-        try {
-            runtimeTsConfig = require.resolve(path.join(devkit_1.workspaceRoot, sourceProject.data.root, base.tsConfig));
-            const tsConfig = (0, devkit_1.readJsonFile)(runtimeTsConfig);
-            rootDir ??= tsConfig.compilerOptions?.rootDir
-                ? path.join(sourceProject.data.root, tsConfig.compilerOptions.rootDir)
-                : undefined;
-            outDir ??= tsConfig.compilerOptions?.outDir
-                ? path.join(sourceProject.data.root, tsConfig.compilerOptions.outDir)
-                : undefined;
-        }
-        catch {
-            // nothing
-        }
-    }
     const pathPrefix = sourceProject.data.root !== '.' ? `${sourceProject.data.root}/` : '';
     return {
         ...base,
@@ -159,11 +142,9 @@ function normalizeOptions(sourceProject, options) {
         packageJson: base.packageJson
             ? `${pathPrefix}${base.packageJson}`
             : undefined,
-        rootDir,
-        outDir,
     };
 }
-function checkCollectionFileNode(baseNode, mode, context, options) {
+function checkCollectionFileNode(baseNode, mode, context, projects) {
     const schematicsRootNode = baseNode.properties.find((x) => x.key.type === 'JSONLiteral' && x.key.value === 'schematics');
     const generatorsRootNode = baseNode.properties.find((x) => x.key.type === 'JSONLiteral' && x.key.value === 'generators');
     const executorsRootNode = baseNode.properties.find((x) => x.key.type === 'JSONLiteral' && x.key.value === 'executors');
@@ -197,11 +178,11 @@ function checkCollectionFileNode(baseNode, mode, context, options) {
             });
         }
         else {
-            checkCollectionNode(collectionNode.value, mode, context, options);
+            checkCollectionNode(collectionNode.value, mode, context, projects);
         }
     }
 }
-function checkCollectionNode(baseNode, mode, context, options) {
+function checkCollectionNode(baseNode, mode, context, projects) {
     const entries = baseNode.properties;
     for (const entryNode of entries) {
         if (entryNode.value.type !== 'JSONObjectExpression') {
@@ -212,11 +193,11 @@ function checkCollectionNode(baseNode, mode, context, options) {
             });
         }
         else if (entryNode.key.type === 'JSONLiteral') {
-            validateEntry(entryNode.value, entryNode.key.value.toString(), mode, context, options);
+            validateEntry(entryNode.value, entryNode.key.value.toString(), mode, context, projects);
         }
     }
 }
-function validateEntry(baseNode, key, mode, context, options) {
+function validateEntry(baseNode, key, mode, context, projects) {
     const schemaNode = baseNode.properties.find((x) => x.key.type === 'JSONLiteral' && x.key.value === 'schema');
     if (mode !== 'migration' && !schemaNode) {
         context.report({
@@ -236,28 +217,20 @@ function validateEntry(baseNode, key, mode, context, options) {
             });
         }
         else {
-            let validJsonFound = false;
-            const schemaFilePath = path.join(path.dirname(context.filename ?? context.getFilename()), schemaNode.value.value);
             try {
-                (0, devkit_1.readJsonFile)(schemaFilePath);
-                validJsonFound = true;
+                (0, internal_2.resolveSchema)(schemaNode.value.value, path.dirname(context.filename ?? context.getFilename()), context.filename ?? context.getFilename(), projects);
             }
-            catch {
-                try {
-                    // Try to map back to source, which will be the case with TS solution setup.
-                    (0, devkit_1.readJsonFile)(schemaFilePath.replace(options.outDir, options.rootDir));
-                    validJsonFound = true;
+            catch (e) {
+                if (e instanceof internal_2.SchemaResolutionError) {
+                    context.report({
+                        messageId: 'invalidSchemaPath',
+                        node: schemaNode.value,
+                    });
                 }
-                catch {
-                    // nothing, will be reported below
+                else {
+                    throw e;
                 }
             }
-            if (!validJsonFound) {
-                context.report({
-                    messageId: 'invalidSchemaPath',
-                    node: schemaNode.value,
-                });
-            }
         }
     }
     const implementationNode = baseNode.properties.find((x) => x.key.type === 'JSONLiteral' &&
@@ -273,10 +246,10 @@ function validateEntry(baseNode, key, mode, context, options) {
         });
     }
     else if (implementationNode) {
-        validateImplementationNode(implementationNode, key, context, options);
+        validateImplementationNode(implementationNode, key, context, projects);
     }
     if (mode === 'migration' && promptNode) {
-        validatePromptNode(promptNode, key, context, options);
+        validatePromptNode(promptNode, key, context);
     }
     if (mode === 'migration') {
         const versionNode = baseNode.properties.find((x) => x.key.type === 'JSONLiteral' && x.key.value === 'version');
@@ -313,27 +286,7 @@ function validateEntry(baseNode, key, mode, context, options) {
         }
     }
 }
-// Under Node's native TS strip, swc-node isn't registered, so `require.resolve`
-// no longer auto-tries `.ts` extensions. Try them explicitly before giving up.
-const TS_EXTENSIONS = ['.ts', '.tsx', '.cts', '.mts'];
-function tryResolveImplementation(modulePath) {
-    try {
-        return require.resolve(modulePath);
-    }
-    catch {
-        // fall through
-    }
-    for (const ext of TS_EXTENSIONS) {
-        try {
-            return require.resolve(`${modulePath}${ext}`);
-        }
-        catch {
-            // try next
-        }
-    }
-    return undefined;
-}
-function validateImplementationNode(implementationNode, key, context, options) {
+function validateImplementationNode(implementationNode, key, context, projects) {
     if (implementationNode.value.type !== 'JSONLiteral' ||
         typeof implementationNode.value.value !== 'string') {
         context.report({
@@ -347,21 +300,24 @@ function validateImplementationNode(implementationNode, key, context, options) {
     else {
         const [implementationPath, identifier] = implementationNode.value.value.split('#');
         let resolvedPath;
-        const modulePath = path.join(path.dirname(context.filename ?? context.getFilename()), implementationPath);
-        resolvedPath = tryResolveImplementation(modulePath);
-        if (!resolvedPath && options.outDir && options.rootDir) {
-            resolvedPath = tryResolveImplementation(modulePath.replace(options.outDir, options.rootDir));
+        try {
+            resolvedPath = (0, internal_2.resolveImplementation)(implementationPath, path.dirname(context.filename ?? context.getFilename()), context.filename ?? context.getFilename(), projects);
         }
-        if (!resolvedPath) {
-            context.report({
-                messageId: 'invalidImplementationPath',
-                data: {
-                    key,
-                },
-                node: implementationNode.value,
-            });
+        catch (e) {
+            if (e instanceof internal_2.ImplementationResolutionError) {
+                context.report({
+                    messageId: 'invalidImplementationPath',
+                    data: {
+                        key,
+                    },
+                    node: implementationNode.value,
+                });
+            }
+            else {
+                throw e;
+            }
         }
-        if (identifier) {
+        if (resolvedPath && identifier) {
             try {
                 if (!checkIfIdentifierIsFunction(resolvedPath, identifier)) {
                     context.report({
@@ -387,7 +343,7 @@ function validateImplementationNode(implementationNode, key, context, options) {
         }
     }
 }
-function validatePromptNode(promptNode, key, context, options) {
+function validatePromptNode(promptNode, key, context) {
     if (promptNode.value.type !== 'JSONLiteral' ||
         typeof promptNode.value.value !== 'string') {
         context.report({
@@ -397,20 +353,13 @@ function validatePromptNode(promptNode, key, context, options) {
             },
             node: promptNode.value,
         });
+        return;
     }
-    else {
-        const promptPath = path.join(path.dirname(context.filename ?? context.getFilename()), promptNode.value.value);
-        let resolvedPath;
-        if ((0, fs_1.existsSync)(promptPath)) {
-            resolvedPath = promptPath;
-        }
-        else if (options.outDir && options.rootDir) {
-            const mapped = promptPath.replace(options.outDir, options.rootDir);
-            if ((0, fs_1.existsSync)(mapped)) {
-                resolvedPath = mapped;
-            }
-        }
-        if (!resolvedPath) {
+    try {
+        (0, internal_2.resolvePrompt)(promptNode.value.value, path.dirname(context.filename ?? context.getFilename()));
+    }
+    catch (e) {
+        if (e instanceof internal_2.PromptResolutionError) {
             context.report({
                 messageId: 'invalidPromptPath',
                 data: {
@@ -419,6 +368,9 @@ function validatePromptNode(promptNode, key, context, options) {
                 node: promptNode.value,
             });
         }
+        else {
+            throw e;
+        }
     }
 }
 function validatePackageGroup(baseNode, context) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/eslint-plugin",
-  "version": "23.0.0-beta.18",
+  "version": "23.0.0-beta.19",
   "private": false,
   "type": "commonjs",
   "files": [
@@ -98,11 +98,11 @@
     "jsonc-eslint-parser": "^2.1.0",
     "semver": "^7.6.3",
     "tslib": "^2.3.0",
-    "@nx/js": "23.0.0-beta.18",
-    "@nx/devkit": "23.0.0-beta.18"
+    "@nx/devkit": "23.0.0-beta.19",
+    "@nx/js": "23.0.0-beta.19"
   },
   "devDependencies": {
-    "nx": "23.0.0-beta.18"
+    "nx": "23.0.0-beta.19"
   },
   "publishConfig": {
     "access": "public"