pre-commit script to run automatically the configuration and variables custom from Vauxoo
Project description
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 was not generated. You need to install “pbr”
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pre_commit_vauxoo-3.2.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d2380053ebdfefb54dc2ddd2858720b532af32b226ca22723711f3a5cf020694 |
|
MD5 | e4ca22bb4a60fe3392e92900bb2f77da |
|
BLAKE2b-256 | a1a57ed9990e516c76803af0d10a8863fa513d5bf7ad63b97abc60291e865dcd |