@webpieces/nx-webpieces-rules 0.0.1 → 0.2.114

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;;AA0OH,0EAqCC;;AA7QD,+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;AAwBD;;;;;;;;;GASG;AACH,SAAS,wBAAwB,CAC7B,WAAmB,EACnB,KAAiC;IAEjC,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAClC,MAAM,KAAK,GAAG,CAAC,WAAW,CAAC,CAAC;IAC5B,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;QAC7B,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QAC7B,IAAI,CAAC,KAAK;YAAE,SAAS;QACrB,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YAChC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBACpB,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBACjB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACpB,CAAC;QACL,CAAC;IACL,CAAC;IACD,OAAO,OAAO,CAAC;AACnB,CAAC;AAOD,SAAS,YAAY,CACjB,eAAyB,EACzB,KAAiB,EACjB,iBAA8B,EAC9B,gBAAqC,EACrC,gBAAqC;IAErC,MAAM,oBAAoB,GAAa,EAAE,CAAC;IAC1C,KAAK,MAAM,cAAc,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;QAC3C,MAAM,cAAc,GAAG,gBAAgB,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,cAAc,CAAC;QAC9E,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;YAC5C,oBAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC9C,CAAC;IACL,CAAC;IAED,2EAA2E;IAC3E,0EAA0E;IAC1E,qEAAqE;IACrE,MAAM,kBAAkB,GAAa,EAAE,CAAC;IACxC,MAAM,kBAAkB,GAAa,EAAE,CAAC;IACxC,KAAK,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QAChC,MAAM,cAAc,GAAG,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACjD,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;YAC/B,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC7B,SAAS;QACb,CAAC;QACD,IAAI,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC;YAAE,SAAS;QACvD,IAAI,iBAAiB,CAAC,GAAG,CAAC,cAAc,CAAC;YAAE,SAAS;QACpD,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,CAAC;AAC5E,CAAC;AAED,SAAS,qBAAqB,CAC1B,WAAmB,EACnB,KAAiB,EACjB,WAAmB,EACnB,eAAyB,EACzB,KAAiC,EACjC,gBAAqC,EACrC,gBAAqC;IAErC,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACvE,MAAM,cAAc,GAAG,YAAY,CAC/B,eAAe,EACf,KAAK,EACL,iBAAiB,EACjB,gBAAgB,EAChB,gBAAgB,CACnB,CAAC;IAEF,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,IAAI,cAAc,CAAC,oBAAoB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACjD,MAAM,CAAC,IAAI,CACP,WAAW,WAAW,KAAK,WAAW,2CAA2C,cAAc,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI;YAC/H,+CAA+C,CACtD,CAAC;IACN,CAAC;IACD,KAAK,MAAM,QAAQ,IAAI,cAAc,CAAC,kBAAkB,EAAE,CAAC;QACvD,MAAM,YAAY,GAAG,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACpD,MAAM,CAAC,IAAI,CACP,WAAW,WAAW,KAAK,WAAW,uBAAuB,QAAQ,oEAAoE,WAAW,MAAM,YAAY,6BAA6B;YAC/L,sBAAsB,YAAY,mGAAmG,QAAQ,mCAAmC,CACvL,CAAC;IACN,CAAC;IAED,MAAM,KAAK,GACP,cAAc,CAAC,oBAAoB,CAAC,MAAM,KAAK,CAAC;QAChD,cAAc,CAAC,kBAAkB,CAAC,MAAM,KAAK,CAAC,CAAC;IACnD,OAAO;QACH,MAAM,EAAE;YACJ,OAAO,EAAE,WAAW;YACpB,KAAK;YACL,oBAAoB,EAAE,cAAc,CAAC,oBAAoB;YACzD,kBAAkB,EAAE,cAAc,CAAC,kBAAkB;SACxD;QACD,MAAM;KACT,CAAC;AACN,CAAC;AAEM,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,MAAM,gBAAgB,GAAG,wBAAwB,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;IACjF,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAkB,CAAC;IACnD,KAAK,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,gBAAgB,CAAC,OAAO,EAAE,EAAE,CAAC;QAC3D,gBAAgB,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC5C,CAAC;IAED,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,MAAM,aAAa,GAAG,cAAc,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC3D,IAAI,CAAC,aAAa;YAAE,SAAS;QAE7B,MAAM,eAAe,GAAG,mBAAmB,CAAC,aAAa,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;QAC/E,IAAI,eAAe,KAAK,IAAI;YAAE,SAAS;QAEvC,MAAM,UAAU,GAAG,qBAAqB,CACpC,WAAW,EACX,KAAK,EACL,aAAa,CAAC,IAAI,EAClB,eAAe,EACf,KAAK,EACL,gBAAgB,EAChB,gBAAgB,CACnB,CAAC;QACF,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACvC,MAAM,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;AAClE,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\ninterface DepClassification {\n    missingInPackageJson: string[];\n    extraInPackageJson: string[];\n    extraWorkspaceDeps: string[];\n}\n\n/**\n * Compute the transitive closure of a project's dependencies in the graph.\n * Example: server → [core-meta, http-server]; transitive closure includes\n * http-server and everything http-server reaches (http-routing, http-filters,\n * core-context, core-util, http-api).\n *\n * Used to allow package.json entries for transitive deps (a legitimate pattern:\n * npm install brings the whole dependency tree, so a consumer may list any\n * reachable package directly).\n */\nfunction computeTransitiveClosure(\n    projectName: string,\n    graph: Record<string, GraphEntry>\n): Set<string> {\n    const closure = new Set<string>();\n    const stack = [projectName];\n    while (stack.length > 0) {\n        const current = stack.pop()!;\n        const entry = graph[current];\n        if (!entry) continue;\n        for (const dep of entry.dependsOn) {\n            if (!closure.has(dep)) {\n                closure.add(dep);\n                stack.push(dep);\n            }\n        }\n    }\n    return closure;\n}\n\ninterface SingleProjectValidation {\n    result: ProjectValidationResult;\n    errors: string[];\n}\n\nfunction classifyDeps(\n    packageJsonDeps: string[],\n    entry: GraphEntry,\n    transitiveClosure: Set<string>,\n    projectToPackage: Map<string, string>,\n    packageToProject: Map<string, string>\n): DepClassification {\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    // Workspace extras are OK if reachable via transitive closure (matches the\n    // ESLint enforce-architecture rule which also allows transitive imports).\n    // Only flag extras that are NOT reachable at all — real graph drift.\n    const extraInPackageJson: string[] = [];\n    const extraWorkspaceDeps: string[] = [];\n    for (const dep of packageJsonDeps) {\n        const depProjectName = packageToProject.get(dep);\n        if (depProjectName === undefined) {\n            extraInPackageJson.push(dep);\n            continue;\n        }\n        if (entry.dependsOn.includes(depProjectName)) continue;\n        if (transitiveClosure.has(depProjectName)) continue;\n        extraWorkspaceDeps.push(dep);\n    }\n\n    return { missingInPackageJson, extraInPackageJson, extraWorkspaceDeps };\n}\n\nfunction validateSingleProject(\n    projectName: string,\n    entry: GraphEntry,\n    projectRoot: string,\n    packageJsonDeps: string[],\n    graph: Record<string, GraphEntry>,\n    projectToPackage: Map<string, string>,\n    packageToProject: Map<string, string>\n): SingleProjectValidation {\n    const transitiveClosure = computeTransitiveClosure(projectName, graph);\n    const classification = classifyDeps(\n        packageJsonDeps,\n        entry,\n        transitiveClosure,\n        projectToPackage,\n        packageToProject\n    );\n\n    const errors: string[] = [];\n    if (classification.missingInPackageJson.length > 0) {\n        errors.push(\n            `Project ${projectName} (${projectRoot}/package.json) is missing dependencies: ${classification.missingInPackageJson.join(', ')}\\n` +\n                `  Fix: Add these to package.json dependencies`\n        );\n    }\n    for (const extraPkg of classification.extraWorkspaceDeps) {\n        const extraProject = packageToProject.get(extraPkg);\n        errors.push(\n            `Project ${projectName} (${projectRoot}/package.json) has \"${extraPkg}\" in package.json but architecture/dependencies.json has no path ${projectName} → ${extraProject} (not even transitively).\\n` +\n                `  Fix: Either add \"${extraProject}:build\" to project.json:build.dependsOn (then run \\`nx run architecture:generate\\`), or remove \"${extraPkg}\" from package.json dependencies.`\n        );\n    }\n\n    const valid =\n        classification.missingInPackageJson.length === 0 &&\n        classification.extraWorkspaceDeps.length === 0;\n    return {\n        result: {\n            project: projectName,\n            valid,\n            missingInPackageJson: classification.missingInPackageJson,\n            extraInPackageJson: classification.extraInPackageJson,\n        },\n        errors,\n    };\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    const projectToPackage = buildProjectToPackageMap(workspaceRoot, projectsConfig);\n    const packageToProject = new Map<string, string>();\n    for (const [projName, pkgName] of projectToPackage.entries()) {\n        packageToProject.set(pkgName, projName);\n    }\n\n    const errors: string[] = [];\n    const projectResults: ProjectValidationResult[] = [];\n\n    for (const [projectName, entry] of Object.entries(graph)) {\n        const projectConfig = projectsConfig.projects[projectName];\n        if (!projectConfig) continue;\n\n        const packageJsonDeps = readPackageJsonDeps(workspaceRoot, projectConfig.root);\n        if (packageJsonDeps === null) continue;\n\n        const validation = validateSingleProject(\n            projectName,\n            entry,\n            projectConfig.root,\n            packageJsonDeps,\n            graph,\n            projectToPackage,\n            packageToProject\n        );\n        projectResults.push(validation.result);\n        errors.push(...validation.errors);\n    }\n\n    return { valid: errors.length === 0, errors, projectResults };\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;