eslint-plugin-crisp 1.4.10 → 1.4.11

package/index.js

@@ -41,6 +41,7 @@ import ruleVariableNames from "./rules/variable-names.js";
 import ruleVueAttributeComma from "./rules/vue-attribute-comma.js";
 import ruleVueAttributeLinebreak from "./rules/vue-attribute-linebreak.js";
 import ruleVueComputedOrder from "./rules/vue-computed-order.js";
+import ruleVueDataComment from "./rules/vue-data-comment.js";
 import ruleVueEmitsOrder from "./rules/vue-emits-order.js";
 import ruleVueHeaderCheck from "./rules/vue-header-check.js";
 import ruleVueHtmlIndent from "./rules/vue-html-indent.js";
@@ -106,6 +107,7 @@ const plugin = {
     "vue-attribute-comma": ruleVueAttributeComma,
     "vue-attribute-linebreak": ruleVueAttributeLinebreak,
     "vue-computed-order": ruleVueComputedOrder,
+    "vue-data-comment": ruleVueDataComment,
     "vue-emits-order": ruleVueEmitsOrder,
     "vue-header-check": ruleVueHeaderCheck,
     "vue-html-indent": ruleVueHtmlIndent,

package/package.json

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

package/recommended-vue.js

@@ -375,6 +375,7 @@ export default function configRecommendedVue(pluginCrisp) {
         "crisp/vue-attribute-comma": "error",
         "crisp/vue-attribute-linebreak": "error",
         "crisp/vue-computed-order": "error",
+        "crisp/vue-data-comment": "error",
         "crisp/vue-emits-order": "error",
         "crisp/vue-header-check": "error",
         "crisp/vue-html-indent": "error",

package/rules/vue-data-comment.js

@@ -0,0 +1,76 @@
+export default {
+  meta: {
+    type: "suggestion",
+    docs: {
+      description: "enforce comment as first line in Vue data() return object",
+      category: "Stylistic Issues",
+      recommended: false
+    },
+    fixable: null,
+    schema: []
+  },
+
+  create(context) {
+    const COMMENT_PATTERN = /^--> (STATE|DATA|ROUTE PARAMS|COMPONENTS) <--$/;
+    const COMMENT_LIKE_PATTERN = /^--> .+ <--$/;
+
+    return {
+      'Property[key.name="data"] > FunctionExpression > BlockStatement > ReturnStatement > ObjectExpression'(node) {
+        const properties = node.properties;
+
+        if (!properties || properties.length === 0) {
+          return;
+        }
+
+        const sourceCode = context.getSourceCode();
+        const comments = sourceCode.getCommentsInside(node);
+
+        if (comments.length === 0) {
+          context.report({
+            node,
+            message:
+              "data() return object must start with a comment: " +
+              "'// --> STATE <--', '// --> DATA <--', " +
+              "'// --> ROUTE PARAMS <--', or '// --> COMPONENTS <--'."
+          });
+
+          return;
+        }
+
+        const firstComment = comments[0];
+
+        if (
+          firstComment.type !== "Line" ||
+          !COMMENT_PATTERN.test(firstComment.value.trim())
+        ) {
+          context.report({
+            node: firstComment,
+            message:
+              "data() return object must start with a comment: " +
+              "'// --> STATE <--', '// --> DATA <--', " +
+              "'// --> ROUTE PARAMS <--', or '// --> COMPONENTS <--'."
+          });
+        }
+
+        comments.forEach((comment) => {
+          if (comment.type === "Line") {
+            const trimmed = comment.value.trim();
+
+            if (
+              COMMENT_LIKE_PATTERN.test(trimmed) &&
+              !COMMENT_PATTERN.test(trimmed)
+            ) {
+              context.report({
+                node: comment,
+                message:
+                  "Invalid comment. Must be '// --> STATE <--', " +
+                  "'// --> DATA <--', '// --> ROUTE PARAMS <--', " +
+                  "or '// --> COMPONENTS <--'."
+              });
+            }
+          }
+        });
+      }
+    };
+  }
+};