Skip to content

Latest commit

 

History

History
104 lines (62 loc) · 2.89 KB

cli.rst

File metadata and controls

104 lines (62 loc) · 2.89 KB
Raw

Command-line interface

Note

The CLI is experimental, still under active development.

Nitpick_ has a CLI to apply changes to files automatically.

  1. It doesn't work for all the plugins yet. Currently, it works for:
  1. It tries to preserve the comments and the formatting of the original file.
  2. Some changes still have to be done manually; Nitpick_ cannot guess how to make certain changes automatically.
  3. On the CLI, the "apply mode" is the default: changes to files will be made automatically, when possible.
  4. The flake8_ plugin only checks the files and doesn't make changes. This is the default for now; once the CLI becomes more stable, the "apply mode" will become the default.

If you use Git, you can review the files before committing.

The available commands are described below.

Main options

Usage: nitpick [OPTIONS] COMMAND [ARGS]...

  Enforce the same settings across multiple language-independent projects.

Options:
  -p, --project DIRECTORY  Path to project root
  --offline                Offline mode: no style will be downloaded (no HTTP
                           requests at all)

  --help                   Show this message and exit.

Commands:
  init  Initialise Nitpick configuration.
  ls    List of files configured in the Nitpick style.
  run   Apply suggestions to configuration files.

run: Apply style to files

At the end of execution, this command displays:

  • the number of fixed violations;
  • the number of violations that have to be changed manually.
Usage: nitpick run [OPTIONS] [FILES]...

  Apply suggestions to configuration files.

  You can use partial and multiple file names in the FILES argument.

Options:
  -c, --check    Don't modify the configuration files, just print the
                 difference. Return code 0 means nothing would change. Return
                 code 1 means some files would be modified.

  -v, --verbose  Verbose logging
  --help         Show this message and exit.

ls: List configures files

Usage: nitpick ls [OPTIONS] [FILES]...

  List of files configured in the Nitpick style.

  Display existing files in green and absent files in red. You can use
  partial and multiple file names in the FILES argument.

Options:
  --help  Show this message and exit.

init: Initialise a configuration file

Usage: nitpick init [OPTIONS]

  Initialise Nitpick configuration.

Options:
  --help  Show this message and exit.