eslint-plugin-crisp 1.0.25 → 1.0.27

package/package.json

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

package/rules/jsdoc-check-optional-params.js

@@ -19,33 +19,47 @@ module.exports = {
         return;
       }
 
-      const parsed = doctrine.parse(jsDocComment.value, { unwrap: true });
-      const jsdocParams = parsed.tags.filter((tag) => tag.title === "param");
-
-      node.params.forEach((param, i) => {
-        // If there's a corresponding JSDoc parameter
-        if (jsdocParams[i]) {
-          checkNode(param, jsdocParams[i], jsdocParams);
-        }
+      // This rule assumes that function params and JSDoc params match \
+      //   (enforced by jsdoc/require-param)
+      const parsed = doctrine.parse(jsDocComment.value, {
+        unwrap: true,
+        sloppy: true,
+        tags: ["param"]
       });
+      const jsdocParams = parsed.tags;
+
+      let i = 0;
+
+      if (jsdocParams.length) {
+        node.params.forEach((param) => {
+          i = checkNode(param, jsdocParams, i);
+        });
+      }
+
+      function checkNode(node, jsdocParams, i) {
+        jsdocParam = jsdocParams[i];
+
+        if (node.type === "ObjectPattern") {
+          i++;
 
-      function checkNode(node, jsdocParam, jsdocParams) {
-        if (node.type === "AssignmentPattern" && !/^\[.*\]$/.test(jsdocParam.name)) {
+          node.properties.forEach((property) => {
+            i = checkNode(property.value, jsdocParams, i);
+          });
+
+          return i;
+        } else if (node.type === "AssignmentPattern" && jsdocParam.type.type !== "OptionalType") {
           context.report({
             node,
             message: "Optional parameters in JSDoc should be surrounded by brackets"
           });
-        } else if (node.type === "ObjectPattern") {
-          node.properties.forEach((property) => {
-            const nestedJsdocParam = jsdocParams.find((param) => {
-              const nameSegments = param.name.split('.');
-              return nameSegments[nameSegments.length - 1] === property.key.name;
-            });
-            if (nestedJsdocParam) {
-              checkNode(property.value, nestedJsdocParam, jsdocParams);
-            }
+        } else if (jsdocParam.type.type === "OptionalType" && node.type !== "AssignmentPattern") {
+          context.report({
+            node,
+            message: "Non-optional parameters in JSDoc should not be surrounded by brackets"
           });
         }
+
+        return i + 1;
       }
     }