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.
findsl parse <ziele...> [-v]| Option | Bedeutung |
|---|---|
-v, --verbose | zusätzliche Ausgabe mit AST-Übersicht |
Beispiele
# Eine einzelne Datei validierenfindsl parse est.findsl
# Ein ganzes Verzeichnis rekursiv prüfenfindsl parse examples/
# Mehrere Ziele zugleich, mit AST-Übersichtfindsl 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.
findsl test <ziele...> [-v]| Option | Bedeutung |
|---|---|
-v, --verbose | auch bestandene Testfälle auflisten |
Beispiele
# prüfe-Blöcke einer Datei ausführenfindsl 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ällefindsl test examples/kst -vcodegen
Abschnitt betitelt „codegen“Erzeugt Zielsprachencode. Details: Code generieren & integrieren.
findsl codegen <basisverzeichnis> [-l java|ts|js] [-o <verzeichnis>] [-t <verzeichnis>]| Option | Default | Bedeutung |
|---|---|---|
-l, --lang | java | Zielsprache: java, ts oder js |
-o, --out | out/java | Ausgabeverzeichnis der Hauptklassen |
-t, --test-out | — | Ausgabeverzeichnis der generierten Tests |
Beispiele
# Java nach out/java (Defaults)findsl codegen examples/kst
# TypeScript in ein eigenes Verzeichnisfindsl codegen src/main/findsl -l ts -o src/generated
# JavaScript erzeugenfindsl codegen src/main/findsl -l js -o dist/findsl
# Java samt JUnit-5-Tests aus den prüfe-Blöckenfindsl codegen src/main/findsl -l java -o out/java -t out/testErzeugt aggregierte Dokumentation. Details: Dokumentation.
findsl docgen <pfade...> [-f md|html|pdf|all] [-o <ziel>] [-k <datei>]| Option | Default | Bedeutung |
|---|---|---|
-f, --format | all | md, html, pdf oder all |
-o, --out | doc | Ausgabe-Basisname (ohne Endung) |
-k, --kopf | — | Markdown-Datei mit Front-Matter für Titelseite |
Beispiele
# Alle Formate (Markdown, HTML, PDF) nach doc.*findsl docgen examples/est
# Nur HTML, eigener Ausgabename → einkommensteuer.htmlfindsl 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 aggregierenfindsl docgen examples/est examples/kst -o steuerrechtErzeugt Programmablaufpläne. Details: Ablaufpläne.
findsl papgen <pfade...> [-f mermaid|html] [--detail struktur|voll] [--ohne-intern] [-o <ziel>]| Option | Default | Bedeutung |
|---|---|---|
-f, --format | mermaid | mermaid oder html (self-contained) |
--detail | struktur | struktur oder voll |
--params | symbole | symbole oder inline |
--theme | default | default/neutral/dark/forest (nur Mermaid) |
--no-farben | — | semantische Knoten-Färbung abschalten |
--ohne-intern | — | interne (_-)Funktionen weglassen |
-o, --out | papgen | Ausgabe-Basisname (ohne Endung) |
Beispiele
# Mermaid-Ablaufplan (Default) → papgen.mmdfindsl papgen examples/est
# Self-contained HTML mit voller Detailtiefefindsl papgen examples/est -f html --detail voll -o ablaufplan
# Übersicht ohne interne Hilfsfunktionen, dunkles Themefindsl papgen examples/est --ohne-intern --theme dark
# Parameter inline statt als Symbole, ohne semantische Färbungfindsl papgen examples/est --params inline --no-farben