@datalackey/update-markdown-uml 0.1.0
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 +14 -0
- package/bin/update-markdown-uml.js +13 -0
- package/package.json +55 -0
package/README.md
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# @datalackey/update-markdown-uml
|
|
2
|
+
|
|
3
|
+
Generates and validates UML class and package diagrams for TypeScript source
|
|
4
|
+
trees, injecting them into Markdown documentation files.
|
|
5
|
+
|
|
6
|
+
> Status: under development
|
|
7
|
+
|
|
8
|
+
## Built With
|
|
9
|
+
|
|
10
|
+
- [`@datalackey/tooling-core`](../tooling-core/README.md) — shared internal utilities
|
|
11
|
+
- [`tsuml2`](https://github.com/demike/TsUML2) — UML class diagram generation from TypeScript
|
|
12
|
+
- [`ts-morph`](https://ts-morph.com/) — TypeScript compiler API wrapper
|
|
13
|
+
|
|
14
|
+
For the full workspace tech stack see: [TECH-STACK.md](../TECH-STACK.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { runCli } from "@datalackey/tooling-core"
|
|
3
|
+
import { descriptor } from "../dist/cli/descriptor.js"
|
|
4
|
+
|
|
5
|
+
await runCli({
|
|
6
|
+
descriptor: descriptor,
|
|
7
|
+
processor: {
|
|
8
|
+
process(_filePath, _config) {
|
|
9
|
+
// stub — implementation pending
|
|
10
|
+
return "unchanged"
|
|
11
|
+
}
|
|
12
|
+
}
|
|
13
|
+
})
|
package/package.json
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@datalackey/update-markdown-uml",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Generates and validates UML class and package diagrams for TypeScript source trees, injecting them into Markdown documentation files",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"private": false,
|
|
8
|
+
"bin": {
|
|
9
|
+
"update-markdown-uml": "./bin/update-markdown-uml.js"
|
|
10
|
+
},
|
|
11
|
+
"files": [
|
|
12
|
+
"bin/",
|
|
13
|
+
"dist/",
|
|
14
|
+
"README.md"
|
|
15
|
+
],
|
|
16
|
+
"engines": {
|
|
17
|
+
"node": ">=18"
|
|
18
|
+
},
|
|
19
|
+
"keywords": [
|
|
20
|
+
"uml",
|
|
21
|
+
"typescript",
|
|
22
|
+
"mermaid",
|
|
23
|
+
"documentation",
|
|
24
|
+
"class-diagram",
|
|
25
|
+
"package-diagram",
|
|
26
|
+
"ci",
|
|
27
|
+
"automation"
|
|
28
|
+
],
|
|
29
|
+
"publishConfig": {
|
|
30
|
+
"access": "public"
|
|
31
|
+
},
|
|
32
|
+
"repository": {
|
|
33
|
+
"type": "git",
|
|
34
|
+
"url": "https://github.com/datalackey/build-tools.git",
|
|
35
|
+
"directory": "javascript/update-markdown-uml"
|
|
36
|
+
},
|
|
37
|
+
"bugs": {
|
|
38
|
+
"url": "https://github.com/datalackey/build-tools/issues"
|
|
39
|
+
},
|
|
40
|
+
"homepage": "https://github.com/datalackey/build-tools/tree/main/javascript/update-markdown-uml",
|
|
41
|
+
"scripts": {
|
|
42
|
+
"build": "tsc -p tsconfig.json",
|
|
43
|
+
"test": "npx vitest run --config vitest.config.ts"
|
|
44
|
+
},
|
|
45
|
+
"dependencies": {
|
|
46
|
+
"@datalackey/tooling-core": "*",
|
|
47
|
+
"ts-morph": "^24.0.0",
|
|
48
|
+
"tsuml2": "^0.17.0"
|
|
49
|
+
},
|
|
50
|
+
"devDependencies": {
|
|
51
|
+
"@types/node": "^18.16.0",
|
|
52
|
+
"typescript": "^5.4.0",
|
|
53
|
+
"vitest": "^1.0.0"
|
|
54
|
+
}
|
|
55
|
+
}
|