eslint-plugin-crisp 1.0.30 → 1.0.32

package/index.js

@@ -16,6 +16,7 @@ module.exports = {
     "jsdoc-enforce-access": require("./rules/jsdoc-enforce-access"),
     "jsdoc-enforce-classdesc": require("./rules/jsdoc-enforce-classdesc"),
     "methods-naming": require("./rules/methods-naming"),
+    "methods-ordering": require("./rules/methods-ordering"),
     "multiline-comment-end-backslash": require("./rules/multiline-comment-end-backslash"),
     "no-async": require("./rules/no-async"),
     "no-var-in-blocks": require("./rules/no-var-in-blocks"),

package/package.json

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

package/recommended-vue.js

@@ -66,6 +66,7 @@ module.exports = {
     "crisp/header-check": "error",
     "crisp/header-comments-check": "error",
     "crisp/methods-naming": "error",
+    "crisp/methods-ordering": "error",
     "crisp/multiline-comment-end-backslash": "error",
     "crisp/no-async": "error",
     "crisp/no-var-in-blocks": "error",
@@ -131,7 +132,6 @@ module.exports = {
     // General Vue rules
     "vue/html-quotes": "off",
     "vue/no-v-html": "off",
-    "vue/prefer-prop-type-boolean-first": "error",
     "vue/prefer-true-attribute-shorthand": "error",
     "vue/attributes-order": [
       "error",

package/recommended.js

@@ -120,6 +120,7 @@ module.exports = {
       "exceptions": ["_", "$"]
     }],
     "crisp/methods-naming": "error",
+    "crisp/methods-ordering": "error",
     "crisp/one-space-after-operator": "error",
     "crisp/ternary-parenthesis": "error",
     "crisp/align-consecutive-class-assignements": "error",

package/rules/methods-ordering.js

@@ -0,0 +1,68 @@
+const doctrine = require("doctrine");
+
+module.exports = {
+  create(context) {
+    let methodOrder = []; // Keep track of method order
+
+    return {
+      MethodDefinition(node) {
+        const commentsBefore = context.getSourceCode().getCommentsBefore(node);
+
+        // Check if there is a comment matching `--> {VALUE} <--` before the node
+        const nodeComment = commentsBefore.find(comment => comment.type === "Line" && /--> (.*) <--/.test(comment.value));
+
+        // Reset methodOrder if a matching comment was found
+        if (nodeComment) {
+          methodOrder = [];
+        }
+
+        // Reset methodOrder if the method name is "constructor"
+        if (node.kind === "constructor") {
+          methodOrder = [];
+        }
+
+        // Parse JSDoc
+        const jsDocComment = commentsBefore.find(comment => comment.type === "Block" && comment.value.startsWith("*"));
+
+        // If there is no JSDoc, ignore this method
+        if (!jsDocComment) {
+          return;
+        }
+
+        // Parse the jsDocComment using doctrine
+        const jsDoc = doctrine.parse(`/*${jsDocComment.value}*/`, { unwrap: true });
+
+        // Extract visibility from JSDoc
+        const visibilityTag = jsDoc.tags.find(tag => ["public", "protected", "private"].includes(tag.title));
+
+        // If there is no visibility tag, ignore this method
+        if (!visibilityTag) {
+          return;
+        }
+
+        const methodKind = visibilityTag.title;
+
+        // Check order of methods
+        if (methodKind === "public") {
+          if (methodOrder.includes("protected") || methodOrder.includes("private")) {
+            context.report({
+              node,
+              message: "Public methods should be defined before protected or private methods."
+            });
+          }
+          methodOrder.push("public");
+        } else if (methodKind === "protected") {
+          if (methodOrder.includes("private")) {
+            context.report({
+              node,
+              message: "Protected methods should be defined before private methods."
+            });
+          }
+          methodOrder.push("protected");
+        } else if (methodKind === "private") {
+          methodOrder.push("private");
+        }
+      }
+    };
+  }
+};