eslint-plugin-crisp 1.7.10 → 1.7.12

package/README.md

@@ -227,9 +227,11 @@ Each item has emojis denoting:
 | [crisp/vue-computed-order](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/vue-computed-order.js) | Ensures computed properties are alphabetically ordered |  | 🟢 |
 | [crisp/vue-define-component](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/vue-define-component.js) | Enforces mixins and components to use the `defineComponent` wrapper |  | 🟢 |
 | [crisp/vue-emits-order](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/vue-emits-order.js) | Ensures emits properties are alphabetically ordered |  | 🟢 |
+| [crisp/vue-event-listener-jsdoc](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/vue-event-listener-jsdoc.js) | Requires event listener method JSDoc descriptions to start with `Triggers on` |  | 🟢 |
 | [crisp/vue-header-check](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/vue-header-check.js) | Ensures `script`, `template` and `style` tags start with corresponding comment block |  | 🟢 |
 | [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-methods-separator](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/vue-methods-separator.js) | Requires method section comments to be ordered as actions, helpers, then event listeners |  | 🟢 |
 | [crisp/vue-no-component-class-shorthand](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/vue-no-component-class-shorthand.js) | Disallows Pug class shorthand on Vue components |  | 🟢 |
 | [crisp/vue-no-mixed-class](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/vue-no-mixed-class.js) | Disallows using both `class` and `:class` on the same element |  | 🟢 |
 | [crisp/vue-no-name-option](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/vue-no-name-option.js) | Disallows explicit component names in Vue single-file components |  | 🟢 |

package/index.js

@@ -50,6 +50,7 @@ import ruleVueComputedOrder from "./rules/vue-computed-order.js";
 import ruleVueDataComment from "./rules/vue-data-comment.js";
 import ruleVueDefineComponent from "./rules/vue-define-component.js";
 import ruleVueEmitsOrder from "./rules/vue-emits-order.js";
+import ruleVueEventListenerJsdoc from "./rules/vue-event-listener-jsdoc.js";
 import ruleVueHeaderCheck from "./rules/vue-header-check.js";
 import ruleVueHtmlIndent from "./rules/vue-html-indent.js";
 import ruleVueHtmlQuotes from "./rules/vue-html-quotes.js";
@@ -129,6 +130,7 @@ const plugin = {
     "vue-data-comment": ruleVueDataComment,
     "vue-define-component": ruleVueDefineComponent,
     "vue-emits-order": ruleVueEmitsOrder,
+    "vue-event-listener-jsdoc": ruleVueEventListenerJsdoc,
     "vue-header-check": ruleVueHeaderCheck,
     "vue-html-indent": ruleVueHtmlIndent,
     "vue-html-quotes": ruleVueHtmlQuotes,

package/package.json

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

package/recommended-vue.js

@@ -385,6 +385,7 @@ export default function configRecommendedVue(pluginCrisp) {
         "crisp/vue-data-comment": "error",
         "crisp/vue-define-component": "error",
         "crisp/vue-emits-order": "error",
+        "crisp/vue-event-listener-jsdoc": "error",
         "crisp/vue-header-check": "error",
         "crisp/vue-html-indent": "error",
         "crisp/vue-html-quotes": "error",

package/rules/vue-event-listener-jsdoc.js

@@ -0,0 +1,87 @@
+import doctrine from "doctrine";
+
+const EVENT_LISTENERS_SEPARATOR = "--> EVENT LISTENERS <--";
+const DESCRIPTION_PREFIX = "Triggers on ";
+
+export default {
+  meta: {
+    type: "suggestion",
+    docs: {
+      description:
+        "require event listener method descriptions to start with 'Triggers on'",
+      category: "Stylistic Issues",
+      recommended: false
+    },
+    fixable: null,
+    schema: [],
+    messages: {
+      invalidDescription:
+        "Event listener method JSDoc description must start with " +
+        "'Triggers on ...'.",
+      missingJsdoc: "Event listener methods must have a JSDoc comment."
+    }
+  },
+
+  create(context) {
+    const sourceCode = context.sourceCode;
+
+    function checkMethods(node) {
+      const properties = node.value.properties;
+
+      if (!properties) {
+        return;
+      }
+
+      let eventListenersStarted = false;
+
+      properties.forEach((property) => {
+        const comments = sourceCode.getCommentsBefore(property);
+
+        if (!eventListenersStarted) {
+          eventListenersStarted = comments.some((comment) => {
+            return (
+              comment.type === "Line" &&
+              comment.value.trim() === EVENT_LISTENERS_SEPARATOR
+            );
+          });
+        }
+
+        if (!eventListenersStarted || property.type !== "Property") {
+          return;
+        }
+
+        const jsdoc = [...comments].reverse().find((comment) => {
+          return comment.type === "Block" && comment.value.startsWith("*");
+        });
+
+        if (!jsdoc) {
+          context.report({
+            node: property,
+            messageId: "missingJsdoc"
+          });
+
+          return;
+        }
+
+        const description = doctrine.parse(
+          `/*${jsdoc.value}*/`,
+          { unwrap: true }
+        ).description.trim();
+
+        if (!description.startsWith(DESCRIPTION_PREFIX)) {
+          context.report({
+            node: jsdoc,
+            messageId: "invalidDescription"
+          });
+        }
+      });
+    }
+
+    return {
+      'ExportDefaultDeclaration > ObjectExpression > Property[key.name="methods"]':
+        checkMethods,
+      'ExportDefaultDeclaration > CallExpression[callee.name="defineComponent"] > ObjectExpression > Property[key.name="methods"]':
+        checkMethods
+    };
+  }
+};

package/rules/vue-methods-separator.js

@@ -1,65 +1,121 @@
+const SEPARATORS = [
+  "--> ACTIONS <--",
+  "--> HELPERS <--",
+  "--> EVENT LISTENERS <--"
+];
+
+const SEPARATOR_ORDER = new Map(
+  SEPARATORS.map((separator, index) => [separator, index])
+);
+const SEPARATOR_LIKE_PATTERN = /^--> .+ <--$/;
+
 export default {
   meta: {
     type: "suggestion",
     docs: {
-      description: "enforce at least one separator comment in Vue methods block",
+      description:
+        "enforce separator comments and their order in Vue methods block",
       category: "Stylistic Issues",
       recommended: false
     },
     fixable: null,
-    schema: []
+    schema: [],
+    messages: {
+      duplicateSeparator:
+        "Duplicate methods separator comment '// {{separator}}'.",
+      invalidSeparator:
+        "Invalid separator comment. Must be '// --> ACTIONS <--', " +
+        "'// --> HELPERS <--', or '// --> EVENT LISTENERS <--'.",
+      missingSeparator:
+        "Methods block must contain at least one separator comment: " +
+        "'// --> ACTIONS <--', '// --> HELPERS <--', " +
+        "or '// --> EVENT LISTENERS <--'.",
+      unorderedSeparator:
+        "Methods separator comments must be ordered: '// --> ACTIONS <--', " +
+        "then '// --> HELPERS <--', then '// --> EVENT LISTENERS <--'."
+    }
   },
 
   create(context) {
-    const SEPARATOR_PATTERN = /^--> (ACTIONS|HELPERS|EVENT LISTENERS) <--$/;
-    const SEPARATOR_LIKE_PATTERN = /^--> .+ <--$/;
+    const sourceCode = context.sourceCode;
 
-    return {
-      'ExportDefaultDeclaration Property[key.name="methods"]'(node) {
-        const properties = node.value.properties;
+    function checkMethods(node) {
+      const properties = node.value.properties;
+
+      if (!properties || properties.length === 0) {
+        return;
+      }
+
+      const comments = sourceCode.getCommentsInside(node.value).filter(
+        (comment) => {
+          return !properties.some((property) => {
+            return (
+              comment.range[0] >= property.range[0] &&
+              comment.range[1] <= property.range[1]
+            );
+          });
+        }
+      );
+      const seenSeparators = new Set();
+      let lastSeparatorOrder = -1;
+      let separatorCount = 0;
 
-        if (!properties || properties.length === 0) {
+      comments.forEach((comment) => {
+        if (comment.type !== "Line") {
           return;
         }
 
-        const sourceCode = context.sourceCode;
-        const comments = sourceCode.getCommentsInside(node);
+        const separator = comment.value.trim();
+        const separatorOrder = SEPARATOR_ORDER.get(separator);
 
-        const hasSeparator = comments.some((comment) => {
-          return (
-            comment.type === "Line" &&
-            SEPARATOR_PATTERN.test(comment.value.trim())
-          );
-        });
+        if (separatorOrder === undefined) {
+          if (SEPARATOR_LIKE_PATTERN.test(separator)) {
+            context.report({
+              node: comment,
+              messageId: "invalidSeparator"
+            });
+          }
+
+          return;
+        }
+
+        separatorCount++;
 
-        if (!hasSeparator) {
+        if (seenSeparators.has(separator)) {
           context.report({
-            node,
-            message:
-              "Methods block must contain at least one separator comment: " +
-              "'// --> ACTIONS <--', '// --> HELPERS <--', " +
-              "or '// --> EVENT LISTENERS <--'."
+            node: comment,
+            messageId: "duplicateSeparator",
+            data: { separator }
           });
+
+          return;
         }
 
-        comments.forEach((comment) => {
-          if (comment.type === "Line") {
-            const trimmed = comment.value.trim();
-
-            if (
-              SEPARATOR_LIKE_PATTERN.test(trimmed) &&
-              !SEPARATOR_PATTERN.test(trimmed)
-            ) {
-              context.report({
-                node: comment,
-                message:
-                  "Invalid separator comment. Must be '// --> ACTIONS <--', " +
-                  "'// --> HELPERS <--', or '// --> EVENT LISTENERS <--'."
-              });
-            }
-          }
+        seenSeparators.add(separator);
+
+        if (separatorOrder < lastSeparatorOrder) {
+          context.report({
+            node: comment,
+            messageId: "unorderedSeparator"
+          });
+        } else {
+          lastSeparatorOrder = separatorOrder;
+        }
+      });
+
+      if (separatorCount === 0) {
+        context.report({
+          node,
+          messageId: "missingSeparator"
         });
       }
+    }
+
+    return {
+      'ExportDefaultDeclaration > ObjectExpression > Property[key.name="methods"]':
+        checkMethods,
+      'ExportDefaultDeclaration > CallExpression[callee.name="defineComponent"] > ObjectExpression > Property[key.name="methods"]':
+        checkMethods
     };
   }
 };

package/tests/rules/vue-event-listener-jsdoc.test.js

@@ -0,0 +1,174 @@
+import rule from "../../rules/vue-event-listener-jsdoc.js";
+import { createVueRuleTester } from "../rule-tester.js";
+
+const ruleTester = createVueRuleTester();
+
+ruleTester.run("vue-event-listener-jsdoc", rule, {
+  valid: [
+    {
+      code: "export default { methods: {} };"
+    },
+    {
+      code: `
+        export default {
+          methods: {
+            // --> HELPERS <--
+            /**
+             * Handles formatting
+             */
+            format() {}
+          }
+        };
+      `
+    },
+    {
+      code: `
+        export default {
+          methods: {
+            // --> EVENT LISTENERS <--
+            /**
+             * Triggers on load more
+             * @public
+             * @param {object} $state
+             */
+            onLoadMore($state) {}
+          }
+        };
+      `
+    },
+    {
+      code: `
+        export default defineComponent({
+          methods: {
+            // --> ACTIONS <--
+            /**
+             * Saves content
+             */
+            save() {},
+            // --> HELPERS <--
+            /**
+             * Formats content
+             */
+            format() {},
+            // --> EVENT LISTENERS <--
+            /**
+             * Triggers on save
+             */
+            onSave() {},
+            /**
+             * Triggers on close
+             */
+            onClose: function() {}
+          }
+        });
+      `
+    },
+    {
+      filename: "Component.vue",
+      code: `
+        <script>
+        export default defineComponent({
+          methods: {
+            // --> EVENT LISTENERS <--
+            /**
+             * Triggers on load more
+             * @public
+             */
+            onLoadMore() {
+              this.loadMore(() => {
+                /**
+                 * Handles a nested callback
+                 */
+                return true;
+              });
+            }
+          }
+        });
+        </script>
+      `
+    }
+  ],
+
+  invalid: [
+    {
+      code: `
+        export default {
+          methods: {
+            // --> EVENT LISTENERS <--
+            /**
+             * Handles load more
+             * @public
+             */
+            onLoadMore() {}
+          }
+        };
+      `,
+      errors: [
+        {
+          messageId: "invalidDescription"
+        }
+      ]
+    },
+    {
+      code: `
+        export default {
+          methods: {
+            // --> EVENT LISTENERS <--
+            onLoadMore() {}
+          }
+        };
+      `,
+      errors: [
+        {
+          messageId: "missingJsdoc"
+        }
+      ]
+    },
+    {
+      code: `
+        export default {
+          methods: {
+            // --> EVENT LISTENERS <--
+            /**
+             * Triggers on
+             * @public
+             */
+            onLoadMore() {}
+          }
+        };
+      `,
+      errors: [
+        {
+          messageId: "invalidDescription"
+        }
+      ]
+    },
+    {
+      filename: "Component.vue",
+      code: `
+        <script>
+        export default defineComponent({
+          methods: {
+            // --> EVENT LISTENERS <--
+            /**
+             * Triggers when content is saved
+             * @public
+             */
+            onSave() {},
+            /**
+             * Triggers on close
+             * @public
+             */
+            onClose() {}
+          }
+        });
+        </script>
+      `,
+      errors: [
+        {
+          messageId: "invalidDescription"
+        }
+      ]
+    }
+  ]
+});

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

@@ -1,7 +1,7 @@
 import rule from "../../rules/vue-methods-separator.js";
-import createRuleTester from "../rule-tester.js";
+import { createVueRuleTester } from "../rule-tester.js";
 
-const ruleTester = createRuleTester();
+const ruleTester = createVueRuleTester();
 
 ruleTester.run("vue-methods-separator", rule, {
   valid: [
@@ -17,6 +17,98 @@ ruleTester.run("vue-methods-separator", rule, {
           }
         };
       `
+    },
+    {
+      code: `
+        export default {
+          methods: {
+            // --> HELPERS <--
+            format() {}
+          }
+        };
+      `
+    },
+    {
+      code: `
+        export default {
+          methods: {
+            // --> EVENT LISTENERS <--
+            onSave() {}
+          }
+        };
+      `
+    },
+    {
+      code: `
+        export default {
+          methods: {
+            // --> ACTIONS <--
+            save() {},
+            // --> EVENT LISTENERS <--
+            onSave() {}
+          }
+        };
+      `
+    },
+    {
+      code: `
+        export default defineComponent({
+          methods: {
+            // --> ACTIONS <--
+            save() {},
+            // --> HELPERS <--
+            format() {},
+            // --> EVENT LISTENERS <--
+            onSave() {}
+          }
+        });
+      `
+    },
+    {
+      code: `
+        export default {
+          options: {
+            methods: {
+              save() {}
+            }
+          }
+        };
+      `
+    },
+    {
+      code: `
+        export default {
+          methods: {
+            // --> ACTIONS <--
+            save() {
+              // --> EVENT LISTENERS <--
+              const status = "saved";
+
+              return status;
+            },
+            // --> HELPERS <--
+            format() {}
+          }
+        };
+      `
+    },
+    {
+      filename: "Component.vue",
+      code: `
+        <template><div /></template>
+        <script>
+        export default defineComponent({
+          methods: {
+            // --> ACTIONS <--
+            save() {},
+            // --> HELPERS <--
+            format() {},
+            // --> EVENT LISTENERS <--
+            onSave() {}
+          }
+        });
+        </script>
+      `
     }
   ],
 
@@ -25,10 +117,7 @@ ruleTester.run("vue-methods-separator", rule, {
       code: "export default { methods: { save() {} } };",
       errors: [
         {
-          message:
-            "Methods block must contain at least one separator comment: " +
-            "'// --> ACTIONS <--', '// --> HELPERS <--', " +
-            "or '// --> EVENT LISTENERS <--'."
+          messageId: "missingSeparator"
         }
       ]
     },
@@ -45,9 +134,95 @@ ruleTester.run("vue-methods-separator", rule, {
       `,
       errors: [
         {
-          message:
-            "Invalid separator comment. Must be '// --> ACTIONS <--', " +
-            "'// --> HELPERS <--', or '// --> EVENT LISTENERS <--'."
+          messageId: "invalidSeparator"
+        }
+      ]
+    },
+    {
+      code: `
+        export default {
+          methods: {
+            // --> HELPERS <--
+            format() {},
+            // --> ACTIONS <--
+            save() {}
+          }
+        };
+      `,
+      errors: [
+        {
+          messageId: "unorderedSeparator"
+        }
+      ]
+    },
+    {
+      code: `
+        export default {
+          methods: {
+            // --> ACTIONS <--
+            save() {},
+            // --> ACTIONS <--
+            publish() {}
+          }
+        };
+      `,
+      errors: [
+        {
+          messageId: "duplicateSeparator",
+          data: { separator: "--> ACTIONS <--" }
+        }
+      ]
+    },
+    {
+      code: `
+        export default defineComponent({
+          methods: {
+            // --> EVENT LISTENERS <--
+            onSave() {},
+            // --> HELPERS <--
+            format() {}
+          }
+        });
+      `,
+      errors: [
+        {
+          messageId: "unorderedSeparator"
+        }
+      ]
+    },
+    {
+      code: `
+        export default {
+          methods: {
+            save() {
+              // --> ACTIONS <--
+            }
+          }
+        };
+      `,
+      errors: [
+        {
+          messageId: "missingSeparator"
+        }
+      ]
+    },
+    {
+      filename: "Component.vue",
+      code: `
+        <script>
+        export default defineComponent({
+          methods: {
+            // --> EVENT LISTENERS <--
+            onSave() {},
+            // --> ACTIONS <--
+            save() {}
+          }
+        });
+        </script>
+      `,
+      errors: [
+        {
+          messageId: "unorderedSeparator"
         }
       ]
     }