Add note about the diff dependency on the fmt command (#2801)

Signed-off-by: Andrei Ciobanu <andrei.ciobanu@opentofu.org>
This commit is contained in:
Andrei Ciobanu
2025-05-14 15:33:59 +03:00
committed by GitHub
parent 24a13dd090
commit 2ef59e2299

View File

@@ -57,5 +57,8 @@ The command-line flags are all optional. The following flags are available:
* `-list=false` - Don't list the files containing formatting inconsistencies.
* `-write=false` - Don't overwrite the input files. (This is implied by `-check` or when the input is STDIN.)
* `-diff` - Display diffs of formatting changes.
* When using this flag, ensure that `diff` tool is installed. This is used internally for providing a better user experience.
* `-check` - Check if the input is formatted. Exit status will be 0 if all input is properly formatted. If not, exit status will be non-zero and the command will output a list of filenames whose files are not properly formatted.
* `-recursive` - Also process files in subdirectories. By default, only the given directory (or current directory) is processed.