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

package/docs/modules/src__validator__signature-matching.ts.md

@@ -0,0 +1,209 @@
+# Modul: src/validator/signature-matching.ts
+
+## Relevante ADRs
+
+- [ADR-001: Signatur-Abweichung-Fix für Plugin/Snapshot](../adr/001-signatur-abweichung-fix.md)
+- [ADR-002: Datei-spezifische Signatur-Validierung und Release 1.0.1](../adr/002-file-specific-validation-1.0.1.md)
+- [ADR-004: Validator Signature-Matching Reparatur](../adr/004-validator-signature-matching-fix.md)
+- [ADR-005: validator-generic-simplification-tightening](../adr/005-validator-generic-simplification-tightening.md)
+- [ADR-013: system-functionality-fixes](../adr/013-system-functionality-fixes.md)
+- [ADR-017: Verbesserte Optional-Feld-Kompatibilität in Signatur-Validierung](../adr/017-signature-matching-optional-fields.md)
+- [ADR-020: API-Doku-Tiefe & zentrale Signatur-Formatierung](../adr/020-api-doc-tiefe-und-signatureformatter.md)
+- [ADR-021: Semantische API-Doku-Tiefe & SymbolClassifier](../adr/021-semantic-api-docs-and-symbol-classifier.md)
+- [ADR-028: Vollständige `src`-Abdeckung, Union-Logik & Resync-Strategie](../adr/028-src-coverage-union-resync.md)
+
+<!-- change: symbol-added name="isApiConfigPattern" kind="function" -->
+### interface: SignatureMatchingOptions
+Rolle: config (Sichtbarkeit: public, Priorität: normal)
+Signatur: `interface SignatureMatchingOptions {
+  validateNonPublic?: boolean;
+  depth?: 'full' | 'standard' | 'minimal';
+}`
+```ts
+interface SignatureMatchingOptions {
+  validateNonPublic?: boolean;
+  depth?: 'full' | 'standard' | 'minimal';
+}
+```
+
+Eigenschaften:
+
+| Name | Typ | Optional |
+|------|-----|----------|
+| `depth` | `'full' | 'standard' | 'minimal'` | ja |
+| `validateNonPublic` | `boolean` | ja |
+
+### interface: SignatureMismatch
+Rolle: infra (Sichtbarkeit: public, Priorität: low)
+Signatur: `interface SignatureMismatch {
+  symbolId: string;
+  expected: string;
+  documented: string;
+  severity: 'warning' | 'error';
+}`
+```ts
+interface SignatureMismatch {
+  symbolId: string;
+  expected: string;
+  documented: string;
+  severity: 'warning' | 'error';
+}
+```
+
+Eigenschaften:
+
+| Name | Typ | Optional |
+|------|-----|----------|
+| `documented` | `string` | nein |
+| `expected` | `string` | nein |
+| `severity` | `'warning' | 'error'` | nein |
+| `symbolId` | `string` | nein |
+
+<!-- change: symbol-added name="isConfigSuffixPattern" kind="function" -->
+### function: escapeRegex
+Rolle: infra (Sichtbarkeit: public, Priorität: low)
+Signatur: `escapeRegex(str: string): string`
+```ts
+escapeRegex(str: string): string
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `str` | `string` | nein | nein |
+
+Rückgabewert: `string`
+
+<!-- change: symbol-added name="isManagerPattern" kind="function" -->
+### function: isApiConfigPattern
+Rolle: infra (Sichtbarkeit: public, Priorität: low)
+Signatur: `isApiConfigPattern(expected: string, documented: string): boolean`
+```ts
+isApiConfigPattern(expected: string, documented: string): boolean
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `documented` | `string` | nein | nein |
+| `expected` | `string` | nein | nein |
+
+Rückgabewert: `boolean`
+
+<!-- change: symbol-added name="isRecommendationApiConfigPattern" kind="function" -->
+### function: isArchitecturallyValid
+Rolle: infra (Sichtbarkeit: public, Priorität: low)
+Signatur: `isArchitecturallyValid(expected: string, documented: string, symbol: ParsedSymbol): boolean`
+```ts
+isArchitecturallyValid(expected: string, documented: string, symbol: ParsedSymbol): boolean
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `documented` | `string` | nein | nein |
+| `expected` | `string` | nein | nein |
+| `symbol` | `ParsedSymbol` | nein | nein |
+
+Rückgabewert: `boolean`
+
+<!-- change: symbol-added name="isRecommendationPattern" kind="function" -->
+### function: isConfigSuffixPattern
+Rolle: infra (Sichtbarkeit: public, Priorität: low)
+Signatur: `isConfigSuffixPattern(expected: string, documented: string): boolean`
+```ts
+isConfigSuffixPattern(expected: string, documented: string): boolean
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `documented` | `string` | nein | nein |
+| `expected` | `string` | nein | nein |
+
+Rückgabewert: `boolean`
+
+### function: isManagerPattern
+Rolle: infra (Sichtbarkeit: public, Priorität: low)
+Signatur: `isManagerPattern(expected: string, documented: string): boolean`
+```ts
+isManagerPattern(expected: string, documented: string): boolean
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `documented` | `string` | nein | nein |
+| `expected` | `string` | nein | nein |
+
+Rückgabewert: `boolean`
+
+### function: isRecommendationApiConfigPattern
+Rolle: infra (Sichtbarkeit: public, Priorität: low)
+Signatur: `isRecommendationApiConfigPattern(expected: string, documented: string): boolean`
+```ts
+isRecommendationApiConfigPattern(expected: string, documented: string): boolean
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `documented` | `string` | nein | nein |
+| `expected` | `string` | nein | nein |
+
+Rückgabewert: `boolean`
+
+### function: isRecommendationPattern
+Rolle: infra (Sichtbarkeit: public, Priorität: low)
+Signatur: `isRecommendationPattern(expected: string, documented: string): boolean`
+```ts
+isRecommendationPattern(expected: string, documented: string): boolean
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `documented` | `string` | nein | nein |
+| `expected` | `string` | nein | nein |
+
+Rückgabewert: `boolean`
+
+### function: isResponseWrapperPattern
+Rolle: infra (Sichtbarkeit: public, Priorität: low)
+Signatur: `isResponseWrapperPattern(expected: string, documented: string): boolean`
+```ts
+isResponseWrapperPattern(expected: string, documented: string): boolean
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `documented` | `string` | nein | nein |
+| `expected` | `string` | nein | nein |
+
+Rückgabewert: `boolean`
+
+### function: validateSignatureMatching
+Rolle: infra (Sichtbarkeit: public, Priorität: low)
+Signatur: `validateSignatureMatching(symbols: ParsedSymbol[], modulesDir: string, options: SignatureMatchingOptions = …): SignatureMismatch[]`
+```ts
+validateSignatureMatching(symbols: ParsedSymbol[], modulesDir: string, options: SignatureMatchingOptions = …): SignatureMismatch[]
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `modulesDir` | `string` | nein | nein |
+| `options` | `SignatureMatchingOptions` | nein | ja |
+| `symbols` | `ParsedSymbol[]` | nein | nein |
+
+Rückgabewert: `SignatureMismatch[]`

package/docs/modules/src__validator__status.ts.md

@@ -0,0 +1,72 @@
+# Modul: src/validator/status.ts
+
+## Relevante ADRs
+
+- [ADR-028: Vollständige `src`-Abdeckung, Union-Logik & Resync-Strategie](../adr/028-src-coverage-union-resync.md)
+
+### interface: StatusReport
+Rolle: infra (Sichtbarkeit: public, Priorität: low)
+Signatur: `interface StatusReport {
+  status: ValidationStatus;
+  message: string;
+  details: {
+        totalErrors: number;
+        totalWarnings: number;
+        coverageIssues: number;
+        signatureMismatches: number;
+        markdownIssues: number;
+    };
+}`
+```ts
+interface StatusReport {
+  status: ValidationStatus;
+  message: string;
+  details: {
+        totalErrors: number;
+        totalWarnings: number;
+        coverageIssues: number;
+        signatureMismatches: number;
+        markdownIssues: number;
+    };
+}
+```
+
+Eigenschaften:
+
+| Name | Typ | Optional |
+|------|-----|----------|
+| `details` | `{
+        totalErrors: number;
+        totalWarnings: number;
+        coverageIssues: number;
+        signatureMismatches: number;
+        markdownIssues: number;
+    }` | nein |
+| `message` | `string` | nein |
+| `status` | `ValidationStatus` | nein |
+
+### function: computeValidationStatus
+Rolle: infra (Sichtbarkeit: public, Priorität: low)
+Signatur: `computeValidationStatus(errors: string[], warnings: string[], coverageErrors: string[], signatureMismatches: number, markdownErrors: string[]): StatusReport`
+```ts
+computeValidationStatus(errors: string[], warnings: string[], coverageErrors: string[], signatureMismatches: number, markdownErrors: string[]): StatusReport
+```
+
+Parameter:
+
+| Name | Typ | Optional | Default |
+|------|-----|----------|---------|
+| `coverageErrors` | `string[]` | nein | nein |
+| `errors` | `string[]` | nein | nein |
+| `markdownErrors` | `string[]` | nein | nein |
+| `signatureMismatches` | `number` | nein | nein |
+| `warnings` | `string[]` | nein | nein |
+
+Rückgabewert: `StatusReport`
+
+### type: ValidationStatus
+Rolle: infra (Sichtbarkeit: public, Priorität: low)
+Signatur: `type ValidationStatus`
+```ts
+type ValidationStatus
+```

package/docs/modules/test-mcp-resources.js.md

@@ -0,0 +1,27 @@
+# Modul: test-mcp-resources.js
+
+<!-- change: symbol-added name="testMcpServer" kind="function" -->
+### function: testMcpServer
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `testMcpServer(): Promise<any>`
+```ts
+testMcpServer(): Promise<any>
+```
+
+Rückgabewert: `Promise<any>`
+
+<!-- change: symbol-added name="{ spawn }" kind="variable" -->
+### variable: { spawn }
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `{ spawn }: any`
+```ts
+{ spawn }: any
+```
+
+<!-- change: symbol-added name="path" kind="variable" -->
+### variable: path
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `path: PlatformPath`
+```ts
+path: PlatformPath
+```

package/docs/modules/tsconfig.json.md

@@ -0,0 +1,22 @@
+# Modul: tsconfig.json
+
+### variable: compilerOptions
+Rolle: config (Sichtbarkeit: public, Priorität: normal)
+Signatur: `compilerOptions: object`
+```ts
+compilerOptions: object
+```
+
+### variable: exclude
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `exclude: object`
+```ts
+exclude: object
+```
+
+### variable: include
+Rolle: other (Sichtbarkeit: public, Priorität: normal)
+Signatur: `include: object`
+```ts
+include: object
+```

package/docs/system/CHANGE_REPORT.md

@@ -0,0 +1,19 @@
+# Änderungsreport
+
+Letzter Lauf: Incremental
+Geparste Dateien: 30
+Übersprungene Dateien: 25
+
+## Neu hinzugefügte Symbole
+- `src/core/consolidation.ts::deduplicateAndSortDependencies` (function)
+- `src/core/scanner.ts::EXCLUDE_FILE_PATTERNS` (variable)
+
+## Abhängigkeiten
+- Neu: 0 Dependencies
+- Entfernt: 0 Dependencies
+- Gesamt: 221 Dependencies
+
+## Validator-Status
+- Fehler: 0
+- Warnungen: 1
+  - Signatur-Abweichung: ts://src/cache/dependencies-cache.ts#DependencyCacheEntry