jj-fix(1) | General Commands Manual | jj-fix(1) |
NAME
jj-fix - Update files with formatting fixes or other changes
SYNOPSIS
jj fix [-s|--source] [--include-unchanged-files] [-R|--repository] [--ignore-working-copy] [--ignore-immutable] [--at-operation] [--debug] [--color] [--quiet] [--no-pager] [--config] [--config-file] [-h|--help] [FILESETS]
DESCRIPTION
Update files with formatting fixes or other changes
The primary use case for this command is to apply the results of automatic code formatting tools to revisions that may not be properly formatted yet. It can also be used to modify files with other tools like `sed` or `sort`.
The changed files in the given revisions will be updated with any fixes determined by passing their file content through any external tools the user has configured for those files. Descendants will also be updated by passing their versions of the same files through the same tools, which will ensure that the fixes are not lost. This will never result in new conflicts. Files with existing conflicts will be updated on all sides of the conflict, which can potentially increase or decrease the number of conflict markers.
The external tools must accept the current file content on standard input, and return the updated file content on standard output. A tool's output will not be used unless it exits with a successful exit code. Output on standard error will be passed through to the terminal.
Tools are defined in a table where the keys are arbitrary
identifiers and the values have the following properties:
- `command`: The arguments used to run the tool. The first argument is the
path to an executable file. Arguments can contain the substring `$path`,
which will be replaced with the repo-relative path of the file being
fixed. It is useful to provide the path to tools that include the path in
error messages, or behave differently based on the directory or file
name.
- `patterns`: Determines which files the tool will affect. If this list is
empty, no files will be affected by the tool. If there are multiple
patterns, the tool is applied only once to each file in the union of the
patterns.
- `enabled`: Enables or disables the tool. If omitted, the tool is enabled.
This is useful for defining disabled tools in user configuration that can
be enabled in individual repositories with one config setting.
For example, the following configuration defines how two code formatters (`clang-format` and `black`) will apply to three different file extensions (`.cc`, `.h`, and `.py`):
```toml [fix.tools.clang-format] command =
["/usr/bin/clang-format", "--assume-filename=$path"]
patterns = ["glob:'**/*.cc'",
"glob:'**/*.h'"]
[fix.tools.black] command = ["/usr/bin/black", "-", "--stdin-filename=$path"] patterns = ["glob:'**/*.py'"] ```
Execution order of tools that affect the same file is deterministic, but currently unspecified, and may change between releases. If two tools affect the same file, the second tool to run will receive its input from the output of the first tool.
OPTIONS
- -s, --source=REVSETS
- Fix files in the specified revision(s) and their descendants. If no revisions are specified, this defaults to the `revsets.fix` setting, or `reachable(@, mutable())` if it is not set
- --include-unchanged-files
- Fix unchanged files in addition to changed ones. If no paths are specified, all files in the repo will be fixed
- -R, --repository=REPOSITORY
- Path to repository to operate on
By default, Jujutsu searches for the closest .jj/ directory in an ancestor of the current working directory.
- --ignore-working-copy
- Don't snapshot the working copy, and don't update it
By default, Jujutsu snapshots the working copy at the beginning of every command. The working copy is also updated at the end of the command, if the command modified the working-copy commit (`@`). If you want to avoid snapshotting the working copy and instead see a possibly stale working-copy commit, you can use `--ignore-working-copy`. This may be useful e.g. in a command prompt, especially if you have another process that commits the working copy.
Loading the repository at a specific operation with `--at-operation` implies `--ignore-working-copy`.
- --ignore-immutable
- Allow rewriting immutable commits
By default, Jujutsu prevents rewriting commits in the configured set of immutable commits. This option disables that check and lets you rewrite any commit but the root commit.
This option only affects the check. It does not affect the `immutable_heads()` revset or the `immutable` template keyword.
- --at-operation=AT_OPERATION
- Operation to load the repo at
Operation to load the repo at. By default, Jujutsu loads the repo at the most recent operation, or at the merge of the divergent operations if any.
You can use `--at-op=<operation ID>` to see what the repo looked like at an earlier operation. For example `jj --at-op=<operation ID> st` will show you what `jj st` would have shown you when the given operation had just finished. `--at-op=@` is pretty much the same as the default except that divergent operations will never be merged.
Use `jj op log` to find the operation ID you want. Any unambiguous prefix of the operation ID is enough.
When loading the repo at an earlier operation, the working copy will be ignored, as if `--ignore-working-copy` had been specified.
It is possible to run mutating commands when loading the repo at an earlier operation. Doing that is equivalent to having run concurrent commands starting at the earlier operation. There's rarely a reason to do that, but it is possible.
- --debug
- Enable debug logging
- --color=WHEN
- When to colorize output
[possible values: always, never, debug, auto]
- --quiet
- Silence non-primary command output
For example, `jj file list` will still list files, but it won't tell you if the working copy was snapshotted or if descendants were rebased.
Warnings and errors will still be printed.
- --no-pager
- Disable the pager
- --config=NAME=VALUE
- Additional configuration options (can be repeated)
The name should be specified as TOML dotted keys. The value should be specified as a TOML expression. If string value doesn't contain any TOML constructs (such as array notation), quotes can be omitted.
- --config-file=PATH
- Additional configuration files (can be repeated)
- -h, --help
- Print help (see a summary with '-h')
- [FILESETS]
- Fix only these paths
fix |