@webpieces/dev-config 0.2.17 → 0.2.21

package/eslint-plugin/rules/enforce-architecture.js

@@ -0,0 +1,406 @@
+"use strict";
+/**
+ * ESLint rule to enforce architecture boundaries
+ *
+ * Validates that imports from @webpieces/* packages comply with the
+ * blessed dependency graph in .graphs/dependencies.json
+ *
+ * Supports transitive dependencies: if A depends on B and B depends on C,
+ * then A can import from C.
+ *
+ * Configuration:
+ * '@webpieces/enforce-architecture': 'error'
+ */
+const tslib_1 = require("tslib");
+const fs = tslib_1.__importStar(require("fs"));
+const path = tslib_1.__importStar(require("path"));
+const DEPENDENCIES_DOC_CONTENT = `# AI Agent Instructions: Architecture Dependency Violation
+
+**READ THIS FILE FIRST before making any changes!**
+
+## ⚠️ CRITICAL WARNING ⚠️
+
+**This is a VERY IMPORTANT change that has LARGE REPERCUSSIONS later!**
+
+Adding new dependencies creates technical debt that compounds over time:
+- Creates coupling between packages that may be hard to undo
+- Can create circular dependency tangles
+- Makes packages harder to test in isolation
+- Increases build times and bundle sizes
+- May force unnecessary upgrades across the codebase
+
+**DO NOT add dependencies without senior developer approval!**
+
+## Understanding the Error
+
+You've attempted to import from a package that is not in your project's allowed dependencies.
+The architecture enforces a layered dependency structure where:
+- Level 0 packages are foundation packages with NO dependencies on other @webpieces packages
+- Higher level packages can only depend on lower level packages
+- All dependencies must be explicitly declared
+
+## Steps to Resolve
+
+### Step 1: Generate Current Dependency Graph
+Run this command to see the current architecture:
+\`\`\`bash
+npx nx run architecture:generate
+\`\`\`
+This creates/updates \`architecture/dependencies.json\` showing all packages and their levels.
+
+### Step 2: Analyze the Proposed Change
+Ask yourself:
+1. **Is this import truly necessary?** Can you refactor to avoid it?
+2. **Should the code move instead?** Maybe the code belongs in a different package.
+3. **Will this create a cycle?** Use \`npx nx graph\` to visualize dependencies.
+4. **Can you use an interface/abstraction?** Define interface in lower-level package, implement in higher-level.
+
+### Step 3: Get Senior Developer Approval
+
+## 🛑 AI AGENTS: STOP HERE AND ASK FOR HUMAN APPROVAL! 🛑
+
+**YOU MUST NOT PROCEED TO STEP 4 WITHOUT EXPLICIT HUMAN APPROVAL!**
+
+**REQUIRED**: Discuss this architectural change with a senior developer before proceeding.
+- Explain why the dependency is needed
+- Show you've considered alternatives (Step 2)
+- **WAIT for explicit approval before making ANY changes to project.json or package.json**
+
+**AI Agent Instructions:**
+1. Present your analysis from Step 2 to the human
+2. Explain which package needs which dependency and why
+3. ASK: "Do you approve adding this dependency?"
+4. **DO NOT modify project.json or package.json until you receive explicit "yes" or approval**
+
+### Step 4: If Approved, Add the Dependency
+
+## ⛔ NEVER MODIFY THESE FILES WITHOUT HUMAN APPROVAL FROM STEP 3! ⛔
+
+Only after receiving explicit human approval in Step 3, make these changes:
+
+1. **Update project.json** - Add to \`build.dependsOn\`:
+   \`\`\`json
+   {
+     "targets": {
+       "build": {
+         "dependsOn": ["^build", "dep1:build", "NEW_PACKAGE:build"]
+       }
+     }
+   }
+   \`\`\`
+
+2. **Update package.json** - Add to \`dependencies\`:
+   \`\`\`json
+   {
+     "dependencies": {
+       "@webpieces/NEW_PACKAGE": "*"
+     }
+   }
+   \`\`\`
+
+### Step 5: Update Architecture Definition
+Run this command to validate and update the architecture:
+\`\`\`bash
+npx nx run architecture:validate --mode=update
+\`\`\`
+
+This will:
+- Detect any cycles (which MUST be fixed before proceeding)
+- Update \`architecture/dependencies.json\` with the new dependency
+- Recalculate package levels
+
+### Step 6: Verify No Cycles
+\`\`\`bash
+npx nx run architecture:validate
+\`\`\`
+
+If cycles are detected, you MUST refactor to break the cycle. Common strategies:
+- Move shared code to a lower-level package
+- Use dependency inversion (interfaces in low-level, implementations in high-level)
+- Restructure package boundaries
+
+## Alternative Solutions (Preferred over adding dependencies)
+
+### Option A: Move the Code
+If you need functionality from another package, consider moving that code to a shared lower-level package.
+
+### Option B: Dependency Inversion
+Define an interface in the lower-level package, implement it in the higher-level package:
+\`\`\`typescript
+// In foundation package (level 0)
+export interface Logger { log(msg: string): void; }
+
+// In higher-level package
+export class ConsoleLogger implements Logger { ... }
+\`\`\`
+
+### Option C: Pass Dependencies as Parameters
+Instead of importing, receive the dependency as a constructor or method parameter.
+
+## Remember
+- Every dependency you add today is technical debt for tomorrow
+- The best dependency is the one you don't need
+- When in doubt, refactor rather than add dependencies
+`;
+// Module-level flag to prevent redundant file creation
+let dependenciesDocCreated = false;
+/**
+ * Ensure a documentation file exists at the given path.
+ */
+function ensureDocFile(docPath, content) {
+    try {
+        fs.mkdirSync(path.dirname(docPath), { recursive: true });
+        fs.writeFileSync(docPath, content, 'utf-8');
+        return true;
+    }
+    catch (err) {
+        void err;
+        console.warn(`[webpieces] Could not create doc file: ${docPath}`);
+        return false;
+    }
+}
+/**
+ * Ensure the dependencies documentation file exists.
+ * Called when an architecture violation is detected.
+ */
+function ensureDependenciesDoc(workspaceRoot) {
+    if (dependenciesDocCreated)
+        return;
+    const docPath = path.join(workspaceRoot, 'tmp', 'webpieces', 'webpieces.dependencies.md');
+    if (ensureDocFile(docPath, DEPENDENCIES_DOC_CONTENT)) {
+        dependenciesDocCreated = true;
+    }
+}
+// Cache for blessed graph (loaded once per lint run)
+let cachedGraph = null;
+let cachedGraphPath = null;
+// Cache for project mappings
+let cachedProjectMappings = null;
+/**
+ * Find workspace root by walking up from file location
+ */
+function findWorkspaceRoot(startPath) {
+    let currentDir = path.dirname(startPath);
+    for (let i = 0; i < 20; i++) {
+        const packagePath = path.join(currentDir, 'package.json');
+        if (fs.existsSync(packagePath)) {
+            try {
+                const pkg = JSON.parse(fs.readFileSync(packagePath, 'utf-8'));
+                if (pkg.workspaces || pkg.name === 'webpieces-ts') {
+                    return currentDir;
+                }
+            }
+            catch (err) {
+                //const error = toError(err);
+                void err;
+            }
+        }
+        const parent = path.dirname(currentDir);
+        if (parent === currentDir)
+            break;
+        currentDir = parent;
+    }
+    return process.cwd();
+}
+/**
+ * Load blessed graph from architecture/dependencies.json
+ */
+function loadBlessedGraph(workspaceRoot) {
+    const graphPath = path.join(workspaceRoot, 'architecture', 'dependencies.json');
+    // Return cached if same path
+    if (cachedGraphPath === graphPath && cachedGraph !== null) {
+        return cachedGraph;
+    }
+    if (!fs.existsSync(graphPath)) {
+        return null;
+    }
+    try {
+        const content = fs.readFileSync(graphPath, 'utf-8');
+        cachedGraph = JSON.parse(content);
+        cachedGraphPath = graphPath;
+        return cachedGraph;
+    }
+    catch (err) {
+        //const error = toError(err);
+        // err is used below
+        console.error(`[ESLint @webpieces/enforce-architecture] Could not load graph: ${err}`);
+        return null;
+    }
+}
+/**
+ * Build project mappings from project.json files in workspace
+ */
+function buildProjectMappings(workspaceRoot) {
+    if (cachedProjectMappings !== null) {
+        return cachedProjectMappings;
+    }
+    const mappings = [];
+    // Scan common locations for project.json files
+    const searchDirs = ['packages', 'apps', 'libs', 'libraries', 'services'];
+    for (const searchDir of searchDirs) {
+        const searchPath = path.join(workspaceRoot, searchDir);
+        if (!fs.existsSync(searchPath))
+            continue;
+        scanForProjects(searchPath, workspaceRoot, mappings);
+    }
+    // Sort by path length (longest first) for more specific matching
+    mappings.sort((a, b) => b.root.length - a.root.length);
+    cachedProjectMappings = mappings;
+    return mappings;
+}
+/**
+ * Recursively scan for project.json files
+ */
+function scanForProjects(dir, workspaceRoot, mappings) {
+    try {
+        const entries = fs.readdirSync(dir, { withFileTypes: true });
+        for (const entry of entries) {
+            const fullPath = path.join(dir, entry.name);
+            if (entry.isDirectory() && !entry.name.startsWith('.') && entry.name !== 'node_modules') {
+                // Check for project.json in this directory
+                const projectJsonPath = path.join(fullPath, 'project.json');
+                if (fs.existsSync(projectJsonPath)) {
+                    try {
+                        const projectJson = JSON.parse(fs.readFileSync(projectJsonPath, 'utf-8'));
+                        const projectRoot = path.relative(workspaceRoot, fullPath);
+                        // Determine project name
+                        let projectName = projectJson.name || entry.name;
+                        // Add @webpieces/ prefix if not present
+                        if (!projectName.startsWith('@webpieces/')) {
+                            projectName = `@webpieces/${projectName}`;
+                        }
+                        mappings.push({
+                            root: projectRoot,
+                            name: projectName,
+                        });
+                    }
+                    catch (err) {
+                        //const error = toError(err);
+                        void err;
+                    }
+                }
+                // Continue scanning subdirectories
+                scanForProjects(fullPath, workspaceRoot, mappings);
+            }
+        }
+    }
+    catch (err) {
+        //const error = toError(err);
+        void err;
+    }
+}
+/**
+ * Get project name from file path
+ */
+function getProjectFromFile(filePath, workspaceRoot) {
+    const relativePath = path.relative(workspaceRoot, filePath).replace(/\\/g, '/');
+    const mappings = buildProjectMappings(workspaceRoot);
+    for (const mapping of mappings) {
+        if (relativePath.startsWith(mapping.root + '/') || relativePath.startsWith(mapping.root)) {
+            return mapping.name;
+        }
+    }
+    return null;
+}
+/**
+ * Compute all transitive dependencies for a project
+ */
+function computeTransitiveDependencies(project, graph) {
+    const result = new Set();
+    const visited = new Set();
+    function visit(currentProject) {
+        if (visited.has(currentProject))
+            return;
+        visited.add(currentProject);
+        const entry = graph[currentProject];
+        if (!entry || !entry.dependsOn)
+            return;
+        for (const dep of entry.dependsOn) {
+            result.add(dep);
+            visit(dep);
+        }
+    }
+    visit(project);
+    return result;
+}
+const rule = {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Enforce blessed architecture dependencies',
+            category: 'Best Practices',
+            recommended: true,
+            url: 'https://github.com/deanhiller/webpieces-ts',
+        },
+        messages: {
+            illegalImport: "⚠️ AI Agent: READ tmp/webpieces/webpieces.dependencies.md for resolution steps!\n\n" +
+                "Import '{{imported}}' violates architecture boundaries.\n\n" +
+                "Project '{{project}}' (level {{level}}) can only import from:\n" +
+                '{{allowedList}}',
+            noGraph: 'No architecture graph found at architecture/dependencies.json\n' +
+                'Run: nx run architecture:validate --mode=update',
+        },
+        schema: [],
+    },
+    create(context) {
+        const filename = context.filename || context.getFilename();
+        const workspaceRoot = findWorkspaceRoot(filename);
+        return {
+            ImportDeclaration(node) {
+                const importPath = node.source.value;
+                // Only check @webpieces/* imports
+                if (!importPath.startsWith('@webpieces/')) {
+                    return;
+                }
+                // Determine which project this file belongs to
+                const project = getProjectFromFile(filename, workspaceRoot);
+                if (!project) {
+                    // File not in any known project (e.g., tools/, scripts/)
+                    return;
+                }
+                // Self-import is always allowed
+                if (importPath === project) {
+                    return;
+                }
+                // Load blessed graph
+                const graph = loadBlessedGraph(workspaceRoot);
+                if (!graph) {
+                    // No graph file - warn but don't fail (allows gradual adoption)
+                    // Uncomment below to enforce graph existence:
+                    // context.report({ node: node.source, messageId: 'noGraph' });
+                    return;
+                }
+                // Get project entry
+                const projectEntry = graph[project];
+                if (!projectEntry) {
+                    // Project not in graph (new project?) - allow
+                    return;
+                }
+                // Compute allowed dependencies (direct + transitive)
+                const allowedDeps = computeTransitiveDependencies(project, graph);
+                // Check if import is allowed
+                if (!allowedDeps.has(importPath)) {
+                    // Write documentation file for AI/developer to read
+                    ensureDependenciesDoc(workspaceRoot);
+                    const directDeps = projectEntry.dependsOn || [];
+                    const allowedList = directDeps.length > 0
+                        ? directDeps.map((dep) => `  - ${dep}`).join('\n') +
+                            '\n  (and their transitive dependencies)'
+                        : '  (none - this is a foundation project)';
+                    context.report({
+                        node: node.source,
+                        messageId: 'illegalImport',
+                        data: {
+                            imported: importPath,
+                            project: project,
+                            level: String(projectEntry.level),
+                            allowedList: allowedList,
+                        },
+                    });
+                }
+            },
+        };
+    },
+};
+module.exports = rule;
+//# sourceMappingURL=enforce-architecture.js.map

package/eslint-plugin/rules/enforce-architecture.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enforce-architecture.js","sourceRoot":"","sources":["../../../../../../packages/tooling/dev-config/eslint-plugin/rules/enforce-architecture.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;AAGH,+CAAyB;AACzB,mDAA6B;AAE7B,MAAM,wBAAwB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+HhC,CAAC;AAEF,uDAAuD;AACvD,IAAI,sBAAsB,GAAG,KAAK,CAAC;AAEnC;;GAEG;AACH,SAAS,aAAa,CAAC,OAAe,EAAE,OAAe;IACnD,IAAI,CAAC;QACD,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACzD,EAAE,CAAC,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC;IAChB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAChB,KAAK,GAAG,CAAC;QACT,OAAO,CAAC,IAAI,CAAC,0CAA0C,OAAO,EAAE,CAAC,CAAC;QAClE,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAS,qBAAqB,CAAC,aAAqB;IAChD,IAAI,sBAAsB;QAAE,OAAO;IACnC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE,2BAA2B,CAAC,CAAC;IAC1F,IAAI,aAAa,CAAC,OAAO,EAAE,wBAAwB,CAAC,EAAE,CAAC;QACnD,sBAAsB,GAAG,IAAI,CAAC;IAClC,CAAC;AACL,CAAC;AAoBD,qDAAqD;AACrD,IAAI,WAAW,GAAyB,IAAI,CAAC;AAC7C,IAAI,eAAe,GAAkB,IAAI,CAAC;AAE1C,6BAA6B;AAC7B,IAAI,qBAAqB,GAA4B,IAAI,CAAC;AAE1D;;GAEG;AACH,SAAS,iBAAiB,CAAC,SAAiB;IACxC,IAAI,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAEzC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;QAC1B,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;QAC1D,IAAI,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YAC7B,IAAI,CAAC;gBACD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC;gBAC9D,IAAI,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;oBAChD,OAAO,UAAU,CAAC;gBACtB,CAAC;YACL,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAChB,6BAA6B;gBAC7B,KAAK,GAAG,CAAC;YACb,CAAC;QACL,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACxC,IAAI,MAAM,KAAK,UAAU;YAAE,MAAM;QACjC,UAAU,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC;AACzB,CAAC;AAED;;GAEG;AACH,SAAS,gBAAgB,CAAC,aAAqB;IAC3C,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,cAAc,EAAE,mBAAmB,CAAC,CAAC;IAEhF,6BAA6B;IAC7B,IAAI,eAAe,KAAK,SAAS,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;QACxD,OAAO,WAAW,CAAC;IACvB,CAAC;IAED,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,IAAI,CAAC;QACD,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACpD,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAkB,CAAC;QACnD,eAAe,GAAG,SAAS,CAAC;QAC5B,OAAO,WAAW,CAAC;IACvB,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAChB,6BAA6B;QAC7B,oBAAoB;QACpB,OAAO,CAAC,KAAK,CAAC,kEAAkE,GAAG,EAAE,CAAC,CAAC;QACvF,OAAO,IAAI,CAAC;IAChB,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAS,oBAAoB,CAAC,aAAqB;IAC/C,IAAI,qBAAqB,KAAK,IAAI,EAAE,CAAC;QACjC,OAAO,qBAAqB,CAAC;IACjC,CAAC;IAED,MAAM,QAAQ,GAAqB,EAAE,CAAC;IAEtC,+CAA+C;IAC/C,MAAM,UAAU,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;IAEzE,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACjC,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QACvD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC;YAAE,SAAS;QAEzC,eAAe,CAAC,UAAU,EAAE,aAAa,EAAE,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED,iEAAiE;IACjE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAEvD,qBAAqB,GAAG,QAAQ,CAAC;IACjC,OAAO,QAAQ,CAAC;AACpB,CAAC;AAED;;GAEG;AACH,SAAS,eAAe,CACpB,GAAW,EACX,aAAqB,EACrB,QAA0B;IAE1B,IAAI,CAAC;QACD,MAAM,OAAO,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QAE7D,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC1B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;YAE5C,IAAI,KAAK,CAAC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;gBACtF,2CAA2C;gBAC3C,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;gBAC5D,IAAI,EAAE,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,CAAC;oBACjC,IAAI,CAAC;wBACD,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,CAAC;wBAC1E,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;wBAE3D,yBAAyB;wBACzB,IAAI,WAAW,GAAG,WAAW,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC;wBAEjD,wCAAwC;wBACxC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;4BACzC,WAAW,GAAG,cAAc,WAAW,EAAE,CAAC;wBAC9C,CAAC;wBAED,QAAQ,CAAC,IAAI,CAAC;4BACV,IAAI,EAAE,WAAW;4BACjB,IAAI,EAAE,WAAW;yBACpB,CAAC,CAAC;oBACP,CAAC;oBAAC,OAAO,GAAQ,EAAE,CAAC;wBAChB,6BAA6B;wBAC7B,KAAK,GAAG,CAAC;oBACb,CAAC;gBACL,CAAC;gBAED,mCAAmC;gBACnC,eAAe,CAAC,QAAQ,EAAE,aAAa,EAAE,QAAQ,CAAC,CAAC;YACvD,CAAC;QACL,CAAC;IACL,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAChB,6BAA6B;QAC7B,KAAK,GAAG,CAAC;IACb,CAAC;AACL,CAAC;AAED;;GAEG;AACH,SAAS,kBAAkB,CAAC,QAAgB,EAAE,aAAqB;IAC/D,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAChF,MAAM,QAAQ,GAAG,oBAAoB,CAAC,aAAa,CAAC,CAAC;IAErD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC7B,IAAI,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACvF,OAAO,OAAO,CAAC,IAAI,CAAC;QACxB,CAAC;IACL,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,SAAS,6BAA6B,CAAC,OAAe,EAAE,KAAoB;IACxE,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;IACjC,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAElC,SAAS,KAAK,CAAC,cAAsB;QACjC,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;YAAE,OAAO;QACxC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAE5B,MAAM,KAAK,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;QACpC,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,SAAS;YAAE,OAAO;QAEvC,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YAChC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAChB,KAAK,CAAC,GAAG,CAAC,CAAC;QACf,CAAC;IACL,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,CAAC;IACf,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,MAAM,IAAI,GAAoB;IAC1B,IAAI,EAAE;QACF,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACF,WAAW,EAAE,2CAA2C;YACxD,QAAQ,EAAE,gBAAgB;YAC1B,WAAW,EAAE,IAAI;YACjB,GAAG,EAAE,4CAA4C;SACpD;QACD,QAAQ,EAAE;YACN,aAAa,EACT,qFAAqF;gBACrF,6DAA6D;gBAC7D,iEAAiE;gBACjE,iBAAiB;YACrB,OAAO,EACH,iEAAiE;gBACjE,iDAAiD;SACxD;QACD,MAAM,EAAE,EAAE;KACb;IAED,MAAM,CAAC,OAAyB;QAC5B,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;QAC3D,MAAM,aAAa,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAElD,OAAO;YACH,iBAAiB,CAAC,IAAS;gBACvB,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,KAAe,CAAC;gBAE/C,kCAAkC;gBAClC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;oBACxC,OAAO;gBACX,CAAC;gBAED,+CAA+C;gBAC/C,MAAM,OAAO,GAAG,kBAAkB,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;gBAC5D,IAAI,CAAC,OAAO,EAAE,CAAC;oBACX,yDAAyD;oBACzD,OAAO;gBACX,CAAC;gBAED,gCAAgC;gBAChC,IAAI,UAAU,KAAK,OAAO,EAAE,CAAC;oBACzB,OAAO;gBACX,CAAC;gBAED,qBAAqB;gBACrB,MAAM,KAAK,GAAG,gBAAgB,CAAC,aAAa,CAAC,CAAC;gBAC9C,IAAI,CAAC,KAAK,EAAE,CAAC;oBACT,gEAAgE;oBAChE,8CAA8C;oBAC9C,+DAA+D;oBAC/D,OAAO;gBACX,CAAC;gBAED,oBAAoB;gBACpB,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;gBACpC,IAAI,CAAC,YAAY,EAAE,CAAC;oBAChB,8CAA8C;oBAC9C,OAAO;gBACX,CAAC;gBAED,qDAAqD;gBACrD,MAAM,WAAW,GAAG,6BAA6B,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;gBAElE,6BAA6B;gBAC7B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC/B,oDAAoD;oBACpD,qBAAqB,CAAC,aAAa,CAAC,CAAC;oBAErC,MAAM,UAAU,GAAG,YAAY,CAAC,SAAS,IAAI,EAAE,CAAC;oBAChD,MAAM,WAAW,GACb,UAAU,CAAC,MAAM,GAAG,CAAC;wBACjB,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;4BAChD,yCAAyC;wBAC3C,CAAC,CAAC,yCAAyC,CAAC;oBAEpD,OAAO,CAAC,MAAM,CAAC;wBACX,IAAI,EAAE,IAAI,CAAC,MAAM;wBACjB,SAAS,EAAE,eAAe;wBAC1B,IAAI,EAAE;4BACF,QAAQ,EAAE,UAAU;4BACpB,OAAO,EAAE,OAAO;4BAChB,KAAK,EAAE,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC;4BACjC,WAAW,EAAE,WAAW;yBAC3B;qBACJ,CAAC,CAAC;gBACP,CAAC;YACL,CAAC;SACJ,CAAC;IACN,CAAC;CACJ,CAAC;AAEF,iBAAS,IAAI,CAAC","sourcesContent":["/**\n * ESLint rule to enforce architecture boundaries\n *\n * Validates that imports from @webpieces/* packages comply with the\n * blessed dependency graph in .graphs/dependencies.json\n *\n * Supports transitive dependencies: if A depends on B and B depends on C,\n * then A can import from C.\n *\n * Configuration:\n * '@webpieces/enforce-architecture': 'error'\n */\n\nimport type { Rule } from 'eslint';\nimport * as fs from 'fs';\nimport * as path from 'path';\n\nconst DEPENDENCIES_DOC_CONTENT = `# AI Agent Instructions: Architecture Dependency Violation\n\n**READ THIS FILE FIRST before making any changes!**\n\n## ⚠️ CRITICAL WARNING ⚠️\n\n**This is a VERY IMPORTANT change that has LARGE REPERCUSSIONS later!**\n\nAdding new dependencies creates technical debt that compounds over time:\n- Creates coupling between packages that may be hard to undo\n- Can create circular dependency tangles\n- Makes packages harder to test in isolation\n- Increases build times and bundle sizes\n- May force unnecessary upgrades across the codebase\n\n**DO NOT add dependencies without senior developer approval!**\n\n## Understanding the Error\n\nYou've attempted to import from a package that is not in your project's allowed dependencies.\nThe architecture enforces a layered dependency structure where:\n- Level 0 packages are foundation packages with NO dependencies on other @webpieces packages\n- Higher level packages can only depend on lower level packages\n- All dependencies must be explicitly declared\n\n## Steps to Resolve\n\n### Step 1: Generate Current Dependency Graph\nRun this command to see the current architecture:\n\\`\\`\\`bash\nnpx nx run architecture:generate\n\\`\\`\\`\nThis creates/updates \\`architecture/dependencies.json\\` showing all packages and their levels.\n\n### Step 2: Analyze the Proposed Change\nAsk yourself:\n1. **Is this import truly necessary?** Can you refactor to avoid it?\n2. **Should the code move instead?** Maybe the code belongs in a different package.\n3. **Will this create a cycle?** Use \\`npx nx graph\\` to visualize dependencies.\n4. **Can you use an interface/abstraction?** Define interface in lower-level package, implement in higher-level.\n\n### Step 3: Get Senior Developer Approval\n\n## 🛑 AI AGENTS: STOP HERE AND ASK FOR HUMAN APPROVAL! 🛑\n\n**YOU MUST NOT PROCEED TO STEP 4 WITHOUT EXPLICIT HUMAN APPROVAL!**\n\n**REQUIRED**: Discuss this architectural change with a senior developer before proceeding.\n- Explain why the dependency is needed\n- Show you've considered alternatives (Step 2)\n- **WAIT for explicit approval before making ANY changes to project.json or package.json**\n\n**AI Agent Instructions:**\n1. Present your analysis from Step 2 to the human\n2. Explain which package needs which dependency and why\n3. ASK: \"Do you approve adding this dependency?\"\n4. **DO NOT modify project.json or package.json until you receive explicit \"yes\" or approval**\n\n### Step 4: If Approved, Add the Dependency\n\n## ⛔ NEVER MODIFY THESE FILES WITHOUT HUMAN APPROVAL FROM STEP 3! ⛔\n\nOnly after receiving explicit human approval in Step 3, make these changes:\n\n1. **Update project.json** - Add to \\`build.dependsOn\\`:\n   \\`\\`\\`json\n   {\n     \"targets\": {\n       \"build\": {\n         \"dependsOn\": [\"^build\", \"dep1:build\", \"NEW_PACKAGE:build\"]\n       }\n     }\n   }\n   \\`\\`\\`\n\n2. **Update package.json** - Add to \\`dependencies\\`:\n   \\`\\`\\`json\n   {\n     \"dependencies\": {\n       \"@webpieces/NEW_PACKAGE\": \"*\"\n     }\n   }\n   \\`\\`\\`\n\n### Step 5: Update Architecture Definition\nRun this command to validate and update the architecture:\n\\`\\`\\`bash\nnpx nx run architecture:validate --mode=update\n\\`\\`\\`\n\nThis will:\n- Detect any cycles (which MUST be fixed before proceeding)\n- Update \\`architecture/dependencies.json\\` with the new dependency\n- Recalculate package levels\n\n### Step 6: Verify No Cycles\n\\`\\`\\`bash\nnpx nx run architecture:validate\n\\`\\`\\`\n\nIf cycles are detected, you MUST refactor to break the cycle. Common strategies:\n- Move shared code to a lower-level package\n- Use dependency inversion (interfaces in low-level, implementations in high-level)\n- Restructure package boundaries\n\n## Alternative Solutions (Preferred over adding dependencies)\n\n### Option A: Move the Code\nIf you need functionality from another package, consider moving that code to a shared lower-level package.\n\n### Option B: Dependency Inversion\nDefine an interface in the lower-level package, implement it in the higher-level package:\n\\`\\`\\`typescript\n// In foundation package (level 0)\nexport interface Logger { log(msg: string): void; }\n\n// In higher-level package\nexport class ConsoleLogger implements Logger { ... }\n\\`\\`\\`\n\n### Option C: Pass Dependencies as Parameters\nInstead of importing, receive the dependency as a constructor or method parameter.\n\n## Remember\n- Every dependency you add today is technical debt for tomorrow\n- The best dependency is the one you don't need\n- When in doubt, refactor rather than add dependencies\n`;\n\n// Module-level flag to prevent redundant file creation\nlet dependenciesDocCreated = false;\n\n/**\n * Ensure a documentation file exists at the given path.\n */\nfunction ensureDocFile(docPath: string, content: string): boolean {\n    try {\n        fs.mkdirSync(path.dirname(docPath), { recursive: true });\n        fs.writeFileSync(docPath, content, 'utf-8');\n        return true;\n    } catch (err: any) {\n        void err;\n        console.warn(`[webpieces] Could not create doc file: ${docPath}`);\n        return false;\n    }\n}\n\n/**\n * Ensure the dependencies documentation file exists.\n * Called when an architecture violation is detected.\n */\nfunction ensureDependenciesDoc(workspaceRoot: string): void {\n    if (dependenciesDocCreated) return;\n    const docPath = path.join(workspaceRoot, 'tmp', 'webpieces', 'webpieces.dependencies.md');\n    if (ensureDocFile(docPath, DEPENDENCIES_DOC_CONTENT)) {\n        dependenciesDocCreated = true;\n    }\n}\n\n/**\n * Graph entry format from .graphs/dependencies.json\n */\ninterface GraphEntry {\n    level: number;\n    dependsOn: string[];\n}\n\ntype EnhancedGraph = Record<string, GraphEntry>;\n\n/**\n * Project mapping entry\n */\ninterface ProjectMapping {\n    root: string;\n    name: string;\n}\n\n// Cache for blessed graph (loaded once per lint run)\nlet cachedGraph: EnhancedGraph | null = null;\nlet cachedGraphPath: string | null = null;\n\n// Cache for project mappings\nlet cachedProjectMappings: ProjectMapping[] | null = null;\n\n/**\n * Find workspace root by walking up from file location\n */\nfunction findWorkspaceRoot(startPath: string): string {\n    let currentDir = path.dirname(startPath);\n\n    for (let i = 0; i < 20; i++) {\n        const packagePath = path.join(currentDir, 'package.json');\n        if (fs.existsSync(packagePath)) {\n            try {\n                const pkg = JSON.parse(fs.readFileSync(packagePath, 'utf-8'));\n                if (pkg.workspaces || pkg.name === 'webpieces-ts') {\n                    return currentDir;\n                }\n            } catch (err: any) {\n                //const error = toError(err);\n                void err;\n            }\n        }\n\n        const parent = path.dirname(currentDir);\n        if (parent === currentDir) break;\n        currentDir = parent;\n    }\n\n    return process.cwd();\n}\n\n/**\n * Load blessed graph from architecture/dependencies.json\n */\nfunction loadBlessedGraph(workspaceRoot: string): EnhancedGraph | null {\n    const graphPath = path.join(workspaceRoot, 'architecture', 'dependencies.json');\n\n    // Return cached if same path\n    if (cachedGraphPath === graphPath && cachedGraph !== null) {\n        return cachedGraph;\n    }\n\n    if (!fs.existsSync(graphPath)) {\n        return null;\n    }\n\n    try {\n        const content = fs.readFileSync(graphPath, 'utf-8');\n        cachedGraph = JSON.parse(content) as EnhancedGraph;\n        cachedGraphPath = graphPath;\n        return cachedGraph;\n    } catch (err: any) {\n        //const error = toError(err);\n        // err is used below\n        console.error(`[ESLint @webpieces/enforce-architecture] Could not load graph: ${err}`);\n        return null;\n    }\n}\n\n/**\n * Build project mappings from project.json files in workspace\n */\nfunction buildProjectMappings(workspaceRoot: string): ProjectMapping[] {\n    if (cachedProjectMappings !== null) {\n        return cachedProjectMappings;\n    }\n\n    const mappings: ProjectMapping[] = [];\n\n    // Scan common locations for project.json files\n    const searchDirs = ['packages', 'apps', 'libs', 'libraries', 'services'];\n\n    for (const searchDir of searchDirs) {\n        const searchPath = path.join(workspaceRoot, searchDir);\n        if (!fs.existsSync(searchPath)) continue;\n\n        scanForProjects(searchPath, workspaceRoot, mappings);\n    }\n\n    // Sort by path length (longest first) for more specific matching\n    mappings.sort((a, b) => b.root.length - a.root.length);\n\n    cachedProjectMappings = mappings;\n    return mappings;\n}\n\n/**\n * Recursively scan for project.json files\n */\nfunction scanForProjects(\n    dir: string,\n    workspaceRoot: string,\n    mappings: ProjectMapping[]\n): void {\n    try {\n        const entries = fs.readdirSync(dir, { withFileTypes: true });\n\n        for (const entry of entries) {\n            const fullPath = path.join(dir, entry.name);\n\n            if (entry.isDirectory() && !entry.name.startsWith('.') && entry.name !== 'node_modules') {\n                // Check for project.json in this directory\n                const projectJsonPath = path.join(fullPath, 'project.json');\n                if (fs.existsSync(projectJsonPath)) {\n                    try {\n                        const projectJson = JSON.parse(fs.readFileSync(projectJsonPath, 'utf-8'));\n                        const projectRoot = path.relative(workspaceRoot, fullPath);\n\n                        // Determine project name\n                        let projectName = projectJson.name || entry.name;\n\n                        // Add @webpieces/ prefix if not present\n                        if (!projectName.startsWith('@webpieces/')) {\n                            projectName = `@webpieces/${projectName}`;\n                        }\n\n                        mappings.push({\n                            root: projectRoot,\n                            name: projectName,\n                        });\n                    } catch (err: any) {\n                        //const error = toError(err);\n                        void err;\n                    }\n                }\n\n                // Continue scanning subdirectories\n                scanForProjects(fullPath, workspaceRoot, mappings);\n            }\n        }\n    } catch (err: any) {\n        //const error = toError(err);\n        void err;\n    }\n}\n\n/**\n * Get project name from file path\n */\nfunction getProjectFromFile(filePath: string, workspaceRoot: string): string | null {\n    const relativePath = path.relative(workspaceRoot, filePath).replace(/\\\\/g, '/');\n    const mappings = buildProjectMappings(workspaceRoot);\n\n    for (const mapping of mappings) {\n        if (relativePath.startsWith(mapping.root + '/') || relativePath.startsWith(mapping.root)) {\n            return mapping.name;\n        }\n    }\n\n    return null;\n}\n\n/**\n * Compute all transitive dependencies for a project\n */\nfunction computeTransitiveDependencies(project: string, graph: EnhancedGraph): Set<string> {\n    const result = new Set<string>();\n    const visited = new Set<string>();\n\n    function visit(currentProject: string): void {\n        if (visited.has(currentProject)) return;\n        visited.add(currentProject);\n\n        const entry = graph[currentProject];\n        if (!entry || !entry.dependsOn) return;\n\n        for (const dep of entry.dependsOn) {\n            result.add(dep);\n            visit(dep);\n        }\n    }\n\n    visit(project);\n    return result;\n}\n\nconst rule: Rule.RuleModule = {\n    meta: {\n        type: 'problem',\n        docs: {\n            description: 'Enforce blessed architecture dependencies',\n            category: 'Best Practices',\n            recommended: true,\n            url: 'https://github.com/deanhiller/webpieces-ts',\n        },\n        messages: {\n            illegalImport:\n                \"⚠️ AI Agent: READ tmp/webpieces/webpieces.dependencies.md for resolution steps!\\n\\n\" +\n                \"Import '{{imported}}' violates architecture boundaries.\\n\\n\" +\n                \"Project '{{project}}' (level {{level}}) can only import from:\\n\" +\n                '{{allowedList}}',\n            noGraph:\n                'No architecture graph found at architecture/dependencies.json\\n' +\n                'Run: nx run architecture:validate --mode=update',\n        },\n        schema: [],\n    },\n\n    create(context: Rule.RuleContext): Rule.RuleListener {\n        const filename = context.filename || context.getFilename();\n        const workspaceRoot = findWorkspaceRoot(filename);\n\n        return {\n            ImportDeclaration(node: any): void {\n                const importPath = node.source.value as string;\n\n                // Only check @webpieces/* imports\n                if (!importPath.startsWith('@webpieces/')) {\n                    return;\n                }\n\n                // Determine which project this file belongs to\n                const project = getProjectFromFile(filename, workspaceRoot);\n                if (!project) {\n                    // File not in any known project (e.g., tools/, scripts/)\n                    return;\n                }\n\n                // Self-import is always allowed\n                if (importPath === project) {\n                    return;\n                }\n\n                // Load blessed graph\n                const graph = loadBlessedGraph(workspaceRoot);\n                if (!graph) {\n                    // No graph file - warn but don't fail (allows gradual adoption)\n                    // Uncomment below to enforce graph existence:\n                    // context.report({ node: node.source, messageId: 'noGraph' });\n                    return;\n                }\n\n                // Get project entry\n                const projectEntry = graph[project];\n                if (!projectEntry) {\n                    // Project not in graph (new project?) - allow\n                    return;\n                }\n\n                // Compute allowed dependencies (direct + transitive)\n                const allowedDeps = computeTransitiveDependencies(project, graph);\n\n                // Check if import is allowed\n                if (!allowedDeps.has(importPath)) {\n                    // Write documentation file for AI/developer to read\n                    ensureDependenciesDoc(workspaceRoot);\n\n                    const directDeps = projectEntry.dependsOn || [];\n                    const allowedList =\n                        directDeps.length > 0\n                            ? directDeps.map((dep) => `  - ${dep}`).join('\\n') +\n                              '\\n  (and their transitive dependencies)'\n                            : '  (none - this is a foundation project)';\n\n                    context.report({\n                        node: node.source,\n                        messageId: 'illegalImport',\n                        data: {\n                            imported: importPath,\n                            project: project,\n                            level: String(projectEntry.level),\n                            allowedList: allowedList,\n                        },\n                    });\n                }\n            },\n        };\n    },\n};\n\nexport = rule;\n"]}