Python wrapper around invoking editorconfig-checker (https://github.com/editorconfig-checker/editorconfig-checker)
Project description
editorconfig-checker.python
A Python wrapper to provide a pip-installable editorconfig-checker binary.
Internally, this package provides a convenient way to download the pre-built editorconfig-checker
binary for your particular platform.
Installation
- From source code:
pip install .
- From
PyPI
:pip install editorconfig-checker
Usage
After installation, the ec
binary should be available in your environment (or ec.exe
on Windows):
ec -version
Usage with the pre-commit git hooks framework
editorconfig-checker
can be included as a hook for pre-commit.
The easiest way to get started is to add this configuration to your .pre-commit-config.yaml
:
repos:
- repo: https://github.com/editorconfig-checker/editorconfig-checker.python
rev: '' # pick a git hash / tag to point to
hooks:
- id: editorconfig-checker
alias: ec
The above hook is a python wrapper that automatically downloads and installs
editorconfig-checker binary.
If you manage your tools in some other way, for example, via ASDF,
you may want to use an alternative pre-commit hook that assumes that
ec
binary executable is already available on the system path:
repos:
- repo: https://github.com/editorconfig-checker/editorconfig-checker.python
rev: '' # pick a git hash / tag to point to
hooks:
- id: editorconfig-checker-system
alias: ec
See the pre-commit docs to check how to customize this configuration.
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
Hashes for editorconfig-checker-2.7.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 69261f55585f0a4897b5534806bd170289d11b4825137411c1e9e5f2c1c5dbc2 |
|
MD5 | 233c779c9e6cd63941dd88c7f2d3e9df |
|
BLAKE2b-256 | c4a4dc5488f942cd138f30b120495f865a5ce048466dffc72dc80915c6c539e1 |