Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phanect/eslint-plugin-editorconfig
An ESLint plugin to enforce EditorConfig rules
https://github.com/phanect/eslint-plugin-editorconfig
editorconfig eslint eslint-plugin
Last synced: 3 months ago
JSON representation
An ESLint plugin to enforce EditorConfig rules
- Host: GitHub
- URL: https://github.com/phanect/eslint-plugin-editorconfig
- Owner: phanect
- License: mit
- Created: 2018-10-06T19:28:07.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-04-15T03:18:52.000Z (9 months ago)
- Last Synced: 2024-04-20T20:00:10.457Z (9 months ago)
- Topics: editorconfig, eslint, eslint-plugin
- Language: JavaScript
- Homepage:
- Size: 281 KB
- Stars: 34
- Watchers: 5
- Forks: 5
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# eslint-plugin-editorconfig
An ESLint plugin to enforce EditorConfig rules
[](https://github.com/phanect/eslint-plugin-editorconfig/actions/workflows/actions.yml) [](https://npmjs.org/package/eslint-plugin-editorconfig)
## Requirements
- ESLint v8
- ESLint v9 and flat config support is not ready yet. Even if you use legacy .eslintrc.\*, it does not work on v9. Sorry! :pray:
- Node.js v{18, 20, 22}
## Install
```bash
$ npm install --save-dev eslint@8 eslint-plugin-editorconfig
```
or
```bash
$ yarn add --dev eslint@8 eslint-plugin-editorconfig
```
If you use [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint), you need to install `@typescript-eslint/eslint-plugin` too.
```bash
$ npm install --save-dev @typescript-eslint/eslint-plugin
```
## Usage
### eslint.config.* (Flat Config)
Unfortunately, eslint-plugin-editorconfig does not work properly with Flat Config for now, even if you use `@eslint/eslintrc` for compatibility.
Please wait for the next version.
### .eslintrc.*
Like other ESLint plugins,
- add rules in the `rules`
- add `"editorconfig"` in the `plugins`
in your .eslintrc*
```json
{
// ...
"rules": {
"editorconfig/charset": "error",
"editorconfig/eol-last": "error",
"editorconfig/indent": "error",
"editorconfig/linebreak-style": "error",
"editorconfig/no-trailing-spaces": "error"
},
"plugins": [ "editorconfig" ]
}
```
Or you can extend `plugin:editorconfig/all` instead of adding rules.
```json
{
// ...
"extends": [ "plugin:editorconfig/all" ],
"plugins": [ "editorconfig" ]
}
```
## Conflicting ESLint rules
Following rules may conflict `editorconfig/*` rule.
It is recommended to disable them.
- `eol-last`
- `indent`
- `linebreak-style`
- `no-trailing-spaces`
- `unicode-bom`
- `@typescript-eslint/eol-last`
- `@typescript-eslint/indent`
- `@typescript-eslint/linebreak-style`
- `@typescript-eslint/no-trailing-spaces`
- `@typescript-eslint/unicode-bom`
If above rules are specified in your .eslintrc, just remove them.
If they are specified in the extended config, consider adding `plugin:editorconfig/noconflict` to your `extends`.
```json
{
"extends": [
"@phanect/phanective",
"plugin:editorconfig/noconflict"
],
// ...
}
```
If you extend `plugin:editorconfig/all`, the rules above are turned off too, so you don't have to add `plugin:editorconfig/noconflict` in addition to `plugin:editorconfig/all`.
### Rules
Internally, eslint-plugin-editorconfig uses the existing ESLint and typescript-eslint rules to verify/fix the code.
Some rules allow passing options.
All the citation in the docs is from the backend ESLint rule document otherwise noted.
| Rule | Description | Fixable |
| ------------------------------------------------------------------- | --------------------------------------------------------------- | -- |
| [editorconfig/charset](docs/rules/charset.md) | Enforce EditorConfig rules for charset | ✅ |
| [editorconfig/eol-last](docs/rules/eol-last.md) | Enforce EditorConfig rules for the newlines at the end of files | ✅ |
| [editorconfig/indent](docs/rules/indent.md) | Enforce EditorConfig rules for indentation | ✅ |
| [editorconfig/linebreak-style](docs/rules/linebreak-style.md) | Enforce EditorConfig rules for linebreak style | ✅ |
| [editorconfig/no-trailing-spaces](docs/rules/no-trailing-spaces.md) | Enforce EditorConfig rules for trailing spaces | ✅ |
## License & Credit
[MIT](./LICENSE)
This plugin includes code derived from [klona](https://github.com/lukeed/klona).