editorconfig-checker

What?

This is a tool to check if your files consider your .editorconfig rules. 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

Installation via npm/yarn is recommended:

npm install --save-dev editorconfig-checker
yarn add --dev editorconfig-checker

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

git clone https://github.com/editorconfig-checker/editorconfig-checker.javascript
cd editorconfig-checker.javascript
npm install
npm run build
npm test
npm start

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 npm you have a binary in your node_modules/.bin folder called editorconfig-checker. Then you could create a script in your package.json like this:

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

Usage output:

USAGE:
  editorconfig-checker [OPTIONS] [FILE...]

With no FILE arguments, all files tracked by git are checked. When one or
more FILE arguments are given, only those files are checked (the configured
exclude patterns still apply).

OPTIONS:
  -color
        enables printing color
  -config string
        config
  -cpuprofile string
        write cpu profile to file
  -debug
        print debugging information
  -disable-charset
        disables only the charset check
  -disable-end-of-line
        disables the end-of-line check
  -disable-indent-size
        disables only the indent-size check
  -disable-indentation
        disables the indentation check
  -disable-insert-final-newline
        disables the final newline check
  -disable-max-line-length
        disables only the max-line-length 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. Combine patterns with | (pipe): -exclude "vendor|testdata"
  -f value
        specify the output format: default, codeclimate, gcc, github-actions (default default)
  -format value
        specify the output format: default, codeclimate, gcc, github-actions (default default)
  -h  print the help
  -help
        print the help
  -ignore-defaults
        ignore default excludes
  -init
        creates an initial configuration
  -no-color
        disables printing color
  -v  print debugging information
  -verbose
        print debugging information
  -version
        print the version number

Support

If you have any questions, suggestions 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.