Fmt
The fmt command formats FQL scripts to a consistent style. By default, it writes language keywords and literals in their canonical lowercase form.
Format files in place
ferret fmt script.fqlThis overwrites the file with the formatted output.
Format multiple files
ferret fmt script.fql utils.fqlOr use a glob:
ferret fmt *.fqlRead from stdin
Pipe a script through stdin to print the formatted output without writing a file:
cat script.fql | ferret fmtPreview changes
Use --dry-run to print the formatted output to stdout instead of overwriting files:
ferret fmt --dry-run script.fqlWhen 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 |
lower |
Keyword case: canonical lower, or compatibility/preference modes upper and ignore |
Examples
Format with a wider line width:
ferret fmt --print-width 120 script.fqlUse single quotes while keeping the canonical lowercase keyword style:
ferret fmt --single-quote script.fqlUse uppercase output for compatibility with an existing codebase or a team preference:
ferret fmt --case-mode upper script.fqlUse --case-mode ignore only when an existing workflow depends on that compatibility mode.