diff --git a/README.md b/README.md index fbf3582..2549ef1 100644 --- a/README.md +++ b/README.md @@ -396,6 +396,8 @@ it('should not contain forbidden dependencies', async () => { Generate dependency graph reports in multiple formats and narrow them to the part of the codebase you want to inspect. +![ArchUnitTS dependency graph showing the architecture of the library's modules (common, files, slices, metrics, graph, testing) and their dependencies, collapsed to folder depth 2](assets/dependency-graph-example.svg) + ```typescript import { projectGraph } from 'archunit'; @@ -427,6 +429,7 @@ Graph exploration options: - `collapseToFolderDepth(depth)` aggregates files to folder-level graph nodes. - `collapseByPattern(pattern, replacement)` maps files to custom graph nodes. - `includeExternalDependencies()` includes external edges when graph extraction provides them. +- `includeSelfDependencies()` includes files' self-referencing edges in the graph. ### Reports diff --git a/assets/dependency-graph-example.svg b/assets/dependency-graph-example.svg new file mode 100644 index 0000000..241cb90 --- /dev/null +++ b/assets/dependency-graph-example.svg @@ -0,0 +1 @@ +
39
7
23
11
11
5
4
2
8
3
6
2
3
15
index.ts
src/common
src/files
src/graph
src/metrics
src/slices
src/testing
test
test/common
test/files
test/graph
test/integration
test/jest
test/layered-arch
test/metrics
test/slices
test/uml-component
test/uml-layered
test/uml-microservices
\ No newline at end of file