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

Document path manipulation functions in readme (#877)

Browse Source
This commit is contained in:
Casey Rodarmor 2021-06-17 01:06:23 -07:00 committed by GitHub
parent 162d2df1ba
commit 8557a6c6b3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.adoc
View File

@ -792,6 +792,16 @@ Starting server with database localhost:6379 on port 1337...
./server --database $DATABASE_ADDRESS --port $SERVER_PORT
```
==== Path Manipulation
- `file_name(path)` - File name of `path` with any leading directory components removed. `file_name("/foo/bar.txt")` is `bar.txt`.
- `parent_directory(path)` - Parent directory of `path`. `parent_directory("/foo/bar.txt")` is `/foo`.
- `file_stem(path)` - File name of `path` without extension. `file_stem("/foo/bar.txt")` is `bar`.
- `without_extension(path)` - `path` without extension. `without_extension("/foo/bar.txt")` is `/foo/bar`.
- `extension(path)` - Extension of `path`. `extension("/foo/bar.txt")` is `txt`.
These functions can fail, for example if a path does not have an extension, which will halt execution.
=== Command Evaluation Using Backticks
Backticks can be used to store the result of commands: