fix(cli): restore PRJ_ROOT env var

PRJ_ROOT is coming from the https://github.com/numtide/prj-spec and was used in treefmt 1.x Fixes #353
numtide · Jul 20, 2024 · 43c2071 · 43c2071
1 parent debc3e4
commit 43c2071
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 17 deletions.
diff --git a/cli/cli.go b/cli/cli.go
@@ -23,7 +23,7 @@ type Format struct {
 	ConfigFile            string             `type:"existingfile" help:"Load the config file from the given path (defaults to searching upwards for treefmt.toml)."`
 	FailOnChange          bool               `help:"Exit with error if any changes were made. Useful for CI."`
 	Formatters            []string           `short:"f" help:"Specify formatters to apply. Defaults to all formatters."`
-	TreeRoot              string             `type:"existingdir" xor:"tree-root" help:"The root directory from which treefmt will start walking the filesystem (defaults to the directory containing the config file)."`
+	TreeRoot              string             `type:"existingdir" xor:"tree-root" env:"PRJ_ROOT" help:"The root directory from which treefmt will start walking the filesystem (defaults to the directory containing the config file)."`
 	TreeRootFile          string             `type:"string" xor:"tree-root" help:"File to search for to find the project root (if --tree-root is not passed)."`
 	Walk                  walk.Type          `enum:"auto,git,filesystem" default:"auto" help:"The method used to traverse the files within --tree-root. Currently supports 'auto', 'git' or 'filesystem'."`
 	Verbosity             int                `name:"verbose" short:"v" type:"counter" default:"0" env:"LOG_LEVEL" help:"Set the verbosity of logs e.g. -vv."`

diff --git a/docs/usage.md b/docs/usage.md
@@ -13,22 +13,24 @@ Arguments:
   [<paths> ...]    Paths to format. Defaults to formatting the whole tree.
 
 Flags:
-  -h, --help                            Show context-sensitive help.
-      --allow-missing-formatter         Do not exit with error if a configured formatter is missing.
-  -C, --working-directory="."           Run as if treefmt was started in the specified working directory instead of the current working directory.
-      --no-cache                        Ignore the evaluation cache entirely. Useful for CI.
-  -c, --clear-cache                     Reset the evaluation cache. Use in case the cache is not precise enough.
-      --config-file="./treefmt.toml"    The config file to use.
-      --fail-on-change                  Exit with error if any changes were made. Useful for CI.
-      --formatters=FORMATTERS,...       Specify formatters to apply. Defaults to all formatters.
-      --tree-root="."                   The root directory from which treefmt will start walking the filesystem.
-      --walk="auto"                     The method used to traverse the files within --tree-root. Currently supports 'auto', 'git' or 'filesystem'.
-  -v, --verbose                         Set the verbosity of logs e.g. -vv ($LOG_LEVEL).
-  -V, --version                         Print version.
-  -i, --init                            Create a new treefmt.toml.
-  -u, --on-unmatched=warn               Log paths that did not match any formatters at the specified log level, with fatal exiting the process with an error. Possible values are <debug|info|warn|error|fatal>.
-      --stdin                           Format the context passed in via stdin.
-      --cpu-profile=STRING              The file into which a cpu profile will be written.
+  -h, --help                         Show context-sensitive help.
+      --allow-missing-formatter      Do not exit with error if a configured formatter is missing.
+  -C, --working-directory="."        Run as if treefmt was started in the specified working directory instead of the current working directory.
+      --no-cache                     Ignore the evaluation cache entirely. Useful for CI.
+  -c, --clear-cache                  Reset the evaluation cache. Use in case the cache is not precise enough.
+      --config-file=STRING           Load the config file from the given path (defaults to searching upwards for treefmt.toml).
+      --fail-on-change               Exit with error if any changes were made. Useful for CI.
+  -f, --formatters=FORMATTERS,...    Specify formatters to apply. Defaults to all formatters.
+      --tree-root=STRING             The root directory from which treefmt will start walking the filesystem (defaults to the directory containing the config file) ($PRJ_ROOT).
+      --tree-root-file=STRING        File to search for to find the project root (if --tree-root is not passed).
+      --walk="auto"                  The method used to traverse the files within --tree-root. Currently supports 'auto', 'git' or 'filesystem'.
+  -v, --verbose                      Set the verbosity of logs e.g. -vv ($LOG_LEVEL).
+  -V, --version                      Print version.
+  -i, --init                         Create a new treefmt.toml.
+  -u, --on-unmatched=warn            Log paths that did not match any formatters at the specified log level, with fatal exiting the process with an error. Possible values are
+                                     <debug|info|warn|error|fatal>.
+      --stdin                        Format the context passed in via stdin.
+      --cpu-profile=STRING           The file into which a cpu profile will be written.
 ```
 
 ## Arguments