Changelog
All changes to fsg, newest first. Based on Keep a Changelog, Semantic Versioning.
-
v0.5.0
Latest- Added
--docsopens the documentation in the browser and prints the URL when no browser is available - Added Documentation site with English and German pages at https://karnesth.github.io/fsg/
- Changed The README is shorter and links to the documentation for options, markers, configuration and styles
- Added
-
- Added Comments after an entry (
# ..., separated by at least two spaces) are kept on--updateand aligned - Added Several marked blocks per file; options in the start marker (
path,depth,dirs-only,exclude,include,fence,style,summary) apply to one block, between the config and the command line - Added
-s/--stylewith the built-in stylesunicode,ascii,rounded,heavyanddouble, plus--glyph KEY=VALUEand[tool.fsg.glyphs]for own glyphs - Added
--summary/--no-summaryand the config keysummaryfor a line with the number of directories and files - Added
--copyto copy the tree to the clipboard with clip.exe, pbcopy, wl-copy, xclip or xsel - Changed A start marker after another one without end marker, and an end marker without start marker, are reported with their line number instead of being skipped
- Added Comments after an entry (
-
- Added
-i/--includeand the config keyincludeto show only entries matching a glob pattern; exclude wins over include - Changed Without a git repository,
--depthand--excludestop the directory walk early instead of filtering afterward, sofsg -d 1on large directories returns immediately - Security GitHub Actions are pinned to commit SHAs, Dependabot opens weekly pull requests to update them
- Security The release workflow runs the full CI before building and publishing
- Added
-
- Changed Status lines start with a symbol (
✔,•,✖, or[ok],[info],[error]with--ascii), are colored in terminals and show a hint on how to fix a problem;NO_COLORandFORCE_COLORare respected - Changed Every error exits with status 2, including a path that is not a directory; status 1 only means an outdated tree
- Changed The search for a config file stops at the git repository root, or at the home directory outside a repository
- Changed Indented code blocks and longer code fences are recognized when looking for the markers
- Fixed Tracked files deleted from the working tree no longer appear in the tree
- Fixed
--setup-hookadds the fsg step before a finalexecline of an existing git hook - Fixed An existing pre-commit entry is detected by its
repo:line, so comments or similarly named repositories no longer block the setup - Fixed
--versionand--setup-hookwork when fsg runs from a source checkout without being installed
- Changed Status lines start with a symbol (
-
- Security Resolve the git executable from absolute PATH entries only, so a
git.exeinside the current directory is never run on Windows - Security Quote the target file in the message of the generated git hook, so shell syntax in the file name is not executed
- Security Reject a configured
paththat leaves the directory of the config file - Fixed
--updateno longer overwrites content when the end marker is missing: both markers must stand on their own line outside a code block - Fixed
--setup-hookchecks that the target file exists and holds both markers before writing a hook - Fixed Files are written atomically, so an interrupted run cannot leave a half-written README or hook
- Fixed A failing
git ls-filesis reported instead of producing an empty tree
- Security Resolve the git executable from absolute PATH entries only, so a
-
- Added Render a directory as a tree, wrapped in a
plaintextcode fence - Added Respect
.gitignoreinside git repositories, skip common generated directories outside of them - Added
--depth,--dirs-only,--excludeand--fence/--no-fenceto shape the output - Added
--asciifor environments without Unicode support; output is always written as UTF-8 - Added
--updateand--checkto keep the tree between<!-- fsg:start -->and<!-- fsg:end -->up to date - Added
--setup-hookto add fsg to an existing.pre-commit-config.yamlor the gitpre-commithook - Added pre-commit hooks
fsgandfsg-check - Added Configuration via
.fsg.tomlor[tool.fsg]inpyproject.toml - Added
--versionand--help
- Added Render a directory as a tree, wrapped in a