@getmikk/diagram-generator 1.2.0 → 1.3.0

package/src/generators/module-diagram.ts

@@ -1,75 +1,75 @@
-import * as path from 'node:path'
-import type { MikkContract, MikkLock } from '@getmikk/core'
-
-/**
- * ModuleDiagramGenerator — generates a detailed Mermaid diagram for a
- * single module, showing its internal files and function call graph.
- * Outputs: .mikk/diagrams/modules/{moduleId}.mmd
- */
-export class ModuleDiagramGenerator {
-    constructor(
-        private contract: MikkContract,
-        private lock: MikkLock
-    ) { }
-
-    generate(moduleId: string): string {
-        const module = this.contract.declared.modules.find(m => m.id === moduleId)
-        if (!module) return `%% Module "${moduleId}" not found`
-
-        const lines: string[] = []
-        lines.push(`graph TD`)
-        lines.push(`    subgraph mod_${this.sanitizeId(moduleId)}["📦 Module: ${module.name}"]`)
-
-        const moduleFunctions = Object.values(this.lock.functions).filter(f => f.moduleId === moduleId)
-
-        // Group functions by file
-        const functionsByFile = new Map<string, typeof moduleFunctions>()
-        for (const fn of moduleFunctions) {
-            if (!functionsByFile.has(fn.file)) {
-                functionsByFile.set(fn.file, [])
-            }
-            functionsByFile.get(fn.file)!.push(fn)
-        }
-
-        // Add file subgraphs
-        for (const [filePath, fns] of functionsByFile) {
-            const fileName = path.basename(filePath)
-            lines.push(`        subgraph file_${this.sanitizeId(filePath)}["📄 ${fileName}"]`)
-            for (const fn of fns) {
-                const icon = fn.calledBy.length === 0 ? '⚡' : 'λ' // ⚡ for entry points (called by nothing internal)
-                lines.push(`            ${this.sanitizeId(fn.id)}["${icon} ${fn.name}"]`)
-            }
-            lines.push('        end')
-        }
-
-        lines.push('    end')
-        lines.push('')
-
-        // Add call edges
-        for (const fn of moduleFunctions) {
-            for (const callTarget of fn.calls) {
-                const targetFn = this.lock.functions[callTarget]
-                if (targetFn) {
-                    if (targetFn.moduleId === moduleId) {
-                        // Internal call
-                        lines.push(`    ${this.sanitizeId(fn.id)} --> ${this.sanitizeId(callTarget)}`)
-                    } else {
-                        // External call
-                        const targetMod = targetFn.moduleId
-                        lines.push(`    ${this.sanitizeId(fn.id)} -.->|"calls"| ext_${this.sanitizeId(callTarget)}["🔗 ${targetFn.name}<br/>(${targetMod})"]`)
-                    }
-                }
-            }
-        }
-
-        lines.push('')
-        lines.push('    classDef default fill:#f9f9f9,stroke:#333,stroke-width:1px')
-        lines.push('    classDef external fill:#ecf0f1,stroke:#bdc3c7,stroke-dasharray: 5 5')
-
-        return lines.join('\n')
-    }
-
-    private sanitizeId(id: string): string {
-        return id.replace(/[^a-zA-Z0-9_]/g, '_')
-    }
-}
+import * as path from 'node:path'
+import type { MikkContract, MikkLock } from '@getmikk/core'
+
+/**
+ * ModuleDiagramGenerator — generates a detailed Mermaid diagram for a
+ * single module, showing its internal files and function call graph.
+ * Outputs: .mikk/diagrams/modules/{moduleId}.mmd
+ */
+export class ModuleDiagramGenerator {
+    constructor(
+        private contract: MikkContract,
+        private lock: MikkLock
+    ) { }
+
+    generate(moduleId: string): string {
+        const module = this.contract.declared.modules.find(m => m.id === moduleId)
+        if (!module) return `%% Module "${moduleId}" not found`
+
+        const lines: string[] = []
+        lines.push(`graph TD`)
+        lines.push(`    subgraph mod_${this.sanitizeId(moduleId)}["📦 Module: ${module.name}"]`)
+
+        const moduleFunctions = Object.values(this.lock.functions).filter(f => f.moduleId === moduleId)
+
+        // Group functions by file
+        const functionsByFile = new Map<string, typeof moduleFunctions>()
+        for (const fn of moduleFunctions) {
+            if (!functionsByFile.has(fn.file)) {
+                functionsByFile.set(fn.file, [])
+            }
+            functionsByFile.get(fn.file)!.push(fn)
+        }
+
+        // Add file subgraphs
+        for (const [filePath, fns] of functionsByFile) {
+            const fileName = path.basename(filePath)
+            lines.push(`        subgraph file_${this.sanitizeId(filePath)}["📄 ${fileName}"]`)
+            for (const fn of fns) {
+                const icon = fn.calledBy.length === 0 ? '⚡' : 'λ' // ⚡ for entry points (called by nothing internal)
+                lines.push(`            ${this.sanitizeId(fn.id)}["${icon} ${fn.name}"]`)
+            }
+            lines.push('        end')
+        }
+
+        lines.push('    end')
+        lines.push('')
+
+        // Add call edges
+        for (const fn of moduleFunctions) {
+            for (const callTarget of fn.calls) {
+                const targetFn = this.lock.functions[callTarget]
+                if (targetFn) {
+                    if (targetFn.moduleId === moduleId) {
+                        // Internal call
+                        lines.push(`    ${this.sanitizeId(fn.id)} --> ${this.sanitizeId(callTarget)}`)
+                    } else {
+                        // External call
+                        const targetMod = targetFn.moduleId
+                        lines.push(`    ${this.sanitizeId(fn.id)} -.->|"calls"| ext_${this.sanitizeId(callTarget)}["🔗 ${targetFn.name}<br/>(${targetMod})"]`)
+                    }
+                }
+            }
+        }
+
+        lines.push('')
+        lines.push('    classDef default fill:#f9f9f9,stroke:#333,stroke-width:1px')
+        lines.push('    classDef external fill:#ecf0f1,stroke:#bdc3c7,stroke-dasharray: 5 5')
+
+        return lines.join('\n')
+    }
+
+    private sanitizeId(id: string): string {
+        return id.replace(/[^a-zA-Z0-9_]/g, '_')
+    }
+}

package/src/index.ts

@@ -1,8 +1,8 @@
-export { DiagramOrchestrator } from './orchestrator.js'
-export { MainDiagramGenerator } from './generators/main-diagram.js'
-export { ModuleDiagramGenerator } from './generators/module-diagram.js'
-export { ImpactDiagramGenerator } from './generators/impact-diagram.js'
-export { HealthDiagramGenerator } from './generators/health-diagram.js'
-export { FlowDiagramGenerator } from './generators/flow-diagram.js'
-export { CapsuleDiagramGenerator } from './generators/capsule-diagram.js'
-export { DependencyMatrixGenerator } from './generators/dependency-matrix.js'
+export { DiagramOrchestrator } from './orchestrator.js'
+export { MainDiagramGenerator } from './generators/main-diagram.js'
+export { ModuleDiagramGenerator } from './generators/module-diagram.js'
+export { ImpactDiagramGenerator } from './generators/impact-diagram.js'
+export { HealthDiagramGenerator } from './generators/health-diagram.js'
+export { FlowDiagramGenerator } from './generators/flow-diagram.js'
+export { CapsuleDiagramGenerator } from './generators/capsule-diagram.js'
+export { DependencyMatrixGenerator } from './generators/dependency-matrix.js'

package/src/orchestrator.ts

@@ -1,76 +1,76 @@
-import * as path from 'node:path'
-import * as fs from 'node:fs/promises'
-import type { MikkContract, MikkLock } from '@getmikk/core'
-import { MainDiagramGenerator } from './generators/main-diagram.js'
-import { ModuleDiagramGenerator } from './generators/module-diagram.js'
-import { ImpactDiagramGenerator } from './generators/impact-diagram.js'
-import { HealthDiagramGenerator } from './generators/health-diagram.js'
-import { FlowDiagramGenerator } from './generators/flow-diagram.js'
-import { CapsuleDiagramGenerator } from './generators/capsule-diagram.js'
-import { DependencyMatrixGenerator } from './generators/dependency-matrix.js'
-
-/**
- * DiagramOrchestrator — generates all diagram types and writes them to
- * the .mikk/diagrams/ directory structure.
- */
-export class DiagramOrchestrator {
-    constructor(
-        private contract: MikkContract,
-        private lock: MikkLock,
-        private projectRoot: string
-    ) { }
-
-    /** Generate all diagrams */
-    async generateAll(): Promise<{ generated: string[] }> {
-        const generated: string[] = []
-
-        // Main diagram
-        const mainGen = new MainDiagramGenerator(this.contract, this.lock)
-        await this.writeDiagram('diagrams/main.mmd', mainGen.generate())
-        generated.push('diagrams/main.mmd')
-
-        // Health diagram
-        const healthGen = new HealthDiagramGenerator(this.contract, this.lock)
-        await this.writeDiagram('diagrams/health.mmd', healthGen.generate())
-        generated.push('diagrams/health.mmd')
-
-        // Flow diagram (entry points)
-        const flowGen = new FlowDiagramGenerator(this.lock)
-        await this.writeDiagram('diagrams/flows/entry-points.mmd', flowGen.generateEntryPoints())
-        generated.push('diagrams/flows/entry-points.mmd')
-
-        // Dependency matrix
-        const matrixGen = new DependencyMatrixGenerator(this.contract, this.lock)
-        await this.writeDiagram('diagrams/dependency-matrix.mmd', matrixGen.generate())
-        generated.push('diagrams/dependency-matrix.mmd')
-
-        // Per-module diagrams
-        for (const module of this.contract.declared.modules) {
-            const moduleGen = new ModuleDiagramGenerator(this.contract, this.lock)
-            await this.writeDiagram(`diagrams/modules/${module.id}.mmd`, moduleGen.generate(module.id))
-            generated.push(`diagrams/modules/${module.id}.mmd`)
-
-            const capsuleGen = new CapsuleDiagramGenerator(this.contract, this.lock)
-            await this.writeDiagram(`diagrams/capsules/${module.id}.mmd`, capsuleGen.generate(module.id))
-            generated.push(`diagrams/capsules/${module.id}.mmd`)
-        }
-
-        return { generated }
-    }
-
-    /** Generate impact diagram for specific changes */
-    async generateImpact(changedIds: string[], impactedIds: string[]): Promise<string> {
-        const impactGen = new ImpactDiagramGenerator(this.lock)
-        const diagram = impactGen.generate(changedIds, impactedIds)
-        const timestamp = Date.now()
-        const filename = `diagrams/impact/impact-${timestamp}.mmd`
-        await this.writeDiagram(filename, diagram)
-        return filename
-    }
-
-    private async writeDiagram(relativePath: string, content: string): Promise<void> {
-        const fullPath = path.join(this.projectRoot, '.mikk', relativePath)
-        await fs.mkdir(path.dirname(fullPath), { recursive: true })
-        await fs.writeFile(fullPath, content, 'utf-8')
-    }
-}
+import * as path from 'node:path'
+import * as fs from 'node:fs/promises'
+import type { MikkContract, MikkLock } from '@getmikk/core'
+import { MainDiagramGenerator } from './generators/main-diagram.js'
+import { ModuleDiagramGenerator } from './generators/module-diagram.js'
+import { ImpactDiagramGenerator } from './generators/impact-diagram.js'
+import { HealthDiagramGenerator } from './generators/health-diagram.js'
+import { FlowDiagramGenerator } from './generators/flow-diagram.js'
+import { CapsuleDiagramGenerator } from './generators/capsule-diagram.js'
+import { DependencyMatrixGenerator } from './generators/dependency-matrix.js'
+
+/**
+ * DiagramOrchestrator — generates all diagram types and writes them to
+ * the .mikk/diagrams/ directory structure.
+ */
+export class DiagramOrchestrator {
+    constructor(
+        private contract: MikkContract,
+        private lock: MikkLock,
+        private projectRoot: string
+    ) { }
+
+    /** Generate all diagrams */
+    async generateAll(): Promise<{ generated: string[] }> {
+        const generated: string[] = []
+
+        // Main diagram
+        const mainGen = new MainDiagramGenerator(this.contract, this.lock)
+        await this.writeDiagram('diagrams/main.mmd', mainGen.generate())
+        generated.push('diagrams/main.mmd')
+
+        // Health diagram
+        const healthGen = new HealthDiagramGenerator(this.contract, this.lock)
+        await this.writeDiagram('diagrams/health.mmd', healthGen.generate())
+        generated.push('diagrams/health.mmd')
+
+        // Flow diagram (entry points)
+        const flowGen = new FlowDiagramGenerator(this.lock)
+        await this.writeDiagram('diagrams/flows/entry-points.mmd', flowGen.generateEntryPoints())
+        generated.push('diagrams/flows/entry-points.mmd')
+
+        // Dependency matrix
+        const matrixGen = new DependencyMatrixGenerator(this.contract, this.lock)
+        await this.writeDiagram('diagrams/dependency-matrix.mmd', matrixGen.generate())
+        generated.push('diagrams/dependency-matrix.mmd')
+
+        // Per-module diagrams
+        for (const module of this.contract.declared.modules) {
+            const moduleGen = new ModuleDiagramGenerator(this.contract, this.lock)
+            await this.writeDiagram(`diagrams/modules/${module.id}.mmd`, moduleGen.generate(module.id))
+            generated.push(`diagrams/modules/${module.id}.mmd`)
+
+            const capsuleGen = new CapsuleDiagramGenerator(this.contract, this.lock)
+            await this.writeDiagram(`diagrams/capsules/${module.id}.mmd`, capsuleGen.generate(module.id))
+            generated.push(`diagrams/capsules/${module.id}.mmd`)
+        }
+
+        return { generated }
+    }
+
+    /** Generate impact diagram for specific changes */
+    async generateImpact(changedIds: string[], impactedIds: string[]): Promise<string> {
+        const impactGen = new ImpactDiagramGenerator(this.lock)
+        const diagram = impactGen.generate(changedIds, impactedIds)
+        const timestamp = Date.now()
+        const filename = `diagrams/impact/impact-${timestamp}.mmd`
+        await this.writeDiagram(filename, diagram)
+        return filename
+    }
+
+    private async writeDiagram(relativePath: string, content: string): Promise<void> {
+        const fullPath = path.join(this.projectRoot, '.mikk', relativePath)
+        await fs.mkdir(path.dirname(fullPath), { recursive: true })
+        await fs.writeFile(fullPath, content, 'utf-8')
+    }
+}

package/tests/smoke.test.ts

@@ -1,5 +1,5 @@
-import { expect, test } from "bun:test";
-
-test("smoke test - diagram-generator", () => {
-    expect(true).toBe(true);
-});
+import { expect, test } from "bun:test";
+
+test("smoke test - diagram-generator", () => {
+    expect(true).toBe(true);
+});

package/tsconfig.json

@@ -1,15 +1,15 @@
-{
-    "extends": "../../tsconfig.base.json",
-    "compilerOptions": {
-        "outDir": "dist",
-        "rootDir": "src"
-    },
-    "include": [
-        "src/**/*"
-    ],
-    "exclude": [
-        "node_modules",
-        "dist",
-        "tests"
-    ]
-}
+{
+    "extends": "../../tsconfig.base.json",
+    "compilerOptions": {
+        "outDir": "dist",
+        "rootDir": "src"
+    },
+    "include": [
+        "src/**/*"
+    ],
+    "exclude": [
+        "node_modules",
+        "dist",
+        "tests"
+    ]
+}