feature: eslint-plugin-putout: add remove-empty-newline-between-declarations

Author: coderaiser

packages/eslint-plugin-putout/README.md

@@ -51,6 +51,7 @@ Then configure the rules you want to use under the rules section.
         "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",
@@ -105,6 +106,7 @@ Then configure the rules you want to use under the rules section.
 - ✅ [Keyword spacing](/packages/eslint-plugin-putout/lib/keyword-spacing#readme)
 - ✅ [Newline function call arguments](/packages/eslint-plugin-putout/lib/newline-function-call-arguments#readme)
 - ✅ [Function declaration paren newline](/packages/eslint-plugin-putout/lib/function-declaration-paren-newline#readme)
+- ✅ [Remove newline between declarations](/packages/eslint-plugin-putout/lib/remove-newline-between-declarations#readme)
 - ✅ [Remove newline after default import](/packages/eslint-plugin-putout/lib/remove-newline-after-default-import#readme)
 - ✅ [Remove newline from empty object](/packages/eslint-plugin-putout/lib/remove-newline-from-empty-object#readme)
 - ✅ [Remove empty newline before first specifier](/packages/eslint-plugin-putout/lib/remove-empty-newline-before-first-specifier#readme)

packages/eslint-plugin-putout/lib/add-newline-after-function-call/index.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {types} = require('putout');
-
 const {
     isBlockStatement,
     isExpressionStatement,

packages/eslint-plugin-putout/lib/add-newline-before-function-call/index.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {types} = require('putout');
-
 const {
     isBlockStatement,
     isVariableDeclaration,

packages/eslint-plugin-putout/lib/add-newlines-between-types-in-union/index.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {types} = require('putout');
-
 const {isTSTypeAliasDeclaration} = types;
 
 module.exports.category = 'typescript';

packages/eslint-plugin-putout/lib/index.js

@@ -48,6 +48,7 @@ module.exports.rules = {
     ...getWrapRule('nonblock-statement-body-newline'),
     ...getRule('putout'),
     ...getRule('remove-empty-newline-after-import'),
+    ...getRule('remove-empty-newline-between-declarations'),
 };
 
 const config = require('@putout/eslint-config');
@@ -81,6 +82,7 @@ const recommended = {
         '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-newline-between-declarations': 'error',
         'putout/remove-empty-specifiers': 'error',
         'putout/objects-braces-inside-array': 'error',
         'putout/object-property-newline': 'error',

packages/eslint-plugin-putout/lib/remove-empty-newline-between-declarations/.eslintrc.json

@@ -0,0 +1,8 @@
+{
+    "overrides": [{
+        "files": "*.md{js}",
+        "rules": {
+            "putout/remove-empty-newline-after-import": "off"
+        }
+    }]
+}

packages/eslint-plugin-putout/lib/remove-empty-newline-between-declarations/README.md

@@ -0,0 +1,17 @@
+# remove-empty-newline-between-declarations
+
+This rule aims to remove empty newline between Variable Declarations. Part of [**eslint-plugin-putout**](https://github.com/coderaiser/putout/tree/master/packages/eslint-plugin-putout#rules).
+
+## ❌ Example of incorrect code
+
+```js
+const {a} = b;
+const {c} = a;
+```
+
+## ✅ Example of correct code
+
+```js
+const {a} = b;
+const {c} = a;
+```

packages/eslint-plugin-putout/lib/remove-empty-newline-between-declarations/index.js

@@ -0,0 +1,60 @@
+'use strict';
+
+const {isObjectPattern} = require('putout').types;
+
+module.exports = {
+    meta: {
+        type: 'suggestion',
+        docs: {
+            description: 'Remove newline between declarations',
+            category: 'putout',
+            recommended: true,
+        },
+        fixable: 'code',
+    },
+    
+    create(context) {
+        return {
+            VariableDeclaration(node) {
+                const source = context.getSourceCode();
+                const text = source.getText(node);
+                const newline = source.getText(node, 0, 2).replace(text, '');
+                
+                if (newline !== '\n\n')
+                    return;
+                
+                const nextNode = context.getNodeByRangeIndex(node.range[1] + 2);
+                
+                if (!nextNode || nextNode.type !== 'VariableDeclaration')
+                    return;
+                
+                const nodeId = node.declarations[0].id;
+                
+                if (!isObjectPattern(nodeId))
+                    return;
+                
+                if (nodeId.properties.length !== 1)
+                    return;
+                
+                const textId = source.getText(nodeId.properties[0].value);
+                
+                const nextNodeInit = nextNode.declarations[0].init;
+                const nextTextInit = source.getText(nextNodeInit);
+                
+                if (textId !== nextTextInit)
+                    return;
+                
+                context.report({
+                    node,
+                    message: 'Remove empty newline between declarations',
+                    
+                    fix(fixer) {
+                        return [
+                            fixer.removeRange([node.range[1], node.range[1] + 1]),
+                        ];
+                    },
+                });
+            },
+        };
+    },
+};

packages/eslint-plugin-putout/lib/remove-empty-newline-between-declarations/index.spec.js

@@ -0,0 +1,57 @@
+'use strict';
+
+const {RuleTester} = require('eslint');
+const montag = require('montag');
+
+const rule = require('.');
+
+const ruleTester = new RuleTester({
+    parserOptions: {
+        ecmaVersion: 2022,
+        sourceType: 'module',
+    },
+});
+
+ruleTester.run('remove-empty-newline-between-declarations', rule, {
+    valid: [
+        montag`
+            const {a} = b;
+            const {c} = a;
+        `,
+        montag`
+            const {m} = b;
+            
+            const {c} = a;
+        `,
+        montag`
+            const m = 'hello';
+            
+            const {c} = a;
+        `,
+        montag`
+            const {
+                operator,
+                types,
+            } = require('putout');
+            
+            const {replaceWith} = operator;
+        `,
+    ],
+    
+    invalid: [{
+        code: montag`
+            const {a} = b;
+            
+            const {c} = a;
+        `,
+        output: montag`
+            const {a} = b;
+            const {c} = a;
+        `,
+        errors: [{
+            message: 'Remove empty newline between declarations',
+            type: 'VariableDeclaration',
+        }],
+    }],
+});
+

packages/eslint-plugin-putout/test/eslint.mjs

@@ -188,3 +188,7 @@ test('eslint-plugin-putout: multiple-properties-destructuring', async ({process}
     await process('multiple-properties-destructuring');
 });
 
+test('eslint-plugin-putout: remove-newline-between-declarations', async ({process}) => {
+    await process('remove-newline-between-declarations');
+});
+

packages/eslint-plugin-putout/test/fixture/remove-newline-between-declarations-fix.js

@@ -0,0 +1,2 @@
+const {a} = b;
+const {c} = a;

packages/eslint-plugin-putout/test/fixture/remove-newline-between-declarations.js

@@ -0,0 +1,3 @@
+const {a} = b;
+
+const {c} = a;

packages/plugin-apply-maybe/lib/noop/index.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {types} = require('putout');
-
 const {isBlockStatement} = types;
 
 module.exports.report = () => `Use 'noop()'`;

packages/plugin-apply-template-literals/lib/apply-template-literals.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {types} = require('putout');
-
 const {
     isBinaryExpression,
     isTemplateLiteral,

packages/plugin-convert-reduce-to-for-of/lib/convert-reduce-to-for-of.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {types} = require('putout');
-
 const {
     isBlockStatement,
     isArrayExpression,

packages/plugin-convert-typeof-to-is-type/lib/convert-typeof-to-is-type.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {operator} = require('putout');
-
 const {compare, getBindingPath} = operator;
 
 const NAMES = {

packages/plugin-extract-object-properties/lib/not-equal-deep/index.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {operator} = require('putout');
-
 const {
     replaceWith,
     compare,

packages/plugin-nextjs/lib/convert-page-to-head/index.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {operator} = require('putout');
-
 const {
     remove,
     traverse,

packages/plugin-nextjs/lib/remove-a-from-link/index.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {types} = require('putout');
-
 const {isJSXElement} = types;
 
 module.exports.report = () => `Remove '<a>' from <Link>, it always renders under the hood`;

packages/plugin-nodejs/lib/declare-after-require/index.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {operator} = require('putout');
-
 const {
     remove,
     compareAny,

packages/plugin-promises/lib/add-missing-await/index.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {types} = require('putout');
-
 const {
     isIdentifier,
     AwaitExpression,

packages/plugin-putout/lib/check-replace-code/index.js

@@ -8,7 +8,6 @@ const generateCode = require('./generate-code');
 const noop = () => {};
 
 const {operator} = putout;
-
 const {
     compare,
     extract,

packages/plugin-putout/lib/replace-test-message/index.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {types} = require('putout');
-
 const {isCallExpression} = types;
 
 module.exports.report = ({correct, operatorPath}) => {

packages/plugin-react-hook-form/lib/v7-apply-form-state/index.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {types} = require('putout');
-
 const {
     ObjectProperty,
     ObjectPattern,

packages/plugin-react-router/lib/convert-component-to-element/index.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {types} = require('putout');
-
 const {
     JSXIdentifier,
     JSXOpeningElement,

packages/plugin-remove-empty/lib/pattern/index.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {types} = require('putout');
-
 const {
     isObjectPattern,
     isArrayPattern,

packages/plugin-remove-empty/lib/static-block/index.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {operator} = require('putout');
-
 const {remove} = operator;
 
 module.exports.report = () => 'Avoid useless empty static blocks';

packages/plugin-remove-unused-for-of-variables/lib/remove-unused-for-of-variables.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {types} = require('putout');
-
 const {
     isIdentifier,
     isObjectProperty,

packages/plugin-remove-unused-variables/lib/get-vars/typescript.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {types} = require('putout');
-
 const {
     isIdentifier,
     isTSModuleDeclaration,

packages/plugin-remove-unused-variables/lib/get-vars/use-params.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {types} = require('putout');
-
 const {
     isIdentifier,
     isObjectPattern,

packages/plugin-remove-useless-continue/lib/remove-useless-continue.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {operator} = require('putout');
-
 const {remove} = operator;
 
 const isLoop = (path) => path.isLoop() || path.parentPath.isLoop();

packages/plugin-remove-useless-functions/lib/remove-useless-functions.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {types} = require('putout');
-
 const {isIdentifier} = types;
 
 module.exports.report = () => 'Useless functions should be avoided';

packages/plugin-remove-useless-operand/lib/remove-useless-operand.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {types} = require('putout');
-
 const {
     isNumericLiteral,
     isIdentifier,

packages/plugin-remove-useless-spread/lib/array/index.js

@@ -1,7 +1,6 @@
 'use strict';
 
 const {types} = require('putout');
-
 const {isNumericLiteral} = types;
 
 module.exports.report = () => `Avoid useless spread '...'`;