editorconfig-checker / editorconfig-checker.python

A tool to verify that your files are in harmony with your .editorconfig

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.