QCCommand - evansde77/cirrus GitHub Wiki

QC Command

[This command was recently refactored, so tweaks to code and docs are in progress - 2018/08]

Command for running quality control checks including tools like pylint, pyflakes, pep8. The linters are managed as plugins and can be run selectively via the --linters option or defined in the config file. Each linter can have specific settings in their own qc/linter section of the cirrus.conf, Eg, for the Pep8 linter, settings can be provided via a [qc/Pep8] section.

Linters are applied to each file in turn, they may all have different configurables/settings depending on their complexity.

Usage:

# qc using default settings in cirrus.conf
git cirrus qc 

Options and config:

  • --include-files INCLUDE_FILES [INCLUDE_FILES ...], -f INCLUDE_FILES [INCLUDE_FILES ...] specify files to run qc on, as list, supports globs
  • --linters {Linter,Pylint,Pyflakes,Coverage,Pep8} specify the subset of linters to run
  • --exclude-dirs Glob patterns for directory paths to exclude
  • --exclude-files glob patterns for filenames to exclude
  • -v, --verbose loud output