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
$ pip install . # from source code
$ pip install editorconfig-checker # from PyPI
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.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1f7839df7d967d95f0cf2ed6a42a0f456c65072d2ffcff1fedc0eac62ed236ea |
|
MD5 | 43f72399cf0f17fd8565d670487c91f4 |
|
BLAKE2b-256 | c96ec6c2a6b6273006f19dbb2c371760eca7e1766f20318cfa5e0cb34040942d |