@htmlacademy/editorconfig-cli

editorconfig-cli

Simple command line interface (CLI) for .editorconfig based on the node-lintspaces module.

Uses .editorconfig by default from current directory. To change default location use -e argument. Supports GLOB format.

Install

Globaly:

npm i -g @htmlacademy/editorconfig-cli

Or localy in the project:

npm i -D @htmlacademy/editorconfig-cli

Help

$ npx editorconfig-cli --help

  Usage: editorconfig-cli [options] <file ... or 'glob'>

  Options:
  -e, --editorconfig <file>                   pass configuration file.
                                              !Warning! absolute paths are not supported or will break on Windows OS. (default: ".editorconfig")
  -i, --ignores <profile-name or regexp...>   ignoring profiles. Like ('js-comments'|'java-comments'|'xml-comments'|'html-comments'|...). (default: ["js-comments","html-comments"])
  -j, --json <file>                           load GLOBs from JSON file. If no input passed, then it tries to find array in package.json (default: "package.json")
  -x, --exclude <regexp...>                   exclude files by patterns. (default: [`.*\\.min\\..*`])
  -v, --verbose                               verbose output
  -h, --help                                  display help for command

Example Commands

Check all files in the project except those with the .min. suffix and listed in ./.gitignore, using ./.editorconfig as the settings:

editorconfig-cli

The same as above, but only JavaScript files:

editorconfig-cli **/*.js

The same as above, but with GLOB format:

editorconfig-cli '**/*.js'

Load GLOBs from package.json:

editorconfig-cli

Format of JSON with GLOBs:

File: glob.json

{
  "editorconfig-cli": [
    "./*.html",
    "./*.json",
    "./img/**/*.svg",
    "./js/**/*.js",
    "./less/**/*.less",
    "./sass/**/*.{sass,scss}",
    "./postcss/**/*.{css,pcss}"
  ]
}

Pass glob.json to CLI:

editorconfig-cli -j glob.json

Ignores

lintspaces supports built-in ignores.

Using built in ignores can be done like so:

editorconfig-cli -i 'js-comments' -i 'c-comments'

If parameters are omitted, then js-comments and html-comments are used.