Skip to content

VS Code Extension

Editor-Support für die CodeCharter-DSL mit Syntax-Highlighting und Autovervollständigung.

Aktualisiert am 2026-05-29

Die VS-Code-Extension bringt vollwertigen Editor-Support für die CodeCharter-DSL mit. Wenn ihr eigene .ccr-Regeln schreibt, bekommt ihr Syntax-Highlighting, Snippets und Autovervollständigung der Schema-Properties.

Installation

  1. Hol codecharter-X.Y.Z.vsix aus den Portal-Downloads.
  2. In VS Code: Kommandopalette → "Extensions: Install from VSIX..." → die heruntergeladene Datei auswählen.

Alternativ per CLI:

code --install-extension codecharter-X.Y.Z.vsix

Der Windows-Installer macht das automatisch, wenn er code im PATH findet.

Features

  • Syntax-Highlighting für .ccr-Files mit eigenem Tokenizer.
  • Snippets für die typischen Regel-Skelette.
  • Autovervollständigung der Schema-Properties (Methoden auf TypeModel, MethodModel und Co.) über einen integrierten Language Server.
  • Inline-Validierung der Regel-Syntax. Tippfehler in Property-Namen oder fehlende Pflicht-Header markiert der Editor sofort.

Commands in der Kommandopalette

  • CodeCharter: Validate current rule file
  • CodeCharter: Analyze workspace (.sln/.slnx/.csproj)
  • CodeCharter: Restart language server
  • CodeCharter: Show language server output

Analyze workspace startet die CodeCharter-CLI auf der Solution oder dem Projekt im VS Code Terminal. Die Findings erscheinen dort als Konsolen-Output.

Konfiguration

Settings unter codecharter.* in den VS Code Einstellungen:

Setting Default Beschreibung
codecharter.serverPath leer Pfad zur CodeCharter-CLI. Leer = Auto-Detect aus PATH.
codecharter.trace.server off LSP-Tracing: off, messages, verbose.
codecharter.analyze.rulesDirectory leer Regel-Verzeichnis für Analyze workspace. Leer = ./rules im Workspace.

Troubleshooting

Wenn der Language Server nicht startet:

  1. Output-Panel öffnen (View → Output), CodeCharter im Dropdown wählen.
  2. CLI-Pfad prüfen. Wenn die CLI nicht im PATH ist, setz codecharter.serverPath explizit auf den vollen Pfad.
  3. Rechte prüfen auf Linux und macOS. Das Binary muss ausführbar sein (chmod +x codecharter).

Mehr unter VS-Code-Extension hängt.