Zum Inhalt springen

CLI-Referenz

Das findsl-Werkzeug bündelt fünf Befehle. Ziele sind jeweils einzelne .findsl-Dateien, Verzeichnisse (rekursiv) oder Glob-Muster (in Anführungszeichen, sonst expandiert die Shell sie selbst).

Parst und validiert .findsl-Dateien und meldet Diagnosen.

Terminal-Fenster
findsl parse <ziele...> [-v]
OptionBedeutung
-v, --verbosezusätzliche Ausgabe mit AST-Übersicht

Beispiele

Terminal-Fenster
# Eine einzelne Datei validieren
findsl parse est.findsl
# Ein ganzes Verzeichnis rekursiv prüfen
findsl parse examples/
# Mehrere Ziele zugleich, mit AST-Übersicht
findsl parse est.findsl kst.findsl -v
# Glob-Muster (Anführungszeichen → findsl expandiert selbst)
findsl parse "examples/**/*.findsl"

Wertet die prüfe-Blöcke aus und berichtet bestanden/fehlgeschlagen.

Terminal-Fenster
findsl test <ziele...> [-v]
OptionBedeutung
-v, --verboseauch bestandene Testfälle auflisten

Beispiele

Terminal-Fenster
# prüfe-Blöcke einer Datei ausführen
findsl test est.findsl
# Alle Module eines Projekts testen (Exit-Code ≠ 0 bei Fehlschlag → CI-tauglich)
findsl test src/main/findsl
# Mit voller Auflistung auch der grünen Fälle
findsl test examples/kst -v

Erzeugt Zielsprachencode. Details: Code generieren & integrieren.

Terminal-Fenster
findsl codegen <basisverzeichnis> [-l java|ts|js] [-o <verzeichnis>] [-t <verzeichnis>]
OptionDefaultBedeutung
-l, --langjavaZielsprache: java, ts oder js
-o, --outout/javaAusgabeverzeichnis der Hauptklassen
-t, --test-outAusgabeverzeichnis der generierten Tests

Beispiele

Terminal-Fenster
# Java nach out/java (Defaults)
findsl codegen examples/kst
# TypeScript in ein eigenes Verzeichnis
findsl codegen src/main/findsl -l ts -o src/generated
# JavaScript erzeugen
findsl codegen src/main/findsl -l js -o dist/findsl
# Java samt JUnit-5-Tests aus den prüfe-Blöcken
findsl codegen src/main/findsl -l java -o out/java -t out/test

Erzeugt aggregierte Dokumentation. Details: Dokumentation.

Terminal-Fenster
findsl docgen <pfade...> [-f md|html|pdf|all] [-o <ziel>] [-k <datei>]
OptionDefaultBedeutung
-f, --formatallmd, html, pdf oder all
-o, --outdocAusgabe-Basisname (ohne Endung)
-k, --kopfMarkdown-Datei mit Front-Matter für Titelseite

Beispiele

Terminal-Fenster
# Alle Formate (Markdown, HTML, PDF) nach doc.*
findsl docgen examples/est
# Nur HTML, eigener Ausgabename → einkommensteuer.html
findsl docgen examples/est -f html -o einkommensteuer
# PDF mit eigener Titelseite (Front-Matter aus titelseite.md)
findsl docgen examples/est -f pdf -k titelseite.md
# Mehrere Module zu einem Dokument aggregieren
findsl docgen examples/est examples/kst -o steuerrecht

Erzeugt Programmablaufpläne. Details: Ablaufpläne.

Terminal-Fenster
findsl papgen <pfade...> [-f mermaid|html] [--detail struktur|voll] [--ohne-intern] [-o <ziel>]
OptionDefaultBedeutung
-f, --formatmermaidmermaid oder html (self-contained)
--detailstrukturstruktur oder voll
--paramssymbolesymbole oder inline
--themedefaultdefault/neutral/dark/forest (nur Mermaid)
--no-farbensemantische Knoten-Färbung abschalten
--ohne-interninterne (_-)Funktionen weglassen
-o, --outpapgenAusgabe-Basisname (ohne Endung)

Beispiele

Terminal-Fenster
# Mermaid-Ablaufplan (Default) → papgen.mmd
findsl papgen examples/est
# Self-contained HTML mit voller Detailtiefe
findsl papgen examples/est -f html --detail voll -o ablaufplan
# Übersicht ohne interne Hilfsfunktionen, dunkles Theme
findsl papgen examples/est --ohne-intern --theme dark
# Parameter inline statt als Symbole, ohne semantische Färbung
findsl papgen examples/est --params inline --no-farben