pre-commit-vauxoo 3.2.1

pre-commit script to run automatically the configuration and variables custom from Vauxoo

pre-commit script to run automatically the configuration and variables custom from Vauxoo

• Free software: GNU Lesser General Public License v3 or later (LGPLv3+)

Installation

Using pypi

pip install -U pre-commit-vauxoo

Using github directly

pip install -U git+https://github.com/Vauxoo/pre-commit-vauxoo.git@main

Usage

Run pre-commit-vauxoo command in git repository where you want to run our lints

The autofixes are disabled by default you can use the following option to enable it

pre-commit-vauxoo -f

Full –help command result:

Usage: pre-commit-vauxoo [OPTIONS]

  PATHS are the specific filenames to run hooks on separated by commas. Also,
  it can be defined using environment variable INCLUDE_LINT [default: Current
  directory]

Options:
  -p, --paths PATH CSV
  -w, --overwrite BOOLEAN         Overwrite configuration files.

                                  *If True, existing configuration files into
                                  the project will be overwritten.

                                  *If False, then current files will be used,
                                  if they exist.  [env var:
                                  PRECOMMIT_OVERWRITE_CONFIG_FILES; default:
                                  True]
  -x, --exclude-autofix PATH CSV  Exclude paths on which to run the autofix
                                  pre-commit configuration, separated by
                                  commas  [env var: EXCLUDE_AUTOFIX]
  -l, --exclude-lint PATH CSV     Paths to exclude checks, separated by
                                  commas.  [env var: EXCLUDE_LINT]
  -d, --disable-pylint-checks TEXT
                                  Pylint checks to disable, separated by
                                  commas.  [env var: DISABLE_PYLINT_CHECKS]
  -f, --autofix                   Run pre-commit with autofix configuration to
                                  change the source code.

                                  Overwrite '-t mandatory,optional,fix'  [env
                                  var: PRECOMMIT_AUTOFIX]
  -t, --precommit-hooks-type [mandatory|optional|fix|all]
                                  Pre-commit configuration file to run hooks,
                                  separated by commas.

                                  *Mandatory: Stable hooks that needs to be
                                  fixed (Affecting build status).

                                  *Optional: Optional hooks that could be
                                  fixed later. (No affects build status).

                                  *Fix: Hooks auto fixing source code (Affects
                                  build status).

                                  *All: All configuration files to run hooks.
                                  [env var: PRECOMMIT_HOOKS_TYPE; default:
                                  mandatory, optional]
  --help                          Show this message and exit.

Development

To run all the tests run:

tox

Note, to combine the coverage data from all the tox environments run:

Windows	set PYTEST_ADDOPTS=--cov-append tox
Other	PYTEST_ADDOPTS=--cov-append tox

Changelog

1.0.0 (2022-06-28)

• First release on PyPI.