eslint-plugin-putout 14.0.1 → 14.1.0

package/README.md

@@ -5,7 +5,7 @@
 [CoverageURL]: https://coveralls.io/github/coderaiser/putout?branch=master
 [CoverageIMGURL]: https://coveralls.io/repos/coderaiser/putout/badge.svg?branch=master&service=github
 
-[`ESLint`](https://eslint.org) plugin for 🐊[`Putout`](https://github.com/coderaiser/putout) with built-in rules from [`@putout/eslint-config`](https://github.com/coderaiser/putout/tree/master/packages/eslint-config).
+[**ESLint**](https://eslint.org) plugin for 🐊[**Putout**](https://github.com/coderaiser/putout) with built-in rules from [**@putout/eslint-config**](https://github.com/coderaiser/putout/tree/master/packages/eslint-config#readme).
 
 ## Installation
 
@@ -13,7 +13,7 @@
 npm i putout eslint eslint-plugin-putout -D
 ```
 
-**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `putout` and `eslint-plugin-putout` globally.
+☝️*If you installed `eslint` globally (using the `-g` flag) then you must also install `putout` and `eslint-plugin-putout` globally.*
 
 ## Usage
 
@@ -108,7 +108,7 @@ Then configure the rules you want to use under the rules section.
 
 ### Safe mode
 
-When using 🐊`Putout` in IDE with `--fix` on save, or when you want to disable the most dangerous rules, use:
+When using 🐊**Putout** in IDE with `--fix` on save, or when you want to disable the most dangerous rules, use:
 
 ```json
 {
@@ -121,12 +121,12 @@ When using 🐊`Putout` in IDE with `--fix` on save, or when you want to disable
 }
 ```
 
-Disabled `ESLint` rules:
+Disabled **ESLint** rules:
 
 - [`no-useless-return`](https://eslint.org/docs/rules/no-useless-return#readme)
 - [`putout/remove-newline-from-empty-object`](https://github.com/coderaiser/putout/tree/master/packages/eslint-plugin-putout/lib/remove-newline-from-empty-object#readme)
 
-Disabled 🐊`Putout` rules:
+Disabled 🐊**Putout** rules:
 
 - 🐲[`remove-empty`](https://github.com/coderaiser/putout/tree/v24.0.0/packages/plugin-remove-empty#readme);
 - 🐲[`nodejs/remove-process-exit`](https://github.com/coderaiser/putout/tree/v24.0.0/packages/plugin-nodejs#remove-process-exit#readme);

package/lib/add-newline-after-function-call/README.md

@@ -1,10 +1,8 @@
-# Add new line after function call (`add-newline-after-function-call`)
-
-## Rule Details
+# add-newline-after-function-call
 
 This rule aims to add newline after function call.
 
-Examples of **incorrect** code for this rule:
+## ❌ Example of incorrect code
 
 ```js
 export function parse() {
@@ -15,7 +13,7 @@ export function parse() {
 }
 ```
 
-Examples of **correct** code for this rule:
+## ✅ Example of correct code
 
 ```js
 export function parse() {

package/lib/align-spaces/README.md

@@ -1,12 +1,8 @@
-# Spaces should be aligned (`aling-spaces`)
+# aling-spaces
 
-After `putout` process files it can remove spaces from empty line, this `rule` fixes it.
+When 🐊**Putout** processes files it can remove spaces from empty line, this `rule` fixes it.
 
-## Rule Details
-
-This rule aims to shorten destricturing of one property.
-
-Examples of **incorrect** code for this rule:
+## ❌ Example of incorrect code
 
 ```js
 function hello() {
@@ -18,7 +14,7 @@ function hello() {
 }
 ```
 
-Examples of **correct** code for this rule:
+## ✅ Example of correct code
 
 ```js
 function hello() {

package/lib/array-element-newline/README.md

@@ -1,19 +1,17 @@
-# Add new lines between types in union (`add-newlines-between-types-in-union`)
-
-Because [`array-element-newline`](https://eslint.org/docs/rules/array-element-newline) requires [`array-bracket-newline`](https://eslint.org/docs/rules/array-bracket-newline).
-And `array-bracket-newline` and conflicts with [`object-braces-inside-array`](https://github.com/coderaiser/putout/tree/master/packages/eslint-plugin-putout/lib/objects-braces-inside-array).
-
-## Rule Details
+# array-elements-newline
 
 This rule aims to add newlines between array elements.
+It exists because [`array-element-newline`](https://eslint.org/docs/rules/array-element-newline) requires [`array-bracket-newline`](https://eslint.org/docs/rules/array-bracket-newline) which conflicts with [`object-braces-inside-array`](https://github.com/coderaiser/putout/tree/master/packages/eslint-plugin-putout/lib/objects-braces-inside-array#readme).
+
+Part of [`eslint-plugin-putout`](https://github.com/coderaiser/putout/tree/master/packages/eslint-plugin-putout#rules).
 
-Examples of **incorrect** code for this rule:
+## ❌ Example of incorrect code
 
 ```js
 const a = [1, 2, 3, 4, 5, 6, 7];
 ```
 
-Examples of **correct** code for this rule:
+## ✅ Example of correct code
 
 ```js
 const a = [

package/lib/evaluate/README.md

@@ -1,11 +1,10 @@
 # Evaluate
 
-Evaluate expression started with `__putout_evaluate: `. Part of [`eslint-plugin-putout`](https://github.com/coderaiser/putout/tree/master/packages/eslint-plugin-putout#rules)
-
+Evaluate expression started with `__putout_evaluate: `. Part of [`eslint-plugin-putout`](https://github.com/coderaiser/putout/tree/master/packages/eslint-plugin-putout#rules).
 Provided code is processed with [`@putout/plugin-declare-undefined-variables`](https://github.com/coderaiser/putout/tree/master/packages/plugin-declare-undefined-variables):
 
 ```js
-__putout_evaluate: join("hello", " ", "world");
+__putout_evaluate: join('hello', ' ', 'world');
 ```
 
 and converted to:
@@ -13,7 +12,7 @@ and converted to:
 ```js
 const fn = (__filename, __dirname, require) => {
     const {join} = require('path');
-    return join("hello", " ", "world");
+    return join('hello', ' ', 'world');
 };
 ```
 

package/lib/for-of-multiple-properties-destructuring/README.md

@@ -1,10 +1,9 @@
-# Keep all properties in one line when using destructuring in `for-of` (`for-of-multiple-properties-destructuring`)
+# for-of-multiple-properties-destructuring
 
-## Rule Details
+This rule aims to shorten destructuring in `for-of` statements, keeping all properties in one line.
+Part of [**eslint-plugin-putout**](https://github.com/coderaiser/putout/tree/master/packages/eslint-plugin-putout#rules).
 
-This rule aims to shorten destructuring in `for-of` statements
-
-Examples of **incorrect** code for this rule:
+## ❌ Example of incorrect code
 
 ```js
 for ({
@@ -14,13 +13,13 @@ for ({
 }
 ```
 
-Examples of **correct** code for this rule:
-
-## Options
-
-`maxProperties` - maximum properties count to work with.
+## ✅ Example of correct code
 
 ```js
 for ({username, password} of users) {
 }
 ```
+
+## Options
+
+`maxProperties` - maximum properties count to work with, defaults to **8**.

package/lib/long-properties-destructuring/README.md

@@ -1,18 +1,16 @@
-# Keep each property on separate line when destructuring long properties (`long-properties-destructuring`)
+# long-properties-destructuring
 
-Always add new lines, when property name is longer then 15 characters.
+Keep each property on separate line when destructuring properties with name length **15** characters and more.
 
-## Rule Details
+Part of [**eslint-plugin-putout**](https://github.com/coderaiser/putout/tree/master/packages/eslint-plugin-putout#rules).
 
-This rule aims to shorten destricturing of one property.
-
-Examples of **incorrect** code for this rule:
+## ❌ Example of incorrect code
 
 ```js
 const {isIdentifier} = user;
 ```
 
-Examples of **correct** code for this rule:
+## ✅ Example of correct code
 
 ```js
 const {

package/lib/markdown.js

@@ -8,8 +8,6 @@ const commonRules = {
     'no-multi-spaces': 'off',
     'no-empty': 'off',
     'eol-last': 'off',
-    'quotes': 'off',
-    'quote-props': 'off',
     'no-unreachable': 'off',
     'no-constant-condition': 'off',
     'node/no-extraneous-require': 'off',

package/lib/multiple-properties-destructuring/README.md

@@ -1,10 +1,11 @@
-# Keep each property on separate line when using multiple destructuring properties (`multiple-properties-destructuring`)
+# multiple-properties-destructuring
 
-In the same way as eslint [object-property-newline](https://eslint.org/docs/rules/object-property-newline), but for destructuring.
+Keep each property on separate line when using multiple destructuring properties
+In the same way as **ESLint** [object-property-newline](https://eslint.org/docs/rules/object-property-newline), but for destructuring.
 
-## Rule Details
+Part of [**eslint-plugin-putout**](https://github.com/coderaiser/putout/tree/master/packages/eslint-plugin-putout#rules).
 
-Examples of **incorrect** code for this rule:
+## ❌ Example of incorrect code
 
 ```js
 const {a, b, c} = user;
@@ -14,7 +15,7 @@ const {a, b, c} = user;
 import {a, b, c} from 'user';
 ```
 
-Examples of **correct** code for this rule:
+## ✅ Example of correct code
 
 ```js
 const {
@@ -34,7 +35,7 @@ import {
 
 ## Options
 
-`minProperties` - minimum properties count to work with.
+`minProperties` - minimum properties count to work with, defaults: `2`.
 
 ```js
 const {

package/lib/single-property-destructuring/README.md

@@ -1,12 +1,11 @@
-# Keep curly braces in one line when property is single (`single-property-destructuring`)
+# single-property-destructuring
 
-When 🐊[`Putout`](https://github.com/coderaiser/putout) removes unused variables declared as destructured properties, it keeps one property to take 3 lines, instead of 1.
+When 🐊[**Putout**](https://github.com/coderaiser/putout) removes unused variables declared as destructured properties, it keeps one property to take 3 lines, instead of 1.
+This rule aims to shorten destructuring of one property, keeping curly braces in one line.
 
-## Rule Details
+Part of [**eslint-plugin-putout**](https://github.com/coderaiser/putout/tree/master/packages/eslint-plugin-putout#rules).
 
-This rule aims to shorten destructuring of one property.
-
-Examples of **incorrect** code for this rule:
+## ❌ Example of incorrect code
 
 ```js
 import {
@@ -19,7 +18,7 @@ const {
 
 ```
 
-Examples of **correct** code for this rule:
+## ✅ Example of correct code
 
 ```js
 import {password} from './user.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-putout",
-  "version": "14.0.1",
+  "version": "14.1.0",
   "type": "commonjs",
   "description": "eslint plugin for putout",
   "release": false,