Konfiguration
Leg Pfad und Optionen neben deinem Projekt ab, dann brauchen --update, --check und der Commit-Hook keine Argumente.
#Konfigurationsdateien
Nutze die Tabelle [tool.fsg] in deiner pyproject.toml oder eine eigene .fsg.toml:
[tool.fsg]
path = "src"
depth = 2
exclude = ["*.log", "docs/api"]
summary = true
style = "rounded"
[tool.fsg.glyphs]
last = "╰── "path = "src"
depth = 2
exclude = ["*.log", "docs/api"]
summary = true
style = "rounded"
[glyphs]
last = "╰── "#Wo fsg sucht
-
Bei der Zieldatei anfangen
Die Suche beginnt im Verzeichnis der Datei, die du
--updateoder--checkübergibst. -
Nach oben gehen
Das erste Verzeichnis mit einer
.fsg.tomloder einerpyproject.tomlmit[tool.fsg]gewinnt. Im selben Verzeichnis hat.fsg.tomlVorrang. -
An der Projektgrenze aufhören
Die Suche endet an der Wurzel des Git-Repositorys, außerhalb eines Repositorys an deinem Home-Verzeichnis.
Einfaches fsg ignoriert die KonfigurationOhne
--update oder --check zählt nur die Kommandozeile, fsg gibt also immer das ganze aktuelle Verzeichnis aus.#Schlüssel
| Schlüssel | Typ | Standard | Beschreibung |
|---|---|---|---|
path |
String | "." |
Auszugebendes Verzeichnis, relativ zur Konfigurationsdatei |
depth |
Ganzzahl | – | Anzahl der Ebenen unterhalb der Wurzel, mindestens 1 |
dirs-only |
Boolean | false |
Nur Verzeichnisse ausgeben |
exclude |
Liste (String) | [] |
Globs für Einträge, die wegfallen |
include |
Liste (String) | [] |
Globs für Einträge, die erscheinen, exclude gewinnt |
fence |
Boolean | true |
Den Baum in einen Codeblock setzen |
summary |
Boolean | false |
Die Zeile mit der Anzahl der Verzeichnisse und Dateien anhängen |
style |
String | "unicode" |
unicode, ascii, rounded, heavy oder double |
ascii |
Boolean | false |
ASCII-Baum und ASCII-Statussymbole |
glyphs |
Tabelle | – | branch, last, pipe, space, siehe Stile |
path bleibt drinnenEin
path, der das Verzeichnis der Konfigurationsdatei verlässt, wird abgelehnt.#Rangfolge
Jeder Wert kommt von der spezifischsten Stelle, die ihn setzt. Include- und exclude-Muster werden aus allen drei Quellen zusammengeführt.
- KonfigurationsdateiStandard für das ganze Projekt
- Start-MarkerÜberschreibt die Konfiguration für einen Baum
- KommandozeileÜberschreibt beides, für jeden Baum
# config: depth = 2, marker: depth=3
$ fsg --update README.md # renders 3 levels
$ fsg --update README.md --depth 1 # renders 1 level