Skip to content

Commit

Permalink
Add better documentation for --dump and --fmt (#1603)
Browse files Browse the repository at this point in the history
  • Loading branch information
neunenak authored Jun 12, 2023
1 parent a1220c6 commit 41aee45
Showing 1 changed file with 39 additions and 2 deletions.
41 changes: 39 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2275,9 +2275,46 @@ default:
echo foo
```

### Dumping `justfile`s as JSON
### Formatting and dumping `justfile`s

The `--dump` command can be used with `--dump-format json` to print a JSON representation of a `justfile`. The JSON format is currently unstable, so the `--unstable` flag is required.
Each `justfile` has a canonical formatting with respect to whitespace and
newlines.

You can overwrite the current justfile with a canonically-formatted version
using the currently-unstable `--fmt` flag:

```sh
$ cat justfile
# A lot of blank lines





some-recipe:
echo "foo"
$ just --fmt --unstable
$ cat justfile
# A lot of blank lines

some-recipe:
echo "foo"
```

Invoking `just --fmt --check --unstable` runs `--fmt` in check mode. Instead of
overwriting the `justfile`, `just` will exit with an exit code of 0 if it is
formatted correctly, and will exit with 1 and print a diff if it is not.

You can use the `--dump` command to output a formatted version of the
`justfile` to stdout:

```sh
$ just --dump > formatted-justfile
```

The `--dump` command can be used with `--dump-format json` to print a JSON
representation of a `justfile`. The JSON format is currently unstable, so the
`--unstable` flag is required.

### Fallback to parent `justfile`s

Expand Down

0 comments on commit 41aee45

Please sign in to comment.