eslint-plugin-putout v23.3.0
eslint-plugin-putout
ESLint plugin for πPutout with built-in rules from @putout/eslint-config.
Installation
npm i putout eslint eslint-plugin-putout -D
βοΈIf you installed eslint
globally (using the -g
flag) then you must also install putout
and eslint-plugin-putout
globally.
Usage
Add putout
to the plugins section of your .eslintrc.json
configuration file. You can omit the eslint-plugin-
prefix:
{
"extends": ["plugin:putout/recommended"],
"plugins": ["putout"]
}
Then configure the rules you want to use under the rules section.
{
"rules": {
"putout/add-newlines-between-types-in-union": "error",
"putout/add-newlines-between-specifiers": "error",
"putout/add-newline-before-return": "error",
"putout/add-newline-before-function-call": "error",
"putout/add-newline-after-function-call": "error",
"putout/putout": "error",
"putout/array-element-newline": "error",
"putout/single-property-destructuring": "error",
"putout/multiple-properties-destructuring": "error",
"putout/long-properties-destructuring": "error",
"putout/destructuring-as-function-argument": "error",
"putout/align-spaces": "error",
"putout/keyword-spacing": "error",
"putout/newline-function-call-arguments": "error",
"putout/function-declaration-paren-newline": "error",
"putout/remove-newline-after-default-import": "error",
"putout/remove-newline-between-declarations": "error",
"putout/remove-newline-from-empty-object": "error",
"putout/remove-empty-newline-before-first-specifier": "error",
"putout/remove-empty-newline-after-last-specifier": "error",
"putout/remove-empty-newline-after-last-element": "error",
"putout/remove-empty-newline-after-import": "error",
"putout/remove-empty-specifiers": "error",
"putout/objects-braces-inside-array": "error",
"putout/object-property-newline": "error",
"putout/tape-add-newline-between-tests": "error",
"putout/tape-add-newline-before-assertion": "error",
"putout/tape-remove-newline-before-t-end": "error"
}
}
Rules
π Putout
πΌ Supertape
TypeScript
ESM
Formatting
- β Add newline before return
- β Add newline before function call
- β Add newline after function call
- β Align spaces
- β Array element newline
- β Single property destructuring
- β Multiple properties destructuring
- β For-of multiple properties destructuring
- β Long properties destructuring
- β Destructuring as function argument
- β Keyword spacing
- β Newline function call arguments
- β Function declaration paren newline
- β Remove newline between declarations
- β Remove newline after default import
- β Remove newline from empty object
- β Remove empty newline before first specifier
- β Remove empty newline after last specifier
- β Remove empty newline after last element
- β Remove empty newline after import
- β Remove empty specifiers
- β Objects braces inside array
- β Nonblock statement body newline
Safe mode
When using πPutout in IDE with --fix
on save, or when you want to disable the most dangerous rules, use:
{
"extends": ["plugin:putout/safe"],
"plugins": ["putout"]
}
Disabled ESLint rules:
Disabled πPutout rules:
- β
apply-template-literals
; - β
remove-empty
; - β
nodejs/remove-process-exit
; - β
remove-unused-variables
; - β
typescript/remove-unused-types
; - β
remove-unused-expressions
; - β
remove-unreferenced-variables
; - β
remove-useless-arguments
; - β
remove-useless-return
; - β
remove-useless-spread
; - β
remove-useless-variables
; - β
tape/remove-skip
; - β
tape/remove-only
; - β
remove-console
; - β
remove-debugger
; - β
remove-unreachable-code
; - β
for-of/for
; - β
for-of/remove-useless
; - β
for-of/remove-unused-variables
; - β
maybe/noop
;
safe+align
When you want to enable ability to align spaces on empty lines, while have all benefits of safe
preset: use safe+align
.
jsx
When you need to support jsx
in files using js
extension, use:
{
"extends": [
"plugin:putout/jsx"
],
"plugins": [
"putout"
]
}
esm
If you want to use ESM plugins of πPutout you need to use esm
preset:
{
"extends": [
"plugin:putout/esm"
],
"plugins": [
"putout"
]
}
Flat
The time is came for a FlatConfig. To use it with eslint-plugin-putout
add to eslint.config.js
:
const {recommended} = require('eslint-plugin-putout/config');
module.exports = [
...recommended,
{},
];
safe
and safeAlign
supported as well.
License
MIT
12 days ago
2 months ago
4 months ago
4 months ago
6 months ago
7 months ago
7 months ago
8 months ago
8 months ago
8 months ago
8 months ago
9 months ago
9 months ago
10 months ago
10 months ago
11 months ago
12 months ago
12 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago