test: complete coverage

Author: brettz9

docs/rules/type-formatting.md

@@ -188,6 +188,11 @@ The following patterns are considered problems:
 // "jsdoc/type-formatting": ["error"|"warn", {"objectFieldQuote":"double"}]
 // Message: Inconsistent object field quotes double
 
+/**
+ * @param {{"a": string}} cfg
+ */
+// Message: Inconsistent object field quotes null
+
 /**
  * @param {ab.cd.ef} cfg
  */
@@ -242,10 +247,12 @@ The following patterns are considered problems:
 // Message: Inconsistent "" union spacing usage
 
 /**
+ * Due to jsdoc-type-pratt-parser not consuming whitespace, the exact
+ *   error will not be reported.
  * @param {ab|cd} cfg
  */
 // "jsdoc/type-formatting": ["error"|"warn", {"unionSpacing":" "}]
-// Message: Inconsistent " " union spacing usage
+// Message: There was an error with type formatting
 
 /**
  * Due to jsdoc-type-pratt-parser representing the separator at the
@@ -266,6 +273,12 @@ The following patterns are considered problems:
  */
 // "jsdoc/type-formatting": ["error"|"warn", {"typeBracketSpacing":""}]
 // Message: Must have no initial spacing
+
+/**
+ * @param {ab."cd".ef} cfg
+ */
+// "jsdoc/type-formatting": ["error"|"warn", {"propertyQuotes":null}]
+// Message: Inconsistent null property quotes usage
 ````
 
 

src/rules/typeFormatting.js

@@ -231,6 +231,7 @@ export default iterateJsdoc(({
         case 'JsdocTypeObject': {
           const typeNode = /** @type {import('jsdoc-type-pratt-parser').ObjectResult} */ (nde);
           if (
+            /* c8 ignore next -- Guard */
             (typeNode.meta.separator ?? 'comma') !== objectFieldSeparator ||
             (typeNode.meta.separatorForSingleObjectField ?? false) !== separatorForSingleObjectField ||
             (typeNode.meta.propertyIndent ?? '') !== objectFieldIndent ||
@@ -285,7 +286,8 @@ export default iterateJsdoc(({
 
         case 'JsdocTypeUnion': {
           const typeNode = /** @type {import('jsdoc-type-pratt-parser').UnionResult} */ (nde);
-          if (typeNode.meta?.spacing !== unionSpacing) {
+          /* c8 ignore next -- Guard */
+          if ((typeNode.meta?.spacing ?? ' ') !== unionSpacing) {
             typeNode.meta = {
               spacing: unionSpacing,
             };

test/rules/assertions/typeFormatting.js

@@ -269,6 +269,24 @@ export default {
          */
       `,
     },
+    {
+      code: `
+        /**
+         * @param {{"a": string}} cfg
+         */
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'Inconsistent object field quotes null',
+        },
+      ],
+      output: `
+        /**
+         * @param {{a: string}} cfg
+         */
+      `,
+    },
     {
       code: `
         /**
@@ -490,13 +508,15 @@ export default {
     {
       code: `
         /**
+         * Due to jsdoc-type-pratt-parser not consuming whitespace, the exact
+         *   error will not be reported.
          * @param {ab|cd} cfg
          */
       `,
       errors: [
         {
-          line: 3,
-          message: 'Inconsistent " " union spacing usage',
+          line: 5,
+          message: 'There was an error with type formatting',
         },
       ],
       options: [
@@ -506,10 +526,34 @@ export default {
       ],
       output: `
         /**
+         * Due to jsdoc-type-pratt-parser not consuming whitespace, the exact
+         *   error will not be reported.
          * @param {ab | cd} cfg
          */
       `,
     },
+    {
+      code: `
+        /**
+         * Due to jsdoc-type-pratt-parser not consuming whitespace, the exact
+         *   error will not be reported.
+         * @param {ab|cd} cfg
+         */
+      `,
+      errors: [
+        {
+          line: 5,
+          message: 'There was an error with type formatting',
+        },
+      ],
+      ignoreReadme: true,
+      options: [
+        {
+          enableFixer: false,
+          unionSpacing: ' ',
+        },
+      ],
+    },
     {
       code: `
         /**
@@ -583,6 +627,29 @@ export default {
          */
       `,
     },
+    {
+      code: `
+        /**
+         * @param {ab."cd".ef} cfg
+         */
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'Inconsistent null property quotes usage',
+        },
+      ],
+      options: [
+        {
+          propertyQuotes: null,
+        },
+      ],
+      output: `
+        /**
+         * @param {ab.cd.ef} cfg
+         */
+      `,
+    },
   ],
   valid: [
     {