npm - @webpieces/nx-webpieces-rules - Versions diffs - 0.0.1 - Mend

@webpieces/nx-webpieces-rules 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (61) hide show

package/LICENSE +373 -0
package/executors.json +124 -0
package/package.json +36 -0
package/src/executor-result.ts +7 -0
package/src/executors/generate/executor.ts +61 -0
package/src/executors/generate/schema.json +14 -0
package/src/executors/help/executor.ts +63 -0
package/src/executors/help/schema.json +7 -0
package/src/executors/validate-architecture-unchanged/executor.ts +253 -0
package/src/executors/validate-architecture-unchanged/schema.json +14 -0
package/src/executors/validate-catch-error-pattern/executor.ts +11 -0
package/src/executors/validate-catch-error-pattern/schema.json +24 -0
package/src/executors/validate-code/executor.ts +11 -0
package/src/executors/validate-code/schema.json +287 -0
package/src/executors/validate-dtos/executor.ts +11 -0
package/src/executors/validate-dtos/schema.json +33 -0
package/src/executors/validate-eslint-sync/executor.ts +87 -0
package/src/executors/validate-eslint-sync/schema.json +7 -0
package/src/executors/validate-modified-files/executor.ts +11 -0
package/src/executors/validate-modified-files/schema.json +25 -0
package/src/executors/validate-modified-methods/executor.ts +11 -0
package/src/executors/validate-modified-methods/schema.json +25 -0
package/src/executors/validate-new-methods/executor.ts +11 -0
package/src/executors/validate-new-methods/schema.json +25 -0
package/src/executors/validate-no-any-unknown/executor.ts +11 -0
package/src/executors/validate-no-any-unknown/schema.json +24 -0
package/src/executors/validate-no-architecture-cycles/executor.ts +63 -0
package/src/executors/validate-no-architecture-cycles/schema.json +8 -0
package/src/executors/validate-no-destructure/executor.ts +11 -0
package/src/executors/validate-no-destructure/schema.json +24 -0
package/src/executors/validate-no-direct-api-resolver/executor.ts +11 -0
package/src/executors/validate-no-direct-api-resolver/schema.json +29 -0
package/src/executors/validate-no-implicit-any/executor.ts +11 -0
package/src/executors/validate-no-implicit-any/schema.json +24 -0
package/src/executors/validate-no-inline-types/executor.ts +11 -0
package/src/executors/validate-no-inline-types/schema.json +24 -0
package/src/executors/validate-no-skiplevel-deps/executor.ts +274 -0
package/src/executors/validate-no-skiplevel-deps/schema.json +8 -0
package/src/executors/validate-no-unmanaged-exceptions/executor.ts +11 -0
package/src/executors/validate-no-unmanaged-exceptions/schema.json +24 -0
package/src/executors/validate-packagejson/executor.ts +76 -0
package/src/executors/validate-packagejson/schema.json +8 -0
package/src/executors/validate-prisma-converters/executor.ts +11 -0
package/src/executors/validate-prisma-converters/schema.json +38 -0
package/src/executors/validate-return-types/executor.ts +11 -0
package/src/executors/validate-return-types/schema.json +24 -0
package/src/executors/validate-ts-in-src/executor.ts +283 -0
package/src/executors/validate-ts-in-src/schema.json +25 -0
package/src/executors/validate-versions-locked/executor.ts +376 -0
package/src/executors/validate-versions-locked/schema.json +8 -0
package/src/executors/visualize/executor.ts +65 -0
package/src/executors/visualize/schema.json +14 -0
package/src/index.ts +9 -0
package/src/lib/graph-comparator.ts +154 -0
package/src/lib/graph-generator.ts +97 -0
package/src/lib/graph-loader.ts +119 -0
package/src/lib/graph-sorter.ts +137 -0
package/src/lib/graph-visualizer.ts +253 -0
package/src/lib/package-validator.ts +184 -0
package/src/plugin.ts +666 -0
package/src/toError.ts +36 -0

package/src/lib/graph-visualizer.ts ADDED Viewed

@@ -0,0 +1,253 @@
+/**
+ * Graph Visualizer
+ *
+ * Generates visual representations of the architecture graph:
+ * - DOT format (for Graphviz)
+ * - Interactive HTML (using viz.js)
+ *
+ * Output files go to tmp/webpieces/ for easy viewing without committing.
+ */
+import * as fs from 'fs';
+import * as path from 'path';
+import { execSync } from 'child_process';
+import type { EnhancedGraph } from './graph-sorter';
+import { toError } from '../toError';
+/**
+ * Level colors for visualization
+ */
+const LEVEL_COLORS: Record<number, string> = {
+    0: '#E8F5E9', // Light green - foundation
+    1: '#E3F2FD', // Light blue - middleware
+    2: '#FFF3E0', // Light orange - applications
+    3: '#FCE4EC', // Light pink - higher level
+};
+/**
+ * Remove scope from name for display
+ * '@scope/name' → 'name'
+ * 'name' → 'name'
+ */
+function getShortName(name: string): string {
+    return name.includes('/') ? name.split('/').pop()! : name;
+}
+/**
+ * Generate Graphviz DOT format from the graph
+ */
+export function generateDot(graph: EnhancedGraph, title: string = 'WebPieces Architecture'): string {
+    let dot = 'digraph Architecture {\n';
+    dot += '  rankdir=TB;\n';
+    dot += '  node [shape=box, style=filled, fontname="Arial"];\n';
+    dot += '  edge [fontname="Arial"];\n\n';
+    // Group projects by level
+    const levels: Record<number, string[]> = {};
+    for (const [project, info] of Object.entries(graph)) {
+        if (!levels[info.level]) levels[info.level] = [];
+        levels[info.level].push(project);
+    }
+    // Create nodes with level-based colors
+    for (const [project, info] of Object.entries(graph)) {
+        const shortName = getShortName(project);
+        const color = LEVEL_COLORS[info.level] || '#F5F5F5';
+        dot += `  "${shortName}" [fillcolor="${color}", label="${shortName}\\n(L${info.level})"];\n`;
+    }
+    dot += '\n';
+    // Create same-rank subgraphs for each level
+    for (const [level, projects] of Object.entries(levels)) {
+        dot += `  { rank=same; `;
+        projects.forEach((p) => {
+            const shortName = getShortName(p);
+            dot += `"${shortName}"; `;
+        });
+        dot += '}\n';
+    }
+    dot += '\n';
+    // Create edges (dependencies)
+    for (const [project, info] of Object.entries(graph)) {
+        const shortName = getShortName(project);
+        for (const dep of info.dependsOn || []) {
+            const depShortName = getShortName(dep);
+            dot += `  "${shortName}" -> "${depShortName}";\n`;
+        }
+    }
+    dot += '\n  labelloc="t";\n';
+    dot += `  label="${title}\\n(from architecture/dependencies.json)";\n`;
+    dot += '  fontsize=20;\n';
+    dot += '}\n';
+    return dot;
+}
+/**
+ * Generate interactive HTML with embedded SVG using viz.js
+ */
+export function generateHTML(dot: string, title: string = 'WebPieces Architecture'): string {
+    const styles = generateHTMLStyles();
+    const legend = generateHTMLLegend();
+    const script = generateHTMLScript(dot);
+    return `<!DOCTYPE html>
+<html>
+<head>
+    <title>${title}</title>
+    <script src="https://cdn.jsdelivr.net/npm/viz.js@2.1.2/viz.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/viz.js@2.1.2/full.render.js"></script>
+    <style>${styles}</style>
+</head>
+<body>
+    <h1>${title}</h1>
+    ${legend}
+    <div id="graph"></div>
+    <script>${script}</script>
+</body>
+</html>`;
+}
+function generateHTMLStyles(): string {
+    return `
+        body {
+            margin: 0;
+            padding: 20px;
+            font-family: Arial, sans-serif;
+            background: #f5f5f5;
+        }
+        h1 {
+            text-align: center;
+            color: #333;
+        }
+        #graph {
+            text-align: center;
+            background: white;
+            padding: 20px;
+            border-radius: 8px;
+            box-shadow: 0 2px 4px rgba(0,0,0,0.1);
+        }
+        .legend {
+            margin: 20px auto;
+            max-width: 600px;
+            padding: 15px;
+            background: white;
+            border-radius: 8px;
+            box-shadow: 0 2px 4px rgba(0,0,0,0.1);
+        }
+        .legend h2 {
+            margin-top: 0;
+        }
+        .legend-item {
+            margin: 8px 0;
+        }
+        .legend-box {
+            display: inline-block;
+            width: 20px;
+            height: 20px;
+            border: 1px solid #ccc;
+            margin-right: 10px;
+            vertical-align: middle;
+        }
+    `;
+}
+function generateHTMLLegend(): string {
+    return `<div class="legend">
+        <h2>Legend</h2>
+        <div class="legend-item">
+            <span class="legend-box" style="background: #E8F5E9;"></span>
+            <strong>Level 0:</strong> Foundation libraries (no dependencies)
+        </div>
+        <div class="legend-item">
+            <span class="legend-box" style="background: #E3F2FD;"></span>
+            <strong>Level 1:</strong> Middleware libraries (depend on Level 0)
+        </div>
+        <div class="legend-item">
+            <span class="legend-box" style="background: #FFF3E0;"></span>
+            <strong>Level 2:</strong> Applications (depend on Level 1)
+        </div>
+        <div class="legend-item" style="margin-top: 15px;">
+            <em>Note: Transitive dependencies are allowed but not shown in the graph.</em>
+        </div>
+    </div>`;
+}
+function generateHTMLScript(dot: string): string {
+    return `
+        const dot = ${JSON.stringify(dot)};
+        const viz = new Viz();
+        viz.renderSVGElement(dot)
+            .then(element => {
+                document.getElementById('graph').appendChild(element);
+            })
+            .catch(err => {
+                console.error(err);
+                document.getElementById('graph').innerHTML = '<pre>' + err + '</pre>';
+            });
+    `;
+}
+interface VisualizationPaths {
+    dotPath: string;
+    htmlPath: string;
+}
+/**
+ * Write visualization files to tmp/webpieces/
+ */
+export function writeVisualization(
+    graph: EnhancedGraph,
+    workspaceRoot: string,
+    title: string = 'WebPieces Architecture'
+): VisualizationPaths {
+    const outputDir = path.join(workspaceRoot, 'tmp', 'webpieces');
+    // Ensure directory exists
+    if (!fs.existsSync(outputDir)) {
+        fs.mkdirSync(outputDir, { recursive: true });
+    }
+    // Generate DOT
+    const dot = generateDot(graph, title);
+    const dotPath = path.join(outputDir, 'architecture.dot');
+    fs.writeFileSync(dotPath, dot, 'utf-8');
+    // Generate HTML
+    const html = generateHTML(dot, title);
+    const htmlPath = path.join(outputDir, 'architecture.html');
+    fs.writeFileSync(htmlPath, html, 'utf-8');
+    return { dotPath, htmlPath };
+}
+/**
+ * Open the HTML visualization in the default browser
+ */
+export function openVisualization(htmlPath: string): boolean {
+    // eslint-disable-next-line @webpieces/no-unmanaged-exceptions
+    try {
+        const platform = process.platform;
+        let openCommand: string;
+        if (platform === 'darwin') {
+            openCommand = `open "${htmlPath}"`;
+        } else if (platform === 'win32') {
+            openCommand = `start "" "${htmlPath}"`;
+        } else {
+            openCommand = `xdg-open "${htmlPath}"`;
+        }
+        execSync(openCommand, { stdio: 'ignore' });
+        return true;
+    } catch (err: unknown) {
+        //const error = toError(err);
+        void err;
+        return false;
+    }
+}

package/src/lib/package-validator.ts ADDED Viewed

@@ -0,0 +1,184 @@
+/**
+ * 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[];
+}
+/**
+ * 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 {
+    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[] = [];
+        // Collect ALL dependencies from package.json
+        for (const depType of ['dependencies', 'peerDependencies']) {
+            const depObj = packageJson[depType] || {};
+            for (const depName of Object.keys(depObj)) {
+                if (!deps.includes(depName)) {
+                    deps.push(depName);
+                }
+            }
+        }
+        return deps.sort();
+    } catch (err: unknown) {
+        //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>();
+    // webpieces-disable no-any-unknown -- Nx devkit projects config entries are untyped
+    for (const [projectName, config] of Object.entries<any>(projectsConfig.projects)) {
+        const packageJsonPath = path.join(workspaceRoot, config.root, 'package.json');
+        if (fs.existsSync(packageJsonPath)) {
+            // eslint-disable-next-line @webpieces/no-unmanaged-exceptions
+            try {
+                const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
+                if (packageJson.name) {
+                    map.set(projectName, packageJson.name);
+                }
+            } catch (err: unknown) {
+                //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);
+    // Build map: project name → package name
+    const projectToPackage = buildProjectToPackageMap(workspaceRoot, projectsConfig);
+    const errors: string[] = [];
+    const projectResults: ProjectValidationResult[] = [];
+    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[] = [];
+        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[] = [];
+        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`
+            );
+        }
+        projectResults.push({
+            project: projectName,
+            valid,
+            missingInPackageJson,
+            extraInPackageJson,
+        });
+    }
+    return {
+        valid: errors.length === 0,
+        errors,
+        projectResults,
+    };
+}