Command line interface for project files with .editorconfig
npm install @htmlacademy/editorconfig-cli[![Vulnerabilities count][vulnerabilities-image]][vulnerabilities-url]
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.
Globaly:
``shell`
npm i -g @htmlacademy/editorconfig-cli
Or localy in the project:
`shell`
npm i -D @htmlacademy/editorconfig-cli
`shell
$ npx editorconfig-cli --help
Usage: editorconfig-cli [options]
Options:
-e, --editorconfig
!Warning! absolute paths are not supported or will break on Windows OS. (default: ".editorconfig")
-i, --ignores
-j, --json
-x, --exclude ])`
-v, --verbose verbose output
-h, --help display help for command
Check all files in the project except those with the .min. suffix and listed in ./.gitignore, using ./.editorconfig as the settings:
`shell`
editorconfig-cli
The same as above, but only JavaScript files:
`shell`
editorconfig-cli */.js
The same as above, but with GLOB format:
`shell`
editorconfig-cli '*/.js'
Load GLOBs from package.json:
`shell`
editorconfig-cli
Format of JSON with GLOBs:
File: glob.json
`json`
{
"editorconfig-cli": [
"./*.html",
"./*.json",
"./img/*/.svg",
"./js/*/.js",
"./less/*/.less",
"./sass/*/.{sass,scss}",
"./postcss/*/.{css,pcss}"
]
}
Pass glob.json to CLI:
`shell`
editorconfig-cli -j glob.json
lintspaces supports built-in ignores.
Using built in ignores can be done like so:
`shell`
editorconfig-cli -i 'js-comments' -i 'c-comments'
If parameters are omitted, then js-comments and html-comments` are used.
[vulnerabilities-url]: https://snyk.io/test/github/htmlacademy/editorconfig-cli
[vulnerabilities-image]: https://snyk.io/test/github/htmlacademy/editorconfig-cli/badge.svg