eslint-plugin-crisp 1.0.93 → 1.0.95

package/README.md

@@ -200,6 +200,7 @@ Each item has emojis denoting:
 | [crisp/vue-html-indent](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/vue-html-indent.js) | Enforces consistent indentation in `template` (supports for Pug) |  | 🟢 |
 | [crisp/vue-html-quotes](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/vue-html-quotes.js) | Enforces HTML attributes to be enclosed with double quotes |  | 🟢 |
 | [crisp/vue-no-regex-data](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/vue-no-regex-data.js) | Disallows regular expressions to be declared in Vue data object |  | 🟢 |
+| [crisp/vue-props-declaration-line-break](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/vue-props-declaration-line-break.js) | Enforces line break between type and default function in prop definition |  | 🟢 |
 | [crisp/vue-props-declaration-multiline](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/vue-props-declaration-multiline.js) | Enforces props declarations to be multiline |  | 🟢 |
 | [crisp/vue-props-declaration-order](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/vue-props-declaration-order.js) | Ensures props declarations are alphabetically ordered |  | 🟢 |
 | [crisp/vue-ref-case](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/vue-ref-case.js) | Enforces `ref` attributes to snake case |  | 🟢 |

package/index.js

@@ -26,6 +26,7 @@ module.exports = {
     "multiline-comment-end-backslash": require("./rules/multiline-comment-end-backslash"),
     "newline-after-switch-case": require("./rules/newline-after-switch-case"),
     "no-async": require("./rules/no-async"),
+    "no-extra-line-within-function": require("./rules/no-extra-line-within-function"),
     "no-var-in-blocks": require("./rules/no-var-in-blocks"),
     "no-space-in-optional-arguments": require("./rules/no-space-in-optional-arguments"),
     "no-useless-template-literals": require("./rules/no-useless-template-literals"),
@@ -43,6 +44,7 @@ module.exports = {
     "vue-html-indent": require("./rules/vue-html-indent"),
     "vue-html-quotes": require("./rules/vue-html-quotes"),
     "vue-no-regex-data": require("./rules/vue-no-regex-data"),
+    "vue-props-declaration-line-break": require("./rules/vue-props-declaration-line-break"),
     "vue-props-declaration-multiline": require("./rules/vue-props-declaration-multiline"),
     "vue-props-declaration-order": require("./rules/vue-props-declaration-order"),
     "vue-ref-case": require("./rules/vue-ref-case")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-crisp",
-  "version": "1.0.93",
+  "version": "1.0.95",
   "description": "Custom ESLint Rules for Crisp",
   "author": "Crisp IM SAS",
   "main": "index.js",

package/recommended-vue.js

@@ -152,6 +152,7 @@ module.exports = {
     "crisp/multiline-comment-end-backslash": "error",
     "crisp/newline-after-switch-case": "error",
     "crisp/no-async": "error",
+    "crisp/no-extra-line-within-function": "error",
     "crisp/no-short-parameters": [
       "error",
 
@@ -352,6 +353,7 @@ module.exports = {
     "crisp/vue-html-indent": "error",
     "crisp/vue-html-quotes": "error",
     "crisp/vue-no-regex-data": "error",
+    "crisp/vue-props-declaration-line-break": "error",
     "crisp/vue-props-declaration-multiline": "error",
     "crisp/vue-props-declaration-order": "error",
     "crisp/vue-ref-case": "error"

package/recommended.js

@@ -152,6 +152,7 @@ module.exports = {
     "crisp/multiline-comment-end-backslash": "error",
     "crisp/newline-after-switch-case": "error",
     "crisp/no-async": "error",
+    "crisp/no-extra-line-within-function": "error",
     "crisp/no-var-in-blocks": "error",
     "crisp/no-short-parameters": [
       "error",

package/rules/no-extra-line-within-function.js

@@ -0,0 +1,61 @@
+module.exports = {
+  meta: {
+    type: "layout",
+    docs: {
+      description: "enforce maximum one line break between declarations within functions",
+      category: "Stylistic Issues",
+      recommended: false,
+    },
+    fixable: "whitespace",
+  },
+  create(context) {
+    const sourceCode = context.getSourceCode();
+
+    function checkFunctionBody(node) {
+      const bodyNode = node.body;
+      if (bodyNode.type !== 'BlockStatement') return;
+
+      const lines = sourceCode.lines;
+
+      for (let i = 1; i < bodyNode.body.length; i++) {
+        const currentNode = bodyNode.body[i];
+        const previousNode = bodyNode.body[i - 1];
+        const lineOfCurrentNode = currentNode.loc.start.line;
+        const lineOfPreviousNodeEnd = previousNode.loc.end.line;
+
+        // Count the empty lines between the end of the previous node and the start of the current one
+        let emptyLineCount = 0;
+        for (let j = lineOfPreviousNodeEnd; j < lineOfCurrentNode - 1; j++) {
+          if (lines[j].trim() === '') {
+            emptyLineCount++;
+          }
+        }
+
+        // Report an error if there are more than one empty line
+        if (emptyLineCount > 1) {
+          context.report({
+            node: currentNode,
+            message: "Expected at most one line break between declarations within a function.",
+            fix(fixer) {
+              const range = [
+                sourceCode.getIndexFromLoc({ line: lineOfPreviousNodeEnd, column: 0 }),
+                sourceCode.getIndexFromLoc({ line: lineOfCurrentNode, column: 0 })
+              ];
+              return fixer.replaceTextRange(range, '\n\n');
+            }
+          });
+        }
+      }
+    }
+
+    return {
+      FunctionDeclaration: checkFunctionBody,
+      FunctionExpression: checkFunctionBody,
+      ArrowFunctionExpression(node) {
+        if (node.body.type === 'BlockStatement') {
+          checkFunctionBody(node);
+        }
+      },
+    };
+  },
+};

package/rules/vue-props-declaration-line-break.js

@@ -0,0 +1,50 @@
+module.exports = {
+  meta: {
+    type: "layout",
+    docs: {
+      description: "Enforce line break between type and default function in Vue props",
+      category: "Stylistic Issues",
+      recommended: false,
+    },
+    fixable: "whitespace",
+    schema: [], // no options
+  },
+
+  create(context) {
+    const sourceCode = context.getSourceCode();
+
+    function checkPropDefinition(propNode) {
+      const typeProperty = propNode.properties.find(p => p.key.name === "type");
+      const defaultProperty = propNode.properties.find(p => p.key.name === "default");
+
+      if (typeProperty && defaultProperty && defaultProperty.value.type === "FunctionExpression") {
+        const typeLine = sourceCode.getLastToken(typeProperty).loc.end.line;
+        const defaultLine = sourceCode.getFirstToken(defaultProperty).loc.start.line;
+
+        if (defaultLine - typeLine < 2) {
+          context.report({
+            node: defaultProperty,
+            message: "There should be a line break between 'type' and 'default' function in prop definition.",
+            fix(fixer) {
+              const typeToken = sourceCode.getLastToken(typeProperty);
+              const defaultToken = sourceCode.getFirstToken(defaultProperty);
+              const textBetween = sourceCode.text.slice(typeToken.range[1], defaultToken.range[0]);
+              const newTextBetween = textBetween.replace(/,?\s*/, ",\n\n");
+              return fixer.replaceTextRange([typeToken.range[1], defaultToken.range[0]], newTextBetween);
+            }
+          });
+        }
+      }
+    }
+
+    return {
+      'ExportDefaultDeclaration Property[key.name="props"] ObjectExpression'(node) {
+        node.properties.forEach(prop => {
+          if (prop.value.type === "ObjectExpression") {
+            checkPropDefinition(prop.value);
+          }
+        });
+      }
+    };
+  }
+};