eslint-plugin-putout 15.6.0 → 15.7.0

package/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)

package/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',
 ];

package/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;
+}
+```

package/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',
+];

package/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',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-putout",
-  "version": "15.6.0",
+  "version": "15.7.0",
   "type": "commonjs",
   "description": "ESLint plugin for 🐊Putout",
   "release": false,