Skip to content

Latest commit

 

History

History
64 lines (54 loc) · 4.35 KB

README.StrongAI.Component.md

File metadata and controls

64 lines (54 loc) · 4.35 KB

This directory implements a Node-based documentation generator that traverses a codebase, produces per-file AI-authored headers, and composes Mermaid C4 diagrams for each directory. A CLI entry parses options, constructs visitors via a factory, and orchestrates traversal using a depth-first traverser with glob filtering. Visitors read and write files through abstracted I/O, resolve prompt templates, and invoke an LLM to generate content. Shared type definitions unify contracts across modules.

C4Component
title C4-Auto Doc Generation - Components and Interactions

Container_Boundary(docgen, "DocGen Toolchain", "Node.js", "Generates headers and C4 diagrams") {
  Component(generateDocsCli, "generate-docs-cli", "CLI", "Parses args and runs traversal")
  Component(visitorFactory, "VisitorFactory", "Factory", "Builds wired visitors and I/O")
  Component(traverser, "DirectoryTreeTraverser", "Traversal", "DFS over directories, invokes visitors")
  Component(moduleHeaderVisitor, "ModuleHeaderVisitor", "Visitor", "Generates StrongAI module headers")
  Component(c4Visitor, "C4DiagramVisitor", "Visitor", "Generates Mermaid C4 docs per directory")
  Component(docGenTypes, "DocGenTypes", "Types", "Shared enums and interfaces")
  Component(promptIds, "PromptIds", "Config", "Stable prompt UUIDs")
  Component(nodeDirReader, "NodeDirectoryReader", "I/O", "Lists directories (fs/promises)")
  Component(minimatchFilter, "MinimatchFileFilter", "Filter", "Glob file matching")
  Component(nodeFileReader, "NodeFileReader", "I/O", "Reads UTF-8 files")
  Component(nodeFileWriter, "NodeFileWriter", "I/O", "Writes UTF-8 files")
}

System_Ext(openAI, "OpenAI API", "LLM", "Generates headers and diagrams via chat driver")
System_Ext(fileSystem, "File System", "fs/promises", "Project source and output files")
System_Ext(promptsJson, "Prompts.json", "Data", "Prompt templates for repository")

Rel(generateDocsCli, visitorFactory, "creates visitors with")
Rel(generateDocsCli, traverser, "configures and runs with options")
Rel(visitorFactory, moduleHeaderVisitor, "instantiates")
Rel(visitorFactory, c4Visitor, "instantiates (when diagram flags set)")
Rel(visitorFactory, nodeFileReader, "provides")
Rel(visitorFactory, nodeFileWriter, "provides")
Rel(visitorFactory, promptsJson, "loads prompts from")
Rel(visitorFactory, promptIds, "uses IDs from")

Rel(traverser, nodeDirReader, "reads directories via")
Rel(traverser, minimatchFilter, "filters files via")
Rel(traverser, moduleHeaderVisitor, "invokes first (higher priority)")
Rel(traverser, c4Visitor, "invokes after headers")

Rel(moduleHeaderVisitor, nodeFileReader, "reads sources from", "IFileReader")
Rel(moduleHeaderVisitor, nodeFileWriter, "writes updated files to", "IFileWriter")
Rel(moduleHeaderVisitor, promptIds, "resolves", "moduleHeaderCommentPromptId")
Rel(moduleHeaderVisitor, openAI, "requests header content via", "IChatDriver")
Rel(moduleHeaderVisitor, fileSystem, "reads/writes", "fs/promises")

Rel(c4Visitor, nodeFileReader, "reads headers and files from")
Rel(c4Visitor, nodeFileWriter, "writes README.StrongAI.* to")
Rel(c4Visitor, promptIds, "resolves", "c4Component/c4Context prompt IDs")
Rel(c4Visitor, openAI, "generates diagram docs via", "IChatDriver")
Rel(c4Visitor, fileSystem, "reads/writes", "fs/promises")

Rel(docGenTypes, moduleHeaderVisitor, "defines contracts for")
Rel(docGenTypes, c4Visitor, "defines contracts for")
Rel(docGenTypes, traverser, "defines contracts for")
Rel(generateDocsCli, docGenTypes, "builds options using")
Loading

Key components:

  • generate-docs-cli: Orchestrates runs. It parses CLI flags, builds IDocGenOptions, wires traversal with visitors, and logs lifecycle events.
  • VisitorFactory: Central composition root. It creates Node I/O implementations, loads Prompts.json into an in-memory repository, constructs a chat driver, and returns ModuleHeaderVisitor and, conditionally, C4DiagramVisitor.
  • DirectoryTreeTraverser: Depth-first walker that applies MinimatchFileFilter and invokes visitors by priority, ensuring headers precede diagram generation.
  • ModuleHeaderVisitor: Reads TypeScript files, detects staleness, resolves the module header prompt, calls the LLM, and rewrites files with updated StrongAI header blocks.
  • C4DiagramVisitor: Aggregates per-file headers, manages word budgets and freshness windows, resolves diagram prompts, and writes README.StrongAI.* diagrams.