editorconfig-checker

    4.0.2 • Public • Published

    editorconfig-checker

    Logo

    Build Status dependencies devDependencies Greenkeeper badge code style: prettier Total alerts Language grade: JavaScript

    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 npm/yarn is recommended:

    yarn add --dev editorconfig-checker
    ./node_modules/.bin/editorconfig-checker
    
    npm install --save-dev editorconfig-checker
    ./node_modules/.bin/editorconfig-checker
    
    # or in a npm-script just
    editorconfig-checker
    

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

    git clone git@github.com:editorconfig-checker/editorconfig-checker.javascript.git
    && cd editorconfig-checker.javascript
    && make setup
    && ./editorconfig-checker.javascript/dist/index
    

    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:
      -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.

    Install

    npm i editorconfig-checker

    DownloadsWeekly Downloads

    8,401

    Version

    4.0.2

    License

    MIT

    Unpacked Size

    19.5 kB

    Total Files

    6

    Last publish

    Collaborators

    • mstruebing