feature(eslint-plugin-putout) add add-newline-before-return

Author: coderaiser

Diff for: packages/babel-plugin-putout/lib/index.js

@@ -36,6 +36,7 @@ module.exports = () => {
         generatorOverride(ast) {
             ast.program.directives = [];
             const code = print(ast);
+            
             return {code};
         },
     };

Diff for: packages/engine-runner/lib/merge-visitors.js

@@ -117,6 +117,7 @@ function getStore(plugin, {fix, rule, shebang, msg, options}) {
         list.clear();
         upstore.clear();
         uplist.clear();
+        
         return placesStore.clear();
     };
 

Diff for: packages/engine-runner/lib/store.js

@@ -22,6 +22,7 @@ module.exports.listStore = (list = new Set()) => {
     fn.clear = () => {
         const a = list;
         list = new Set();
+        
         return Array.from(a);
     };
 

Diff for: packages/eslint-plugin-putout/.eslintrc.json

@@ -11,6 +11,14 @@
             "@typescript-eslint/no-namespace": "off",
             "@typescript-eslint/no-inferrable-types": "off"
         }
+    }, {
+        "files": [
+            "eslint-fixture/**/*.md{js}",
+            "eslint-fixture/**/*.md{ts}"
+        ],
+        "rules": {
+            "putout/add-newline-before-return": "off"
+        }
     }],
     "extends": [
         "plugin:node/recommended",

Diff for: packages/eslint-plugin-putout/README.md

@@ -37,6 +37,7 @@ 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",
@@ -91,6 +92,7 @@ Then configure the rules you want to use under the rules section.
 
 ### Formatting
 
+- ✅ [Add newline before return](/packages/eslint-plugin-putout/lib/add-newline-before-return#readme)
 - ✅ [Add newline before function call](/packages/eslint-plugin-putout/lib/add-newline-before-function-call#readme)
 - ✅ [Add newline after function call](/packages/eslint-plugin-putout/lib/add-newline-after-function-call#readme)
 - ✅ [Align spaces](/packages/eslint-plugin-putout/lib/align-spaces#readme)

Diff for: packages/eslint-plugin-putout/eslint-fixture/markdown.md

@@ -3,14 +3,12 @@ throw Error('hi');
 () => throw Error('hi');
 
 const hello = 'world';
-
 return hello;
 ```
 
 ```ts
 throw Error('hi');
 
 const hello: string = 'world';
-
 return hello;
 ```

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

@@ -10,7 +10,6 @@ const {
 
 const regExp = /^\n( +)?\n +$/;
 
-module.exports.category = 'typescript';
 module.exports.report = () => 'Add newline before expression';
 
 module.exports.filter = ({text, node, getCommentsBefore, getSpacesBeforeNode}) => {
@@ -57,8 +56,6 @@ module.exports.filter = ({text, node, getCommentsBefore, getSpacesBeforeNode}) =
 
         return true;
     }
-    
-    return false;
 };
 
 module.exports.fix = ({text}) => {
@@ -68,4 +65,5 @@ module.exports.fix = ({text}) => {
 module.exports.include = () => [
     'CallExpression',
     'AssignmentExpression',
+    'ReturnStatement',
 ];

Diff for: packages/eslint-plugin-putout/lib/add-newline-before-return/.eslintrc.json

@@ -0,0 +1,8 @@
+{
+    "overrides": [{
+        "files": "*.md{js}",
+        "rules": {
+            "putout/add-newline-before-return": "off"
+        }
+    }]
+}

Diff for: packages/eslint-plugin-putout/lib/add-newline-before-return/README.md

@@ -0,0 +1,24 @@
+# add-newline-before-return
+
+This rule aims to add newline before `return`. Part of [`eslint-plugin-putout`](https://github.com/coderaiser/putout/tree/master/packages/eslint-plugin-putout#rules).
+
+## ❌ Example of incorrect code
+
+```js
+export function sum() {
+    const a = 1;
+    const b = 2;
+    return a + b;
+}
+```
+
+## ✅ Example of correct code
+
+```js
+export function parse() {
+    const a = 1;
+    const b = 2;
+    
+    return a + b;
+}
+```

Diff for: packages/eslint-plugin-putout/lib/add-newline-before-return/fixture/return-fix.js

@@ -0,0 +1,6 @@
+function sum() {
+    const a = 5;
+    const b = 6;
+    
+return a + b;
+}

Diff for: packages/eslint-plugin-putout/lib/add-newline-before-return/fixture/return.js

@@ -0,0 +1,5 @@
+function sum() {
+    const a = 5;
+    const b = 6;
+    return a + b;
+}

Diff for: packages/eslint-plugin-putout/lib/add-newline-before-return/index.js

@@ -0,0 +1,44 @@
+'use strict';
+
+const regExp = /^\n( +)?\n +$/;
+
+module.exports.report = () => `Add newline before 'return'`;
+
+module.exports.filter = ({text, node, getCommentsBefore, getSpacesBeforeNode}) => {
+    if (getCommentsBefore(node).length)
+        return false;
+    
+    const {parent} = node;
+    const {body} = parent;
+    
+    if (!body)
+        return false;
+    
+    const n = body.length;
+    
+    if (n < 3)
+        return false;
+    
+    const spaces = getSpacesBeforeNode(node, text);
+    
+    if (regExp.test(spaces))
+        return false;
+    
+    for (let i = 2; i < n; i++) {
+        const prevA = body[i - 1];
+        const spaces = getSpacesBeforeNode(prevA);
+        
+        if (regExp.test(spaces))
+            return false;
+    }
+    
+    return true;
+};
+
+module.exports.fix = ({text}) => {
+    return `\n${text}`;
+};
+
+module.exports.include = () => [
+    'ReturnStatement',
+];

Diff for: packages/eslint-plugin-putout/lib/add-newline-before-return/index.spec.js

@@ -0,0 +1,79 @@
+'use strict';
+
+const {join} = require('path');
+
+const {readFileSync} = require('fs');
+
+const {RuleTester} = require('eslint');
+const montag = require('montag');
+
+const wrap = require('../wrap');
+const rule = wrap(require('.'));
+
+const ruleTester = new RuleTester({
+    parserOptions: {
+        ecmaVersion: 2022,
+        sourceType: 'module',
+    },
+});
+
+const readFixture = (a) => readFileSync(join(__dirname, 'fixture', `${a}.js`), 'utf8');
+
+ruleTester.run('add-newline-before-return', rule, {
+    valid: [
+        montag`
+            test('hello: world', (t) => {
+                const a = 5;
+                return;
+            });
+        `,
+        montag`
+            test('hello: world', (t) => {
+                return;
+            });
+        `,
+        montag`
+            test('hello: world', (t) => {
+                const a = 5;
+                const b = 4;
+                
+                return a + b;
+            });
+        `, montag`
+            test('hello: world', (t) => {
+                const a = 5;
+                const b = 4;
+                // hello world
+                return a + b;
+            });
+        `, montag`
+            test('hello: world', (t) => {
+                const a = 5;
+                const x = 6;
+                
+                fn();
+                
+                const b = 4;
+                return a + b;
+            });
+        `, montag`
+            function x() {
+                const a = 5;
+                const b = 6;
+                
+                if (a)
+                    return;
+            }
+        `,
+    ],
+    
+    invalid: [{
+        code: readFixture('return'),
+        output: readFixture('return-fix'),
+        errors: [{
+            message: `Add newline before 'return'`,
+            type: 'ReturnStatement',
+        }],
+    }],
+});
+

Diff for: packages/eslint-plugin-putout/lib/index.js

@@ -28,6 +28,7 @@ module.exports.rules = {
     ...getWrapRule('function-declaration-paren-newline'),
     ...getWrapRule('add-newlines-between-types-in-union'),
     ...getWrapRule('add-newlines-between-specifiers'),
+    ...getWrapRule('add-newline-before-return'),
     ...getWrapRule('add-newline-before-function-call'),
     ...getWrapRule('add-newline-after-function-call'),
     ...getWrapRule('remove-newline-after-default-import'),
@@ -71,6 +72,7 @@ const recommended = {
         'putout/function-declaration-paren-newline': 'error',
         '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/remove-newline-after-default-import': 'error',

Diff for: packages/eslint-plugin-putout/test/eslint.mjs

@@ -179,3 +179,7 @@ test('eslint-plugin-putout: add-newlines-between-specifiers', async ({process})
 test('eslint-plugin-putout: object-property-newline', async ({process}) => {
     await process('object-property-newline');
 });
+
+test('eslint-plugin-putout: add-newline-before-return', async ({process}) => {
+    await process('add-newline-before-return');
+});

Diff for: packages/eslint-plugin-putout/test/fixture/add-newline-before-return-fix.js

@@ -0,0 +1,6 @@
+function sum() {
+    const a = 5;
+    const b = 6;
+    
+    return a + b;
+}

Diff for: packages/eslint-plugin-putout/test/fixture/add-newline-before-return.js

@@ -0,0 +1,5 @@
+function sum() {
+    const a = 5;
+    const b = 6;
+    return a + b;
+}

Diff for: packages/plugin-madrun/lib/set-lint-dot/index.js

@@ -23,6 +23,7 @@ module.exports.fix = ({lintPath}) => {
     if (isStringLiteral(node)) {
         node.value = dotLine;
         node.raw = dotLine;
+        
         return;
     }
 

Diff for: packages/plugin-putout/lib/convert-node-to-path-in-get-template-values/index.js

@@ -24,6 +24,7 @@ module.exports.fix = ({path, __aPath, init}) => {
     if (compare(path, GET_TEMPLATE_VALUES_NODE)) {
         const {__a} = getTemplateValues(path, GET_TEMPLATE_VALUES_NODE);
         replaceWith(__aPath, __a);
+        
         return;
     }
 

Diff for: packages/plugin-remove-useless-escape/lib/remove-useless-escape.js

@@ -16,6 +16,7 @@ module.exports.fix = (path) => {
     if (path.isStringLiteral()) {
         const {raw} = path.node;
         path.node.raw = unEscape(raw);
+        
         return;
     }
 

Diff for: packages/plugin-tape/lib/apply-with-name/index.js

@@ -26,12 +26,14 @@ function checkStubs({__a, __b}, path) {
     const __array = {
         elements,
     };
+    
     return checkStubsArray({__array}, path);
 }
 
 function applyWithName({__a, __b}, path) {
     applyWithNameToNode(__a, path);
     applyWithNameToNode(__b, path);
+    
     return path;
 }
 

Diff for: packages/plugin-typescript/lib/convert-generic-to-shorthand/index.js

@@ -15,6 +15,7 @@ module.exports.fix = ({path, typeReference}) => {
         const {types} = typeReference;
         typeReference.types = types.map(tSArrayType);
         replaceWith(path, typeReference);
+        
         return;
     }
 

Diff for: packages/plugin-typescript/lib/remove-useless-parens/index.js

@@ -16,6 +16,7 @@ module.exports.fix = ({path, parentPath, typeAnnotation}) => {
         const {types} = typeAnnotation;
         typeAnnotation.types = types.map(tSArrayType);
         replaceWith(parentPath, typeAnnotation);
+        
         return;
     }
 

Diff for: packages/processor-ignore/lib/ignore.js

@@ -36,6 +36,7 @@ export const merge = (rawSource, list) => {
 function convertToArray(str) {
     const safeStr = str.replace(/\r/g, '');
     const lines = rmLast(safeStr).split(/\n/g);
+    
     return stringify(lines);
 }
 

Diff for: packages/putout/lib/cli/index.js

@@ -168,6 +168,7 @@ module.exports = async ({argv, halt, log, write, logError, readFile, writeFile})
     if (args.help) {
         const help = require('./help');
         log(help());
+        
         return exit();
     }