wre-commit 1.0.7

A wrapper for pre-commit.

Wrapper for https://pre-commit.com, so wre-commit

Extensions

• Run pre-commit:
  • in Docker container when ### wre-commit-docker-image: ... is found in the config file
  • or directly calling locally installed pre-commit
• Support multiple configurations using:
  • multiple config files using shell wildcards in option --config, by default .pre-commit-config*.yaml, with respecting the fail_fast config setting.
  • multi-doc YAML config files, with respecting the fail_fast config setting.

Installation into system

Install the wraper into system by command:

pip3 install --upgrade wre-commit

Then a script wre-commit is available in the $PATH.

Installation into Git repository

Install this script as .git/hooks/pre-commit into your Git repository by running the command:

wre-commit install

Add option -t or --hook-type to specify another/more hook(s) to install.

Uninstallation from Git repository

Uninstall this script as .git/hooks/pre-commit from your Git repository by running the command

wre-commit uninstall

Add option -t or --hook-type to specify another/more hook(s) to uninstall.

Usage

Place the line ### wre-commit-docker-image: DOCKER_IMAGE (without quotes) into your pre-commit config file, typically .pre-commit-config.yaml. Replace the DOCKER_IMAGE with the Docker image name in format expected by command docker run. That image should have pre-commit installed, possibly with other binaries and hook repository dependencies. Then pre-commit in that container will be triggered with your repository dir read-write visible.

You can also call the pre-commit in the Docker container directly, f.e.:

wre-commit run --all-files

If no such line is present in the pre-commit config file, then the locally installed pre-commit will be called as usuall.

Debugging

Set environment variable WRE_COMMIT_DEBUG to see debug messages on standard error:

• of the executed commands
• about splitting multi-doc config files

Requirements

• python3 AND:
  • locally installed and running docker OR:
  • locally installed pre-commit

Developing

Update versions

• in wre_commit/main.py
• in setup.cfg

Ensure local dependencies

python3 -m pip install --user --upgrade setuptools wheel twine

Build PyPi package

rm -rf dist
python3 setup.py sdist bdist_wheel

Upload package to PyPi

python3 -m twine upload dist/*