@webpieces/nx-webpieces-rules 0.0.1 → 0.2.113

package/src/lib/{package-validator.ts → package-validator.js}

@@ -1,53 +1,29 @@
+"use strict";
 /**
  * Package Validator
  *
  * Validates that package.json dependencies match the project.json build.dependsOn
  * This ensures the two sources of truth don't drift apart.
  */
-
-import * as fs from 'fs';
-import * as path from 'path';
-import {
-    createProjectGraphAsync,
-    readProjectsConfigurationFromProjectGraph,
-} from '@nx/devkit';
-import { toError } from '../toError';
-
-/**
- * Validation result for a single project
- */
-export interface ProjectValidationResult {
-    project: string;
-    valid: boolean;
-    missingInPackageJson: string[];
-    extraInPackageJson: string[];
-}
-
-/**
- * Overall validation result
- */
-export interface ValidationResult {
-    valid: boolean;
-    errors: string[];
-    projectResults: ProjectValidationResult[];
-}
-
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validatePackageJsonDependencies = validatePackageJsonDependencies;
+const tslib_1 = require("tslib");
+const fs = tslib_1.__importStar(require("fs"));
+const path = tslib_1.__importStar(require("path"));
+const devkit_1 = require("@nx/devkit");
 /**
  * Read package.json dependencies for a project
  * Returns null if package.json doesn't exist (apps often don't have one)
  */
-function readPackageJsonDeps(workspaceRoot: string, projectRoot: string): string[] | null {
+function readPackageJsonDeps(workspaceRoot, projectRoot) {
     const packageJsonPath = path.join(workspaceRoot, projectRoot, 'package.json');
-
     if (!fs.existsSync(packageJsonPath)) {
         return null; // No package.json - skip validation for this project
     }
-
     // eslint-disable-next-line @webpieces/no-unmanaged-exceptions
     try {
         const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
-        const deps: string[] = [];
-
+        const deps = [];
         // Collect ALL dependencies from package.json
         for (const depType of ['dependencies', 'peerDependencies']) {
             const depObj = packageJson[depType] || {};
@@ -57,29 +33,25 @@ function readPackageJsonDeps(workspaceRoot: string, projectRoot: string): string
                 }
             }
         }
-
         return deps.sort();
-    } catch (err: unknown) {
+    }
+    catch (err) {
         //const error = toError(err);
         void err;
         console.warn(`Could not read package.json at ${packageJsonPath}`);
         return [];
     }
 }
-
 /**
  * Build map of project names to their package names
  * e.g., "core-util" → "@webpieces/core-util"
  */
-function buildProjectToPackageMap(
-    workspaceRoot: string,
-    // webpieces-disable no-any-unknown -- Nx devkit projectsConfig type is dynamic and not strongly typed
-    projectsConfig: any
-): Map<string, string> {
-    const map = new Map<string, string>();
-
+function buildProjectToPackageMap(workspaceRoot, 
+// webpieces-disable no-any-unknown -- Nx devkit projectsConfig type is dynamic and not strongly typed
+projectsConfig) {
+    const map = new Map();
     // webpieces-disable no-any-unknown -- Nx devkit projects config entries are untyped
-    for (const [projectName, config] of Object.entries<any>(projectsConfig.projects)) {
+    for (const [projectName, config] of Object.entries(projectsConfig.projects)) {
         const packageJsonPath = path.join(workspaceRoot, config.root, 'package.json');
         if (fs.existsSync(packageJsonPath)) {
             // eslint-disable-next-line @webpieces/no-unmanaged-exceptions
@@ -88,86 +60,54 @@ function buildProjectToPackageMap(
                 if (packageJson.name) {
                     map.set(projectName, packageJson.name);
                 }
-            } catch (err: unknown) {
+            }
+            catch (err) {
                 //const error = toError(err);
                 void err;
                 // Ignore parse errors
             }
         }
     }
-
     return map;
 }
-
-/**
- * Validate that package.json dependencies match the dependency graph
- *
- * For each project in the graph:
- * - Check that all graph dependencies exist in package.json
- * - Maps project names to package names for accurate comparison
- *
- * @param graph - Enhanced graph with project dependencies (uses project names)
- * @param workspaceRoot - Absolute path to workspace root
- * @returns Validation result with errors if any
- */
-interface GraphEntry {
-    level: number;
-    dependsOn: string[];
-}
-
-export async function validatePackageJsonDependencies(
-    graph: Record<string, GraphEntry>,
-    workspaceRoot: string
-): Promise<ValidationResult> {
-    const projectGraph = await createProjectGraphAsync();
-    const projectsConfig = readProjectsConfigurationFromProjectGraph(projectGraph);
-
+async function validatePackageJsonDependencies(graph, workspaceRoot) {
+    const projectGraph = await (0, devkit_1.createProjectGraphAsync)();
+    const projectsConfig = (0, devkit_1.readProjectsConfigurationFromProjectGraph)(projectGraph);
     // Build map: project name → package name
     const projectToPackage = buildProjectToPackageMap(workspaceRoot, projectsConfig);
-
-    const errors: string[] = [];
-    const projectResults: ProjectValidationResult[] = [];
-
+    const errors = [];
+    const projectResults = [];
     for (const [projectName, entry] of Object.entries(graph)) {
         // Find the project config using project name directly
         const projectConfig = projectsConfig.projects[projectName];
         if (!projectConfig) {
             continue;
         }
-
         const projectRoot = projectConfig.root;
         const packageJsonDeps = readPackageJsonDeps(workspaceRoot, projectRoot);
-
         if (packageJsonDeps === null) {
             continue;
         }
-
         // Convert graph dependencies (project names) to package names for comparison
-        const missingInPackageJson: string[] = [];
+        const missingInPackageJson = [];
         for (const depProjectName of entry.dependsOn) {
             const depPackageName = projectToPackage.get(depProjectName) || depProjectName;
             if (!packageJsonDeps.includes(depPackageName)) {
                 missingInPackageJson.push(depProjectName);
             }
         }
-
         // Check for extra dependencies in package.json (not critical, just informational)
-        const extraInPackageJson: string[] = [];
+        const extraInPackageJson = [];
         for (const dep of packageJsonDeps) {
             if (!entry.dependsOn.includes(dep)) {
                 extraInPackageJson.push(dep);
             }
         }
-
         const valid = missingInPackageJson.length === 0;
-
         if (!valid) {
-            errors.push(
-                `Project ${projectName} (${projectRoot}/package.json) is missing dependencies: ${missingInPackageJson.join(', ')}\n` +
-                    `  Fix: Add these to package.json dependencies`
-            );
+            errors.push(`Project ${projectName} (${projectRoot}/package.json) is missing dependencies: ${missingInPackageJson.join(', ')}\n` +
+                `  Fix: Add these to package.json dependencies`);
         }
-
         projectResults.push({
             project: projectName,
             valid,
@@ -175,10 +115,10 @@ export async function validatePackageJsonDependencies(
             extraInPackageJson,
         });
     }
-
     return {
         valid: errors.length === 0,
         errors,
         projectResults,
     };
 }
+//# sourceMappingURL=package-validator.js.map

package/src/lib/package-validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-validator.js","sourceRoot":"","sources":["../../../../../../packages/tooling/nx-webpieces-rules/src/lib/package-validator.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAgHH,0EAkEC;;AAhLD,+CAAyB;AACzB,mDAA6B;AAC7B,uCAGoB;AAsBpB;;;GAGG;AACH,SAAS,mBAAmB,CAAC,aAAqB,EAAE,WAAmB;IACnE,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;IAE9E,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC,CAAC,qDAAqD;IACtE,CAAC;IAED,8DAA8D;IAC9D,IAAI,CAAC;QACD,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;QAC1E,MAAM,IAAI,GAAa,EAAE,CAAC;QAE1B,6CAA6C;QAC7C,KAAK,MAAM,OAAO,IAAI,CAAC,cAAc,EAAE,kBAAkB,CAAC,EAAE,CAAC;YACzD,MAAM,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YAC1C,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;gBACxC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC1B,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACvB,CAAC;YACL,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;IACvB,CAAC;IAAC,OAAO,GAAY,EAAE,CAAC;QACpB,6BAA6B;QAC7B,KAAK,GAAG,CAAC;QACT,OAAO,CAAC,IAAI,CAAC,kCAAkC,eAAe,EAAE,CAAC,CAAC;QAClE,OAAO,EAAE,CAAC;IACd,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAS,wBAAwB,CAC7B,aAAqB;AACrB,sGAAsG;AACtG,cAAmB;IAEnB,MAAM,GAAG,GAAG,IAAI,GAAG,EAAkB,CAAC;IAEtC,oFAAoF;IACpF,KAAK,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAM,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC/E,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QAC9E,IAAI,EAAE,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,CAAC;YACjC,8DAA8D;YAC9D,IAAI,CAAC;gBACD,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;gBAC1E,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC;oBACnB,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;gBAC3C,CAAC;YACL,CAAC;YAAC,OAAO,GAAY,EAAE,CAAC;gBACpB,6BAA6B;gBAC7B,KAAK,GAAG,CAAC;gBACT,sBAAsB;YAC1B,CAAC;QACL,CAAC;IACL,CAAC;IAED,OAAO,GAAG,CAAC;AACf,CAAC;AAkBM,KAAK,UAAU,+BAA+B,CACjD,KAAiC,EACjC,aAAqB;IAErB,MAAM,YAAY,GAAG,MAAM,IAAA,gCAAuB,GAAE,CAAC;IACrD,MAAM,cAAc,GAAG,IAAA,kDAAyC,EAAC,YAAY,CAAC,CAAC;IAE/E,yCAAyC;IACzC,MAAM,gBAAgB,GAAG,wBAAwB,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;IAEjF,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,cAAc,GAA8B,EAAE,CAAC;IAErD,KAAK,MAAM,CAAC,WAAW,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACvD,sDAAsD;QACtD,MAAM,aAAa,GAAG,cAAc,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC3D,IAAI,CAAC,aAAa,EAAE,CAAC;YACjB,SAAS;QACb,CAAC;QAED,MAAM,WAAW,GAAG,aAAa,CAAC,IAAI,CAAC;QACvC,MAAM,eAAe,GAAG,mBAAmB,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;QAExE,IAAI,eAAe,KAAK,IAAI,EAAE,CAAC;YAC3B,SAAS;QACb,CAAC;QAED,6EAA6E;QAC7E,MAAM,oBAAoB,GAAa,EAAE,CAAC;QAC1C,KAAK,MAAM,cAAc,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YAC3C,MAAM,cAAc,GAAG,gBAAgB,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,cAAc,CAAC;YAC9E,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;gBAC5C,oBAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAC9C,CAAC;QACL,CAAC;QAED,kFAAkF;QAClF,MAAM,kBAAkB,GAAa,EAAE,CAAC;QACxC,KAAK,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;YAChC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACjC,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACjC,CAAC;QACL,CAAC;QAED,MAAM,KAAK,GAAG,oBAAoB,CAAC,MAAM,KAAK,CAAC,CAAC;QAEhD,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,MAAM,CAAC,IAAI,CACP,WAAW,WAAW,KAAK,WAAW,2CAA2C,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI;gBAChH,+CAA+C,CACtD,CAAC;QACN,CAAC;QAED,cAAc,CAAC,IAAI,CAAC;YAChB,OAAO,EAAE,WAAW;YACpB,KAAK;YACL,oBAAoB;YACpB,kBAAkB;SACrB,CAAC,CAAC;IACP,CAAC;IAED,OAAO;QACH,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC;QAC1B,MAAM;QACN,cAAc;KACjB,CAAC;AACN,CAAC","sourcesContent":["/**\n * Package Validator\n *\n * Validates that package.json dependencies match the project.json build.dependsOn\n * This ensures the two sources of truth don't drift apart.\n */\n\nimport * as fs from 'fs';\nimport * as path from 'path';\nimport {\n    createProjectGraphAsync,\n    readProjectsConfigurationFromProjectGraph,\n} from '@nx/devkit';\nimport { toError } from '../toError';\n\n/**\n * Validation result for a single project\n */\nexport interface ProjectValidationResult {\n    project: string;\n    valid: boolean;\n    missingInPackageJson: string[];\n    extraInPackageJson: string[];\n}\n\n/**\n * Overall validation result\n */\nexport interface ValidationResult {\n    valid: boolean;\n    errors: string[];\n    projectResults: ProjectValidationResult[];\n}\n\n/**\n * Read package.json dependencies for a project\n * Returns null if package.json doesn't exist (apps often don't have one)\n */\nfunction readPackageJsonDeps(workspaceRoot: string, projectRoot: string): string[] | null {\n    const packageJsonPath = path.join(workspaceRoot, projectRoot, 'package.json');\n\n    if (!fs.existsSync(packageJsonPath)) {\n        return null; // No package.json - skip validation for this project\n    }\n\n    // eslint-disable-next-line @webpieces/no-unmanaged-exceptions\n    try {\n        const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));\n        const deps: string[] = [];\n\n        // Collect ALL dependencies from package.json\n        for (const depType of ['dependencies', 'peerDependencies']) {\n            const depObj = packageJson[depType] || {};\n            for (const depName of Object.keys(depObj)) {\n                if (!deps.includes(depName)) {\n                    deps.push(depName);\n                }\n            }\n        }\n\n        return deps.sort();\n    } catch (err: unknown) {\n        //const error = toError(err);\n        void err;\n        console.warn(`Could not read package.json at ${packageJsonPath}`);\n        return [];\n    }\n}\n\n/**\n * Build map of project names to their package names\n * e.g., \"core-util\" → \"@webpieces/core-util\"\n */\nfunction buildProjectToPackageMap(\n    workspaceRoot: string,\n    // webpieces-disable no-any-unknown -- Nx devkit projectsConfig type is dynamic and not strongly typed\n    projectsConfig: any\n): Map<string, string> {\n    const map = new Map<string, string>();\n\n    // webpieces-disable no-any-unknown -- Nx devkit projects config entries are untyped\n    for (const [projectName, config] of Object.entries<any>(projectsConfig.projects)) {\n        const packageJsonPath = path.join(workspaceRoot, config.root, 'package.json');\n        if (fs.existsSync(packageJsonPath)) {\n            // eslint-disable-next-line @webpieces/no-unmanaged-exceptions\n            try {\n                const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));\n                if (packageJson.name) {\n                    map.set(projectName, packageJson.name);\n                }\n            } catch (err: unknown) {\n                //const error = toError(err);\n                void err;\n                // Ignore parse errors\n            }\n        }\n    }\n\n    return map;\n}\n\n/**\n * Validate that package.json dependencies match the dependency graph\n *\n * For each project in the graph:\n * - Check that all graph dependencies exist in package.json\n * - Maps project names to package names for accurate comparison\n *\n * @param graph - Enhanced graph with project dependencies (uses project names)\n * @param workspaceRoot - Absolute path to workspace root\n * @returns Validation result with errors if any\n */\ninterface GraphEntry {\n    level: number;\n    dependsOn: string[];\n}\n\nexport async function validatePackageJsonDependencies(\n    graph: Record<string, GraphEntry>,\n    workspaceRoot: string\n): Promise<ValidationResult> {\n    const projectGraph = await createProjectGraphAsync();\n    const projectsConfig = readProjectsConfigurationFromProjectGraph(projectGraph);\n\n    // Build map: project name → package name\n    const projectToPackage = buildProjectToPackageMap(workspaceRoot, projectsConfig);\n\n    const errors: string[] = [];\n    const projectResults: ProjectValidationResult[] = [];\n\n    for (const [projectName, entry] of Object.entries(graph)) {\n        // Find the project config using project name directly\n        const projectConfig = projectsConfig.projects[projectName];\n        if (!projectConfig) {\n            continue;\n        }\n\n        const projectRoot = projectConfig.root;\n        const packageJsonDeps = readPackageJsonDeps(workspaceRoot, projectRoot);\n\n        if (packageJsonDeps === null) {\n            continue;\n        }\n\n        // Convert graph dependencies (project names) to package names for comparison\n        const missingInPackageJson: string[] = [];\n        for (const depProjectName of entry.dependsOn) {\n            const depPackageName = projectToPackage.get(depProjectName) || depProjectName;\n            if (!packageJsonDeps.includes(depPackageName)) {\n                missingInPackageJson.push(depProjectName);\n            }\n        }\n\n        // Check for extra dependencies in package.json (not critical, just informational)\n        const extraInPackageJson: string[] = [];\n        for (const dep of packageJsonDeps) {\n            if (!entry.dependsOn.includes(dep)) {\n                extraInPackageJson.push(dep);\n            }\n        }\n\n        const valid = missingInPackageJson.length === 0;\n\n        if (!valid) {\n            errors.push(\n                `Project ${projectName} (${projectRoot}/package.json) is missing dependencies: ${missingInPackageJson.join(', ')}\\n` +\n                    `  Fix: Add these to package.json dependencies`\n            );\n        }\n\n        projectResults.push({\n            project: projectName,\n            valid,\n            missingInPackageJson,\n            extraInPackageJson,\n        });\n    }\n\n    return {\n        valid: errors.length === 0,\n        errors,\n        projectResults,\n    };\n}\n"]}

package/src/plugin.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Unified Nx Inference Plugin for @webpieces/nx-webpieces-rules
+ *
+ * This plugin automatically creates targets for:
+ * 1. Workspace-level architecture validation (generate, visualize, validate-*)
+ * 2. Per-project circular dependency checking
+ *
+ * Install with: nx add @webpieces/nx-webpieces-rules
+ *
+ * Usage:
+ * Add to nx.json plugins array:
+ * {
+ *   "plugins": ["@webpieces/nx-webpieces-rules"]
+ * }
+ *
+ * Then all targets appear automatically without manual project.json configuration.
+ */
+import type { CreateNodesV2 } from '@nx/devkit';
+/**
+ * Circular dependency checking options
+ */
+export interface CircularDepsOptions {
+    enabled?: boolean;
+    targetName?: string;
+    excludePatterns?: string[];
+}
+/**
+ * Validation options for architecture checks
+ */
+export interface ValidationOptions {
+    noCycles?: boolean;
+    noSkipLevelDeps?: boolean;
+    architectureUnchanged?: boolean;
+    validatePackageJson?: boolean;
+    validateNewMethods?: boolean;
+    validateModifiedMethods?: boolean;
+    validateModifiedFiles?: boolean;
+    validateVersionsLocked?: boolean;
+    validateTsInSrc?: boolean;
+    newMethodsMaxLines?: number;
+    modifiedAndNewMethodsMaxLines?: number;
+    modifiedFilesMaxLines?: number;
+    /**
+     * Validation mode for method/file size limits:
+     * - STRICT: All limits enforced, disable comments ignored
+     * - NORMAL: Limits enforced, disable comments with dates work
+     * - OFF: Skip size validations entirely (for fast iteration)
+     */
+    validationMode?: 'STRICT' | 'NORMAL' | 'OFF';
+}
+/**
+ * Feature flags for workspace targets
+ */
+export interface FeatureOptions {
+    generate?: boolean;
+    visualize?: boolean;
+}
+/**
+ * Workspace-level configuration options
+ */
+export interface WorkspaceOptions {
+    enabled?: boolean;
+    targetPrefix?: string;
+    graphPath?: string;
+    validations?: ValidationOptions;
+    features?: FeatureOptions;
+}
+/**
+ * Configuration for @webpieces/nx-webpieces-rules Nx plugin
+ */
+export interface ArchitecturePluginOptions {
+    circularDeps?: CircularDepsOptions;
+    workspace?: WorkspaceOptions;
+}
+/**
+ * Nx V2 Inference Plugin
+ * Matches project.json and package.json files to create targets
+ */
+export declare const createNodesV2: CreateNodesV2<ArchitecturePluginOptions>;
+/**
+ * Export plugin as default for Nx
+ */
+declare const _default: {
+    createNodesV2: CreateNodesV2<ArchitecturePluginOptions>;
+};
+export default _default;