Fmt
The fmt command formats FQL scripts to a consistent style.
Format files in place
terminal
ferret fmt script.fql
This overwrites the file with the formatted output.
Format multiple files
terminal
ferret fmt script.fql utils.fql
Or use a glob:
terminal
ferret fmt *.fql
Read from stdin
Pipe a script through stdin to print the formatted output without writing a file:
terminal
cat script.fql | ferret fmt
Preview changes
Use --dry-run to print the formatted output to stdout instead of overwriting files:
terminal
ferret fmt --dry-run script.fql
When formatting multiple files with --dry-run, each file’s output is preceded by a ==> filename <== header.
Formatting options
| Flag | Default | Description |
|---|---|---|
--dry-run |
false |
Print to stdout instead of overwriting files |
--print-width |
80 |
Maximum line length |
--tab-width |
4 |
Indentation size in spaces |
--single-quote |
false |
Use single quotes instead of double quotes |
--bracket-spacing |
true |
Add spaces inside object brackets |
--case-mode |
upper |
Keyword case: upper, lower, or ignore |
Examples
Format with a wider line width:
terminal
ferret fmt --print-width 120 script.fql
Use lowercase keywords and single quotes:
terminal
ferret fmt --case-mode lower --single-quote script.fql