help/zigfmt.md

   1 # Zig Fmt Plugin
   2
   3 To run `zig fmt` on the current file:
   4
   5 ```
   6 > zigfmt
   7 ```
   8
   9 To run `zig fmt --check` on the current file (using the linter plugin):
  10
  11 ```
  12 > lint
  13 ```
  14
  15 To automatically run these when you save the file, use the following
  16 options:
  17
  18 * `zigfmt.fmt`: run `zig fmt` on file saved (will not report parse errors). Default value: `on`
  19 * `zigfmt.lint`: enable `zig fmt --check` integration with the linter plugin. Default value: `on`