eslint-plugin-crisp 1.7.13 → 1.7.15

package/README.md

@@ -228,6 +228,7 @@ Each item has emojis denoting:
 | [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-event-listener-section](https://github.com/crisp-oss/eslint-plugin-crisp/blob/master/rules/vue-event-listener-section.js) | Requires methods named `on` followed by an uppercase letter to be in the event listeners section |  | 🟢 |
 | [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 |  | 🟢 |

package/index.js

@@ -51,6 +51,7 @@ 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 ruleVueEventListenerSection from "./rules/vue-event-listener-section.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";
@@ -131,6 +132,7 @@ const plugin = {
     "vue-define-component": ruleVueDefineComponent,
     "vue-emits-order": ruleVueEmitsOrder,
     "vue-event-listener-jsdoc": ruleVueEventListenerJsdoc,
+    "vue-event-listener-section": ruleVueEventListenerSection,
     "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.13",
+  "version": "1.7.15",
   "description": "Custom ESLint Rules for Crisp",
   "author": "Crisp IM SAS",
   "main": "index.js",

package/recommended-vue.js

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

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

@@ -0,0 +1,290 @@
+const EVENT_LISTENERS_SEPARATOR = "--> EVENT LISTENERS <--";
+const EVENT_LISTENER_NAME_PATTERN = /^on[A-Z]/;
+const SEPARATOR_LIKE_PATTERN = /^--> .+ <--$/;
+
+export default {
+  meta: {
+    type: "suggestion",
+    docs: {
+      description:
+        "require on-prefixed Vue methods to be in the event listeners section",
+      category: "Stylistic Issues",
+      recommended: false
+    },
+    fixable: "code",
+    schema: [],
+    messages: {
+      wrongSection:
+        "Method '{{name}}' must be declared in the EVENT LISTENERS section."
+    }
+  },
+
+  create(context) {
+    const sourceCode = context.sourceCode;
+
+    function getLineStart(node) {
+      return sourceCode.getIndexFromLoc({
+        line: node.loc.start.line,
+        column: 0
+      });
+    }
+
+    function getPropertyName(property) {
+      if (property.type !== "Property" || property.computed) {
+        return null;
+      }
+
+      if (property.key.type === "Identifier") {
+        return property.key.name;
+      }
+
+      if (
+        property.key.type === "Literal" &&
+        typeof property.key.value === "string"
+      ) {
+        return property.key.value;
+      }
+
+      return null;
+    }
+
+    function getTopLevelComments(node, properties) {
+      return sourceCode.getCommentsInside(node.value).filter((comment) => {
+        return !properties.some((property) => {
+          return (
+            comment.range[0] >= property.range[0] &&
+            comment.range[1] <= property.range[1]
+          );
+        });
+      });
+    }
+
+    function getMethodBlock(node, property) {
+      const comments = sourceCode.getCommentsBefore(property);
+      const lastSeparatorIndex = comments.findLastIndex((comment) => {
+        return (
+          comment.type === "Line" &&
+          SEPARATOR_LIKE_PATTERN.test(comment.value.trim())
+        );
+      });
+      const ownedComments = comments.slice(lastSeparatorIndex + 1);
+      const firstNode = ownedComments[0] || property;
+      const start = getLineStart(firstNode);
+      const linePrefix = sourceCode.text.slice(start, firstNode.range[0]);
+
+      if (linePrefix.trim() !== "") {
+        return null;
+      }
+
+      const tokenAfter = sourceCode.getTokenAfter(property);
+      const comma = (
+        tokenAfter?.value === "," &&
+        tokenAfter.range[0] < node.value.range[1]
+      )
+        ? tokenAfter
+        : null;
+      const propertyEnd = comma?.range[1] || property.range[1];
+      const remainingText = sourceCode.text.slice(
+        propertyEnd,
+        node.value.range[1] - 1
+      );
+      const nextContentMatch = remainingText.match(/\S/);
+      let removalEnd = propertyEnd;
+
+      if (nextContentMatch) {
+        const nextContent = propertyEnd + nextContentMatch.index;
+        const nextContentLocation = sourceCode.getLocFromIndex(nextContent);
+
+        if (nextContentLocation.line > property.loc.end.line) {
+          removalEnd = sourceCode.getIndexFromLoc({
+            line: nextContentLocation.line,
+            column: 0
+          });
+        }
+      }
+
+      return {
+        start,
+        end: removalEnd,
+        text: sourceCode.text.slice(start, property.range[1]).trimEnd()
+      };
+    }
+
+    function createMoveFix(node, properties, violations) {
+      const topLevelComments = getTopLevelComments(node, properties);
+      const eventSeparators = topLevelComments.filter((comment) => {
+        return (
+          comment.type === "Line" &&
+          comment.value.trim() === EVENT_LISTENERS_SEPARATOR
+        );
+      });
+
+      if (eventSeparators.length > 1) {
+        return null;
+      }
+
+      const eventSeparator = eventSeparators[0] || null;
+      const hasSectionAfterEvent = eventSeparator && topLevelComments.some(
+        (comment) => {
+          return (
+            comment.range[0] > eventSeparator.range[1] &&
+            comment.type === "Line" &&
+            SEPARATOR_LIKE_PATTERN.test(comment.value.trim())
+          );
+        }
+      );
+
+      if (hasSectionAfterEvent) {
+        return null;
+      }
+
+      const lastProperty = properties.at(-1);
+      const trailingComments = topLevelComments.filter((comment) => {
+        return comment.range[0] > lastProperty.range[1];
+      });
+      const hasUnsafeTrailingComment = trailingComments.some((comment) => {
+        return comment !== eventSeparator;
+      });
+
+      if (hasUnsafeTrailingComment) {
+        return null;
+      }
+
+      const methodBlocks = violations.map(({ property }) => {
+        return getMethodBlock(node, property);
+      });
+
+      if (methodBlocks.some((block) => block === null)) {
+        return null;
+      }
+
+      const movedProperties = new Set(
+        violations.map(({ property }) => property)
+      );
+      const remainingProperties = properties.filter((property) => {
+        return !movedProperties.has(property);
+      });
+      const interiorStart = node.value.range[0] + 1;
+      const interiorEnd = node.value.range[1] - 1;
+      const interiorText = sourceCode.text.slice(interiorStart, interiorEnd);
+      const suffixMatch = interiorText.match(/\s*$/);
+      const suffix = suffixMatch?.[0] || "";
+      const edits = methodBlocks.map((block) => {
+        return {
+          start: block.start - interiorStart,
+          end: block.end - interiorStart,
+          text: ""
+        };
+      });
+
+      if (remainingProperties.length > 0) {
+        const lastRemainingProperty = remainingProperties.at(-1);
+        const tokenAfter = sourceCode.getTokenAfter(lastRemainingProperty);
+        const hasComma = (
+          tokenAfter?.value === "," &&
+          tokenAfter.range[0] < interiorEnd
+        );
+
+        if (!hasComma) {
+          const propertyEnd = lastRemainingProperty.range[1] - interiorStart;
+
+          edits.push({
+            start: propertyEnd,
+            end: propertyEnd,
+            text: ","
+          });
+        }
+      }
+
+      const transformedText = [...edits]
+        .sort((first, second) => {
+          return second.start - first.start || second.end - first.end;
+        })
+        .reduce((text, edit) => {
+          return (
+            text.slice(0, edit.start) +
+            edit.text +
+            text.slice(edit.end)
+          );
+        }, interiorText)
+        .trimEnd();
+      const movedText = methodBlocks
+        .map((block) => block.text)
+        .join(",\n\n");
+      const methodIndent = movedText.match(/^[\t ]*/)?.[0] || "";
+      const sectionText = eventSeparator
+        ? movedText
+        : (
+          `${methodIndent}// ${EVENT_LISTENERS_SEPARATOR}\n\n` +
+          movedText
+        );
+      const fixedInterior = transformedText === ""
+        ? `\n${sectionText}${suffix}`
+        : `${transformedText}\n\n${sectionText}${suffix}`;
+
+      return (fixer) => {
+        return fixer.replaceTextRange(
+          [interiorStart, interiorEnd],
+          fixedInterior
+        );
+      };
+    }
+
+    function checkMethods(node) {
+      const properties = node.value.properties;
+
+      if (!properties) {
+        return;
+      }
+
+      let eventListenersStarted = false;
+      const violations = [];
+
+      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) {
+          return;
+        }
+
+        const name = getPropertyName(property);
+
+        if (name && EVENT_LISTENER_NAME_PATTERN.test(name)) {
+          violations.push({
+            property,
+            name
+          });
+        }
+      });
+
+      const moveFix = violations.length > 0
+        ? createMoveFix(node, properties, violations)
+        : null;
+
+      violations.forEach(({ property, name }, index) => {
+        context.report({
+          node: property.key,
+          messageId: "wrongSection",
+          data: { name },
+          ...(index === 0 && moveFix ? { fix: moveFix } : {})
+        });
+      });
+    }
+
+    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-section.test.js

@@ -0,0 +1,228 @@
+import rule from "../../rules/vue-event-listener-section.js";
+import { createVueRuleTester } from "../rule-tester.js";
+
+const ruleTester = createVueRuleTester();
+
+ruleTester.run("vue-event-listener-section", rule, {
+  valid: [
+    {
+      code: "export default { methods: {} };"
+    },
+    {
+      code: `
+        export default {
+          methods: {
+            // --> ACTIONS <--
+            save() {},
+            // --> HELPERS <--
+            onlyOnce() {},
+            onload() {},
+            on_save() {},
+            on2Factor() {}
+          }
+        };
+      `
+    },
+    {
+      code: `
+        export default defineComponent({
+          methods: {
+            // --> EVENT LISTENERS <--
+            onSave() {},
+            onURLChange() {},
+            "onClose"() {}
+          }
+        });
+      `
+    },
+    {
+      code: `
+        export default {
+          methods: {
+            // --> HELPERS <--
+            createHandlers() {
+              return {
+                onSave() {}
+              };
+            }
+          }
+        };
+      `
+    },
+    {
+      filename: "Component.vue",
+      code: `
+        <script>
+        export default defineComponent({
+          methods: {
+            // --> ACTIONS <--
+            save() {},
+            // --> EVENT LISTENERS <--
+            onLoadMore() {}
+          }
+        });
+        </script>
+      `
+    }
+  ],
+
+  invalid: [
+    {
+      code: `
+        export default {
+          methods: {
+            // --> ACTIONS <--
+
+            /**
+             * Saves content
+             */
+            save() {},
+
+            /**
+             * Triggers on save
+             */
+            onSave() {}
+          }
+        };
+      `,
+      output: `
+        export default {
+          methods: {
+            // --> ACTIONS <--
+
+            /**
+             * Saves content
+             */
+            save() {},
+
+            // --> EVENT LISTENERS <--
+
+            /**
+             * Triggers on save
+             */
+            onSave() {}
+          }
+        };
+      `,
+      errors: [
+        {
+          messageId: "wrongSection",
+          data: { name: "onSave" }
+        }
+      ]
+    },
+    {
+      code: `
+        export default {
+          methods: {
+            // --> HELPERS <--
+
+            format() {},
+
+            onLoadMore() {}
+          }
+        };
+      `,
+      output: `
+        export default {
+          methods: {
+            // --> HELPERS <--
+
+            format() {},
+
+            // --> EVENT LISTENERS <--
+
+            onLoadMore() {}
+          }
+        };
+      `,
+      errors: [
+        {
+          messageId: "wrongSection",
+          data: { name: "onLoadMore" }
+        }
+      ]
+    },
+    {
+      code: `
+        export default {
+          methods: {
+            "onClose": function() {}
+          }
+        };
+      `,
+      output: `
+        export default {
+          methods: {
+            // --> EVENT LISTENERS <--
+
+            "onClose": function() {}
+          }
+        };
+      `,
+      errors: [
+        {
+          messageId: "wrongSection",
+          data: { name: "onClose" }
+        }
+      ]
+    },
+    {
+      filename: "Component.vue",
+      code: `
+        <script>
+        export default defineComponent({
+          methods: {
+            // --> ACTIONS <--
+
+            save() {},
+
+            onSave() {},
+            // --> HELPERS <--
+
+            format() {},
+
+            onFormatComplete() {},
+            // --> EVENT LISTENERS <--
+
+            onClose() {}
+          }
+        });
+        </script>
+      `,
+      output: `
+        <script>
+        export default defineComponent({
+          methods: {
+            // --> ACTIONS <--
+
+            save() {},
+
+            // --> HELPERS <--
+
+            format() {},
+
+            // --> EVENT LISTENERS <--
+
+            onClose() {},
+
+            onSave() {},
+
+            onFormatComplete() {}
+          }
+        });
+        </script>
+      `,
+      errors: [
+        {
+          messageId: "wrongSection",
+          data: { name: "onSave" }
+        },
+        {
+          messageId: "wrongSection",
+          data: { name: "onFormatComplete" }
+        }
+      ]
+    }
+  ]
+});