eslint-plugin-crisp 1.7.15 → 1.7.16

package/package.json

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

package/rules/vue-methods-separator.js

@@ -30,6 +30,8 @@ export default {
         "Methods block must contain at least one separator comment: " +
         "'// --> ACTIONS <--', '// --> HELPERS <--', " +
         "or '// --> EVENT LISTENERS <--'.",
+      missingSeparatorSpacing:
+        "Methods separator comments must be followed by a blank line.",
       unorderedSeparator:
         "Methods separator comments must be ordered: '// --> ACTIONS <--', " +
         "then '// --> HELPERS <--', then '// --> EVENT LISTENERS <--'."
@@ -147,6 +149,75 @@ export default {
       };
     }
 
+    function checkSeparatorSpacing(comment, comments, properties) {
+      const nextSeparator = comments.find((candidate) => {
+        return (
+          candidate.range[0] > comment.range[1] &&
+          candidate.type === "Line" &&
+          SEPARATOR_LIKE_PATTERN.test(candidate.value.trim())
+        );
+      });
+      const firstProperty = properties.find((property) => {
+        return (
+          property.range[0] > comment.range[1] &&
+          (!nextSeparator || property.range[0] < nextSeparator.range[0])
+        );
+      });
+
+      if (!firstProperty) {
+        return;
+      }
+
+      const firstLeadingComment = sourceCode
+        .getCommentsBefore(firstProperty)
+        .find((candidate) => {
+          return (
+            candidate.range[0] > comment.range[1] &&
+            (!nextSeparator || candidate.range[0] < nextSeparator.range[0])
+          );
+        });
+      const firstNode = firstLeadingComment || firstProperty;
+
+      if (firstNode.loc.start.line > comment.loc.end.line + 1) {
+        return;
+      }
+
+      const spacingFix = (fixer) => {
+        const lineStart = sourceCode.getIndexFromLoc({
+          line: firstNode.loc.start.line,
+          column: 0
+        });
+        const indentation = sourceCode.text.slice(
+          lineStart,
+          firstNode.range[0]
+        );
+        const currentSpacing = sourceCode.text.slice(
+          comment.range[1],
+          firstNode.range[0]
+        );
+
+        if (
+          indentation.trim() !== "" ||
+          currentSpacing.trim() !== ""
+        ) {
+          return null;
+        }
+
+        const linebreak = currentSpacing.includes("\r\n") ? "\r\n" : "\n";
+
+        return fixer.replaceTextRange(
+          [comment.range[1], firstNode.range[0]],
+          `${linebreak}${linebreak}${indentation}`
+        );
+      };
+
+      context.report({
+        node: comment,
+        messageId: "missingSeparatorSpacing",
+        fix: spacingFix
+      });
+    }
+
     function checkMethods(node) {
       const properties = node.value.properties;
 
@@ -171,11 +242,21 @@ export default {
       let hasInvalidSeparator = false;
 
       comments.forEach((comment) => {
+        const separator = comment.value.trim();
+
         if (comment.type !== "Line") {
+          if (SEPARATOR_LIKE_PATTERN.test(separator)) {
+            hasInvalidSeparator = true;
+
+            context.report({
+              node: comment,
+              messageId: "invalidSeparator"
+            });
+          }
+
           return;
         }
 
-        const separator = comment.value.trim();
         const separatorOrder = SEPARATOR_ORDER.get(separator);
 
         if (separatorOrder === undefined) {
@@ -212,6 +293,17 @@ export default {
         });
       });
 
+      comments
+        .filter((comment) => {
+          return (
+            comment.type === "Line" &&
+            SEPARATOR_ORDER.has(comment.value.trim())
+          );
+        })
+        .forEach((comment) => {
+          checkSeparatorSpacing(comment, comments, properties);
+        });
+
       let lastSeparatorOrder = -1;
       const unorderedEntries = separatorEntries.filter((entry) => {
         if (entry.order < lastSeparatorOrder) {

package/tests/rules/vue-methods-separator.test.js

@@ -13,6 +13,7 @@ ruleTester.run("vue-methods-separator", rule, {
         export default {
           methods: {
             // --> ACTIONS <--
+
             save() {}
           }
         };
@@ -23,6 +24,7 @@ ruleTester.run("vue-methods-separator", rule, {
         export default {
           methods: {
             // --> HELPERS <--
+
             format() {}
           }
         };
@@ -33,6 +35,7 @@ ruleTester.run("vue-methods-separator", rule, {
         export default {
           methods: {
             // --> EVENT LISTENERS <--
+
             onSave() {}
           }
         };
@@ -43,8 +46,10 @@ ruleTester.run("vue-methods-separator", rule, {
         export default {
           methods: {
             // --> ACTIONS <--
+
             save() {},
             // --> EVENT LISTENERS <--
+
             onSave() {}
           }
         };
@@ -55,10 +60,13 @@ ruleTester.run("vue-methods-separator", rule, {
         export default defineComponent({
           methods: {
             // --> ACTIONS <--
+
             save() {},
             // --> HELPERS <--
+
             format() {},
             // --> EVENT LISTENERS <--
+
             onSave() {}
           }
         });
@@ -80,6 +88,7 @@ ruleTester.run("vue-methods-separator", rule, {
         export default {
           methods: {
             // --> ACTIONS <--
+
             save() {
               // --> EVENT LISTENERS <--
               const status = "saved";
@@ -87,6 +96,7 @@ ruleTester.run("vue-methods-separator", rule, {
               return status;
             },
             // --> HELPERS <--
+
             format() {}
           }
         };
@@ -100,10 +110,13 @@ ruleTester.run("vue-methods-separator", rule, {
         export default defineComponent({
           methods: {
             // --> ACTIONS <--
+
             save() {},
             // --> HELPERS <--
+
             format() {},
             // --> EVENT LISTENERS <--
+
             onSave() {}
           }
         });
@@ -121,11 +134,42 @@ ruleTester.run("vue-methods-separator", rule, {
         }
       ]
     },
+    {
+      code: `
+        export default {
+          methods: {
+            // --> ACTIONS <--
+            /**
+             * Saves content
+             */
+            save() {}
+          }
+        };
+      `,
+      output: `
+        export default {
+          methods: {
+            // --> ACTIONS <--
+
+            /**
+             * Saves content
+             */
+            save() {}
+          }
+        };
+      `,
+      errors: [
+        {
+          messageId: "missingSeparatorSpacing"
+        }
+      ]
+    },
     {
       code: `
         export default {
           methods: {
             // --> HELPERS <--
+
             help() {},
             // --> OTHER <--
             run() {}
@@ -138,13 +182,33 @@ ruleTester.run("vue-methods-separator", rule, {
         }
       ]
     },
+    {
+      code: `
+        export default {
+          methods: {
+            // --> ACTIONS <--
+
+            save() {},
+            /* --> OTHER <-- */
+            run() {}
+          }
+        };
+      `,
+      errors: [
+        {
+          messageId: "invalidSeparator"
+        }
+      ]
+    },
     {
       code: `
         export default {
           methods: {
             // --> HELPERS <--
+
             format() {},
             // --> ACTIONS <--
+
             save() {}
           }
         };
@@ -153,8 +217,10 @@ ruleTester.run("vue-methods-separator", rule, {
         export default {
           methods: {
             // --> ACTIONS <--
+
             save() {},
             // --> HELPERS <--
+
             format() {}
           }
         };
@@ -242,8 +308,10 @@ ruleTester.run("vue-methods-separator", rule, {
         export default {
           methods: {
             // --> ACTIONS <--
+
             save() {},
             // --> ACTIONS <--
+
             publish() {}
           }
         };
@@ -260,8 +328,10 @@ ruleTester.run("vue-methods-separator", rule, {
         export default defineComponent({
           methods: {
             // --> EVENT LISTENERS <--
+
             onSave() {},
             // --> HELPERS <--
+
             format() {}
           }
         });
@@ -270,8 +340,10 @@ ruleTester.run("vue-methods-separator", rule, {
         export default defineComponent({
           methods: {
             // --> HELPERS <--
+
             format() {},
             // --> EVENT LISTENERS <--
+
             onSave() {}
           }
         });
@@ -305,8 +377,10 @@ ruleTester.run("vue-methods-separator", rule, {
         export default defineComponent({
           methods: {
             // --> EVENT LISTENERS <--
+
             onSave() {},
             // --> ACTIONS <--
+
             save() {}
           }
         });
@@ -317,8 +391,10 @@ ruleTester.run("vue-methods-separator", rule, {
         export default defineComponent({
           methods: {
             // --> ACTIONS <--
+
             save() {},
             // --> EVENT LISTENERS <--
+
             onSave() {}
           }
         });