greg/just
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document invocation_directory_native() (#1508)

Browse Source
This commit is contained in:
Casey Rodarmor 2023-01-13 11:20:37 -08:00 committed by GitHub
parent 182ef134d9
commit 7aff35a37b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1106,22 +1106,33 @@ $ just
#### Invocation Directory
- `invocation_directory()` - Retrieves the absolute path to the current directory when `just` was invoked, before `just` changed it (chdir'd) prior to executing commands.
- `invocation_directory()` - Retrieves the absolute path to the current
directory when `just` was invoked, before `just` changed it (chdir'd) prior
to executing commands. On Windows, `invocation_directory()` uses `cygpath` to
convert the invocation directory to a Cygwin-compatible `/`-separated path.
Use `invocation_directory_native()` to return the verbatim invocation
directory on all platforms.
For example, to call `rustfmt` on files just under the "current directory" (from the user/invoker's perspective), use the following rule:
For example, to call `rustfmt` on files just under the "current directory"
(from the user/invoker's perspective), use the following rule:
```just
rustfmt:
find {{invocation_directory()}} -name \*.rs -exec rustfmt {} \;
```
Alternatively, if your command needs to be run from the current directory, you could use (e.g.):
Alternatively, if your command needs to be run from the current directory, you
could use (e.g.):
```just
build:
cd {{invocation_directory()}}; ./some_script_that_needs_to_be_run_from_here
```
- `invocation_directory_native()` - Retrieves the absolute path to the current
directory when `just` was invoked, before `just` changed it (chdir'd) prior
to executing commands.
#### Justfile and Justfile Directory
- `justfile()` - Retrieves the path of the current `justfile`.