Skip to content

Commit 64917de

Browse files
committed
feat: Add render options and CLI command options to architecture documentation
1 parent 4efb7f8 commit 64917de

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

ARCHITECTURE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,11 +82,19 @@
8282
- Nodes: `class UserService {}` / Interface: `class UserRepositoryInterface { <<interface>> }`
8383
- Edges: `UserService *-- UserRepositoryInterface: composition`, `UserService ..> User: dependency`
8484

85+
### Render options
86+
- `RenderOptions` controls view-time filtering without changing parsing (all default true via `RenderOptions::default()`):
87+
- `includeDependencies`: show/hide `Dependency` edges (parameter/return/`new`-derived)
88+
- `includeCompositions`: show/hide `Composition` edges (properties/constructor promotion/FQCN properties)
89+
- `includeInheritances`: show/hide `Inheritance` edges (`extends`)
90+
- `includeRealizations`: show/hide `Realization` edges (`implements`)
91+
8592
## CLI
8693
- Entry: `mermaid-class-diagram`
8794
- Boots `Symfony\Component\Console\Application` and registers `GenerateCommand`.
8895
- Command: `generate`
8996
- Option: `--path` (required; file or directory).
97+
- Option: `--exclude-relationships` (CSV): exclude relationship types: `dependency,composition,inheritance,realization` (aliases supported)
9098
- Execution: `GenerateCommand::execute()` delegates to `ClassDiagramBuilder`, then writes the Mermaid text to stdout.
9199
- AST: `ParserFactory::createForVersion(PhpVersion::fromComponents(8, 1))` (PHP 8.1).
92100

0 commit comments

Comments
 (0)