
Security News
Deno 2.2 Improves Dependency Management and Expands Node.js Compatibility
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
eslint-plugin-editorconfig
Advanced tools
An ESLint plugin to enforce EditorConfig rules
$ npm install --save-dev eslint eslint-plugin-editorconfig
or
$ yarn add --dev eslint eslint-plugin-editorconfig
If you use typescript-eslint, you need to install @typescript-eslint/eslint-plugin
too.
$ npm install --save-dev @typescript-eslint/eslint-plugin
Like other ESLint plugins,
rules
"editorconfig"
in the plugins
in your .eslintrc*
{
// ...
"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.
{
// ...
"extends": [ "plugin:editorconfig/all" ],
"plugins": [ "editorconfig" ]
}
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
.
{
"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
.
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 | Enforce EditorConfig rules for charset | ✅ |
editorconfig/eol-last | Enforce EditorConfig rules for the newlines at the end of files | ✅ |
editorconfig/indent | Enforce EditorConfig rules for indentation | ✅ |
editorconfig/linebreak-style | Enforce EditorConfig rules for linebreak style | ✅ |
editorconfig/no-trailing-spaces | Enforce EditorConfig rules for trailing spaces | ✅ |
This plugin includes code derived from klona.
FAQs
An ESLint plugin to enforce EditorConfig rules
The npm package eslint-plugin-editorconfig receives a total of 16,773 weekly downloads. As such, eslint-plugin-editorconfig popularity was classified as popular.
We found that eslint-plugin-editorconfig demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.