pre-commit-vauxoo 8.1.0

Description:

precommitvauxoo 8.1.0

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
Install in the same way than you usually install pypi packages

python3 -m pip install –force-reinstall -U pre-commit-vauxoo

Or using ‘sudo’:

sudo python3 -m pip install –force-reinstall -U pre-commit-vauxoo

Or using ‘–user’:

python3 -m pip install –user –force-reinstall -U pre-commit-vauxoo

Or using virtualenv

source YOUR_VENV/bin/activate && pip install –force-reinstall -U pre-commit-vauxoo

You can confirm your environment running pre-commit-vauxoo –version


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
--version Show the version of this package
--odoo-version TEXT Odoo version used for the repository. [env
var: VERSION]
--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

v8.1.0

Bump version: 8.0.2 → 8.1.0
[ADD] name-non-ascii: Prevents file or directory names with ASCII characters (#134)
[REF] github-actions: Add arch in cache-key to use macosx m1 and intel compatibility
[REF] github-actions: Use latest codecov version
[REF] setup: Add setuptools deps to build
[REF] github-actions: Use macosx-latest only for py-latest and macosx-14 for older Related to https://github.com/actions/setup-python/issues/825#issuecomment-2096792396
[REF] setup: Add py3.12 because we are compatible
[REF] .github: Add py3.12, update gh action packages and fix pre-commit cache (#133)



v8.0.2

Bump version: 8.0.1 → 8.0.2
[IMP] cfg: update pylint-odoo



v8.0.1

Bump version: 8.0.0 → 8.0.1
[CI]: fix wrong path on windows runners
[IMP] cfg: update black version



v8.0.0

Bump version: 7.0.26 → 8.0.0
[REF] cfg: bump pylint-odoo to v9.0.4 (#127)



v7.0.26

Bump version: 7.0.25 → 7.0.26
[IMP] cfg: bump pylint-odoo to v8.0.21 (#126)
[REF] Remove redundant autofix checks (#125)
[REF] CI: Update CI/RTD (#123)
ci: Update actions/checkout (#122)



v7.0.25

Bump version: 7.0.24 → 7.0.25
[REF] .pre-commit-config: pylint-odoo bumpversion v8.0.20 (#120)
[REF] tox: Build ChangeLog again (#119)



v7.0.24

Bump version: 7.0.23 → 7.0.24
[REF] setup: Enable py311 classifier (#117)
[IMP] cfg: update oca odoo hooks version (#114)
[REF] .gitignore: Ignore .oca_hooks*



v7.0.23

Bump version: 7.0.22 → 7.0.23
[IMP] support disabling oca hooks through env var (#116)



v7.0.22

Bump version: 7.0.21 → 7.0.22
[REF] use config files for oca-hooks (#112)



v7.0.21

Bump version: 7.0.20 → 7.0.21
[REF] Disable xml-oe-structure-missing-id (#110)



v7.0.20

Bump version: 7.0.19 → 7.0.20
[REF] Disable xml-oe-structure-id (#109)



v7.0.19

Bump version: 7.0.18 → 7.0.19
[REF] cfg: Update bandit version and disable “defusedxml” checks part 2 (#108)



v7.0.18

Bump version: 7.0.17 → 7.0.18
[REF] cfg: Update bandit version and disable “defusedxml” checks (#107)



v7.0.17

Bump version: 7.0.16 → 7.0.17
[REF] pre-commit-config: Upgrade OCA/odoo-pre-commit-hooks to v0.0.28



v7.0.16

Bump version: 7.0.15 → 7.0.16
[FIX] CI: Add ignored installed to Cannot uninstall ‘distlib’ error
[IMP] update odoo-pre-commit-hooks, add po-pretty-format, oe_structure



v7.0.15

Bump version: 7.0.14 → 7.0.15
[FIX] non-installable module regex (#103)
[FIX] CI: Fix typo for windows (#101)



v7.0.14

Bump version: 7.0.13 → 7.0.14
[FIX] pre-commit-vauxoo: Fix isort hook - RuntimeError The Poetry configuration is invalid (#100)



v7.0.13

Bump version: 7.0.12 → 7.0.13
[REF] pylint.conf: Update partner name as required author



v7.0.12

Bump version: 7.0.11 → 7.0.12
[REF] pre-commit-vauxoo: Include migrations script for versions 15 and higher (#98)
[FIX] ci: Array matrix syntax, rm tox envs and fix src (#96)



v7.0.11

Bump version: 7.0.10 → 7.0.11
[REF] pre-commit-vauxoo: Fix missing newline for pyproject.toml (#95)



v7.0.10

Bump version: 7.0.9 → 7.0.10
[REF] pre-commit-config-autofix: Update latest version of repos for autofixes (#94)



v7.0.9

Bump version: 7.0.8 → 7.0.9
[FIX] pre-commit-config*.yaml: Replace deprecated gitlab URL (#92)



v7.0.8

Bump version: 7.0.7 → 7.0.8
[ADD] pre-commit-config-optional: Add new bandit security checks experimental (#88)



v7.0.7

Bump version: 7.0.6 → 7.0.7
[REF] pre-commit-config-optional: Bump hooks version



v7.0.6

Bump version: 7.0.5 → 7.0.6
[REF] pre-commit-config: bumpversion hooks (#87)



v7.0.5

Bump version: 7.0.4 → 7.0.5
[REF] tox: More testing for package build and dependencies
[REF] .pre-commit-config: pylint-odoo bumpversion v8.0.16



v7.0.4

Bump version: 7.0.3 → 7.0.4
[REF] pre-commit-config-optional: Bump OCA odoo-pre-commit-hooks version (#83)



v7.0.3

Bump version: 7.0.2 → 7.0.3
[REF] .pylintrc: Disable unsupported-binary-operation check (#82)



v7.0.2

Bump version: 7.0.1 → 7.0.2
[REF] pre-commit-config: Migrate to new pylint-odoo - #apocalintSYS (#79)



v7.0.1

Bump version: 7.0.0 → 7.0.1
[FIX] eslint: Fix ‘import’ sentence error (#80)
[REF] CI: Remove deprecated MQT build (#78)



v7.0.0

Bump version: 6.0.0 → 7.0.0
[REF] CI: Add py3.11, update tox, gitignore (#75)



v6.0.0

Bump version: 5.3.2 → 6.0.0
[REF] tests: Remove git –initial-branch parameter incompatible with old git version (#76)
[REF] pylintrc: Add ‘column’ to message-template option and change format (#74)
[REM] Remove unused “tests” directory (#73)
[REF] pylintrc: re-enable check bad-super-call (#72)
[REF] pre_commit_vauxoo: Use the same git diff command than original (#71)
[REF] pylintrc: Disable assignment-from-none and bad-super-call (#70)



v5.3.2

Bump version: 5.3.1 → 5.3.2
[REF] cfg/.flake8: ignore E203 (whitespace before ‘:’)



v5.3.1

Bump version: 5.3.0 → 5.3.1
[IMP] pre_commit_vauxoo: show diff with changes made in autofixes
[FIX] pre_commit_vauxoo: Removed non autofix checks from autofix cfg #58
[REF] pre_commit_vauxoo: Merge vauxoo hooks into repo



v5.3.0

Bump version: 5.2.3 → 5.3.0
[REF] tests: Improve unittests to be more deterministic
[REF] pre_commit_vauxoo: Test repo structure set to standards The previous structure was: /tmp_dir/resources/all_modules
[IMP] pre-commit-vauxoo: Uninstallable modules are no longer checked



v5.2.3

Bump version: 5.2.2 → 5.2.3
[REF] pre-commit-config: Update sha of pylint-odoo from vx (#62)



v5.2.2

Bump version: 5.2.1 → 5.2.2
[REF] mandatory: Update custom hook (#60)
[REF] readme: Update from help command and add multiple ways to install it (#57)



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