WvdS Audit Plugin

Verzija: 1.0
Avtor: Wolfgang van der Stille zeljko.petrusic@outlook.de
Licenca: GPL 2


Opis

Vtičnik wvdsaudit omogoča vključitev revizijskih značk na wiki strani z avtomatskim izračunom statusa na podlagi sintakse potrditvenih polj.

Funkcije:

  • Avtomatski izračun statusa (passed/issues/critical)
  • Kritične sekcije so lahko označene
  • Možno ročno preglasitev
  • Fluent Design barvna shema (združljivo z Note vtičnikom)
  • Večjezično (DE, EN, SL)

Sintaksa

Varianta 1: Eksplicitne sekcije

<wvds:audit stack="stack-name" title="Naslov-modula">
  <wvds:audit:result value="passed|issues|critical" />  <!-- Opcijsko: Preglasitev -->
 
  <wvds:section title="Naslov-sekcije" ref="wiki:povezava" critical="true">
    [x] Uspešno
    [ ] Neuspešno
    [-] Ni uporabno
  </wvds:section>
</wvds:audit>

Varianta 2: Include (priporočeno)

Avtomatsko naloži naslov sekcije iz referenčne wiki strani:

<wvds:audit stack="vsix" title="FPC Solution Explorer 2">
  <!-- S polnim besedilom -->
  <wvds:include ref="code:qualitaet" critical="true">
    [ ] Brez TODO komentarjev (22 najdenih)
    [x] Brez stub funkcij
  </wvds:include>
 
  <!-- Način predloge: horizontalno (kompaktno) -->
  <wvds:include ref="stacks:vscode-extension">[x][x][ ][x][x]</wvds:include>
 
  <!-- Način predloge: vertikalno -->
  <wvds:include ref="sicherheit:kritis">
[x]
[x]
[-]
  </wvds:include>
</wvds:audit>

Prednosti Include:

  • Naslov sekcije se avtomatsko naloži iz strani s kontrolnim seznamom
  • Povezava do kontrolnega seznama se avtomatsko nastavi
  • Krajša sintaksa, manj napak
  • Večjezično: Naslov se naloži iz jezikovne različice strani
  • Način predloge: Besedila postavk iz strani za pregled (samo status je naveden)

Atributi

<wvds:audit>

Atribut Obvezno Opis
stack Ne Identifikator sklada (vsix, doku, fpc, itd.)
title Da Prikazni naslov revizije

<wvds:audit:result>

Atribut Opis
value Preglasitev: passed, issues, critical ali auto

<wvds:section>

Atribut Obvezno Opis
title Da Naslov sekcije
ref Ne Wiki povezava do kontrolnega seznama (brez jezikovne predpone)
critical Ne Če true, [ ] povzroči CRITICAL namesto ISSUES

<wvds:include> (NOVO)

Atribut Obvezno Opis
ref Da Wiki povezava do kontrolnega seznama (npr. code:qualitaet, stacks:vscode-extension)
critical Ne Če true, [ ] povzroči CRITICAL namesto ISSUES

Opomba: Naslov sekcije se avtomatsko naloži iz prvega naslova (====== Naslov ======) referenčne strani.


Sintaksa potrditvenih polj

Sintaksa Status Pomen
[x] passed Kontrolna točka uspešna
[ ] failed Kontrolna točka neuspešna
[-] na Ni uporabno (prezrto)

Izračun statusa

Pogoj Status Barva
Vse [x] passed Zelena (#dff6dd)
Vsaj en [ ] (nekritično) issues Oranžna (#fff4ce)
[ ] v critical=„true“ sekciji critical Rdeča (#fde7e9)

Primeri

Vse uspešno (Zelena)

Popoln modulAudit bestanden • 2026-03-30
Kakovost kode
  • ✓ Brez TODO komentarjev
  • ✓ Brez FIXME komentarjev

Z opombami (Oranžna)

Modul z opombamiAudit: Anmerkungen • 2026-03-30
Dokumentacija
  • ✓ README prisoten
  • ✗ API dokumentiran

Kritično (Rdeča)

Kritičen modulAudit: Kritisch • 2026-03-30
Varnost *
  • ✗ Validacija vnosov
  • ✓ Obravnava napak

Datoteke

lib/plugins/wvdsaudit/
├── plugin.info.txt     # Metapodatki vtičnika
├── syntax.php          # Parser sintakse
├── helper.php          # Izračun statusa in izris
├── style.css           # Fluent Design oblikovanje
├── conf/
│   ├── default.php     # Privzete nastavitve
│   └── metadata.php    # Admin-UI
└── lang/
    ├── de/lang.php     # Nemščina
    ├── en/lang.php     # Angleščina
    └── sl/lang.php     # Slovenščina

CSS razredi

Razred Opis
.wvds-audit Vsebnik
.wvds-audit-passed Zelen status
.wvds-audit-issues Oranžen status
.wvds-audit-critical Rdeč status
.wvds-audit-header Območje glave
.wvds-audit-body Telo s sekcijami
.wvds-audit-section Posamezna sekcija
.wvds-audit-item-passed Uspešna postavka
.wvds-audit-item-failed Neuspešna postavka
.wvds-audit-item-na N/A postavka

Glej tudi

Zuletzt geändert: dne 29.01.2026 ob 19:48