Inhaltsverzeichnis

WvdS Audit Plugin - Demo

Diese Seite demonstriert das neue wvdsaudit Plugin mit verschiedenen Status-Varianten.


Live-Beispiel: FPC Solution Explorer 2

Dieses Audit wurde automatisch aus der Code-Analyse generiert:

FPC Solution Explorer 2Audit: Kritisch • 2026-03-30
Code-Qualität *
  • ✗ Keine TODO-Kommentare (22 gefunden)
  • ✗ Keine FIXME-Kommentare
  • ✓ Keine Stub-Funktionen
  • ✓ Keine Magic Numbers (Constants.pas)
VSCode Extension
  • ✗ activationEvents definiert
  • ✓ Commands konsistent (IDs, Titles, Category)
  • ✓ Settings dokumentiert und validiert
  • ✗ repository Feld in package.json
  • ✗ CHANGELOG.md existiert
  • ✓ README.md vorhanden
Projektstruktur
  • ✓ src/ Source Code (sauber)
  • ✓ dist/ Build Output
  • ✓ Namespace-Struktur korrekt

Ergebnis: CRITICAL (Rot) - weil Code-Qualität Section critical=„true“ ist und [ ] Items enthält.


Test: Alles bestanden (Grün)

Perfektes ModulAudit bestanden • 2026-03-30
Code-Qualität
  • ✓ Keine TODO-Kommentare
  • ✓ Keine FIXME-Kommentare
  • ✓ Keine Stub-Funktionen
Dokumentation
  • ✓ README vorhanden
  • ✓ API dokumentiert

Test: Anmerkungen (Orange)

Modul mit AnmerkungenAudit: Anmerkungen • 2026-03-30
Code-Qualität
  • ✓ Keine TODO-Kommentare
  • ✗ Keine FIXME-Kommentare
  • ✓ Keine Stub-Funktionen
Dokumentation
  • ✓ README vorhanden
  • ✗ API dokumentiert

Ergebnis: ISSUES (Orange) - [ ] Items vorhanden, aber keine critical Section betroffen.


Test: Kritisch (Rot)

Kritisches ModulAudit: Kritisch • 2026-03-30
Code-Qualität
  • ✓ Keine TODO-Kommentare
  • ✗ Keine FIXME-Kommentare
Sicherheit *
  • ✗ Input-Validierung
  • ✓ Fehlerbehandlung

Ergebnis: CRITICAL (Rot) - [ ] in critical Section.


Test: Override auf Grün

Override-BeispielAudit bestanden • 2026-03-30
Code-Qualität
  • ✓ Keine TODO-Kommentare
  • ✗ Bekannte Ausnahme (akzeptiert)

Ergebnis: PASSED (Grün) - manuelles Override überschreibt automatische Berechnung.


Test: Mit N/A Items

Mit N/A ItemsAudit bestanden • 2026-03-30
Code-Qualität
  • ✓ Keine TODO-Kommentare
  • — Unit-Tests (nicht anwendbar für dieses Projekt)
  • ✓ Keine Stub-Funktionen

Ergebnis: PASSED (Grün) - [-] Items werden ignoriert.


Test: Template-Modus (horizontal)

Kompakte Inline-Syntax - alle Status in einer Zeile:

Horizontal-TestAudit bestanden • 2026-03-30

Ergebnis: Template-Texte werden automatisch aus den Review-Seiten geladen.


Test: Template-Modus (vertikal)

Alternativ: Ein Status pro Zeile:

Vertikal-TestAudit bestanden • 2026-03-30

Ergebnis: Gleiche Funktion, andere Formatierung.


Test: Include mit vollem Text

Include-TestAudit: Kritisch • 2026-03-30
Code / qualitaet *
  • ✓ Keine TODO-Kommentare
  • ✗ Keine FIXME-Kommentare (2 gefunden)
  • ✓ Keine Stub-Funktionen
  • ✓ Vollständig implementiert
Sicherheit / kritis
  • ✓ Keine exec/shell_exec/system Aufrufe
  • ✓ Keine eval() Aufrufe
  • ✓ Output Escaping
  • — SQL Injection (keine DB)
  • — CSRF Protection (keine Forms)

Ergebnis: CRITICAL (Rot) - weil code:qualitaet critical ist und [ ] enthält.


Syntax-Referenz

Variante 1: Explizite Sections

<wvds:audit stack="stack-name" title="Modul-Titel">
  <wvds:audit:result value="passed|issues|critical" />  <!-- Optional: Override -->
 
  <wvds:section title="Section-Titel" ref="wiki:link" critical="true">
    [x] Bestanden
    [ ] Nicht bestanden
    [-] Nicht anwendbar
  </wvds:section>
</wvds:audit>

Variante 2: Include (empfohlen)

<wvds:audit stack="stack-name" title="Modul-Titel">
  <!-- Mit vollem Text -->
  <wvds:include ref="code:qualitaet" critical="true">
    [x] Keine TODO-Kommentare
    [ ] Keine FIXME-Kommentare
  </wvds:include>
 
  <!-- Status-only horizontal (kompakt) -->
  <wvds:include ref="stacks:vscode-extension">[x][ ][x][x][x]</wvds:include>
 
  <!-- Status-only vertikal -->
  <wvds:include ref="sicherheit:kritis">
[x]
[ ]
[x]
  </wvds:include>
</wvds:audit>

Attribute

Attribut Beschreibung
stack Stack-Identifikator (vsix, doku, fpc, etc.)
title Anzeige-Titel des Audits
ref Wiki-Link zur Checklist (ohne Sprach-Prefix)
critical Wenn true, führt [ ] zu CRITICAL statt ISSUES

Zurück zu Review Checklists