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

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 (144) hide show
  1. package/out/cli/generate-cli.js +58 -0
  2. package/out/cli/generate-cli.js.map +1 -1
  3. package/out/cli/scan-cli.js +6 -0
  4. package/out/cli/scan-cli.js.map +1 -1
  5. package/out/core/scanner.js +9 -1
  6. package/out/core/scanner.js.map +1 -1
  7. package/out/generator/system-metadata.js +202 -0
  8. package/out/generator/system-metadata.js.map +1 -0
  9. package/out/index/index.js +14 -0
  10. package/out/index/index.js.map +1 -1
  11. package/out/parsers/json-yaml.js +35 -4
  12. package/out/parsers/json-yaml.js.map +1 -1
  13. package/out/parsers/ts-js.js +208 -7
  14. package/out/parsers/ts-js.js.map +1 -1
  15. package/package.json +11 -4
  16. package/scripts/verify-adrs.js +74 -2
  17. package/scripts/verify-architecture.js +94 -9
  18. package/scripts/verify-imports.js +73 -9
  19. package/.vscodeignore +0 -41
  20. package/MCP_SERVER_SETUP.md +0 -371
  21. package/assets/icon.svg +0 -27
  22. package/docs/LINKEDIN_ANTWORT_SEQUENZDIAGRAMME.md +0 -190
  23. package/docs/SEQUENZDIAGRAMM_BEWEIS.md +0 -469
  24. package/docs/SEQUENZDIAGRAMM_VALIDATE_FLOW.md +0 -282
  25. package/docs/adr/001-signatur-abweichung-fix.md +0 -54
  26. package/docs/adr/002-file-specific-validation-1.0.1.md +0 -45
  27. package/docs/adr/003-documentation-generation-bugs.md +0 -134
  28. package/docs/adr/004-validator-signature-matching-fix.md +0 -121
  29. package/docs/adr/005-validator-generic-simplification-tightening.md +0 -35
  30. package/docs/adr/006-parser-variable-type-extraction.md +0 -33
  31. package/docs/adr/007-ts-parser-load-libs-for-accurate-types.md +0 -31
  32. package/docs/adr/008-dependencies-cache-phase1.md +0 -133
  33. package/docs/adr/009-consolidation-union-logic-phase1-2.md +0 -147
  34. package/docs/adr/010-extension-union-integration-phase1-3-and-phase2.md +0 -179
  35. package/docs/adr/011-module-doc-change-tracking-phase3.md +0 -190
  36. package/docs/adr/012-git-deletions-change-report-phase4.md +0 -235
  37. package/docs/adr/013-system-functionality-fixes.md +0 -279
  38. package/docs/adr/014-rules-migration-und-mcp-integration.md +0 -113
  39. package/docs/adr/015-global-agent-package.md +0 -158
  40. package/docs/adr/016-produktisierung-docguard.md +0 -193
  41. package/docs/adr/017-signature-matching-optional-fields.md +0 -128
  42. package/docs/adr/018-rebranding-docguard-to-noyrax.md +0 -109
  43. package/docs/adr/019-system-schwachstellen-analyse-und-fixes.md +0 -204
  44. package/docs/adr/020-api-doc-tiefe-und-signatureformatter.md +0 -74
  45. package/docs/adr/021-semantic-api-docs-and-symbol-classifier.md +0 -125
  46. package/docs/adr/022-semantic-class-and-constants-rendering.md +0 -82
  47. package/docs/adr/023-adr-verknuepfung-modul-doku.md +0 -54
  48. package/docs/adr/024-cursor-rules-mehrdimensionaler-raum.md +0 -230
  49. package/docs/adr/025-mcp-tools-scan-validate-cli-bridge.md +0 -202
  50. package/docs/adr/026-reality-driven-development-system.md +0 -173
  51. package/docs/adr/027-scanner-excludes-and-union-logic-fix.md +0 -189
  52. package/docs/adr/028-src-coverage-union-resync.md +0 -124
  53. package/docs/adr/029-parser-flow-kopplung-und-sync-drift-modi.md +0 -102
  54. package/docs/adr/030-dependency-import-symbol-names-preservation.md +0 -123
  55. package/docs/adr/031-generate-cli-vollstaendige-dokumentation.md +0 -99
  56. package/docs/adr/032-windows-optimized-verification-scripts.md +0 -165
  57. package/docs/adr/036-enhanced-dependency-metadata.md +0 -190
  58. package/docs/adr/TEMPLATE.md +0 -76
  59. package/docs/index/symbols.jsonl +0 -31
  60. package/docs/modules/action__action.yml.md +0 -50
  61. package/docs/modules/documentation.config.schema.json.md +0 -37
  62. package/docs/modules/mcp__package.json.md +0 -130
  63. package/docs/modules/mcp__src__resources__docs.ts.md +0 -94
  64. package/docs/modules/mcp__src__server.ts.md +0 -15
  65. package/docs/modules/mcp__src__tools__drift.ts.md +0 -110
  66. package/docs/modules/mcp__src__tools__impact.ts.md +0 -127
  67. package/docs/modules/mcp__src__tools__scan.ts.md +0 -75
  68. package/docs/modules/mcp__src__tools__validate.ts.md +0 -116
  69. package/docs/modules/mcp__src__tools__verify-adrs.ts.md +0 -106
  70. package/docs/modules/mcp__tsconfig.json.md +0 -22
  71. package/docs/modules/package.json.md +0 -131
  72. package/docs/modules/packages__doc-system-agent__examples__basic-project__package.json.md +0 -43
  73. package/docs/modules/packages__doc-system-agent__examples__basic-project__src__calculator.ts.md +0 -81
  74. package/docs/modules/packages__doc-system-agent__package.json.md +0 -154
  75. package/docs/modules/packages__doc-system-agent__src__cli__index.ts.md +0 -8
  76. package/docs/modules/packages__doc-system-agent__src__cli__init.ts.md +0 -93
  77. package/docs/modules/packages__doc-system-agent__src__cli__update.ts.md +0 -113
  78. package/docs/modules/packages__doc-system-agent__src__constants.ts.md +0 -29
  79. package/docs/modules/packages__doc-system-agent__src__index.ts.md +0 -234
  80. package/docs/modules/packages__doc-system-agent__src__mcp__resources__docs.ts.md +0 -94
  81. package/docs/modules/packages__doc-system-agent__src__mcp__server.ts.md +0 -17
  82. package/docs/modules/packages__doc-system-agent__src__mcp__tools__drift.ts.md +0 -38
  83. package/docs/modules/packages__doc-system-agent__src__mcp__tools__impact.ts.md +0 -75
  84. package/docs/modules/packages__doc-system-agent__src__mcp__tools__scan.ts.md +0 -23
  85. package/docs/modules/packages__doc-system-agent__src__mcp__tools__validate.ts.md +0 -23
  86. package/docs/modules/packages__doc-system-agent__src__mcp__tools__verify-adrs.ts.md +0 -106
  87. package/docs/modules/packages__doc-system-agent__src__mcp__types.ts.md +0 -355
  88. package/docs/modules/packages__doc-system-agent__tsconfig.json.md +0 -22
  89. package/docs/modules/scripts__verify-adrs.js.md +0 -97
  90. package/docs/modules/scripts__verify-architecture.js.md +0 -93
  91. package/docs/modules/scripts__verify-imports.js.md +0 -114
  92. package/docs/modules/src____tests____setup.ts.md +0 -8
  93. package/docs/modules/src____tests____signature-formatter.test.ts.md +0 -16
  94. package/docs/modules/src____tests____snapshot-doc-generation.test.ts.md +0 -8
  95. package/docs/modules/src____tests____symbol-classifier.test.ts.md +0 -16
  96. package/docs/modules/src__cache__ast-cache.ts.md +0 -91
  97. package/docs/modules/src__cache__dependencies-cache.ts.md +0 -89
  98. package/docs/modules/src__cache__output-cache.ts.md +0 -91
  99. package/docs/modules/src__cache__signature-cache.ts.md +0 -76
  100. package/docs/modules/src__cli__generate-cli.ts.md +0 -130
  101. package/docs/modules/src__cli__scan-cli.ts.md +0 -99
  102. package/docs/modules/src__cli__validate-cli.ts.md +0 -144
  103. package/docs/modules/src__core__async.ts.md +0 -18
  104. package/docs/modules/src__core__consolidation.ts.md +0 -158
  105. package/docs/modules/src__core__git.ts.md +0 -35
  106. package/docs/modules/src__core__language-detection.ts.md +0 -31
  107. package/docs/modules/src__core__scanner.ts.md +0 -101
  108. package/docs/modules/src__core__signature-formatter.ts.md +0 -232
  109. package/docs/modules/src__core__symbol-classifier.ts.md +0 -178
  110. package/docs/modules/src__core__symbols.ts.md +0 -31
  111. package/docs/modules/src__drift__index.ts.md +0 -53
  112. package/docs/modules/src__extension.ts.md +0 -418
  113. package/docs/modules/src__generator__adr-linker.ts.md +0 -154
  114. package/docs/modules/src__generator__change-report.ts.md +0 -85
  115. package/docs/modules/src__generator__dependency-graph.ts.md +0 -63
  116. package/docs/modules/src__generator__index.ts.md +0 -40
  117. package/docs/modules/src__generator__module-doc.ts.md +0 -242
  118. package/docs/modules/src__index__index.ts.md +0 -141
  119. package/docs/modules/src__logging__index.ts.md +0 -87
  120. package/docs/modules/src__parsers__dependencies.ts.md +0 -69
  121. package/docs/modules/src__parsers__json-yaml.ts.md +0 -81
  122. package/docs/modules/src__parsers__python.ts.md +0 -73
  123. package/docs/modules/src__parsers__ts-js.ts.md +0 -48
  124. package/docs/modules/src__parsers__types.ts.md +0 -99
  125. package/docs/modules/src__ui__commands-provider.ts.md +0 -70
  126. package/docs/modules/src__ui__status-bar.ts.md +0 -79
  127. package/docs/modules/src__validator__index.ts.md +0 -211
  128. package/docs/modules/src__validator__signature-matching.ts.md +0 -209
  129. package/docs/modules/src__validator__status.ts.md +0 -72
  130. package/docs/modules/test-mcp-resources.js.md +0 -27
  131. package/docs/modules/tsconfig.json.md +0 -22
  132. package/docs/system/CHANGE_REPORT.md +0 -19
  133. package/docs/system/DEPENDENCIES.md +0 -430
  134. package/docs/system/DEPENDENCY_GRAPH.md +0 -368
  135. package/docs/system/NAVIGATION_SPACE_ANALYSIS.md +0 -244
  136. package/docs/system/NPX_CACHE_FIX.md +0 -85
  137. package/docs/system/NPX_LOCAL_USAGE.md +0 -66
  138. package/docs/system/PLUGIN_ECOSYSTEM_STATUS.md +0 -465
  139. package/docs/system/PLUGIN_UPDATE_GUIDE.md +0 -212
  140. package/docs/system/RULES_UPDATE_GUIDE.md +0 -182
  141. package/docs/system/SYSTEM_ANALYSIS.md +0 -947
  142. package/documentation.config.schema.json +0 -77
  143. package/noyrax-5d-database-plugin-0.1.8.tgz +0 -0
  144. package/publish.ps1 +0 -21
@@ -1,81 +0,0 @@
1
- # Modul: src/parsers/json-yaml.ts
2
-
3
- ### class: JsonYamlParser
4
- Rolle: other (Sichtbarkeit: public, Priorität: normal)
5
- Signatur: `class JsonYamlParser`
6
- ```ts
7
- class JsonYamlParser
8
- ```
9
-
10
- Diese Klasse bündelt 3 Methoden. Die detaillierten Signaturen sind in den nachfolgenden `method:`-Abschnitten dokumentiert.
11
-
12
- ### method: JsonYamlParser.parse
13
- Rolle: other (Sichtbarkeit: public, Priorität: normal)
14
- Signatur: `parse(filePath: string, fileContent: string): ParsedSymbol[]`
15
- ```ts
16
- parse(filePath: string, fileContent: string): ParsedSymbol[]
17
- ```
18
-
19
- Parameter:
20
-
21
- | Name | Typ | Optional | Default |
22
- |------|-----|----------|---------|
23
- | `fileContent` | `string` | nein | nein |
24
- | `filePath` | `string` | nein | nein |
25
-
26
- Rückgabewert: `ParsedSymbol[]`
27
-
28
- ### method: JsonYamlParser.collectFromObject
29
- Rolle: other (Sichtbarkeit: internal, Priorität: low)
30
- Signatur: `collectFromObject(obj: any, repoRel: string, out: ParsedSymbol[], lang: string): void`
31
- ```ts
32
- collectFromObject(obj: any, repoRel: string, out: ParsedSymbol[], lang: string): void
33
- ```
34
-
35
- Parameter:
36
-
37
- | Name | Typ | Optional | Default |
38
- |------|-----|----------|---------|
39
- | `lang` | `string` | nein | nein |
40
- | `obj` | `any` | nein | nein |
41
- | `out` | `ParsedSymbol[]` | nein | nein |
42
- | `repoRel` | `string` | nein | nein |
43
-
44
- Rückgabewert: `void`
45
-
46
- ### method: JsonYamlParser.extractFrontMatter
47
- Rolle: other (Sichtbarkeit: internal, Priorität: low)
48
- Signatur: `extractFrontMatter(content: string): any | null`
49
- ```ts
50
- extractFrontMatter(content: string): any | null
51
- ```
52
-
53
- Parameter:
54
-
55
- | Name | Typ | Optional | Default |
56
- |------|-----|----------|---------|
57
- | `content` | `string` | nein | nein |
58
-
59
- Rückgabewert: `any | null`
60
-
61
- ### function: asRepoRel
62
- Rolle: other (Sichtbarkeit: public, Priorität: normal)
63
- Signatur: `asRepoRel(p: string): string`
64
- ```ts
65
- asRepoRel(p: string): string
66
- ```
67
-
68
- Parameter:
69
-
70
- | Name | Typ | Optional | Default |
71
- |------|-----|----------|---------|
72
- | `p` | `string` | nein | nein |
73
-
74
- Rückgabewert: `string`
75
-
76
- ### variable: JsonYamlParser.language
77
- Rolle: other (Sichtbarkeit: public, Priorität: normal)
78
- Signatur: `language: string`
79
- ```ts
80
- language: string
81
- ```
@@ -1,73 +0,0 @@
1
- # Modul: src/parsers/python.ts
2
-
3
- ### class: PythonParser
4
- Rolle: other (Sichtbarkeit: public, Priorität: normal)
5
- Signatur: `class PythonParser`
6
- ```ts
7
- class PythonParser
8
- ```
9
-
10
- Diese Klasse bündelt 3 Methoden. Die detaillierten Signaturen sind in den nachfolgenden `method:`-Abschnitten dokumentiert.
11
-
12
- ### method: PythonParser.parse
13
- Rolle: other (Sichtbarkeit: public, Priorität: normal)
14
- Signatur: `parse(filePath: string, fileContent: string): ParsedSymbol[]`
15
- ```ts
16
- parse(filePath: string, fileContent: string): ParsedSymbol[]
17
- ```
18
-
19
- Parameter:
20
-
21
- | Name | Typ | Optional | Default |
22
- |------|-----|----------|---------|
23
- | `fileContent` | `string` | nein | nein |
24
- | `filePath` | `string` | nein | nein |
25
-
26
- Rückgabewert: `ParsedSymbol[]`
27
-
28
- ### method: PythonParser.extractParameters
29
- Rolle: other (Sichtbarkeit: internal, Priorität: low)
30
- Signatur: `extractParameters(funcNode: Parser.SyntaxNode, source: string): Array<{ name: string; type?: string; hasDefault?: boolean }>`
31
- ```ts
32
- extractParameters(funcNode: Parser.SyntaxNode, source: string): Array<{ name: string; type?: string; hasDefault?: boolean }>
33
- ```
34
-
35
- Parameter:
36
-
37
- | Name | Typ | Optional | Default |
38
- |------|-----|----------|---------|
39
- | `funcNode` | `Parser.SyntaxNode` | nein | nein |
40
- | `source` | `string` | nein | nein |
41
-
42
- Rückgabewert: `Array<{ name: string; type?: string; hasDefault?: boolean }>`
43
-
44
- ### method: PythonParser.getNodeText
45
- Rolle: other (Sichtbarkeit: internal, Priorität: low)
46
- Signatur: `getNodeText(node: Parser.SyntaxNode, childType: string, source: string): string | null`
47
- ```ts
48
- getNodeText(node: Parser.SyntaxNode, childType: string, source: string): string | null
49
- ```
50
-
51
- Parameter:
52
-
53
- | Name | Typ | Optional | Default |
54
- |------|-----|----------|---------|
55
- | `childType` | `string` | nein | nein |
56
- | `node` | `Parser.SyntaxNode` | nein | nein |
57
- | `source` | `string` | nein | nein |
58
-
59
- Rückgabewert: `string | null`
60
-
61
- ### variable: PythonParser.language
62
- Rolle: other (Sichtbarkeit: public, Priorität: normal)
63
- Signatur: `language: string`
64
- ```ts
65
- language: string
66
- ```
67
-
68
- ### variable: PythonParser.parser
69
- Rolle: other (Sichtbarkeit: internal, Priorität: low)
70
- Signatur: `parser: Parser`
71
- ```ts
72
- parser: Parser
73
- ```
@@ -1,48 +0,0 @@
1
- # Modul: src/parsers/ts-js.ts
2
-
3
- ## Relevante ADRs
4
-
5
- - [ADR-003: Kritische Probleme in der generierten Dokumentation](../adr/003-documentation-generation-bugs.md)
6
- - [ADR-005: validator-generic-simplification-tightening](../adr/005-validator-generic-simplification-tightening.md)
7
- - [ADR-006: parser-variable-type-extraction](../adr/006-parser-variable-type-extraction.md)
8
- - [ADR-007: ts-parser-load-libs-for-accurate-types](../adr/007-ts-parser-load-libs-for-accurate-types.md)
9
- - [ADR-023: ADR-Verknüpfung mit Modul-Dokumentation](../adr/023-adr-verknuepfung-modul-doku.md)
10
-
11
- ### class: TsJsParser
12
- Rolle: other (Sichtbarkeit: public, Priorität: normal)
13
- Signatur: `class TsJsParser`
14
- ```ts
15
- class TsJsParser
16
- ```
17
-
18
- Diese Klasse bündelt 1 Methoden. Die detaillierten Signaturen sind in den nachfolgenden `method:`-Abschnitten dokumentiert.
19
-
20
- ### method: TsJsParser.parse
21
- Rolle: other (Sichtbarkeit: public, Priorität: normal)
22
- Signatur: `parse(filePath: string, fileContent: string): ParsedSymbol[]`
23
- ```ts
24
- parse(filePath: string, fileContent: string): ParsedSymbol[]
25
- ```
26
-
27
- Parameter:
28
-
29
- | Name | Typ | Optional | Default |
30
- |------|-----|----------|---------|
31
- | `fileContent` | `string` | nein | nein |
32
- | `filePath` | `string` | nein | nein |
33
-
34
- Rückgabewert: `ParsedSymbol[]`
35
-
36
- ### variable: TsJsParser.language
37
- Rolle: other (Sichtbarkeit: public, Priorität: normal)
38
- Signatur: `language: string`
39
- ```ts
40
- language: string
41
- ```
42
-
43
- ### variable: TsJsParser.project
44
- Rolle: other (Sichtbarkeit: internal, Priorität: low)
45
- Signatur: `project: Project`
46
- ```ts
47
- project: Project
48
- ```
@@ -1,99 +0,0 @@
1
- # Modul: src/parsers/types.ts
2
-
3
- ### interface: ParsedSymbol
4
- Rolle: other (Sichtbarkeit: public, Priorität: normal)
5
- Signatur: `interface ParsedSymbol {
6
- language: string;
7
- filePath: string;
8
- fullyQualifiedName: string;
9
- signature: SymbolSignature;
10
- kind: 'class' | 'interface' | 'function' | 'method' | 'type' | 'enum' | 'variable' | 'module';
11
- }`
12
- ```ts
13
- interface ParsedSymbol {
14
- language: string;
15
- filePath: string;
16
- fullyQualifiedName: string;
17
- signature: SymbolSignature;
18
- kind: 'class' | 'interface' | 'function' | 'method' | 'type' | 'enum' | 'variable' | 'module';
19
- }
20
- ```
21
-
22
- Eigenschaften:
23
-
24
- | Name | Typ | Optional |
25
- |------|-----|----------|
26
- | `filePath` | `string` | nein |
27
- | `fullyQualifiedName` | `string` | nein |
28
- | `kind` | `'class' | 'interface' | 'function' | 'method' | 'type' | 'enum' | 'variable' | 'module'` | nein |
29
- | `language` | `string` | nein |
30
- | `signature` | `SymbolSignature` | nein |
31
-
32
- ### interface: ParserAdapter
33
- Rolle: other (Sichtbarkeit: public, Priorität: normal)
34
- Signatur: `interface ParserAdapter {
35
- language: string;
36
- }`
37
- ```ts
38
- interface ParserAdapter {
39
- language: string;
40
- }
41
- ```
42
-
43
- Eigenschaften:
44
-
45
- | Name | Typ | Optional |
46
- |------|-----|----------|
47
- | `language` | `string` | nein |
48
-
49
- ### interface: SymbolParameter
50
- Rolle: other (Sichtbarkeit: public, Priorität: normal)
51
- Signatur: `interface SymbolParameter {
52
- name: string;
53
- type?: string;
54
- hasDefault?: boolean;
55
- optional?: boolean;
56
- }`
57
- ```ts
58
- interface SymbolParameter {
59
- name: string;
60
- type?: string;
61
- hasDefault?: boolean;
62
- optional?: boolean;
63
- }
64
- ```
65
-
66
- Eigenschaften:
67
-
68
- | Name | Typ | Optional |
69
- |------|-----|----------|
70
- | `hasDefault` | `boolean` | ja |
71
- | `name` | `string` | nein |
72
- | `optional` | `boolean` | ja |
73
- | `type` | `string` | ja |
74
-
75
- ### interface: SymbolSignature
76
- Rolle: other (Sichtbarkeit: public, Priorität: normal)
77
- Signatur: `interface SymbolSignature {
78
- name: string;
79
- parameters: SymbolParameter[];
80
- returnType?: string;
81
- visibility?: 'public' | 'protected' | 'private' | 'package';
82
- }`
83
- ```ts
84
- interface SymbolSignature {
85
- name: string;
86
- parameters: SymbolParameter[];
87
- returnType?: string;
88
- visibility?: 'public' | 'protected' | 'private' | 'package';
89
- }
90
- ```
91
-
92
- Eigenschaften:
93
-
94
- | Name | Typ | Optional |
95
- |------|-----|----------|
96
- | `name` | `string` | nein |
97
- | `parameters` | `SymbolParameter[]` | nein |
98
- | `returnType` | `string` | ja |
99
- | `visibility` | `'public' | 'protected' | 'private' | 'package'` | ja |
@@ -1,70 +0,0 @@
1
- # Modul: src/ui/commands-provider.ts
2
-
3
- ### class: CommandItem
4
- Rolle: other (Sichtbarkeit: public, Priorität: normal)
5
- Signatur: `class CommandItem`
6
- ```ts
7
- class CommandItem
8
- ```
9
-
10
- ### class: CommandsProvider
11
- Rolle: other (Sichtbarkeit: public, Priorität: normal)
12
- Signatur: `class CommandsProvider`
13
- ```ts
14
- class CommandsProvider
15
- ```
16
-
17
- Diese Klasse bündelt 3 Methoden. Die detaillierten Signaturen sind in den nachfolgenden `method:`-Abschnitten dokumentiert.
18
-
19
- ### method: CommandsProvider.getChildren
20
- Rolle: other (Sichtbarkeit: public, Priorität: normal)
21
- Signatur: `getChildren(element: CommandItem): Thenable<CommandItem[]>`
22
- ```ts
23
- getChildren(element: CommandItem): Thenable<CommandItem[]>
24
- ```
25
-
26
- Parameter:
27
-
28
- | Name | Typ | Optional | Default |
29
- |------|-----|----------|---------|
30
- | `element` | `CommandItem` | nein | nein |
31
-
32
- Rückgabewert: `Thenable<CommandItem[]>`
33
-
34
- ### method: CommandsProvider.getTreeItem
35
- Rolle: other (Sichtbarkeit: public, Priorität: normal)
36
- Signatur: `getTreeItem(element: CommandItem): vscode.TreeItem`
37
- ```ts
38
- getTreeItem(element: CommandItem): vscode.TreeItem
39
- ```
40
-
41
- Parameter:
42
-
43
- | Name | Typ | Optional | Default |
44
- |------|-----|----------|---------|
45
- | `element` | `CommandItem` | nein | nein |
46
-
47
- Rückgabewert: `vscode.TreeItem`
48
-
49
- ### method: CommandsProvider.refresh
50
- Rolle: other (Sichtbarkeit: public, Priorität: normal)
51
- Signatur: `refresh(): void`
52
- ```ts
53
- refresh(): void
54
- ```
55
-
56
- Rückgabewert: `void`
57
-
58
- ### variable: CommandsProvider.onDidChangeTreeData
59
- Rolle: other (Sichtbarkeit: public, Priorität: normal)
60
- Signatur: `onDidChangeTreeData: vscode.Event<CommandItem | undefined | null | void>`
61
- ```ts
62
- onDidChangeTreeData: vscode.Event<CommandItem | undefined | null | void>
63
- ```
64
-
65
- ### variable: CommandsProvider._onDidChangeTreeData
66
- Rolle: other (Sichtbarkeit: internal, Priorität: low)
67
- Signatur: `_onDidChangeTreeData: vscode.EventEmitter<CommandItem | undefined | null | void>`
68
- ```ts
69
- _onDidChangeTreeData: vscode.EventEmitter<CommandItem | undefined | null | void>
70
- ```
@@ -1,79 +0,0 @@
1
- # Modul: src/ui/status-bar.ts
2
-
3
- <!-- change: symbol-added name="StatusBarManager.validateButton" kind="variable" -->
4
- ### class: StatusBarManager
5
- Rolle: service-api (Sichtbarkeit: public, Priorität: high)
6
- Signatur: `class StatusBarManager`
7
- ```ts
8
- class StatusBarManager
9
- ```
10
-
11
- Diese Klasse bündelt 3 Methoden. Die detaillierten Signaturen sind in den nachfolgenden `method:`-Abschnitten dokumentiert.
12
-
13
- ### method: StatusBarManager.hideProgress
14
- Rolle: other (Sichtbarkeit: public, Priorität: normal)
15
- Signatur: `hideProgress(): void`
16
- ```ts
17
- hideProgress(): void
18
- ```
19
-
20
- Rückgabewert: `void`
21
-
22
- ### method: StatusBarManager.showProgress
23
- Rolle: other (Sichtbarkeit: public, Priorität: normal)
24
- Signatur: `showProgress(operation: string): void`
25
- ```ts
26
- showProgress(operation: string): void
27
- ```
28
-
29
- Parameter:
30
-
31
- | Name | Typ | Optional | Default |
32
- |------|-----|----------|---------|
33
- | `operation` | `string` | nein | nein |
34
-
35
- Rückgabewert: `void`
36
-
37
- ### method: StatusBarManager.updateStatus
38
- Rolle: other (Sichtbarkeit: public, Priorität: normal)
39
- Signatur: `updateStatus(status: 'green' | 'yellow' | 'red' | 'unknown', message: string): void`
40
- ```ts
41
- updateStatus(status: 'green' | 'yellow' | 'red' | 'unknown', message: string): void
42
- ```
43
-
44
- Parameter:
45
-
46
- | Name | Typ | Optional | Default |
47
- |------|-----|----------|---------|
48
- | `message` | `string` | nein | nein |
49
- | `status` | `'green' | 'yellow' | 'red' | 'unknown'` | nein | nein |
50
-
51
- Rückgabewert: `void`
52
-
53
- ### variable: StatusBarManager.generateButton
54
- Rolle: other (Sichtbarkeit: internal, Priorität: low)
55
- Signatur: `generateButton: vscode.StatusBarItem`
56
- ```ts
57
- generateButton: vscode.StatusBarItem
58
- ```
59
-
60
- ### variable: StatusBarManager.scanButton
61
- Rolle: other (Sichtbarkeit: internal, Priorität: low)
62
- Signatur: `scanButton: vscode.StatusBarItem`
63
- ```ts
64
- scanButton: vscode.StatusBarItem
65
- ```
66
-
67
- ### variable: StatusBarManager.statusIndicator
68
- Rolle: other (Sichtbarkeit: internal, Priorität: low)
69
- Signatur: `statusIndicator: vscode.StatusBarItem`
70
- ```ts
71
- statusIndicator: vscode.StatusBarItem
72
- ```
73
-
74
- ### variable: StatusBarManager.validateButton
75
- Rolle: other (Sichtbarkeit: internal, Priorität: low)
76
- Signatur: `validateButton: vscode.StatusBarItem`
77
- ```ts
78
- validateButton: vscode.StatusBarItem
79
- ```
@@ -1,211 +0,0 @@
1
- # Modul: src/validator/index.ts
2
-
3
- ## Relevante ADRs
4
-
5
- - [ADR-002: Datei-spezifische Signatur-Validierung und Release 1.0.1](../adr/002-file-specific-validation-1.0.1.md)
6
- - [ADR-025: MCP-Server Tools Scan/Validate – CLI-Bridge-Pattern](../adr/025-mcp-tools-scan-validate-cli-bridge.md)
7
-
8
- <!-- change: symbol-added name="validateMarkdownContent" kind="function" -->
9
- ### interface: CoverageMetrics
10
- Rolle: infra (Sichtbarkeit: public, Priorität: low)
11
- Signatur: `interface CoverageMetrics {
12
- totalClasses: number;
13
- documentedClasses: number;
14
- totalInterfaces: number;
15
- documentedInterfaces: number;
16
- totalMethods: number;
17
- documentedMethods: number;
18
- totalFunctions: number;
19
- documentedFunctions: number;
20
- }`
21
- ```ts
22
- interface CoverageMetrics {
23
- totalClasses: number;
24
- documentedClasses: number;
25
- totalInterfaces: number;
26
- documentedInterfaces: number;
27
- totalMethods: number;
28
- documentedMethods: number;
29
- totalFunctions: number;
30
- documentedFunctions: number;
31
- }
32
- ```
33
-
34
- Eigenschaften:
35
-
36
- | Name | Typ | Optional |
37
- |------|-----|----------|
38
- | `documentedClasses` | `number` | nein |
39
- | `documentedFunctions` | `number` | nein |
40
- | `documentedInterfaces` | `number` | nein |
41
- | `documentedMethods` | `number` | nein |
42
- | `totalClasses` | `number` | nein |
43
- | `totalFunctions` | `number` | nein |
44
- | `totalInterfaces` | `number` | nein |
45
- | `totalMethods` | `number` | nein |
46
-
47
- <!-- change: symbol-added name="validateMarkdownDir" kind="function" -->
48
- ### interface: CoverageReport
49
- Rolle: infra (Sichtbarkeit: public, Priorität: low)
50
- Signatur: `interface CoverageReport {
51
- metrics: CoverageMetrics;
52
- errors: string[];
53
- warnings: string[];
54
- }`
55
- ```ts
56
- interface CoverageReport {
57
- metrics: CoverageMetrics;
58
- errors: string[];
59
- warnings: string[];
60
- }
61
- ```
62
-
63
- Eigenschaften:
64
-
65
- | Name | Typ | Optional |
66
- |------|-----|----------|
67
- | `errors` | `string[]` | nein |
68
- | `metrics` | `CoverageMetrics` | nein |
69
- | `warnings` | `string[]` | nein |
70
-
71
- <!-- change: symbol-added name="validateSymbols" kind="function" -->
72
- ### interface: CoverageThresholds
73
- Rolle: infra (Sichtbarkeit: public, Priorität: low)
74
- Signatur: `interface CoverageThresholds {
75
- classes: number;
76
- interfaces: number;
77
- methods: number;
78
- functions: number;
79
- }`
80
- ```ts
81
- interface CoverageThresholds {
82
- classes: number;
83
- interfaces: number;
84
- methods: number;
85
- functions: number;
86
- }
87
- ```
88
-
89
- Eigenschaften:
90
-
91
- | Name | Typ | Optional |
92
- |------|-----|----------|
93
- | `classes` | `number` | nein |
94
- | `functions` | `number` | nein |
95
- | `interfaces` | `number` | nein |
96
- | `methods` | `number` | nein |
97
-
98
- ### interface: MarkdownDirReport
99
- Rolle: infra (Sichtbarkeit: public, Priorität: low)
100
- Signatur: `interface MarkdownDirReport {
101
- errors: string[];
102
- warnings: string[];
103
- files: Array<{ file: string; errors: string[]; warnings: string[] }>;
104
- mismatchesCount?: number;
105
- }`
106
- ```ts
107
- interface MarkdownDirReport {
108
- errors: string[];
109
- warnings: string[];
110
- files: Array<{ file: string; errors: string[]; warnings: string[] }>;
111
- mismatchesCount?: number;
112
- }
113
- ```
114
-
115
- Eigenschaften:
116
-
117
- | Name | Typ | Optional |
118
- |------|-----|----------|
119
- | `errors` | `string[]` | nein |
120
- | `files` | `Array<{ file: string; errors: string[]; warnings: string[] }>` | nein |
121
- | `mismatchesCount` | `number` | ja |
122
- | `warnings` | `string[]` | nein |
123
-
124
- ### interface: ValidationReport
125
- Rolle: infra (Sichtbarkeit: public, Priorität: low)
126
- Signatur: `interface ValidationReport {
127
- totalSymbols: number;
128
- errors: string[];
129
- warnings: string[];
130
- status?: StatusReport;
131
- }`
132
- ```ts
133
- interface ValidationReport {
134
- totalSymbols: number;
135
- errors: string[];
136
- warnings: string[];
137
- status?: StatusReport;
138
- }
139
- ```
140
-
141
- Eigenschaften:
142
-
143
- | Name | Typ | Optional |
144
- |------|-----|----------|
145
- | `errors` | `string[]` | nein |
146
- | `status` | `StatusReport` | ja |
147
- | `totalSymbols` | `number` | nein |
148
- | `warnings` | `string[]` | nein |
149
-
150
- ### function: computeCoverage
151
- Rolle: infra (Sichtbarkeit: public, Priorität: low)
152
- Signatur: `computeCoverage(symbols: ParsedSymbol[], modulesDir: string, thresholds: CoverageThresholds = …): CoverageReport`
153
- ```ts
154
- computeCoverage(symbols: ParsedSymbol[], modulesDir: string, thresholds: CoverageThresholds = …): CoverageReport
155
- ```
156
-
157
- Parameter:
158
-
159
- | Name | Typ | Optional | Default |
160
- |------|-----|----------|---------|
161
- | `modulesDir` | `string` | nein | nein |
162
- | `symbols` | `ParsedSymbol[]` | nein | nein |
163
- | `thresholds` | `CoverageThresholds` | nein | ja |
164
-
165
- Rückgabewert: `CoverageReport`
166
-
167
- ### function: validateMarkdownContent
168
- Rolle: infra (Sichtbarkeit: public, Priorität: low)
169
- Signatur: `validateMarkdownContent(md: string): { errors: string[]; warnings: string[] }`
170
- ```ts
171
- validateMarkdownContent(md: string): { errors: string[]; warnings: string[] }
172
- ```
173
-
174
- Parameter:
175
-
176
- | Name | Typ | Optional | Default |
177
- |------|-----|----------|---------|
178
- | `md` | `string` | nein | nein |
179
-
180
- Rückgabewert: `{ errors: string[]; warnings: string[] }`
181
-
182
- ### function: validateMarkdownDir
183
- Rolle: infra (Sichtbarkeit: public, Priorität: low)
184
- Signatur: `validateMarkdownDir(modulesDir: string, symbols: ParsedSymbol[]): MarkdownDirReport`
185
- ```ts
186
- validateMarkdownDir(modulesDir: string, symbols: ParsedSymbol[]): MarkdownDirReport
187
- ```
188
-
189
- Parameter:
190
-
191
- | Name | Typ | Optional | Default |
192
- |------|-----|----------|---------|
193
- | `modulesDir` | `string` | nein | nein |
194
- | `symbols` | `ParsedSymbol[]` | nein | nein |
195
-
196
- Rückgabewert: `MarkdownDirReport`
197
-
198
- ### function: validateSymbols
199
- Rolle: infra (Sichtbarkeit: public, Priorität: low)
200
- Signatur: `validateSymbols(symbols: ParsedSymbol[]): ValidationReport`
201
- ```ts
202
- validateSymbols(symbols: ParsedSymbol[]): ValidationReport
203
- ```
204
-
205
- Parameter:
206
-
207
- | Name | Typ | Optional | Default |
208
- |------|-----|----------|---------|
209
- | `symbols` | `ParsedSymbol[]` | nein | nein |
210
-
211
- Rückgabewert: `ValidationReport`