editorconfig-checker/editorconfig-checker

A tool to verify that your files follow the rules of your .editorconfig

10.6.0 2024-03-04 12:55 UTC

Requires

• php: ^7.2 || ^8.0

Requires (Dev)

• php-coveralls/php-coveralls: ^2.1
• phpstan/phpstan: ^1.4
• phpunit/phpunit: ^8.5.23
• squizlabs/php_codesniffer: ^3.6

MIT

• Max Strübing

README

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

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.

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.