format

jk format -h
Format test files

Usage: jk format [OPTIONS] [path]...

Arguments:
  [path]...  The path(s) to search for test files
             By default, the current path is used

Options:
  -r               Recursively search for test files
  -t, --tag <tag>  Select tests to format based on tags
                   By default, tests must match all given tags to be selected
      --tags-or    Toggle tag matching logic to select tests matching any of the given tags
  -h, --help       Print help

Description

Formats all test definitions in the current directory, including reordering fields and removing unneeded ones.

You can also specify one or more test files and/or paths to format, enable recursive searching, and filter tests based on tags via options.

Arguments

Argument	Default	Description
path	The current path	(Optional) The path(s) at which to format test files. These can be single test files, or directories containing one or more files. By default, the current path is used.

Options

Option	Value	Description
‑h ‑‑help		Print command details, arguments, and options to the console.
‑r		Enable recursive search for test files.
‑t ‑‑tag	A single tag value	Specify one or more tags to be matched when searching for test files. By default, test files much match all provided tags to be selected. Each tag should be provided as a separate -t option (e.g. -t tag1 -t tag2).
‑‑tags‑or		Toggle tag matching behavior to select tests matching any of the provided tags (as opposed to all).