fix(valid-types): report postfix nullable in object or labeled tuple position; fixes jsdoc-type-pratt-parser/jsdoc-type-pratt-parser#62

Author: brettz9

docs/rules/valid-types.md

@@ -471,6 +471,22 @@ function quux () {}
  */
 function quux () {}
 // Message: Invalid name: invalid default value syntax
+
+/**
+ * @type {{message: string?}}
+ */
+function quux (items) {
+}
+// Settings: {"jsdoc":{"mode":"closure"}}
+// Message: Syntax error in type: JsdocTypeNullable
+
+/**
+ * @type {[message: string?]}
+ */
+function quux (items) {
+}
+// Settings: {"jsdoc":{"mode":"typescript"}}
+// Message: Syntax error in type: JsdocTypeNullable
 ````
 
 

src/rules/validTypes.js

@@ -143,18 +143,35 @@ export default iterateJsdoc(({
     };
 
     const validTypeParsing = function (type) {
+      let parsedTypes;
       try {
         if (mode === 'permissive') {
-          tryParse(type);
+          parsedTypes = tryParse(type);
         } else {
-          parse(type, mode);
+          parsedTypes = parse(type, mode);
         }
       } catch {
         report(`Syntax error in type: ${type}`, null, tag);
 
         return false;
       }
 
+      if (mode === 'closure' || mode === 'typescript') {
+        traverse(parsedTypes, (node) => {
+          const {
+            type: typ,
+          } = node;
+
+          if (
+            (typ === 'JsdocTypeObjectField' || typ === 'JsdocTypeKeyValue') &&
+            node.right.type === 'JsdocTypeNullable' &&
+            node.right.meta.position === 'suffix'
+          ) {
+            report(`Syntax error in type: ${node.right.type}`, null, tag);
+          }
+        });
+      }
+
       return true;
     };
 

test/rules/assertions/validTypes.js

@@ -1062,6 +1062,46 @@ export default {
         },
       ],
     },
+    {
+      code: `
+            /**
+             * @type {{message: string?}}
+             */
+            function quux (items) {
+            }
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'Syntax error in type: JsdocTypeNullable',
+        },
+      ],
+      settings: {
+        jsdoc: {
+          mode: 'closure',
+        },
+      },
+    },
+    {
+      code: `
+            /**
+             * @type {[message: string?]}
+             */
+            function quux (items) {
+            }
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'Syntax error in type: JsdocTypeNullable',
+        },
+      ],
+      settings: {
+        jsdoc: {
+          mode: 'typescript',
+        },
+      },
+    },
   ],
   valid: [
     {