Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mradionov/eslint-plugin-disable
Disable ESLint plugins using file path patterns and inline comments
https://github.com/mradionov/eslint-plugin-disable
eslint eslint-plugin
Last synced: 8 days ago
JSON representation
Disable ESLint plugins using file path patterns and inline comments
- Host: GitHub
- URL: https://github.com/mradionov/eslint-plugin-disable
- Owner: mradionov
- License: mit
- Created: 2015-12-13T10:36:21.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T03:18:18.000Z (over 1 year ago)
- Last Synced: 2024-10-10T12:07:29.436Z (29 days ago)
- Topics: eslint, eslint-plugin
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/eslint-plugin-disable
- Size: 168 KB
- Stars: 56
- Watchers: 4
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-eslint - disable - Disable specified plugins using file path patterns and inline comments. (Plugins / Deprecation)
README
# eslint-plugin-disable [](https://travis-ci.org/mradionov/eslint-plugin-disable)
> Disable ESLint plugins using file path patterns and inline comments
..which means all disabled plugins' errors and warnings won't appear in ESLint report.
- Example: inline comments:
```js
/* eslint-plugin-disable react */
function greet(name) {
console.log('Hi, ' + name);
}
```
- Example: file path patterns (.eslintrc):
```json
{
"plugins": ["react", "disable"],
"processor": "disable/disable",
"overrides": [
{
"files": ["tests/**/*.test.js"],
"settings": {
"disable/plugins": ["react"]
}
}
]
}
```
## Install
```bash
npm install eslint-plugin-disable --save-dev
```
## Use
Add plugin to a config file (.eslintrc) and make it default processor:
```json
{
"plugins": ["disable"],
"processor": "disable/disable"
}
```
#### Inline comments
##### Regular disable
Plugin adds a custom directive to use in files in a form of inline comment, which allows to disable entire plugins for this file. Plugin names have to be the same as in ESLint config file, separated by comma.
The following directive will disable _"react"_ and _"jsx-a11y"_ plugins for this particular file.
```js
/* eslint-plugin-disable react, jsx-a11y */
function greet(name) {
console.log('Hi, ' + name);
}
```
If no any plugins provided - **all** plugins registered in ESLint config will be disabled:
```js
/* eslint-plugin-disable */
function greet(name) {
console.log('Hi, ' + name);
}
```
##### Disable all except
Another custom option allows to disable all plugins except ones that are specified. It might be useful when there are a lot of plugins in the project and it is required to use one or two of them for particular files, usage of regular disable syntax might be cumbersome to maintain if there are plans to add new plugins to the project. Plugin names have to be the same as in ESLint config file, separated by comma.
The following directive will disable all plugins registered in ESLint config except _"react"_ and _"jsx-a11y"_.
```js
/* eslint-plugin-disable-all-except react, jsx-a11y */
function greet(name) {
console.log('Hi, ' + name);
}
```
_Notes_:
- disable all except: if no plugins specified, then **none** of the plugins listed in ESLint config will be disabled i.e. error messages will not be removed from ESLint report
- all target files must have a _"disable/disable"_ processor enabled for them, including usage of [ESLint 6 Overrides](https://eslint.org/docs/user-guide/configuring#specifying-processor)
- whitespace inside block comment is ignored
- original file is not modified
- there is no way to restore behavior with another inline option
#### File paths
##### Regular disable
To disable plugins for file paths use new [ESLint 6+ Overrides](https://eslint.org/docs/user-guide/configuring) feature in config (.eslintrc). It has many different configurations for glob path patterns, ignore patterns and it basically creates a nested config for a list of files ([ESLint docs for more info](https://eslint.org/docs/user-guide/configuring#configuration-based-on-glob-patterns)). This list of files should be assigned with a _"disable/disable"_ processor in order for plugin to work. You can have multiple _"overrides"_ entries with different paths and different plugins to disable.
The following config will:
- disable _"import"_ and _"jsx-a11y"_ plugins for all files matching _"tests/\*\*/\*.test.js"_ glob pattern
- disable _"react"_ plugin for all files matching _"lib/\*.js"_ glob pattern
```json
{
"plugins": ["import", "react", "jsx-a11y", "disable"],
"processor": "disable/disable",
"overrides": [
{
"files": ["tests/**/*.test.js"],
"settings": {
"disable/plugins": ["import", "jsx-a11y"]
}
},
{
"files": ["lib/*.js"],
"settings": {
"disable/plugins": ["react"]
}
}
]
}
```
To disable all registered plugins you can simply omit _"disable/plugins"_ setting or use a star in place of plugin name:
```json
{
"plugins": ["import", "react", "jsx-a11y", "disable"],
"processor": "disable/disable",
"overrides": [
{
"files": ["tests/**/*.test.js"],
"settings": {
"disable/plugins": "*"
}
}
]
}
```
##### Disable all except
To disable all plugins except specified ones use _"disableAllExcept"_ flag in config settings (.eslintrc).
The following config will disable all registered plugins except _"react"_ for all files mathing _"tests/\*\*\/\*.test.js"_ glob pattern (_"import"_ and _"jsx-a11y"_ will be disabled).
```json
{
"plugins": ["import", "react", "jsx-a11y", "disable"],
"processor": "disable/disable",
"overrides": [
{
"files": ["tests/**/*.test.js"],
"settings": {
"disable/disableAllExcept": true,
"disable/plugins": ["react"]
}
}
]
}
```
## Conflicts with other plugins
Some ESLint plugins also use processors, which creates a conflict with this plugin, because ESLint does not allow to chain processors for the same source files without processing it and producing another files. There is a setting _"externalProcessor"_, which accepts a processor identifier _"pluginName/processorName"_ and makes this plugin to call other plugin's processor before disabling the rules.
One of the cases is _"eslint-plugin-vue"_:
```json
{
"plugins": ["vue", "disable"],
"processor": "disable/disable",
"settings": {
"disable/plugins": ["vue"],
"disable/externalProcessor": "vue/.vue"
}
}
```
As a plugin might export multiple processors, the only way to find out what _"processorName"_ to use, is to browse plugin's sources. If you don't know it, then you can just skip _"processorName"_ in identifier and only leave _"pluginName"_ - this way the first available processor will be auto-picked.
```json
{
"plugins": ["vue", "disable"],
"processor": "disable/disable",
"settings": {
"disable/plugins": ["vue"],
"disable/externalProcessor": "vue"
}
}
```
## Option precedence
All the options are not merged together, there is a strict order in which they apply:
1. Inline comment to disable all plugins except specified ([docs](#disable-all-except))
2. Inline comment to disable specified plugins ([docs](#regular-disable))
3. Settings paths to disable all plugins except specified ([docs](#disable-all-except-1))
4. Settings paths to disable specified plugins ([docs](#regular-disable-1))
If first option applies, then only plugins mentioned in this option will be used to disable, the rest of the options down the list will be ignored. If first and second options do not apply (no inline comments in file), but third option does apply, then only plugins mentioned in third option will be used to disable, the rest will be ignored.
## Support
| eslint | eslint-plugin-disable |
| ---------------- | --------------------- |
| >= 0.16.0 <6.0.0 | <=1.0.5 |
| >=6.0.0 | >=2.0.0 |
## Migrating
- [1.x to 2.x](MIGRATING.md)
## Origin
Unfortunately this feature is not natively supported in ESLint yet, so this module may become a temporary workaround. Read the following issues for additional information:
- [eslint/eslint - Disable plugin with comments #2118](https://github.com/eslint/eslint/issues/2118)
- [eslint/eslint - Provide means for disabling all rules from a given plugin within a file #3419](https://github.com/eslint/eslint/issues/3419)
- [Gillespie59/eslint-plugin-angular - Don't lint non-angular files #228](https://github.com/Gillespie59/eslint-plugin-angular/issues/228)