Inhaltsverzeichnis

WvdS Audit Plugin

Version: 1.0
Autor: Wolfgang van der Stille zeljko.petrusic@outlook.de
Lizenz: GPL 2


Beschreibung

Das wvdsaudit Plugin ermöglicht die Einbettung von Audit-Badges auf Wiki-Seiten mit automatischer Status-Berechnung basierend auf Checkbox-Syntax.

Features:


Syntax

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)

Lädt Section-Titel automatisch aus der referenzierten Wiki-Seite:

<wvds:audit stack="vsix" title="FPC Solution Explorer 2">
  <!-- Mit vollem Text -->
  <wvds:include ref="code:qualitaet" critical="true">
    [ ] Keine TODO-Kommentare (22 gefunden)
    [x] Keine Stub-Funktionen
  </wvds:include>
 
  <!-- Template-Modus: horizontal (kompakt) -->
  <wvds:include ref="stacks:vscode-extension">[x][x][ ][x][x]</wvds:include>
 
  <!-- Template-Modus: vertikal -->
  <wvds:include ref="sicherheit:kritis">
[x]
[x]
[-]
  </wvds:include>
</wvds:audit>

Vorteile von Include:

Attribute

<wvds:audit>

Attribut Pflicht Beschreibung
stack Nein Stack-Identifikator (vsix, doku, fpc, etc.)
title Ja Anzeige-Titel des Audits

<wvds:audit:result>

Attribut Beschreibung
value Override: passed, issues, critical oder auto

<wvds:section>

Attribut Pflicht Beschreibung
title Ja Section-Titel
ref Nein Wiki-Link zur Checklist (ohne Sprach-Prefix)
critical Nein Wenn true, führt [ ] zu CRITICAL statt ISSUES

<wvds:include> (NEU)

Attribut Pflicht Beschreibung
ref Ja Wiki-Link zur Checklist (z.B. code:qualitaet, stacks:vscode-extension)
critical Nein Wenn true, führt [ ] zu CRITICAL statt ISSUES

Hinweis: Der Section-Titel wird automatisch aus der ersten Headline (====== Titel ======) der referenzierten Seite geladen.


Checkbox-Syntax

Syntax Status Bedeutung
[x] passed Prüfpunkt bestanden
[ ] failed Prüfpunkt nicht bestanden
[-] na Nicht anwendbar (wird ignoriert)

Status-Berechnung

Bedingung Status Farbe
Alle [x] passed Grün (#dff6dd)
Mindestens ein [ ] (nicht kritisch) issues Orange (#fff4ce)
[ ] in critical=„true“ Section critical Rot (#fde7e9)

Beispiele

Alles bestanden (Grün)

Perfektes ModulAudit bestanden • 2026-03-30
Code-Qualität
  • ✓ Keine TODO-Kommentare
  • ✓ Keine FIXME-Kommentare

Mit Anmerkungen (Orange)

Modul mit AnmerkungenAudit: Anmerkungen • 2026-03-30
Dokumentation
  • ✓ README vorhanden
  • ✗ API dokumentiert

Kritisch (Rot)

Kritisches ModulAudit: Kritisch • 2026-03-30
Sicherheit *
  • ✗ Input-Validierung
  • ✓ Fehlerbehandlung

Dateien

lib/plugins/wvdsaudit/
├── plugin.info.txt     # Plugin-Metadaten
├── syntax.php          # Syntax-Parser
├── helper.php          # Status-Berechnung & Rendering
├── style.css           # Fluent Design Styling
├── conf/
│   ├── default.php     # Standard-Einstellungen
│   └── metadata.php    # Admin-UI
└── lang/
    ├── de/lang.php     # Deutsch
    ├── en/lang.php     # Englisch
    └── sl/lang.php     # Slowenisch

CSS-Klassen

Klasse Beschreibung
.wvds-audit Container
.wvds-audit-passed Grüner Status
.wvds-audit-issues Oranger Status
.wvds-audit-critical Roter Status
.wvds-audit-header Header-Bereich
.wvds-audit-body Body mit Sections
.wvds-audit-section Einzelne Section
.wvds-audit-item-passed Bestandenes Item
.wvds-audit-item-failed Fehlgeschlagenes Item
.wvds-audit-item-na N/A Item

Siehe auch


wvdsaudit PluginAudit bestanden • 2026-03-30