Releases: GitSmart86/archidoc
Releases · GitSmart86/archidoc
v0.5.0
v0.3.2
Full Changelog: v0.3.1...v0.3.2
v0.1.0 — First Public Release
archidoc v0.1.0
Your architecture diagrams are always wrong because nobody updates them. archidoc fixes this — it extracts C4 architecture documentation directly from source code annotations, so your diagrams stay in sync with your code.
Install
cargo install archidoc-cli
npm install -g archidoc-tsHighlights
- Single ARCHITECTURE.md output — inline Mermaid C4 diagrams, component index with source links, relationship map
- Rust adapter — extracts
@c4annotations from//!doc comments, flat crate support, 9 GoF pattern heuristics - TypeScript adapter — parses
@c4JSDoc annotations, auto-discovers import/export relationships - JSON IR — portable
ModuleDoc[]contract between any language adapter and the core engine - Polyglot support —
--merge-ircombines IR from multiple adapters into a unified architecture doc - Drift detection —
archidoc --check .exits non-zero when docs are stale (CI gate) - Health reporting —
archidoc --health .shows file maturity and pattern confidence - File validation —
archidoc --validate .detects ghost entries and orphan files - Pattern validation — structural heuristics auto-verify Observer, Strategy, Facade, and 6 more GoF patterns
- Annotation scaffolding —
archidoc suggest src/api/generates templates for unannotated directories - PlantUML & draw.io — opt-in sidecar outputs via
--plantumland--drawio
Published Packages
| Package | Registry | Version |
|---|---|---|
| archidoc-cli | crates.io | 0.1.0 |
| archidoc-types | crates.io | 0.1.0 |
| archidoc-engine | crates.io | 0.1.0 |
| archidoc-rust | crates.io | 0.1.0 |
| archidoc-ts | npm | 0.1.0 |
Test Suite
185 tests (131 Rust + 54 TypeScript) using Dave Farley-style BDD: declarative test cases, protocol drivers, in-memory fakes.