Home

Awesome

editorconfig-checker

Logo

This is a command-line tool to check if given files implement your .editorconfig rules.

Build Status Coverage Status Code Climate Issue Count psr2 composer.lock Total Downloads Daily Downloads Monthly Downloads Latest Stable Version Latest Unstable Version License

<a href="https://www.buymeacoffee.com/mstruebing" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>

What?

This is a tool to check if your files consider your .editorconfig. Most tools - like linters for example - only test one filetype and need an extra configuration. This tool only needs your editorconfig to check all files.

Sample Output

Important

This is only a wrapper for the core editorconfig-checker. You should have a look at this repository to know how this tool can be used and what possibilities/caveats are there. This version can be used in the same way as the core as every argument is simply passed down to it.

Installation

composer require --dev editorconfig-checker/editorconfig-checker

Usage

vendor/bin/ec

Configuration

You can configure analysis in .ecrc json file, e.g.:

{
    "Exclude": [
        "^vendor\/",
        "^var\/",
        "^\\.idea\/",
        "\\.phar$"
    ]
}

Full list of config options is in core docs

Cli options

Please head to core docs.

Support

If you have any questions or just want to chat join #editorconfig-checker on freenode(IRC). If you don't have an IRC-client set up you can use the freenode webchat.