https://github.com/editorconfig-checker/editorconfig-checker.javascript
A tool to verify that your files are in harmony with your .editorconfig
https://github.com/editorconfig-checker/editorconfig-checker.javascript
clean-architecture code-quality codequality editorconfig editorconfig-checker linting
Last synced: about 2 months ago
JSON representation
A tool to verify that your files are in harmony with your .editorconfig
- Host: GitHub
- URL: https://github.com/editorconfig-checker/editorconfig-checker.javascript
- Owner: editorconfig-checker
- License: mit
- Created: 2017-03-18T12:37:12.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2025-10-24T09:55:40.000Z (2 months ago)
- Last Synced: 2025-10-24T11:19:18.534Z (2 months ago)
- Topics: clean-architecture, code-quality, codequality, editorconfig, editorconfig-checker, linting
- Language: TypeScript
- Homepage: https://editorconfig-checker.github.io/
- Size: 4.64 MB
- Stars: 71
- Watchers: 7
- Forks: 13
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG-LEGACY.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# editorconfig-checker
[](https://www.npmjs.com/package/editorconfig-checker)
[](https://github.com/editorconfig-checker/editorconfig-checker.javascript/actions/workflows/ci.yml)
](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)
[](https://github.com/semantic-release/semantic-release)
## 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](https://github.com/editorconfig-checker/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:
```shell
npm install --save-dev editorconfig-checker
yarn add --dev editorconfig-checker
```
Otherwise you could clone the repository and execute the script manually.
```shell
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:
```json
"scripts": {
"lint:editorconfig": "editorconfig-checker"
}
```
Usage output:
```txt
USAGE:
-config string
config
-debug
print debugging information
-disable-end-of-line
disables the trailing whitespace 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-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, 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](https://webchat.freenode.net/?channels=editorconfig-checker).