noyrax-doc-cli

Standalone CLI für Noyrax Documentation System - Scan, Validate, Generate, Verify

Überblick

Dieses Package stellt alle CLI-Befehle des Noyrax Documentation System als eigenständige, installierbare Commands zur Verfügung. Es nutzt nur das noyrax (documentation-system-plugin) Package als Dependency und funktioniert ohne Database- oder Semantic-Brain-Plugins.

Installation

npm install -D noyrax-doc-cli noyrax

Wichtig: Das noyrax Package muss ebenfalls installiert sein, da es als Peer-Dependency verwendet wird.

Verfügbare Commands

Dokumentations-Generierung

noyrax-scan

Führt einen vollständigen Scan durch und generiert die Dokumentation.

noyrax-scan

Funktionalität:

• Scannt das Projekt nach TypeScript/JavaScript/Python-Dateien
• Extrahiert Symbole (Funktionen, Klassen, Interfaces, etc.)
• Generiert Modul-Dokumentation in docs/modules/
• Erstellt Symbol-Index in docs/index/symbols.jsonl
• Generiert Dependency-Graph in docs/system/DEPENDENCY_GRAPH.md
• Erstellt Change Report in docs/system/CHANGE_REPORT.md

noyrax-generate

Generiert nur die Dokumentation (ohne Scan).

noyrax-generate

Verwendung: Wenn bereits gescannt wurde und nur die Dokumentation aktualisiert werden soll.

Validierung

noyrax-validate

Validiert die Dokumentation gegen den Code.

noyrax-validate

Funktionalität:

• Prüft Signatur-Übereinstimmung zwischen Code und Dokumentation
• Prüft Coverage (welche Symbole sind dokumentiert)
• Erkennt veraltete Dokumentation
• Gibt Exit-Code zurück:
  • 0 = Alles valide
  • 1 = Warnungen (z.B. fehlende Docs)
  • 2 = Fehler (z.B. Signatur-Mismatch)

Verification

noyrax-verify-adrs

Prüft ADR-Claims gegen den Code.

noyrax-verify-adrs

Funktionalität:

• Prüft, ob in ADRs erwähnte Dateien existieren
• Prüft, ob in ADRs erwähnte Funktionen existieren
• Erkennt veraltete ADR-Claims

Optionen:

noyrax-verify-adrs --verbose  # Ausführliche Ausgabe mit Warnungen

noyrax-verify-architecture

Prüft Architektur-Regeln.

noyrax-verify-architecture

Funktionalität:

• Prüft Import-Richtungen
• Erkennt zirkuläre Abhängigkeiten
• Validiert Modul-Struktur

noyrax-verify-imports

Prüft Import-Verfügbarkeit.

noyrax-verify-imports

Funktionalität:

• Prüft, ob alle Imports verfügbar sind
• Erkennt fehlende Dependencies
• Validiert Import-Pfade

noyrax-verify-all

Führt alle Verification-Checks aus.

noyrax-verify-all

Funktionalität:

• Führt verify-architecture, verify-adrs und verify-imports nacheinander aus
• Gibt Exit-Code 1 zurück, wenn ein Check fehlschlägt

Workflow-Integration

Standard-Workflow

# 1. Dokumentation generieren
noyrax-scan

# 2. Dokumentation validieren
noyrax-validate

# 3. Verification-Checks
noyrax-verify-all

In package.json Scripts

{
  "scripts": {
    "docs:scan": "noyrax-scan",
    "docs:validate": "noyrax-validate",
    "docs:verify": "noyrax-verify-all",
    "docs:full": "noyrax-scan && noyrax-validate && noyrax-verify-all"
  }
}

Dann können Sie verwenden:

npm run docs:scan
npm run docs:validate
npm run docs:verify
npm run docs:full

Mit npx (ohne Installation)

npx noyrax-doc-cli noyrax-scan
npx noyrax-doc-cli noyrax-validate
npx noyrax-doc-cli noyrax-verify-all

Cursor Rules Integration

Die CLI-Befehle sind in den Cursor Rules dokumentiert:

• 001-pre-check.mdc: Verification-Commands Quick-Reference
• 026-reality-driven-verification.mdc: Build-Verification Commands

Die Cursor Rules unterstützen beide Varianten:

1. Standalone CLI (noyrax-scan, noyrax-validate, etc.) - für neue Projekte
2. Lokale Scripts (npm run scan:cli, etc.) - für Projekte mit documentation-system-plugin

Voraussetzungen

• Node.js >= 18.0.0
• TypeScript >= 4.9.0 oder >= 5.0.0
• Das noyrax Package muss installiert und kompiliert sein

Fehlerbehebung

"Could not find noyrax package"

Lösung: Installieren Sie das noyrax Package:

npm install noyrax

"Script not found"

Lösung: Stellen Sie sicher, dass das noyrax Package kompiliert ist:

cd node_modules/noyrax
npm run compile

"Command not found"

Lösung: Stellen Sie sicher, dass noyrax-doc-cli installiert ist:

npm install -D noyrax-doc-cli

Oder verwenden Sie npx:

npx noyrax-scan

Vorteile

1. Eigenständig: Nur Doku-Plugin als Dependency, keine Database/Semantic-Brain
2. Einfache Installation: npm install -D noyrax-doc-cli noyrax
3. Konsistente Commands: Gleiche Befehle in allen Projekten
4. Cursor Rules Integration: Dokumentiert in den Rules
5. Keine Abhängigkeiten: Funktioniert ohne VS Code Extension

Unterschied zu lokalen Scripts

| Aspekt | Standalone CLI | Lokale Scripts | |--------|----------------|----------------| | Installation | npm install -D noyrax-doc-cli | Teil von noyrax Package | | Verwendung | noyrax-scan | npm run scan:cli | | Abhängigkeiten | Nur noyrax | Vollständiges Plugin-Ecosystem | | Verfügbarkeit | In jedem Projekt | Nur in Projekten mit noyrax |

Weitere Informationen

• Noyrax Documentation
• GitHub Repository
• Cursor Rules

Lizenz

MIT