@brainwav/diagram 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +52 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,8 +4,11 @@ Generate codebase architecture diagrams from source files. No AI required.
|
|
|
4
4
|
|
|
5
5
|
## Table of Contents
|
|
6
6
|
|
|
7
|
+
- [Upgrade notice](#upgrade-notice)
|
|
8
|
+
- [Plain-language summary](#plain-language-summary)
|
|
7
9
|
- [Install](#install)
|
|
8
10
|
- [Quick start](#quick-start)
|
|
11
|
+
- [First-run checklist](#first-run-checklist)
|
|
9
12
|
- [Commands](#commands)
|
|
10
13
|
- [Diagram types](#diagram-types)
|
|
11
14
|
- [Output formats](#output-formats)
|
|
@@ -15,6 +18,27 @@ Generate codebase architecture diagrams from source files. No AI required.
|
|
|
15
18
|
- [Development](#development)
|
|
16
19
|
- [License](#license)
|
|
17
20
|
|
|
21
|
+
## Upgrade notice
|
|
22
|
+
|
|
23
|
+
⚠️ `@brainwav/diagram@1.0.0` had a packaging regression and failed at runtime with
|
|
24
|
+
`Cannot find module './utils/commands'`. Please use
|
|
25
|
+
`@brainwav/diagram@1.0.1` or later.
|
|
26
|
+
|
|
27
|
+
## Plain-language summary
|
|
28
|
+
|
|
29
|
+
This tool reads code and draws a map.
|
|
30
|
+
You point it at a repo.
|
|
31
|
+
It scans files.
|
|
32
|
+
It finds links.
|
|
33
|
+
It prints a clear graph.
|
|
34
|
+
You can save that graph.
|
|
35
|
+
You can save PNG or SVG files.
|
|
36
|
+
You can make short video clips.
|
|
37
|
+
You can test code layer rules.
|
|
38
|
+
You can run it on your laptop.
|
|
39
|
+
You can run it in CI.
|
|
40
|
+
The goal is simple: keep the code map clear and keep rule drift low.
|
|
41
|
+
|
|
18
42
|
## Install
|
|
19
43
|
|
|
20
44
|
```bash
|
|
@@ -38,6 +62,27 @@ diagram generate .
|
|
|
38
62
|
diagram all .
|
|
39
63
|
```
|
|
40
64
|
|
|
65
|
+
## First-run checklist
|
|
66
|
+
|
|
67
|
+
Use a small test repo first.
|
|
68
|
+
Run from the repo root.
|
|
69
|
+
Start with `diagram analyze .`.
|
|
70
|
+
Read the file and link count.
|
|
71
|
+
Next, run `diagram generate .`.
|
|
72
|
+
Save one file with `--output`.
|
|
73
|
+
Pick `.mmd` for text output.
|
|
74
|
+
Pick `.svg` for image output.
|
|
75
|
+
Use `diagram all .` for all views.
|
|
76
|
+
Use `--max-files` if runs are slow.
|
|
77
|
+
Keep path globs short and clear.
|
|
78
|
+
Skip build and vendored dirs.
|
|
79
|
+
Try `diagram test --init` for rules.
|
|
80
|
+
Then run `diagram test` to check rules.
|
|
81
|
+
Use `--dry-run` when match sets look odd.
|
|
82
|
+
Use `--verbose` if you need more detail.
|
|
83
|
+
Run `npm test` to check local health.
|
|
84
|
+
Run `npm run test:deep` for deep checks.
|
|
85
|
+
|
|
41
86
|
## Commands
|
|
42
87
|
|
|
43
88
|
### `diagram analyze [path]`
|
|
@@ -279,6 +324,9 @@ jobs:
|
|
|
279
324
|
|
|
280
325
|
## Documentation
|
|
281
326
|
|
|
327
|
+
- Getting started: [docs/getting-started.md](docs/getting-started.md)
|
|
328
|
+
- Architecture testing guide: [docs/architecture-testing.md](docs/architecture-testing.md)
|
|
329
|
+
- Migration guide: [docs/migration-from-dependency-cruiser.md](docs/migration-from-dependency-cruiser.md)
|
|
282
330
|
- Contributor guide: [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
283
331
|
- Security policy: [SECURITY.md](SECURITY.md)
|
|
284
332
|
- Support policy: [SUPPORT.md](SUPPORT.md)
|
|
@@ -286,6 +334,10 @@ jobs:
|
|
|
286
334
|
- Maintainer docs index: [docs/README.md](docs/README.md)
|
|
287
335
|
- Release history: [CHANGELOG.md](CHANGELOG.md)
|
|
288
336
|
|
|
337
|
+
## Documentation signature
|
|
338
|
+
|
|
339
|
+
brAInwav - from demo to duty
|
|
340
|
+
|
|
289
341
|
## Development
|
|
290
342
|
|
|
291
343
|
```bash
|