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 -t all
Full –help command result:
Usage: pre-commit-vauxoo [OPTIONS] pre-commit-vauxoo run pre-commit with custom validations and configuration files Options: -p, --paths PATH CSV PATHS are the specific filenames to run hooks on separated by commas. [env var: INCLUDE_LINT; default: .] --no-overwrite 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_NO_OVERWRITE_CONFIG_FILES] --fail-optional Change the exit_code for 'optional' precommit-hooks-type. *If this flag is enabled so the exit_code will be -1 (error) if 'optional' fails. *If it is disabled (by default), exit_code will be 0 (successful) even if 'optional' fails. [env var: PRECOMMIT_FAIL_OPTIONAL] -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, --pylint-disable-checks TEXT CSV Pylint checks to disable, separated by commas. [env var: PYLINT_DISABLE_CHECKS] -S, --skip-string-normalization If '-t fix' is enabled, don't normalize string quotes or prefixes '' -> "" This parameter is related to 'black' hook [env var: BLACK_SKIP_STRING_NORMALIZATION] -t, --precommit-hooks-type [mandatory|optional|fix|experimental|all|-mandatory|-optional|-fix|-experimental] Pre-commit configuration file to run hooks, separated by commas. prefix '-' means that the option will be removed. *Mandatory: Stable hooks that needs to be fixed (Affecting build status). *Optional: Optional hooks that could be fixed later. (No affects build status almost '--fail-optional' is set). *Experimental: Experimental hooks that only to test. (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: all, -fix] --install Install the pre-commit script Using this option a '.git/hooks/pre-commit' will be created Now your command 'git commit' will run 'pre- commit-vauxoo' before to commit --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 |
CHANGES
v5.2.1
Bump version: 5.2.0 → 5.2.1
[REF] pre-commit-vauxoo: Better message for CI autofixes and add –version option parameter
v5.2.0
Bump version: 5.1.2 → 5.2.0
[REF] CI: No install ecpg since MQT must install it
[REF] tests: Add module_autofix1 in order to validate it is working well
[REF] test: Improve the unittest to check if logs were raised
[REF] tox: No use workers in order to show the full logs
[REF] autofixes: Better message for CI if autofixes are required
v5.1.2
Bump version: 5.1.1 → 5.1.2
[REF] cfg: Update custom vx hook to v0.0.2 (#53)
v5.1.1
Bump version: 5.1.0 → 5.1.1
[REF] README: Update README –help to last version (#52)
[REF] CI: Trigger pipeline to dockerv if new release (#51)
v5.1.0
Bump version: 5.0.0 → 5.1.0
[ADD] pre_commit_vauxoo: Mandatory - Add vx-check-deactivate hook (#50)
v5.0.0
Bump version: 4.0.0 → 5.0.0
[REF] pre_commit_vauxoo: Enable black’s string normalization and add extra parameter to disable it (#38)
v4.0.0
Bump version: 3.5.0 → 4.0.0
[ADD] pre_commit_vauxoo: Add option to install .git/hooks/pre_commit (#48)
[REF] pre_commit_vauxoo: Mandatory green even if mandatory are red (#47)
[REF] pre_commit_vauxoo: Deprecate PRECOMMIT_AUTOFIX in pro PRECOMMIT_HOOKS_TYPE=all (#46)
[FIX] pre_commit_vauxoo: Fix duplicate ‘-w’ parameter (#45)
[REF] CI: Faster pypi publish, remove “needs” to run parallel but only trigger for stable branches and PRs and tags (#44)
[REF] CI: Enable pytest-xdist to run tests with multiple CPUs to speed up test execution (#43)
[REF] pre_commit_vauxoo: Reformat code running black with string-normalizatio
v3.5.0
Bump version: 3.4.0 → 3.5.0
[REF] cli: fail-optional now is a flag (#36)
v3.4.0
Bump version: 3.3.0 → 3.4.0
[IMP] pre_commit_vauxoo: Support fail if ‘optional’ hooks type and support “-” prefix to remove hooks type (#35)
v3.3.0
Bump version: 3.2.4 → 3.3.0
[FIX] click: Match envvar for disable-pylint-checks and use csv string (#34)
v3.2.4
Bump version: 3.2.3 → 3.2.4
[ADD] requirements.txt: Add requirements.txt file and setup.py read this file (#32)
[REF] cli: Show env var for INCLUDE_LINT and add help to path option (#31)
[REF] docs: Clean dummy files and add docs badge and logo (#30)
v3.2.3
Bump version: 3.2.2 → 3.2.3
[REF] CI: Generates ChangeLog with pbr installed (#29)
v3.2.2
Bump version: 3.2.1 → 3.2.2
[REF] setup.py: Autogenerate ChangeLog (#28)
v3.2.1
Bump version: 3.2.0 → 3.2.1
[REF] cli: Bypassing errors if git repo is not found allow to run –help (#27)
v3.2.0
Bump version: 3.1.0 → 3.2.0
[REF] README: Better help output with newlines (#26)
[REF] cli: Small refactoring, typos and py3.5 compatibility (#25)
v3.1.0
Bump version: 3.0.0 → 3.1.0
[FIX] click: Compatibility with click==8.0.1 used by big image (#24)
v3.0.0
Bump version: 2.1.1 → 3.0.0
[REF] click: Use standard parameters, envvar and callback transformation and a few refactoring and more (#23)
v2.1.1
Bump version: 2.1.0 → 2.1.1
[REF] CI: Add test to run with dockerv vauxoo image (#22)
[REF] click: Remove incompatible parameter for all click versions (#21)
v2.1.0
Bump version: 2.0.0 → 2.1.0
[FIX] CI: Auto deploy pypi
v2.0.0
Bump version: 1.3.2 → 2.0.0
[IMP] pre-commit-vauxoo: Add params, help, default and environment variable matches (#20)
[FIX] prettierrc: Enable only for js and xml files (#19)
[REF] CI: Order builds by OS and add py3.10 (#17)
[REF] tests: Create dummy repo in tmp folder
[REF] CI: Fix covtest
[REF] tests: Migrating tests to unittest
v1.3.2
Bump version: 1.3.1 → 1.3.2
[REF] CI: Build package before to publish it (#15)
v1.3.1
Bump version: 1.3.0 → 1.3.1
[REF] gh-actions: Publish package (#14)
[FIX] pre_commit_vauxoo: typos in log messages (#13)
v1.3.0
Bump version: 1.2.1 → 1.3.0
[REF] CI: Enable py3.10 (#12)
[REF] github: Set pre-commit cache
[REF] tests: Fixing test
[FIX] pre_commit_vauxoo: Fix current path
[REF] pre_commit_vauxoo: Use INCLUDE_LINT and EXCLUDE_AUTOFIX
[REF] pre_commit_vauxoo: Add logging colorized and summary result
[REF] pre_commit_vauxoo: Small refactoring
[REF] config: Add flake8 optional checks includes bugbear (#8)
v1.2.1
Bump version: 1.2.0 → 1.2.1
[REF] README: Fix installation command and version (#9)
[FIX] pre_commit_vauxoo: Return the same type of object (#7)
[REF] pre_commit_vauxoo: Add verbose subprocess.call wrapper in order to know what command was executed (#6)
v1.2.0
Bump version: 1.1.0 → 1.2.0
[REF] pre_commit_vauxoo: Run pre-commit only in current path (#5)
v1.1.0
Bump version: 1.0.1 → 1.1.0
[REF] prettierrc.yml: Enable xmlSelfClosingSpace (#3)
v1.0.1
Bump version: 1.0.0 → 1.0.1
[REF] pre_commit_vauxoo: Look for .git dir in parent dirs and allow to run the command in any subfolder (#2)
[REF] cfg: Update configuration from vx/mqt (remove flake8 bugbear)
[REF] eslintrc: Support syntax “??=”
[ADD] pre-commit-vauxoo: first code
v1.0.0
Add initial project skeleton
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-5.2.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e981186a9aad2adbb4f8c0ec8ff3cb69bea9744cb4aa818c20e771c64859339c |
|
MD5 | a6bd7f50a2fabdae7d6273d9ee9da359 |
|
BLAKE2b-256 | b0178862c33eb881fd66ace22b6790354cba4442efe4907f63bf0f376f44b583 |