@noyrax/documentation-system-plugin 1.0.4-beta.1

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.
Files changed (200) hide show
  1. package/.vscodeignore +41 -0
  2. package/LICENSE +21 -0
  3. package/MCP_SERVER_SETUP.md +371 -0
  4. package/README.md +663 -0
  5. package/assets/icon.svg +27 -0
  6. package/docs/LINKEDIN_ANTWORT_SEQUENZDIAGRAMME.md +190 -0
  7. package/docs/SEQUENZDIAGRAMM_BEWEIS.md +469 -0
  8. package/docs/SEQUENZDIAGRAMM_VALIDATE_FLOW.md +282 -0
  9. package/docs/adr/001-signatur-abweichung-fix.md +54 -0
  10. package/docs/adr/002-file-specific-validation-1.0.1.md +45 -0
  11. package/docs/adr/003-documentation-generation-bugs.md +134 -0
  12. package/docs/adr/004-validator-signature-matching-fix.md +121 -0
  13. package/docs/adr/005-validator-generic-simplification-tightening.md +35 -0
  14. package/docs/adr/006-parser-variable-type-extraction.md +33 -0
  15. package/docs/adr/007-ts-parser-load-libs-for-accurate-types.md +31 -0
  16. package/docs/adr/008-dependencies-cache-phase1.md +133 -0
  17. package/docs/adr/009-consolidation-union-logic-phase1-2.md +147 -0
  18. package/docs/adr/010-extension-union-integration-phase1-3-and-phase2.md +179 -0
  19. package/docs/adr/011-module-doc-change-tracking-phase3.md +190 -0
  20. package/docs/adr/012-git-deletions-change-report-phase4.md +235 -0
  21. package/docs/adr/013-system-functionality-fixes.md +279 -0
  22. package/docs/adr/014-rules-migration-und-mcp-integration.md +113 -0
  23. package/docs/adr/015-global-agent-package.md +158 -0
  24. package/docs/adr/016-produktisierung-docguard.md +193 -0
  25. package/docs/adr/017-signature-matching-optional-fields.md +128 -0
  26. package/docs/adr/018-rebranding-docguard-to-noyrax.md +109 -0
  27. package/docs/adr/019-system-schwachstellen-analyse-und-fixes.md +204 -0
  28. package/docs/adr/020-api-doc-tiefe-und-signatureformatter.md +74 -0
  29. package/docs/adr/021-semantic-api-docs-and-symbol-classifier.md +125 -0
  30. package/docs/adr/022-semantic-class-and-constants-rendering.md +82 -0
  31. package/docs/adr/023-adr-verknuepfung-modul-doku.md +54 -0
  32. package/docs/adr/024-cursor-rules-mehrdimensionaler-raum.md +230 -0
  33. package/docs/adr/025-mcp-tools-scan-validate-cli-bridge.md +202 -0
  34. package/docs/adr/026-reality-driven-development-system.md +173 -0
  35. package/docs/adr/027-scanner-excludes-and-union-logic-fix.md +189 -0
  36. package/docs/adr/028-src-coverage-union-resync.md +124 -0
  37. package/docs/adr/029-parser-flow-kopplung-und-sync-drift-modi.md +102 -0
  38. package/docs/adr/030-dependency-import-symbol-names-preservation.md +123 -0
  39. package/docs/adr/031-generate-cli-vollstaendige-dokumentation.md +99 -0
  40. package/docs/adr/032-windows-optimized-verification-scripts.md +165 -0
  41. package/docs/adr/036-enhanced-dependency-metadata.md +190 -0
  42. package/docs/adr/TEMPLATE.md +76 -0
  43. package/docs/index/symbols.jsonl +31 -0
  44. package/docs/modules/action__action.yml.md +50 -0
  45. package/docs/modules/documentation.config.schema.json.md +37 -0
  46. package/docs/modules/mcp__package.json.md +130 -0
  47. package/docs/modules/mcp__src__resources__docs.ts.md +94 -0
  48. package/docs/modules/mcp__src__server.ts.md +15 -0
  49. package/docs/modules/mcp__src__tools__drift.ts.md +110 -0
  50. package/docs/modules/mcp__src__tools__impact.ts.md +127 -0
  51. package/docs/modules/mcp__src__tools__scan.ts.md +75 -0
  52. package/docs/modules/mcp__src__tools__validate.ts.md +116 -0
  53. package/docs/modules/mcp__src__tools__verify-adrs.ts.md +106 -0
  54. package/docs/modules/mcp__tsconfig.json.md +22 -0
  55. package/docs/modules/package.json.md +131 -0
  56. package/docs/modules/packages__doc-system-agent__examples__basic-project__package.json.md +43 -0
  57. package/docs/modules/packages__doc-system-agent__examples__basic-project__src__calculator.ts.md +81 -0
  58. package/docs/modules/packages__doc-system-agent__package.json.md +154 -0
  59. package/docs/modules/packages__doc-system-agent__src__cli__index.ts.md +8 -0
  60. package/docs/modules/packages__doc-system-agent__src__cli__init.ts.md +93 -0
  61. package/docs/modules/packages__doc-system-agent__src__cli__update.ts.md +113 -0
  62. package/docs/modules/packages__doc-system-agent__src__constants.ts.md +29 -0
  63. package/docs/modules/packages__doc-system-agent__src__index.ts.md +234 -0
  64. package/docs/modules/packages__doc-system-agent__src__mcp__resources__docs.ts.md +94 -0
  65. package/docs/modules/packages__doc-system-agent__src__mcp__server.ts.md +17 -0
  66. package/docs/modules/packages__doc-system-agent__src__mcp__tools__drift.ts.md +38 -0
  67. package/docs/modules/packages__doc-system-agent__src__mcp__tools__impact.ts.md +75 -0
  68. package/docs/modules/packages__doc-system-agent__src__mcp__tools__scan.ts.md +23 -0
  69. package/docs/modules/packages__doc-system-agent__src__mcp__tools__validate.ts.md +23 -0
  70. package/docs/modules/packages__doc-system-agent__src__mcp__tools__verify-adrs.ts.md +106 -0
  71. package/docs/modules/packages__doc-system-agent__src__mcp__types.ts.md +355 -0
  72. package/docs/modules/packages__doc-system-agent__tsconfig.json.md +22 -0
  73. package/docs/modules/scripts__verify-adrs.js.md +97 -0
  74. package/docs/modules/scripts__verify-architecture.js.md +93 -0
  75. package/docs/modules/scripts__verify-imports.js.md +114 -0
  76. package/docs/modules/src____tests____setup.ts.md +8 -0
  77. package/docs/modules/src____tests____signature-formatter.test.ts.md +16 -0
  78. package/docs/modules/src____tests____snapshot-doc-generation.test.ts.md +8 -0
  79. package/docs/modules/src____tests____symbol-classifier.test.ts.md +16 -0
  80. package/docs/modules/src__cache__ast-cache.ts.md +91 -0
  81. package/docs/modules/src__cache__dependencies-cache.ts.md +89 -0
  82. package/docs/modules/src__cache__output-cache.ts.md +91 -0
  83. package/docs/modules/src__cache__signature-cache.ts.md +76 -0
  84. package/docs/modules/src__cli__generate-cli.ts.md +130 -0
  85. package/docs/modules/src__cli__scan-cli.ts.md +99 -0
  86. package/docs/modules/src__cli__validate-cli.ts.md +144 -0
  87. package/docs/modules/src__core__async.ts.md +18 -0
  88. package/docs/modules/src__core__consolidation.ts.md +158 -0
  89. package/docs/modules/src__core__git.ts.md +35 -0
  90. package/docs/modules/src__core__language-detection.ts.md +31 -0
  91. package/docs/modules/src__core__scanner.ts.md +101 -0
  92. package/docs/modules/src__core__signature-formatter.ts.md +232 -0
  93. package/docs/modules/src__core__symbol-classifier.ts.md +178 -0
  94. package/docs/modules/src__core__symbols.ts.md +31 -0
  95. package/docs/modules/src__drift__index.ts.md +53 -0
  96. package/docs/modules/src__extension.ts.md +418 -0
  97. package/docs/modules/src__generator__adr-linker.ts.md +154 -0
  98. package/docs/modules/src__generator__change-report.ts.md +85 -0
  99. package/docs/modules/src__generator__dependency-graph.ts.md +63 -0
  100. package/docs/modules/src__generator__index.ts.md +40 -0
  101. package/docs/modules/src__generator__module-doc.ts.md +242 -0
  102. package/docs/modules/src__index__index.ts.md +141 -0
  103. package/docs/modules/src__logging__index.ts.md +87 -0
  104. package/docs/modules/src__parsers__dependencies.ts.md +69 -0
  105. package/docs/modules/src__parsers__json-yaml.ts.md +81 -0
  106. package/docs/modules/src__parsers__python.ts.md +73 -0
  107. package/docs/modules/src__parsers__ts-js.ts.md +48 -0
  108. package/docs/modules/src__parsers__types.ts.md +99 -0
  109. package/docs/modules/src__ui__commands-provider.ts.md +70 -0
  110. package/docs/modules/src__ui__status-bar.ts.md +79 -0
  111. package/docs/modules/src__validator__index.ts.md +211 -0
  112. package/docs/modules/src__validator__signature-matching.ts.md +209 -0
  113. package/docs/modules/src__validator__status.ts.md +72 -0
  114. package/docs/modules/test-mcp-resources.js.md +27 -0
  115. package/docs/modules/tsconfig.json.md +22 -0
  116. package/docs/system/CHANGE_REPORT.md +19 -0
  117. package/docs/system/DEPENDENCIES.md +430 -0
  118. package/docs/system/DEPENDENCY_GRAPH.md +368 -0
  119. package/docs/system/NAVIGATION_SPACE_ANALYSIS.md +244 -0
  120. package/docs/system/NPX_CACHE_FIX.md +85 -0
  121. package/docs/system/NPX_LOCAL_USAGE.md +66 -0
  122. package/docs/system/PLUGIN_ECOSYSTEM_STATUS.md +465 -0
  123. package/docs/system/PLUGIN_UPDATE_GUIDE.md +212 -0
  124. package/docs/system/RULES_UPDATE_GUIDE.md +182 -0
  125. package/docs/system/SYSTEM_ANALYSIS.md +947 -0
  126. package/documentation.config.schema.json +77 -0
  127. package/noyrax-5d-database-plugin-0.1.8.tgz +0 -0
  128. package/out/cache/ast-cache.js +69 -0
  129. package/out/cache/ast-cache.js.map +1 -0
  130. package/out/cache/dependencies-cache.js +73 -0
  131. package/out/cache/dependencies-cache.js.map +1 -0
  132. package/out/cache/output-cache.js +69 -0
  133. package/out/cache/output-cache.js.map +1 -0
  134. package/out/cache/signature-cache.js +60 -0
  135. package/out/cache/signature-cache.js.map +1 -0
  136. package/out/cli/generate-cli.js +330 -0
  137. package/out/cli/generate-cli.js.map +1 -0
  138. package/out/cli/scan-cli.js +151 -0
  139. package/out/cli/scan-cli.js.map +1 -0
  140. package/out/cli/validate-cli.js +258 -0
  141. package/out/cli/validate-cli.js.map +1 -0
  142. package/out/core/async.js +38 -0
  143. package/out/core/async.js.map +1 -0
  144. package/out/core/consolidation.js +230 -0
  145. package/out/core/consolidation.js.map +1 -0
  146. package/out/core/git.js +48 -0
  147. package/out/core/git.js.map +1 -0
  148. package/out/core/language-detection.js +29 -0
  149. package/out/core/language-detection.js.map +1 -0
  150. package/out/core/scanner.js +179 -0
  151. package/out/core/scanner.js.map +1 -0
  152. package/out/core/signature-formatter.js +162 -0
  153. package/out/core/signature-formatter.js.map +1 -0
  154. package/out/core/symbol-classifier.js +96 -0
  155. package/out/core/symbol-classifier.js.map +1 -0
  156. package/out/core/symbols.js +24 -0
  157. package/out/core/symbols.js.map +1 -0
  158. package/out/drift/index.js +28 -0
  159. package/out/drift/index.js.map +1 -0
  160. package/out/extension.js +984 -0
  161. package/out/extension.js.map +1 -0
  162. package/out/generator/adr-linker.js +216 -0
  163. package/out/generator/adr-linker.js.map +1 -0
  164. package/out/generator/change-report.js +124 -0
  165. package/out/generator/change-report.js.map +1 -0
  166. package/out/generator/dependency-graph.js +98 -0
  167. package/out/generator/dependency-graph.js.map +1 -0
  168. package/out/generator/index.js +117 -0
  169. package/out/generator/index.js.map +1 -0
  170. package/out/generator/module-doc.js +438 -0
  171. package/out/generator/module-doc.js.map +1 -0
  172. package/out/index/index.js +147 -0
  173. package/out/index/index.js.map +1 -0
  174. package/out/logging/index.js +24 -0
  175. package/out/logging/index.js.map +1 -0
  176. package/out/parsers/dependencies.js +126 -0
  177. package/out/parsers/dependencies.js.map +1 -0
  178. package/out/parsers/json-yaml.js +90 -0
  179. package/out/parsers/json-yaml.js.map +1 -0
  180. package/out/parsers/python.js +160 -0
  181. package/out/parsers/python.js.map +1 -0
  182. package/out/parsers/ts-js.js +397 -0
  183. package/out/parsers/ts-js.js.map +1 -0
  184. package/out/parsers/types.js +3 -0
  185. package/out/parsers/types.js.map +1 -0
  186. package/out/ui/commands-provider.js +91 -0
  187. package/out/ui/commands-provider.js.map +1 -0
  188. package/out/ui/status-bar.js +85 -0
  189. package/out/ui/status-bar.js.map +1 -0
  190. package/out/validator/index.js +185 -0
  191. package/out/validator/index.js.map +1 -0
  192. package/out/validator/signature-matching.js +261 -0
  193. package/out/validator/signature-matching.js.map +1 -0
  194. package/out/validator/status.js +38 -0
  195. package/out/validator/status.js.map +1 -0
  196. package/package.json +306 -0
  197. package/publish.ps1 +21 -0
  198. package/scripts/verify-adrs.js +312 -0
  199. package/scripts/verify-architecture.js +181 -0
  200. package/scripts/verify-imports.js +274 -0
@@ -0,0 +1,16 @@
1
+ # Modul: src/__tests__/symbol-classifier.test.ts
2
+
3
+ ### function: makeSymbol
4
+ Rolle: other (Sichtbarkeit: public, Priorität: normal)
5
+ Signatur: `makeSymbol(partial: Partial<ParsedSymbol>): ParsedSymbol`
6
+ ```ts
7
+ makeSymbol(partial: Partial<ParsedSymbol>): ParsedSymbol
8
+ ```
9
+
10
+ Parameter:
11
+
12
+ | Name | Typ | Optional | Default |
13
+ |------|-----|----------|---------|
14
+ | `partial` | `Partial<ParsedSymbol>` | nein | nein |
15
+
16
+ Rückgabewert: `ParsedSymbol`
@@ -0,0 +1,91 @@
1
+ # Modul: src/cache/ast-cache.ts
2
+
3
+ ## Relevante ADRs
4
+
5
+ - [ADR-008: dependencies-cache-phase1](../adr/008-dependencies-cache-phase1.md)
6
+
7
+ ### interface: AstHashCacheData
8
+ Rolle: infra (Sichtbarkeit: public, Priorität: low)
9
+ Signatur: `interface AstHashCacheData {
10
+ version: 1;
11
+ entries: AstHashEntry[];
12
+ }`
13
+ ```ts
14
+ interface AstHashCacheData {
15
+ version: 1;
16
+ entries: AstHashEntry[];
17
+ }
18
+ ```
19
+
20
+ Eigenschaften:
21
+
22
+ | Name | Typ | Optional |
23
+ |------|-----|----------|
24
+ | `entries` | `AstHashEntry[]` | nein |
25
+ | `version` | `1` | nein |
26
+
27
+ ### interface: AstHashEntry
28
+ Rolle: infra (Sichtbarkeit: public, Priorität: low)
29
+ Signatur: `interface AstHashEntry {
30
+ path: string;
31
+ hash: string;
32
+ }`
33
+ ```ts
34
+ interface AstHashEntry {
35
+ path: string;
36
+ hash: string;
37
+ }
38
+ ```
39
+
40
+ Eigenschaften:
41
+
42
+ | Name | Typ | Optional |
43
+ |------|-----|----------|
44
+ | `hash` | `string` | nein |
45
+ | `path` | `string` | nein |
46
+
47
+ ### function: computeFileHash
48
+ Rolle: infra (Sichtbarkeit: public, Priorität: low)
49
+ Signatur: `computeFileHash(content: string): string`
50
+ ```ts
51
+ computeFileHash(content: string): string
52
+ ```
53
+
54
+ Parameter:
55
+
56
+ | Name | Typ | Optional | Default |
57
+ |------|-----|----------|---------|
58
+ | `content` | `string` | nein | nein |
59
+
60
+ Rückgabewert: `string`
61
+
62
+ ### function: loadAstHashCache
63
+ Rolle: infra (Sichtbarkeit: public, Priorität: low)
64
+ Signatur: `loadAstHashCache(cacheFile: string): AstHashCacheData | null`
65
+ ```ts
66
+ loadAstHashCache(cacheFile: string): AstHashCacheData | null
67
+ ```
68
+
69
+ Parameter:
70
+
71
+ | Name | Typ | Optional | Default |
72
+ |------|-----|----------|---------|
73
+ | `cacheFile` | `string` | nein | nein |
74
+
75
+ Rückgabewert: `AstHashCacheData | null`
76
+
77
+ ### function: saveAstHashCache
78
+ Rolle: infra (Sichtbarkeit: public, Priorität: low)
79
+ Signatur: `saveAstHashCache(cacheDir: string, data: AstHashCacheData): void`
80
+ ```ts
81
+ saveAstHashCache(cacheDir: string, data: AstHashCacheData): void
82
+ ```
83
+
84
+ Parameter:
85
+
86
+ | Name | Typ | Optional | Default |
87
+ |------|-----|----------|---------|
88
+ | `cacheDir` | `string` | nein | nein |
89
+ | `data` | `AstHashCacheData` | nein | nein |
90
+
91
+ Rückgabewert: `void`
@@ -0,0 +1,89 @@
1
+ # Modul: src/cache/dependencies-cache.ts
2
+
3
+ ## Relevante ADRs
4
+
5
+ - [ADR-008: dependencies-cache-phase1](../adr/008-dependencies-cache-phase1.md)
6
+ - [ADR-036: Enhanced Dependency Metadata (Aliasing, Type-Only, Re-Exports)](../adr/036-enhanced-dependency-metadata.md)
7
+
8
+ ### interface: DependenciesCacheData
9
+ Rolle: infra (Sichtbarkeit: public, Priorität: low)
10
+ Signatur: `interface DependenciesCacheData {
11
+ version: 1;
12
+ entries: DependencyCacheEntry[];
13
+ }`
14
+ ```ts
15
+ interface DependenciesCacheData {
16
+ version: 1;
17
+ entries: DependencyCacheEntry[];
18
+ }
19
+ ```
20
+
21
+ Eigenschaften:
22
+
23
+ | Name | Typ | Optional |
24
+ |------|-----|----------|
25
+ | `entries` | `DependencyCacheEntry[]` | nein |
26
+ | `version` | `1` | nein |
27
+
28
+ ### interface: DependencyCacheEntry
29
+ Rolle: infra (Sichtbarkeit: public, Priorität: low)
30
+ Signatur: `interface DependencyCacheEntry {
31
+ from: string;
32
+ to: string;
33
+ type: 'import' | 'export' | 'require';
34
+ symbols?: string[];
35
+ isTypeOnly?: boolean;
36
+ isReexport?: boolean;
37
+ }`
38
+ ```ts
39
+ interface DependencyCacheEntry {
40
+ from: string;
41
+ to: string;
42
+ type: 'import' | 'export' | 'require';
43
+ symbols?: string[];
44
+ isTypeOnly?: boolean;
45
+ isReexport?: boolean;
46
+ }
47
+ ```
48
+
49
+ Eigenschaften:
50
+
51
+ | Name | Typ | Optional |
52
+ |------|-----|----------|
53
+ | `from` | `string` | nein |
54
+ | `isReexport` | `boolean` | ja |
55
+ | `isTypeOnly` | `boolean` | ja |
56
+ | `symbols` | `string[]` | ja |
57
+ | `to` | `string` | nein |
58
+ | `type` | `'import' | 'export' | 'require'` | nein |
59
+
60
+ ### function: loadDependenciesCache
61
+ Rolle: infra (Sichtbarkeit: public, Priorität: low)
62
+ Signatur: `loadDependenciesCache(cacheFile: string): DependenciesCacheData | null`
63
+ ```ts
64
+ loadDependenciesCache(cacheFile: string): DependenciesCacheData | null
65
+ ```
66
+
67
+ Parameter:
68
+
69
+ | Name | Typ | Optional | Default |
70
+ |------|-----|----------|---------|
71
+ | `cacheFile` | `string` | nein | nein |
72
+
73
+ Rückgabewert: `DependenciesCacheData | null`
74
+
75
+ ### function: saveDependenciesCache
76
+ Rolle: infra (Sichtbarkeit: public, Priorität: low)
77
+ Signatur: `saveDependenciesCache(cacheDir: string, data: DependenciesCacheData): void`
78
+ ```ts
79
+ saveDependenciesCache(cacheDir: string, data: DependenciesCacheData): void
80
+ ```
81
+
82
+ Parameter:
83
+
84
+ | Name | Typ | Optional | Default |
85
+ |------|-----|----------|---------|
86
+ | `cacheDir` | `string` | nein | nein |
87
+ | `data` | `DependenciesCacheData` | nein | nein |
88
+
89
+ Rückgabewert: `void`
@@ -0,0 +1,91 @@
1
+ # Modul: src/cache/output-cache.ts
2
+
3
+ ## Relevante ADRs
4
+
5
+ - [ADR-008: dependencies-cache-phase1](../adr/008-dependencies-cache-phase1.md)
6
+
7
+ ### interface: OutputHashCacheData
8
+ Rolle: infra (Sichtbarkeit: public, Priorität: low)
9
+ Signatur: `interface OutputHashCacheData {
10
+ version: 1;
11
+ entries: OutputHashEntry[];
12
+ }`
13
+ ```ts
14
+ interface OutputHashCacheData {
15
+ version: 1;
16
+ entries: OutputHashEntry[];
17
+ }
18
+ ```
19
+
20
+ Eigenschaften:
21
+
22
+ | Name | Typ | Optional |
23
+ |------|-----|----------|
24
+ | `entries` | `OutputHashEntry[]` | nein |
25
+ | `version` | `1` | nein |
26
+
27
+ ### interface: OutputHashEntry
28
+ Rolle: infra (Sichtbarkeit: public, Priorität: low)
29
+ Signatur: `interface OutputHashEntry {
30
+ path: string;
31
+ hash: string;
32
+ }`
33
+ ```ts
34
+ interface OutputHashEntry {
35
+ path: string;
36
+ hash: string;
37
+ }
38
+ ```
39
+
40
+ Eigenschaften:
41
+
42
+ | Name | Typ | Optional |
43
+ |------|-----|----------|
44
+ | `hash` | `string` | nein |
45
+ | `path` | `string` | nein |
46
+
47
+ ### function: computeContentHash
48
+ Rolle: infra (Sichtbarkeit: public, Priorität: low)
49
+ Signatur: `computeContentHash(content: string): string`
50
+ ```ts
51
+ computeContentHash(content: string): string
52
+ ```
53
+
54
+ Parameter:
55
+
56
+ | Name | Typ | Optional | Default |
57
+ |------|-----|----------|---------|
58
+ | `content` | `string` | nein | nein |
59
+
60
+ Rückgabewert: `string`
61
+
62
+ ### function: loadOutputHashCache
63
+ Rolle: infra (Sichtbarkeit: public, Priorität: low)
64
+ Signatur: `loadOutputHashCache(cacheFile: string): OutputHashCacheData | null`
65
+ ```ts
66
+ loadOutputHashCache(cacheFile: string): OutputHashCacheData | null
67
+ ```
68
+
69
+ Parameter:
70
+
71
+ | Name | Typ | Optional | Default |
72
+ |------|-----|----------|---------|
73
+ | `cacheFile` | `string` | nein | nein |
74
+
75
+ Rückgabewert: `OutputHashCacheData | null`
76
+
77
+ ### function: saveOutputHashCache
78
+ Rolle: infra (Sichtbarkeit: public, Priorität: low)
79
+ Signatur: `saveOutputHashCache(cacheDir: string, data: OutputHashCacheData): void`
80
+ ```ts
81
+ saveOutputHashCache(cacheDir: string, data: OutputHashCacheData): void
82
+ ```
83
+
84
+ Parameter:
85
+
86
+ | Name | Typ | Optional | Default |
87
+ |------|-----|----------|---------|
88
+ | `cacheDir` | `string` | nein | nein |
89
+ | `data` | `OutputHashCacheData` | nein | nein |
90
+
91
+ Rückgabewert: `void`
@@ -0,0 +1,76 @@
1
+ # Modul: src/cache/signature-cache.ts
2
+
3
+ ## Relevante ADRs
4
+
5
+ - [ADR-008: dependencies-cache-phase1](../adr/008-dependencies-cache-phase1.md)
6
+
7
+ ### interface: CacheEntry
8
+ Rolle: infra (Sichtbarkeit: public, Priorität: low)
9
+ Signatur: `interface CacheEntry {
10
+ baseId: string;
11
+ signatureHash: string;
12
+ }`
13
+ ```ts
14
+ interface CacheEntry {
15
+ baseId: string;
16
+ signatureHash: string;
17
+ }
18
+ ```
19
+
20
+ Eigenschaften:
21
+
22
+ | Name | Typ | Optional |
23
+ |------|-----|----------|
24
+ | `baseId` | `string` | nein |
25
+ | `signatureHash` | `string` | nein |
26
+
27
+ ### interface: SignatureCacheData
28
+ Rolle: infra (Sichtbarkeit: public, Priorität: low)
29
+ Signatur: `interface SignatureCacheData {
30
+ version: 1;
31
+ entries: CacheEntry[];
32
+ }`
33
+ ```ts
34
+ interface SignatureCacheData {
35
+ version: 1;
36
+ entries: CacheEntry[];
37
+ }
38
+ ```
39
+
40
+ Eigenschaften:
41
+
42
+ | Name | Typ | Optional |
43
+ |------|-----|----------|
44
+ | `entries` | `CacheEntry[]` | nein |
45
+ | `version` | `1` | nein |
46
+
47
+ ### function: loadSignatureCache
48
+ Rolle: infra (Sichtbarkeit: public, Priorität: low)
49
+ Signatur: `loadSignatureCache(cacheFile: string): SignatureCacheData | null`
50
+ ```ts
51
+ loadSignatureCache(cacheFile: string): SignatureCacheData | null
52
+ ```
53
+
54
+ Parameter:
55
+
56
+ | Name | Typ | Optional | Default |
57
+ |------|-----|----------|---------|
58
+ | `cacheFile` | `string` | nein | nein |
59
+
60
+ Rückgabewert: `SignatureCacheData | null`
61
+
62
+ ### function: saveSignatureCache
63
+ Rolle: infra (Sichtbarkeit: public, Priorität: low)
64
+ Signatur: `saveSignatureCache(cacheDir: string, data: SignatureCacheData): void`
65
+ ```ts
66
+ saveSignatureCache(cacheDir: string, data: SignatureCacheData): void
67
+ ```
68
+
69
+ Parameter:
70
+
71
+ | Name | Typ | Optional | Default |
72
+ |------|-----|----------|---------|
73
+ | `cacheDir` | `string` | nein | nein |
74
+ | `data` | `SignatureCacheData` | nein | nein |
75
+
76
+ Rückgabewert: `void`
@@ -0,0 +1,130 @@
1
+ # Modul: src/cli/generate-cli.ts
2
+
3
+ ## Relevante ADRs
4
+
5
+ - [ADR-031: Generate-CLI für vollständige Dokumentationsgenerierung](../adr/031-generate-cli-vollstaendige-dokumentation.md)
6
+ - [ADR-036: Enhanced Dependency Metadata (Aliasing, Type-Only, Re-Exports)](../adr/036-enhanced-dependency-metadata.md)
7
+
8
+ <!-- change: symbol-added name="GenerateCliResult" kind="interface" -->
9
+ ### interface: GenerateCliResult
10
+ Rolle: domain-model (Sichtbarkeit: public, Priorität: high)
11
+ Signatur: `interface GenerateCliResult {
12
+ status: 'success' | 'error' | 'partial';
13
+ filesProcessed: number;
14
+ symbolsExtracted: number;
15
+ dependenciesExtracted: number;
16
+ docsGenerated: number;
17
+ duration: number;
18
+ logs: string[];
19
+ errors?: string[];
20
+ }`
21
+ ```ts
22
+ interface GenerateCliResult {
23
+ status: 'success' | 'error' | 'partial';
24
+ filesProcessed: number;
25
+ symbolsExtracted: number;
26
+ dependenciesExtracted: number;
27
+ docsGenerated: number;
28
+ duration: number;
29
+ logs: string[];
30
+ errors?: string[];
31
+ }
32
+ ```
33
+
34
+ Eigenschaften:
35
+
36
+ | Name | Typ | Optional |
37
+ |------|-----|----------|
38
+ | `dependenciesExtracted` | `number` | nein |
39
+ | `docsGenerated` | `number` | nein |
40
+ | `duration` | `number` | nein |
41
+ | `errors` | `string[]` | ja |
42
+ | `filesProcessed` | `number` | nein |
43
+ | `logs` | `string[]` | nein |
44
+ | `status` | `'success' | 'error' | 'partial'` | nein |
45
+ | `symbolsExtracted` | `number` | nein |
46
+
47
+ <!-- change: symbol-added name="GenerateCliOptions" kind="interface" -->
48
+ ### interface: GenerateCliOptions
49
+ Rolle: config (Sichtbarkeit: public, Priorität: normal)
50
+ Signatur: `interface GenerateCliOptions {
51
+ workspaceRoot?: string;
52
+ outputPath?: string;
53
+ incremental?: boolean;
54
+ verbose?: boolean;
55
+ }`
56
+ ```ts
57
+ interface GenerateCliOptions {
58
+ workspaceRoot?: string;
59
+ outputPath?: string;
60
+ incremental?: boolean;
61
+ verbose?: boolean;
62
+ }
63
+ ```
64
+
65
+ Eigenschaften:
66
+
67
+ | Name | Typ | Optional |
68
+ |------|-----|----------|
69
+ | `incremental` | `boolean` | ja |
70
+ | `outputPath` | `string` | ja |
71
+ | `verbose` | `boolean` | ja |
72
+ | `workspaceRoot` | `string` | ja |
73
+
74
+ <!-- change: symbol-added name="log" kind="function" -->
75
+ ### function: log
76
+ Rolle: other (Sichtbarkeit: public, Priorität: normal)
77
+ Signatur: `log(logs: string[], message: string, verbose: boolean): void`
78
+ ```ts
79
+ log(logs: string[], message: string, verbose: boolean): void
80
+ ```
81
+
82
+ Parameter:
83
+
84
+ | Name | Typ | Optional | Default |
85
+ |------|-----|----------|---------|
86
+ | `logs` | `string[]` | nein | nein |
87
+ | `message` | `string` | nein | nein |
88
+ | `verbose` | `boolean` | nein | nein |
89
+
90
+ Rückgabewert: `void`
91
+
92
+ <!-- change: symbol-added name="runGenerateCli" kind="function" -->
93
+ ### function: runGenerateCli
94
+ Rolle: other (Sichtbarkeit: public, Priorität: normal)
95
+ Signatur: `runGenerateCli(options: GenerateCliOptions = …): Promise<GenerateCliResult>`
96
+ ```ts
97
+ runGenerateCli(options: GenerateCliOptions = …): Promise<GenerateCliResult>
98
+ ```
99
+
100
+ Parameter:
101
+
102
+ | Name | Typ | Optional | Default |
103
+ |------|-----|----------|---------|
104
+ | `options` | `GenerateCliOptions` | nein | ja |
105
+
106
+ Rückgabewert: `Promise<GenerateCliResult>`
107
+
108
+ <!-- change: symbol-added name="reexport:GenerateCliOptionsfrom:undefined" kind="variable" -->
109
+ ### variable: reexport:GenerateCliOptionsfrom:undefined
110
+ Rolle: other (Sichtbarkeit: public, Priorität: normal)
111
+ Signatur: `reexport:GenerateCliOptionsfrom:undefined`
112
+ ```ts
113
+ reexport:GenerateCliOptionsfrom:undefined
114
+ ```
115
+
116
+ <!-- change: symbol-added name="reexport:GenerateCliResultfrom:undefined" kind="variable" -->
117
+ ### variable: reexport:GenerateCliResultfrom:undefined
118
+ Rolle: other (Sichtbarkeit: public, Priorität: normal)
119
+ Signatur: `reexport:GenerateCliResultfrom:undefined`
120
+ ```ts
121
+ reexport:GenerateCliResultfrom:undefined
122
+ ```
123
+
124
+ <!-- change: symbol-added name="reexport:runGenerateClifrom:undefined" kind="variable" -->
125
+ ### variable: reexport:runGenerateClifrom:undefined
126
+ Rolle: other (Sichtbarkeit: public, Priorität: normal)
127
+ Signatur: `reexport:runGenerateClifrom:undefined`
128
+ ```ts
129
+ reexport:runGenerateClifrom:undefined
130
+ ```
@@ -0,0 +1,99 @@
1
+ # Modul: src/cli/scan-cli.ts
2
+
3
+ ## Relevante ADRs
4
+
5
+ - [ADR-025: MCP-Server Tools Scan/Validate – CLI-Bridge-Pattern](../adr/025-mcp-tools-scan-validate-cli-bridge.md)
6
+
7
+ ### interface: ScanCliResult
8
+ Rolle: domain-model (Sichtbarkeit: public, Priorität: high)
9
+ Signatur: `interface ScanCliResult {
10
+ status: 'success' | 'error' | 'partial';
11
+ filesProcessed: number;
12
+ symbolsExtracted: number;
13
+ duration: number;
14
+ logs: string[];
15
+ errors?: string[];
16
+ }`
17
+ ```ts
18
+ interface ScanCliResult {
19
+ status: 'success' | 'error' | 'partial';
20
+ filesProcessed: number;
21
+ symbolsExtracted: number;
22
+ duration: number;
23
+ logs: string[];
24
+ errors?: string[];
25
+ }
26
+ ```
27
+
28
+ Eigenschaften:
29
+
30
+ | Name | Typ | Optional |
31
+ |------|-----|----------|
32
+ | `duration` | `number` | nein |
33
+ | `errors` | `string[]` | ja |
34
+ | `filesProcessed` | `number` | nein |
35
+ | `logs` | `string[]` | nein |
36
+ | `status` | `'success' | 'error' | 'partial'` | nein |
37
+ | `symbolsExtracted` | `number` | nein |
38
+
39
+ ### interface: ScanCliOptions
40
+ Rolle: config (Sichtbarkeit: public, Priorität: normal)
41
+ Signatur: `interface ScanCliOptions {
42
+ workspaceRoot?: string;
43
+ includeBackups?: boolean;
44
+ files?: string[];
45
+ incremental?: boolean;
46
+ }`
47
+ ```ts
48
+ interface ScanCliOptions {
49
+ workspaceRoot?: string;
50
+ includeBackups?: boolean;
51
+ files?: string[];
52
+ incremental?: boolean;
53
+ }
54
+ ```
55
+
56
+ Eigenschaften:
57
+
58
+ | Name | Typ | Optional |
59
+ |------|-----|----------|
60
+ | `files` | `string[]` | ja |
61
+ | `includeBackups` | `boolean` | ja |
62
+ | `incremental` | `boolean` | ja |
63
+ | `workspaceRoot` | `string` | ja |
64
+
65
+ ### function: runScanCli
66
+ Rolle: other (Sichtbarkeit: public, Priorität: normal)
67
+ Signatur: `runScanCli(options: ScanCliOptions = …): Promise<ScanCliResult>`
68
+ ```ts
69
+ runScanCli(options: ScanCliOptions = …): Promise<ScanCliResult>
70
+ ```
71
+
72
+ Parameter:
73
+
74
+ | Name | Typ | Optional | Default |
75
+ |------|-----|----------|---------|
76
+ | `options` | `ScanCliOptions` | nein | ja |
77
+
78
+ Rückgabewert: `Promise<ScanCliResult>`
79
+
80
+ ### variable: reexport:runScanClifrom:undefined
81
+ Rolle: other (Sichtbarkeit: public, Priorität: normal)
82
+ Signatur: `reexport:runScanClifrom:undefined`
83
+ ```ts
84
+ reexport:runScanClifrom:undefined
85
+ ```
86
+
87
+ ### variable: reexport:ScanCliOptionsfrom:undefined
88
+ Rolle: other (Sichtbarkeit: public, Priorität: normal)
89
+ Signatur: `reexport:ScanCliOptionsfrom:undefined`
90
+ ```ts
91
+ reexport:ScanCliOptionsfrom:undefined
92
+ ```
93
+
94
+ ### variable: reexport:ScanCliResultfrom:undefined
95
+ Rolle: other (Sichtbarkeit: public, Priorität: normal)
96
+ Signatur: `reexport:ScanCliResultfrom:undefined`
97
+ ```ts
98
+ reexport:ScanCliResultfrom:undefined
99
+ ```