eslint-plugin-crisp 1.4.1 → 1.4.2

package/index.js

@@ -42,6 +42,7 @@ import ruleVueEmitsOrder from "./rules/vue-emits-order.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";
+import ruleVueMethodsSeparator from "./rules/vue-methods-separator.js";
 import ruleVueNameProp from "./rules/vue-name-prop.js";
 import ruleVueNoRegexData from "./rules/vue-no-regex-data.js";
 import ruleVuePropsDeclarationLineBreak from "./rules/vue-props-declaration-line-break.js";
@@ -103,6 +104,7 @@ const plugin = {
     "vue-header-check": ruleVueHeaderCheck,
     "vue-html-indent": ruleVueHtmlIndent,
     "vue-html-quotes": ruleVueHtmlQuotes,
+    "vue-methods-separator": ruleVueMethodsSeparator,
     "vue-name-prop": ruleVueNameProp,
     "vue-no-regex-data": ruleVueNoRegexData,
     "vue-props-declaration-line-break": ruleVuePropsDeclarationLineBreak,

package/package.json

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

package/recommended-vue.js

@@ -377,6 +377,7 @@ export default function configRecommendedVue(pluginCrisp) {
         "crisp/vue-header-check": "error",
         "crisp/vue-html-indent": "error",
         "crisp/vue-html-quotes": "error",
+        "crisp/vue-methods-separator": "error",
         "crisp/vue-name-prop": "error",
         "crisp/vue-no-regex-data": "error",
         "crisp/vue-props-declaration-line-break": "error",

package/rules/vue-methods-separator.js

@@ -0,0 +1,46 @@
+export default {
+  meta: {
+    type: "suggestion",
+    docs: {
+      description: "enforce at least one separator comment in Vue methods block",
+      category: "Stylistic Issues",
+      recommended: false
+    },
+    fixable: null,
+    schema: []
+  },
+
+  create(context) {
+    const SEPARATOR_PATTERN = /^--> (ACTIONS|HELPERS|EVENT LISTENERS) <--$/;
+
+    return {
+      'ExportDefaultDeclaration Property[key.name="methods"]'(node) {
+        const properties = node.value.properties;
+
+        if (!properties || properties.length === 0) {
+          return;
+        }
+
+        const sourceCode = context.getSourceCode();
+        const comments = sourceCode.getCommentsInside(node);
+
+        const hasSeparator = comments.some((comment) => {
+          return (
+            comment.type === "Line" &&
+            SEPARATOR_PATTERN.test(comment.value.trim())
+          );
+        });
+
+        if (!hasSeparator) {
+          context.report({
+            node,
+            message:
+              "Methods block must contain at least one separator comment " +
+              "('// --> ACTIONS <--', '// --> HELPERS <--', " +
+              "or '// --> EVENT LISTENERS <--')"
+          });
+        }
+      }
+    };
+  }
+};