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.
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
File details
Details for the file editorconfig_checker-3.6.0.tar.gz.
File metadata
- Download URL: editorconfig_checker-3.6.0.tar.gz
- Upload date:
- Size: 4.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dcaf0248ad7e8539fda03857c300267a4af004e0c2aaa195485e6be85034f6d0
|
|
| MD5 |
b2b23e44b58b0d7c7cda04700970fcdd
|
|
| BLAKE2b-256 |
363300730df977c6d3b18441f7726f503036db678ed089b10710ed6b6dd299a3
|
