Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
bin
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

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

Buy Me A Coffee

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

Installation via composer is recommended:

composer require --dev editorconfig-checker/editorconfig-checker
./vendor/bin/ec

# or in a composer-script just
ec

Otherwise you could clone the repository and execute the script manually.

git clone git@github.com:editorconfig-checker/editorconfig-checker.php.git
./editorconfig-checker.php/bin/ec

Usage

There is an alias from editorconfig-checker to ec so you can exchange every occurrence of editorconfig-checker with ec.

If you installed it via composer you have a binary in your composer-bin-dir folder called editorconfig-checker. Then you could create a script in your composer.json like this:

"scripts": {
    "lint:editorconfig": "editorconfig-checker"
}

Usage output:

USAGE:
  -config string
        config
  -debug
        print debugging information
  -disable-end-of-line
        disables the trailing whitespace check
  -disable-indentation
        disables the indentation check
  -disable-insert-final-newline
        disables the final newline check
  -disable-trim-trailing-whitespace
        disables the trailing whitespace check
  -dry-run
        show which files would be checked
  -exclude string
        a regex which files should be excluded from checking - needs to be a valid regular expression
  -h    print the help
  -help
        print the help
  -ignore-defaults
        ignore default excludes
  -init
        creates an initial configuration
  -no-color
        dont print colors
  -v    print debugging information
  -verbose
        print debugging information
  -version
        print the version number

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.

You can’t perform that action at this time.