eslint-plugin-jsdoc 55.3.0 → 55.4.0

package/dist/rules/typeFormatting.cjs

@@ -20,10 +20,13 @@ var _default = exports.default = (0, _iterateJsdoc.default)(({
     genericDot = false,
     objectFieldIndent = '',
     objectFieldQuote = null,
-    objectFieldSeparator = null,
+    objectFieldSeparator = 'comma',
+    objectFieldSeparatorTrailingPunctuation = false,
     propertyQuotes = null,
     separatorForSingleObjectField = false,
-    stringQuotes = 'single'
+    stringQuotes = 'single',
+    typeBracketSpacing = '',
+    unionSpacing = ' '
   } = context.options[0] || {};
   const {
     mode
@@ -49,7 +52,7 @@ var _default = exports.default = (0, _iterateJsdoc.default)(({
       }) => {
         return tokens.name || tokens.description;
       });
-      const nameAndDesc = tag.source.slice(beginNameOrDescIdx);
+      const nameAndDesc = beginNameOrDescIdx === -1 ? null : tag.source.slice(beginNameOrDescIdx);
       const initialNumber = tag.source[0].number;
       const src = [
       // Get inevitably present tag from first `tag.source`
@@ -64,7 +67,7 @@ var _default = exports.default = (0, _iterateJsdoc.default)(({
             postName: '',
             postType: ''
           } : {}),
-          type: '{' + firstTypeLine + (!typeLines.length && lastTypeLine === undefined ? '}' : '')
+          type: '{' + typeBracketSpacing + firstTypeLine + (!typeLines.length && lastTypeLine === undefined ? typeBracketSpacing + '}' : '')
         }
       },
       // Get any intervening type lines
@@ -91,13 +94,13 @@ var _default = exports.default = (0, _iterateJsdoc.default)(({
       // Merge any final type line and name and description
       if (
       // Name and description may be already included if present with the tag
-      beginNameOrDescIdx > 0) {
+      nameAndDesc && beginNameOrDescIdx > 0) {
         src.push({
           number: src.length + 1,
           source: '',
           tokens: {
             ...nameAndDesc[0].tokens,
-            type: lastTypeLine + '}'
+            type: lastTypeLine + typeBracketSpacing + '}'
           }
         });
         if (
@@ -114,7 +117,7 @@ var _default = exports.default = (0, _iterateJsdoc.default)(({
             };
           }));
         }
-      } else {
+      } else if (nameAndDesc) {
         if (lastTypeLine) {
           src.push({
             number: src.length + 1,
@@ -125,7 +128,7 @@ var _default = exports.default = (0, _iterateJsdoc.default)(({
               postTag: '',
               start: indent + ' ',
               tag: '',
-              type: lastTypeLine + '}'
+              type: lastTypeLine + typeBracketSpacing + '}'
             }
           });
         }
@@ -154,28 +157,44 @@ var _default = exports.default = (0, _iterateJsdoc.default)(({
       }) => {
         return tg;
       });
+      const initialEndSource = jsdoc.source.find(({
+        tokens: {
+          end
+        }
+      }) => {
+        return end;
+      });
       jsdoc.source = [...jsdoc.source.slice(0, firstTagIdx), ...jsdoc.tags.flatMap(({
         source
       }) => {
         return source;
       })];
+      if (initialEndSource && !jsdoc.source.at(-1)?.tokens?.end) {
+        jsdoc.source.push(initialEndSource);
+      }
     };
 
     /** @type {string[]} */
     const errorMessages = [];
-    let needToReport = false;
+    if (typeBracketSpacing && (!tag.type.startsWith(typeBracketSpacing) || !tag.type.endsWith(typeBracketSpacing))) {
+      errorMessages.push(`Must have initial and final "${typeBracketSpacing}" spacing`);
+    } else if (!typeBracketSpacing && (/^\s/v.test(tag.type) || /\s$/v.test(tag.type))) {
+      errorMessages.push('Must have no initial spacing');
+    }
+
+    // eslint-disable-next-line complexity -- Todo
     (0, _jsdoccomment.traverse)(parsedType, nde => {
-      let typeFound = true;
       let errorMessage = '';
-      const initialType = (0, _jsdoccomment.stringify)(/** @type {import('jsdoc-type-pratt-parser').RootResult} */nde);
       switch (nde.type) {
         case 'JsdocTypeGeneric':
           {
             const typeNode = /** @type {import('jsdoc-type-pratt-parser').GenericResult} */nde;
             if ('value' in typeNode.left && typeNode.left.value === 'Array') {
-              typeNode.meta.brackets = arrayBrackets;
-              errorMessage = `Array bracket style should be ${arrayBrackets}`;
-            } else {
+              if (typeNode.meta.brackets !== arrayBrackets) {
+                typeNode.meta.brackets = arrayBrackets;
+                errorMessage = `Array bracket style should be ${arrayBrackets}`;
+              }
+            } else if (typeNode.meta.dot !== genericDot) {
               typeNode.meta.dot = genericDot;
               errorMessage = `Dot usage should be ${genericDot}`;
             }
@@ -184,62 +203,78 @@ var _default = exports.default = (0, _iterateJsdoc.default)(({
         case 'JsdocTypeObject':
           {
             const typeNode = /** @type {import('jsdoc-type-pratt-parser').ObjectResult} */nde;
-            typeNode.meta.separator = objectFieldSeparator ?? undefined;
-            typeNode.meta.separatorForSingleObjectField = separatorForSingleObjectField;
-            typeNode.meta.propertyIndent = objectFieldIndent;
-            errorMessage = `Inconsistent ${objectFieldSeparator} usage`;
+            if (/* c8 ignore next -- Guard */
+            (typeNode.meta.separator ?? 'comma') !== objectFieldSeparator || (typeNode.meta.separatorForSingleObjectField ?? false) !== separatorForSingleObjectField || (typeNode.meta.propertyIndent ?? '') !== objectFieldIndent || (typeNode.meta.trailingPunctuation ?? false) !== objectFieldSeparatorTrailingPunctuation) {
+              typeNode.meta.separator = objectFieldSeparator;
+              typeNode.meta.separatorForSingleObjectField = separatorForSingleObjectField;
+              typeNode.meta.propertyIndent = objectFieldIndent;
+              typeNode.meta.trailingPunctuation = objectFieldSeparatorTrailingPunctuation;
+              errorMessage = `Inconsistent ${objectFieldSeparator} separator usage`;
+            }
             break;
           }
         case 'JsdocTypeObjectField':
           {
             const typeNode = /** @type {import('jsdoc-type-pratt-parser').ObjectFieldResult} */nde;
-            if (objectFieldQuote || typeof typeNode.key === 'string' && !/\s/v.test(typeNode.key)) {
+            if ((objectFieldQuote || typeof typeNode.key === 'string' && !/\s/v.test(typeNode.key)) && typeNode.meta.quote !== (objectFieldQuote ?? undefined)) {
               typeNode.meta.quote = objectFieldQuote ?? undefined;
               errorMessage = `Inconsistent object field quotes ${objectFieldQuote}`;
-            } else {
-              typeFound = false;
             }
             break;
           }
         case 'JsdocTypeProperty':
           {
             const typeNode = /** @type {import('jsdoc-type-pratt-parser').PropertyResult} */nde;
-            if (propertyQuotes || typeof typeNode.value === 'string' && !/\s/v.test(typeNode.value)) {
+            if ((propertyQuotes || typeof typeNode.value === 'string' && !/\s/v.test(typeNode.value)) && typeNode.meta.quote !== (propertyQuotes ?? undefined)) {
               typeNode.meta.quote = propertyQuotes ?? undefined;
               errorMessage = `Inconsistent ${propertyQuotes} property quotes usage`;
-            } else {
-              typeFound = false;
             }
             break;
           }
         case 'JsdocTypeStringValue':
           {
             const typeNode = /** @type {import('jsdoc-type-pratt-parser').StringValueResult} */nde;
-            typeNode.meta.quote = stringQuotes;
-            errorMessage = `Inconsistent ${stringQuotes} string quotes usage`;
+            if (typeNode.meta.quote !== stringQuotes) {
+              typeNode.meta.quote = stringQuotes;
+              errorMessage = `Inconsistent ${stringQuotes} string quotes usage`;
+            }
+            break;
+          }
+        case 'JsdocTypeUnion':
+          {
+            const typeNode = /** @type {import('jsdoc-type-pratt-parser').UnionResult} */nde;
+            /* c8 ignore next -- Guard */
+            if ((typeNode.meta?.spacing ?? ' ') !== unionSpacing) {
+              typeNode.meta = {
+                spacing: unionSpacing
+              };
+              errorMessage = `Inconsistent "${unionSpacing}" union spacing usage`;
+            }
             break;
           }
         default:
-          typeFound = false;
           break;
       }
-      if (typeFound) {
-        const convertedType = (0, _jsdoccomment.stringify)(/** @type {import('jsdoc-type-pratt-parser').RootResult} */nde);
-        if (initialType !== convertedType) {
-          needToReport = true;
-          errorMessages.push(errorMessage);
-        }
+      if (errorMessage) {
+        errorMessages.push(errorMessage);
       }
     });
-    if (needToReport) {
+    const differentResult = tag.type !== typeBracketSpacing + (0, _jsdoccomment.stringify)(parsedType) + typeBracketSpacing;
+    if (errorMessages.length && differentResult) {
       for (const errorMessage of errorMessages) {
-        utils.reportJSDoc(errorMessage, tag, enableFixer ? fix : null, true);
+        utils.reportJSDoc(errorMessage, tag, enableFixer ? fix : null);
       }
+      // Stringification may have been equal previously (and thus no error reported)
+      //   because the stringification doesn't preserve everything
+    } else if (differentResult) {
+      utils.reportJSDoc('There was an error with type formatting', tag, enableFixer ? fix : null);
     }
   };
-  const tags = utils.getPresentTags(['param', 'returns']);
+  const tags = utils.getPresentTags(['param', 'returns', 'type', 'typedef']);
   for (const tag of tags) {
-    checkTypeFormats(tag);
+    if (tag.type) {
+      checkTypeFormats(tag);
+    }
   }
 }, {
   iterateAllJsdocs: true,
@@ -268,7 +303,10 @@ var _default = exports.default = (0, _iterateJsdoc.default)(({
           enum: ['double', 'single', null]
         },
         objectFieldSeparator: {
-          enum: ['comma', 'comma-and-linebreak', 'linebreak', 'semicolon', 'semicolon-and-linebreak', null]
+          enum: ['comma', 'comma-and-linebreak', 'linebreak', 'semicolon', 'semicolon-and-linebreak']
+        },
+        objectFieldSeparatorTrailingPunctuation: {
+          type: 'boolean'
         },
         propertyQuotes: {
           enum: ['double', 'single', null]
@@ -278,6 +316,12 @@ var _default = exports.default = (0, _iterateJsdoc.default)(({
         },
         stringQuotes: {
           enum: ['double', 'single']
+        },
+        typeBracketSpacing: {
+          type: 'string'
+        },
+        unionSpacing: {
+          type: 'string'
         }
       },
       type: 'object'

package/dist/rules/typeFormatting.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"typeFormatting.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","_jsdoccomment","e","__esModule","default","_default","exports","iterateJsdoc","context","indent","jsdoc","settings","utils","arrayBrackets","enableFixer","genericDot","objectFieldIndent","objectFieldQuote","objectFieldSeparator","propertyQuotes","separatorForSingleObjectField","stringQuotes","options","mode","checkTypeFormats","tag","potentialType","type","parsedType","tryParseType","parseType","fix","typeLines","stringify","split","firstTypeLine","shift","lastTypeLine","pop","beginNameOrDescIdx","source","findIndex","tokens","name","description","nameAndDesc","slice","initialNumber","number","src","length","end","postName","postType","undefined","map","typeLine","idx","delimiter","postTag","start","push","firstTagIdx","tg","tags","flatMap","errorMessages","needToReport","traverse","nde","typeFound","errorMessage","initialType","typeNode","left","value","meta","brackets","dot","separator","propertyIndent","key","test","quote","convertedType","reportJSDoc","getPresentTags","iterateAllJsdocs","docs","url","fixable","schema","additionalProperties","properties","enum","module"],"sources":["../../src/rules/typeFormatting.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  parse as parseType,\n  stringify,\n  traverse,\n  tryParse as tryParseType,\n} from '@es-joy/jsdoccomment';\n\nexport default iterateJsdoc(({\n  context,\n  indent,\n  jsdoc,\n  settings,\n  utils,\n}) => {\n  const {\n    arrayBrackets = 'square',\n    enableFixer = true,\n    genericDot = false,\n    objectFieldIndent = '',\n    objectFieldQuote = null,\n    objectFieldSeparator = null,\n    propertyQuotes = null,\n    separatorForSingleObjectField = false,\n    stringQuotes = 'single',\n  } = context.options[0] || {};\n\n  const {\n    mode,\n  } = settings;\n\n  /**\n   * @param {import('@es-joy/jsdoccomment').JsdocTagWithInline} tag\n   */\n  const checkTypeFormats = (tag) => {\n    const potentialType = tag.type;\n    let parsedType;\n    try {\n      parsedType = mode === 'permissive' ?\n        tryParseType(/** @type {string} */ (potentialType)) :\n        parseType(/** @type {string} */ (potentialType), mode);\n    } catch {\n      return;\n    }\n\n    const fix = () => {\n      const typeLines = stringify(parsedType).split('\\n');\n      const firstTypeLine = typeLines.shift();\n      const lastTypeLine = typeLines.pop();\n\n      const beginNameOrDescIdx = tag.source.findIndex(({\n        tokens,\n      }) => {\n        return tokens.name || tokens.description;\n      });\n\n      const nameAndDesc = tag.source.slice(beginNameOrDescIdx);\n      const initialNumber = tag.source[0].number;\n      const src = [\n        // Get inevitably present tag from first `tag.source`\n        {\n          number: initialNumber,\n          source: '',\n          tokens: {\n            ...tag.source[0].tokens,\n            ...(typeLines.length || lastTypeLine ? {\n              end: '',\n              name: '',\n              postName: '',\n              postType: '',\n            } : {}),\n            type: '{' + firstTypeLine + (!typeLines.length && lastTypeLine === undefined ? '}' : ''),\n          },\n        },\n        // Get any intervening type lines\n        ...(typeLines.length ? typeLines.map((typeLine, idx) => {\n          return {\n            number: initialNumber + idx + 1,\n            source: '',\n            tokens: {\n              // Grab any delimiter info from first item\n              ...tag.source[0].tokens,\n              delimiter: tag.source[0].tokens.delimiter === '/**' ? '*' : tag.source[0].tokens.delimiter,\n              end: '',\n              name: '',\n              postName: '',\n              postTag: '',\n              postType: '',\n              start: indent + ' ',\n              tag: '',\n              type: typeLine,\n            },\n          };\n        }) : []),\n      ];\n\n      // Merge any final type line and name and description\n      if (\n        // Name and description may be already included if present with the tag\n        beginNameOrDescIdx > 0\n      ) {\n        src.push({\n          number: src.length + 1,\n          source: '',\n          tokens: {\n            ...nameAndDesc[0].tokens,\n            type: lastTypeLine + '}',\n          },\n        });\n\n        if (\n          // Get any remaining description lines\n          nameAndDesc.length > 1\n        ) {\n          src.push(\n            ...nameAndDesc.slice(1).map(({\n              source,\n              tokens,\n            }, idx) => {\n              return {\n                number: src.length + idx + 2,\n                source,\n                tokens,\n              };\n            }),\n          );\n        }\n      } else {\n        if (lastTypeLine) {\n          src.push({\n            number: src.length + 1,\n            source: '',\n            tokens: {\n              ...nameAndDesc[0].tokens,\n              delimiter: nameAndDesc[0].tokens.delimiter === '/**' ? '*' : nameAndDesc[0].tokens.delimiter,\n              postTag: '',\n              start: indent + ' ',\n              tag: '',\n              type: lastTypeLine + '}',\n            },\n          });\n        }\n\n        if (\n          // Get any remaining description lines\n          nameAndDesc.length > 1\n        ) {\n          src.push(\n            ...nameAndDesc.slice(1).map(({\n              source,\n              tokens,\n            }, idx) => {\n              return {\n                number: src.length + idx + 2,\n                source,\n                tokens,\n              };\n            }),\n          );\n        }\n      }\n\n      tag.source = src;\n\n      // Properly rewire `jsdoc.source`\n      const firstTagIdx = jsdoc.source.findIndex(({\n        tokens: {\n          tag: tg,\n        },\n      }) => {\n        return tg;\n      });\n\n      jsdoc.source = [\n        ...jsdoc.source.slice(0, firstTagIdx),\n        ...jsdoc.tags.flatMap(({\n          source,\n        }) => {\n          return source;\n        }),\n      ];\n    };\n\n    /** @type {string[]} */\n    const errorMessages = [];\n    let needToReport = false;\n    traverse(parsedType, (nde) => {\n      let typeFound = true;\n      let errorMessage = '';\n      const initialType = stringify(\n        /** @type {import('jsdoc-type-pratt-parser').RootResult} */ (nde),\n      );\n      switch (nde.type) {\n        case 'JsdocTypeGeneric': {\n          const typeNode = /** @type {import('jsdoc-type-pratt-parser').GenericResult} */ (nde);\n          if ('value' in typeNode.left && typeNode.left.value === 'Array') {\n            typeNode.meta.brackets = arrayBrackets;\n            errorMessage = `Array bracket style should be ${arrayBrackets}`;\n          } else {\n            typeNode.meta.dot = genericDot;\n            errorMessage = `Dot usage should be ${genericDot}`;\n          }\n\n          break;\n        }\n\n        case 'JsdocTypeObject': {\n          const typeNode = /** @type {import('jsdoc-type-pratt-parser').ObjectResult} */ (nde);\n          typeNode.meta.separator = objectFieldSeparator ?? undefined;\n          typeNode.meta.separatorForSingleObjectField = separatorForSingleObjectField;\n          typeNode.meta.propertyIndent = objectFieldIndent;\n          errorMessage = `Inconsistent ${objectFieldSeparator} usage`;\n          break;\n        }\n\n        case 'JsdocTypeObjectField': {\n          const typeNode = /** @type {import('jsdoc-type-pratt-parser').ObjectFieldResult} */ (nde);\n          if (objectFieldQuote ||\n            (typeof typeNode.key === 'string' && !(/\\s/v).test(typeNode.key))\n          ) {\n            typeNode.meta.quote = objectFieldQuote ?? undefined;\n            errorMessage = `Inconsistent object field quotes ${objectFieldQuote}`;\n          } else {\n            typeFound = false;\n          }\n\n          break;\n        }\n\n        case 'JsdocTypeProperty': {\n          const typeNode = /** @type {import('jsdoc-type-pratt-parser').PropertyResult} */ (nde);\n\n          if (propertyQuotes ||\n            (typeof typeNode.value === 'string' && !(/\\s/v).test(typeNode.value))\n          ) {\n            typeNode.meta.quote = propertyQuotes ?? undefined;\n            errorMessage = `Inconsistent ${propertyQuotes} property quotes usage`;\n          } else {\n            typeFound = false;\n          }\n\n          break;\n        }\n\n        case 'JsdocTypeStringValue': {\n          const typeNode = /** @type {import('jsdoc-type-pratt-parser').StringValueResult} */ (nde);\n          typeNode.meta.quote = stringQuotes;\n          errorMessage = `Inconsistent ${stringQuotes} string quotes usage`;\n          break;\n        }\n\n        default:\n          typeFound = false;\n          break;\n      }\n\n      if (typeFound) {\n        const convertedType = stringify(/** @type {import('jsdoc-type-pratt-parser').RootResult} */ (nde));\n        if (initialType !== convertedType) {\n          needToReport = true;\n          errorMessages.push(errorMessage);\n        }\n      }\n    });\n\n    if (needToReport) {\n      for (const errorMessage of errorMessages) {\n        utils.reportJSDoc(\n          errorMessage, tag, enableFixer ? fix : null, true,\n        );\n      }\n    }\n  };\n\n  const tags = utils.getPresentTags([\n    'param',\n    'returns',\n  ]);\n  for (const tag of tags) {\n    checkTypeFormats(tag);\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Formats JSDoc type values.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/type-formatting.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          arrayBrackets: {\n            enum: [\n              'angle',\n              'square',\n            ],\n          },\n          enableFixer: {\n            type: 'boolean',\n          },\n          genericDot: {\n            type: 'boolean',\n          },\n          objectFieldIndent: {\n            type: 'string',\n          },\n          objectFieldQuote: {\n            enum: [\n              'double',\n              'single',\n              null,\n            ],\n          },\n          objectFieldSeparator: {\n            enum: [\n              'comma',\n              'comma-and-linebreak',\n              'linebreak',\n              'semicolon',\n              'semicolon-and-linebreak',\n              null,\n            ],\n          },\n          propertyQuotes: {\n            enum: [\n              'double',\n              'single',\n              null,\n            ],\n          },\n          separatorForSingleObjectField: {\n            type: 'boolean',\n          },\n          stringQuotes: {\n            enum: [\n              'double',\n              'single',\n            ],\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AAK8B,SAAAD,uBAAAG,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,IAAAG,QAAA,GAAAC,OAAA,CAAAF,OAAA,GAEf,IAAAG,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,MAAM;EACNC,KAAK;EACLC,QAAQ;EACRC;AACF,CAAC,KAAK;EACJ,MAAM;IACJC,aAAa,GAAG,QAAQ;IACxBC,WAAW,GAAG,IAAI;IAClBC,UAAU,GAAG,KAAK;IAClBC,iBAAiB,GAAG,EAAE;IACtBC,gBAAgB,GAAG,IAAI;IACvBC,oBAAoB,GAAG,IAAI;IAC3BC,cAAc,GAAG,IAAI;IACrBC,6BAA6B,GAAG,KAAK;IACrCC,YAAY,GAAG;EACjB,CAAC,GAAGb,OAAO,CAACc,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,MAAM;IACJC;EACF,CAAC,GAAGZ,QAAQ;;EAEZ;AACF;AACA;EACE,MAAMa,gBAAgB,GAAIC,GAAG,IAAK;IAChC,MAAMC,aAAa,GAAGD,GAAG,CAACE,IAAI;IAC9B,IAAIC,UAAU;IACd,IAAI;MACFA,UAAU,GAAGL,IAAI,KAAK,YAAY,GAChC,IAAAM,sBAAY,EAAC,qBAAuBH,aAAc,CAAC,GACnD,IAAAI,mBAAS,EAAC,qBAAuBJ,aAAa,EAAGH,IAAI,CAAC;IAC1D,CAAC,CAAC,MAAM;MACN;IACF;IAEA,MAAMQ,GAAG,GAAGA,CAAA,KAAM;MAChB,MAAMC,SAAS,GAAG,IAAAC,uBAAS,EAACL,UAAU,CAAC,CAACM,KAAK,CAAC,IAAI,CAAC;MACnD,MAAMC,aAAa,GAAGH,SAAS,CAACI,KAAK,CAAC,CAAC;MACvC,MAAMC,YAAY,GAAGL,SAAS,CAACM,GAAG,CAAC,CAAC;MAEpC,MAAMC,kBAAkB,GAAGd,GAAG,CAACe,MAAM,CAACC,SAAS,CAAC,CAAC;QAC/CC;MACF,CAAC,KAAK;QACJ,OAAOA,MAAM,CAACC,IAAI,IAAID,MAAM,CAACE,WAAW;MAC1C,CAAC,CAAC;MAEF,MAAMC,WAAW,GAAGpB,GAAG,CAACe,MAAM,CAACM,KAAK,CAACP,kBAAkB,CAAC;MACxD,MAAMQ,aAAa,GAAGtB,GAAG,CAACe,MAAM,CAAC,CAAC,CAAC,CAACQ,MAAM;MAC1C,MAAMC,GAAG,GAAG;MACV;MACA;QACED,MAAM,EAAED,aAAa;QACrBP,MAAM,EAAE,EAAE;QACVE,MAAM,EAAE;UACN,GAAGjB,GAAG,CAACe,MAAM,CAAC,CAAC,CAAC,CAACE,MAAM;UACvB,IAAIV,SAAS,CAACkB,MAAM,IAAIb,YAAY,GAAG;YACrCc,GAAG,EAAE,EAAE;YACPR,IAAI,EAAE,EAAE;YACRS,QAAQ,EAAE,EAAE;YACZC,QAAQ,EAAE;UACZ,CAAC,GAAG,CAAC,CAAC,CAAC;UACP1B,IAAI,EAAE,GAAG,GAAGQ,aAAa,IAAI,CAACH,SAAS,CAACkB,MAAM,IAAIb,YAAY,KAAKiB,SAAS,GAAG,GAAG,GAAG,EAAE;QACzF;MACF,CAAC;MACD;MACA,IAAItB,SAAS,CAACkB,MAAM,GAAGlB,SAAS,CAACuB,GAAG,CAAC,CAACC,QAAQ,EAAEC,GAAG,KAAK;QACtD,OAAO;UACLT,MAAM,EAAED,aAAa,GAAGU,GAAG,GAAG,CAAC;UAC/BjB,MAAM,EAAE,EAAE;UACVE,MAAM,EAAE;YACN;YACA,GAAGjB,GAAG,CAACe,MAAM,CAAC,CAAC,CAAC,CAACE,MAAM;YACvBgB,SAAS,EAAEjC,GAAG,CAACe,MAAM,CAAC,CAAC,CAAC,CAACE,MAAM,CAACgB,SAAS,KAAK,KAAK,GAAG,GAAG,GAAGjC,GAAG,CAACe,MAAM,CAAC,CAAC,CAAC,CAACE,MAAM,CAACgB,SAAS;YAC1FP,GAAG,EAAE,EAAE;YACPR,IAAI,EAAE,EAAE;YACRS,QAAQ,EAAE,EAAE;YACZO,OAAO,EAAE,EAAE;YACXN,QAAQ,EAAE,EAAE;YACZO,KAAK,EAAEnD,MAAM,GAAG,GAAG;YACnBgB,GAAG,EAAE,EAAE;YACPE,IAAI,EAAE6B;UACR;QACF,CAAC;MACH,CAAC,CAAC,GAAG,EAAE,CAAC,CACT;;MAED;MACA;MACE;MACAjB,kBAAkB,GAAG,CAAC,EACtB;QACAU,GAAG,CAACY,IAAI,CAAC;UACPb,MAAM,EAAEC,GAAG,CAACC,MAAM,GAAG,CAAC;UACtBV,MAAM,EAAE,EAAE;UACVE,MAAM,EAAE;YACN,GAAGG,WAAW,CAAC,CAAC,CAAC,CAACH,MAAM;YACxBf,IAAI,EAAEU,YAAY,GAAG;UACvB;QACF,CAAC,CAAC;QAEF;QACE;QACAQ,WAAW,CAACK,MAAM,GAAG,CAAC,EACtB;UACAD,GAAG,CAACY,IAAI,CACN,GAAGhB,WAAW,CAACC,KAAK,CAAC,CAAC,CAAC,CAACS,GAAG,CAAC,CAAC;YAC3Bf,MAAM;YACNE;UACF,CAAC,EAAEe,GAAG,KAAK;YACT,OAAO;cACLT,MAAM,EAAEC,GAAG,CAACC,MAAM,GAAGO,GAAG,GAAG,CAAC;cAC5BjB,MAAM;cACNE;YACF,CAAC;UACH,CAAC,CACH,CAAC;QACH;MACF,CAAC,MAAM;QACL,IAAIL,YAAY,EAAE;UAChBY,GAAG,CAACY,IAAI,CAAC;YACPb,MAAM,EAAEC,GAAG,CAACC,MAAM,GAAG,CAAC;YACtBV,MAAM,EAAE,EAAE;YACVE,MAAM,EAAE;cACN,GAAGG,WAAW,CAAC,CAAC,CAAC,CAACH,MAAM;cACxBgB,SAAS,EAAEb,WAAW,CAAC,CAAC,CAAC,CAACH,MAAM,CAACgB,SAAS,KAAK,KAAK,GAAG,GAAG,GAAGb,WAAW,CAAC,CAAC,CAAC,CAACH,MAAM,CAACgB,SAAS;cAC5FC,OAAO,EAAE,EAAE;cACXC,KAAK,EAAEnD,MAAM,GAAG,GAAG;cACnBgB,GAAG,EAAE,EAAE;cACPE,IAAI,EAAEU,YAAY,GAAG;YACvB;UACF,CAAC,CAAC;QACJ;QAEA;QACE;QACAQ,WAAW,CAACK,MAAM,GAAG,CAAC,EACtB;UACAD,GAAG,CAACY,IAAI,CACN,GAAGhB,WAAW,CAACC,KAAK,CAAC,CAAC,CAAC,CAACS,GAAG,CAAC,CAAC;YAC3Bf,MAAM;YACNE;UACF,CAAC,EAAEe,GAAG,KAAK;YACT,OAAO;cACLT,MAAM,EAAEC,GAAG,CAACC,MAAM,GAAGO,GAAG,GAAG,CAAC;cAC5BjB,MAAM;cACNE;YACF,CAAC;UACH,CAAC,CACH,CAAC;QACH;MACF;MAEAjB,GAAG,CAACe,MAAM,GAAGS,GAAG;;MAEhB;MACA,MAAMa,WAAW,GAAGpD,KAAK,CAAC8B,MAAM,CAACC,SAAS,CAAC,CAAC;QAC1CC,MAAM,EAAE;UACNjB,GAAG,EAAEsC;QACP;MACF,CAAC,KAAK;QACJ,OAAOA,EAAE;MACX,CAAC,CAAC;MAEFrD,KAAK,CAAC8B,MAAM,GAAG,CACb,GAAG9B,KAAK,CAAC8B,MAAM,CAACM,KAAK,CAAC,CAAC,EAAEgB,WAAW,CAAC,EACrC,GAAGpD,KAAK,CAACsD,IAAI,CAACC,OAAO,CAAC,CAAC;QACrBzB;MACF,CAAC,KAAK;QACJ,OAAOA,MAAM;MACf,CAAC,CAAC,CACH;IACH,CAAC;;IAED;IACA,MAAM0B,aAAa,GAAG,EAAE;IACxB,IAAIC,YAAY,GAAG,KAAK;IACxB,IAAAC,sBAAQ,EAACxC,UAAU,EAAGyC,GAAG,IAAK;MAC5B,IAAIC,SAAS,GAAG,IAAI;MACpB,IAAIC,YAAY,GAAG,EAAE;MACrB,MAAMC,WAAW,GAAG,IAAAvC,uBAAS,EAC3B,2DAA6DoC,GAC/D,CAAC;MACD,QAAQA,GAAG,CAAC1C,IAAI;QACd,KAAK,kBAAkB;UAAE;YACvB,MAAM8C,QAAQ,GAAG,8DAAgEJ,GAAI;YACrF,IAAI,OAAO,IAAII,QAAQ,CAACC,IAAI,IAAID,QAAQ,CAACC,IAAI,CAACC,KAAK,KAAK,OAAO,EAAE;cAC/DF,QAAQ,CAACG,IAAI,CAACC,QAAQ,GAAGhE,aAAa;cACtC0D,YAAY,GAAG,iCAAiC1D,aAAa,EAAE;YACjE,CAAC,MAAM;cACL4D,QAAQ,CAACG,IAAI,CAACE,GAAG,GAAG/D,UAAU;cAC9BwD,YAAY,GAAG,uBAAuBxD,UAAU,EAAE;YACpD;YAEA;UACF;QAEA,KAAK,iBAAiB;UAAE;YACtB,MAAM0D,QAAQ,GAAG,6DAA+DJ,GAAI;YACpFI,QAAQ,CAACG,IAAI,CAACG,SAAS,GAAG7D,oBAAoB,IAAIoC,SAAS;YAC3DmB,QAAQ,CAACG,IAAI,CAACxD,6BAA6B,GAAGA,6BAA6B;YAC3EqD,QAAQ,CAACG,IAAI,CAACI,cAAc,GAAGhE,iBAAiB;YAChDuD,YAAY,GAAG,gBAAgBrD,oBAAoB,QAAQ;YAC3D;UACF;QAEA,KAAK,sBAAsB;UAAE;YAC3B,MAAMuD,QAAQ,GAAG,kEAAoEJ,GAAI;YACzF,IAAIpD,gBAAgB,IACjB,OAAOwD,QAAQ,CAACQ,GAAG,KAAK,QAAQ,IAAI,CAAE,KAAK,CAAEC,IAAI,CAACT,QAAQ,CAACQ,GAAG,CAAE,EACjE;cACAR,QAAQ,CAACG,IAAI,CAACO,KAAK,GAAGlE,gBAAgB,IAAIqC,SAAS;cACnDiB,YAAY,GAAG,oCAAoCtD,gBAAgB,EAAE;YACvE,CAAC,MAAM;cACLqD,SAAS,GAAG,KAAK;YACnB;YAEA;UACF;QAEA,KAAK,mBAAmB;UAAE;YACxB,MAAMG,QAAQ,GAAG,+DAAiEJ,GAAI;YAEtF,IAAIlD,cAAc,IACf,OAAOsD,QAAQ,CAACE,KAAK,KAAK,QAAQ,IAAI,CAAE,KAAK,CAAEO,IAAI,CAACT,QAAQ,CAACE,KAAK,CAAE,EACrE;cACAF,QAAQ,CAACG,IAAI,CAACO,KAAK,GAAGhE,cAAc,IAAImC,SAAS;cACjDiB,YAAY,GAAG,gBAAgBpD,cAAc,wBAAwB;YACvE,CAAC,MAAM;cACLmD,SAAS,GAAG,KAAK;YACnB;YAEA;UACF;QAEA,KAAK,sBAAsB;UAAE;YAC3B,MAAMG,QAAQ,GAAG,kEAAoEJ,GAAI;YACzFI,QAAQ,CAACG,IAAI,CAACO,KAAK,GAAG9D,YAAY;YAClCkD,YAAY,GAAG,gBAAgBlD,YAAY,sBAAsB;YACjE;UACF;QAEA;UACEiD,SAAS,GAAG,KAAK;UACjB;MACJ;MAEA,IAAIA,SAAS,EAAE;QACb,MAAMc,aAAa,GAAG,IAAAnD,uBAAS,EAAC,2DAA6DoC,GAAI,CAAC;QAClG,IAAIG,WAAW,KAAKY,aAAa,EAAE;UACjCjB,YAAY,GAAG,IAAI;UACnBD,aAAa,CAACL,IAAI,CAACU,YAAY,CAAC;QAClC;MACF;IACF,CAAC,CAAC;IAEF,IAAIJ,YAAY,EAAE;MAChB,KAAK,MAAMI,YAAY,IAAIL,aAAa,EAAE;QACxCtD,KAAK,CAACyE,WAAW,CACfd,YAAY,EAAE9C,GAAG,EAAEX,WAAW,GAAGiB,GAAG,GAAG,IAAI,EAAE,IAC/C,CAAC;MACH;IACF;EACF,CAAC;EAED,MAAMiC,IAAI,GAAGpD,KAAK,CAAC0E,cAAc,CAAC,CAChC,OAAO,EACP,SAAS,CACV,CAAC;EACF,KAAK,MAAM7D,GAAG,IAAIuC,IAAI,EAAE;IACtBxC,gBAAgB,CAACC,GAAG,CAAC;EACvB;AACF,CAAC,EAAE;EACD8D,gBAAgB,EAAE,IAAI;EACtBX,IAAI,EAAE;IACJY,IAAI,EAAE;MACJ5C,WAAW,EAAE,4BAA4B;MACzC6C,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVhF,aAAa,EAAE;UACbiF,IAAI,EAAE,CACJ,OAAO,EACP,QAAQ;QAEZ,CAAC;QACDhF,WAAW,EAAE;UACXa,IAAI,EAAE;QACR,CAAC;QACDZ,UAAU,EAAE;UACVY,IAAI,EAAE;QACR,CAAC;QACDX,iBAAiB,EAAE;UACjBW,IAAI,EAAE;QACR,CAAC;QACDV,gBAAgB,EAAE;UAChB6E,IAAI,EAAE,CACJ,QAAQ,EACR,QAAQ,EACR,IAAI;QAER,CAAC;QACD5E,oBAAoB,EAAE;UACpB4E,IAAI,EAAE,CACJ,OAAO,EACP,qBAAqB,EACrB,WAAW,EACX,WAAW,EACX,yBAAyB,EACzB,IAAI;QAER,CAAC;QACD3E,cAAc,EAAE;UACd2E,IAAI,EAAE,CACJ,QAAQ,EACR,QAAQ,EACR,IAAI;QAER,CAAC;QACD1E,6BAA6B,EAAE;UAC7BO,IAAI,EAAE;QACR,CAAC;QACDN,YAAY,EAAE;UACZyE,IAAI,EAAE,CACJ,QAAQ,EACR,QAAQ;QAEZ;MACF,CAAC;MACDnE,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAoE,MAAA,CAAAzF,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}
+{"version":3,"file":"typeFormatting.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","_jsdoccomment","e","__esModule","default","_default","exports","iterateJsdoc","context","indent","jsdoc","settings","utils","arrayBrackets","enableFixer","genericDot","objectFieldIndent","objectFieldQuote","objectFieldSeparator","objectFieldSeparatorTrailingPunctuation","propertyQuotes","separatorForSingleObjectField","stringQuotes","typeBracketSpacing","unionSpacing","options","mode","checkTypeFormats","tag","potentialType","type","parsedType","tryParseType","parseType","fix","typeLines","stringify","split","firstTypeLine","shift","lastTypeLine","pop","beginNameOrDescIdx","source","findIndex","tokens","name","description","nameAndDesc","slice","initialNumber","number","src","length","end","postName","postType","undefined","map","typeLine","idx","delimiter","postTag","start","push","firstTagIdx","tg","initialEndSource","find","tags","flatMap","at","errorMessages","startsWith","endsWith","test","traverse","nde","errorMessage","typeNode","left","value","meta","brackets","dot","separator","propertyIndent","trailingPunctuation","key","quote","spacing","differentResult","reportJSDoc","getPresentTags","iterateAllJsdocs","docs","url","fixable","schema","additionalProperties","properties","enum","module"],"sources":["../../src/rules/typeFormatting.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  parse as parseType,\n  stringify,\n  traverse,\n  tryParse as tryParseType,\n} from '@es-joy/jsdoccomment';\n\nexport default iterateJsdoc(({\n  context,\n  indent,\n  jsdoc,\n  settings,\n  utils,\n}) => {\n  const {\n    arrayBrackets = 'square',\n    enableFixer = true,\n    genericDot = false,\n    objectFieldIndent = '',\n    objectFieldQuote = null,\n    objectFieldSeparator = 'comma',\n    objectFieldSeparatorTrailingPunctuation = false,\n    propertyQuotes = null,\n    separatorForSingleObjectField = false,\n    stringQuotes = 'single',\n    typeBracketSpacing = '',\n    unionSpacing = ' ',\n  } = context.options[0] || {};\n\n  const {\n    mode,\n  } = settings;\n\n  /**\n   * @param {import('@es-joy/jsdoccomment').JsdocTagWithInline} tag\n   */\n  const checkTypeFormats = (tag) => {\n    const potentialType = tag.type;\n    let parsedType;\n    try {\n      parsedType = mode === 'permissive' ?\n        tryParseType(/** @type {string} */ (potentialType)) :\n        parseType(/** @type {string} */ (potentialType), mode);\n    } catch {\n      return;\n    }\n\n    const fix = () => {\n      const typeLines = stringify(parsedType).split('\\n');\n      const firstTypeLine = typeLines.shift();\n      const lastTypeLine = typeLines.pop();\n\n      const beginNameOrDescIdx = tag.source.findIndex(({\n        tokens,\n      }) => {\n        return tokens.name || tokens.description;\n      });\n\n      const nameAndDesc = beginNameOrDescIdx === -1 ?\n        null :\n        tag.source.slice(beginNameOrDescIdx);\n\n      const initialNumber = tag.source[0].number;\n      const src = [\n        // Get inevitably present tag from first `tag.source`\n        {\n          number: initialNumber,\n          source: '',\n          tokens: {\n            ...tag.source[0].tokens,\n            ...(typeLines.length || lastTypeLine ? {\n              end: '',\n              name: '',\n              postName: '',\n              postType: '',\n            } : {}),\n            type: '{' + typeBracketSpacing + firstTypeLine + (!typeLines.length && lastTypeLine === undefined ? typeBracketSpacing + '}' : ''),\n          },\n        },\n        // Get any intervening type lines\n        ...(typeLines.length ? typeLines.map((typeLine, idx) => {\n          return {\n            number: initialNumber + idx + 1,\n            source: '',\n            tokens: {\n              // Grab any delimiter info from first item\n              ...tag.source[0].tokens,\n              delimiter: tag.source[0].tokens.delimiter === '/**' ? '*' : tag.source[0].tokens.delimiter,\n              end: '',\n              name: '',\n              postName: '',\n              postTag: '',\n              postType: '',\n              start: indent + ' ',\n              tag: '',\n              type: typeLine,\n            },\n          };\n        }) : []),\n      ];\n\n      // Merge any final type line and name and description\n      if (\n        // Name and description may be already included if present with the tag\n        nameAndDesc && beginNameOrDescIdx > 0\n      ) {\n        src.push({\n          number: src.length + 1,\n          source: '',\n          tokens: {\n            ...nameAndDesc[0].tokens,\n            type: lastTypeLine + typeBracketSpacing + '}',\n          },\n        });\n\n        if (\n          // Get any remaining description lines\n          nameAndDesc.length > 1\n        ) {\n          src.push(\n            ...nameAndDesc.slice(1).map(({\n              source,\n              tokens,\n            }, idx) => {\n              return {\n                number: src.length + idx + 2,\n                source,\n                tokens,\n              };\n            }),\n          );\n        }\n      } else if (nameAndDesc) {\n        if (lastTypeLine) {\n          src.push({\n            number: src.length + 1,\n            source: '',\n            tokens: {\n              ...nameAndDesc[0].tokens,\n              delimiter: nameAndDesc[0].tokens.delimiter === '/**' ? '*' : nameAndDesc[0].tokens.delimiter,\n              postTag: '',\n              start: indent + ' ',\n              tag: '',\n              type: lastTypeLine + typeBracketSpacing + '}',\n            },\n          });\n        }\n\n        if (\n          // Get any remaining description lines\n          nameAndDesc.length > 1\n        ) {\n          src.push(\n            ...nameAndDesc.slice(1).map(({\n              source,\n              tokens,\n            }, idx) => {\n              return {\n                number: src.length + idx + 2,\n                source,\n                tokens,\n              };\n            }),\n          );\n        }\n      }\n\n      tag.source = src;\n\n      // Properly rewire `jsdoc.source`\n      const firstTagIdx = jsdoc.source.findIndex(({\n        tokens: {\n          tag: tg,\n        },\n      }) => {\n        return tg;\n      });\n\n      const initialEndSource = jsdoc.source.find(({\n        tokens: {\n          end,\n        },\n      }) => {\n        return end;\n      });\n\n      jsdoc.source = [\n        ...jsdoc.source.slice(0, firstTagIdx),\n        ...jsdoc.tags.flatMap(({\n          source,\n        }) => {\n          return source;\n        }),\n      ];\n\n      if (initialEndSource && !jsdoc.source.at(-1)?.tokens?.end) {\n        jsdoc.source.push(initialEndSource);\n      }\n    };\n\n    /** @type {string[]} */\n    const errorMessages = [];\n\n    if (typeBracketSpacing && (!tag.type.startsWith(typeBracketSpacing) || !tag.type.endsWith(typeBracketSpacing))) {\n      errorMessages.push(`Must have initial and final \"${typeBracketSpacing}\" spacing`);\n    } else if (!typeBracketSpacing && ((/^\\s/v).test(tag.type) || (/\\s$/v).test(tag.type))) {\n      errorMessages.push('Must have no initial spacing');\n    }\n\n    // eslint-disable-next-line complexity -- Todo\n    traverse(parsedType, (nde) => {\n      let errorMessage = '';\n\n      switch (nde.type) {\n        case 'JsdocTypeGeneric': {\n          const typeNode = /** @type {import('jsdoc-type-pratt-parser').GenericResult} */ (nde);\n          if ('value' in typeNode.left && typeNode.left.value === 'Array') {\n            if (typeNode.meta.brackets !== arrayBrackets) {\n              typeNode.meta.brackets = arrayBrackets;\n              errorMessage = `Array bracket style should be ${arrayBrackets}`;\n            }\n          } else if (typeNode.meta.dot !== genericDot) {\n            typeNode.meta.dot = genericDot;\n            errorMessage = `Dot usage should be ${genericDot}`;\n          }\n\n          break;\n        }\n\n        case 'JsdocTypeObject': {\n          const typeNode = /** @type {import('jsdoc-type-pratt-parser').ObjectResult} */ (nde);\n          if (\n            /* c8 ignore next -- Guard */\n            (typeNode.meta.separator ?? 'comma') !== objectFieldSeparator ||\n            (typeNode.meta.separatorForSingleObjectField ?? false) !== separatorForSingleObjectField ||\n            (typeNode.meta.propertyIndent ?? '') !== objectFieldIndent ||\n            (typeNode.meta.trailingPunctuation ?? false) !== objectFieldSeparatorTrailingPunctuation\n          ) {\n            typeNode.meta.separator = objectFieldSeparator;\n            typeNode.meta.separatorForSingleObjectField = separatorForSingleObjectField;\n            typeNode.meta.propertyIndent = objectFieldIndent;\n            typeNode.meta.trailingPunctuation = objectFieldSeparatorTrailingPunctuation;\n            errorMessage = `Inconsistent ${objectFieldSeparator} separator usage`;\n          }\n\n          break;\n        }\n\n        case 'JsdocTypeObjectField': {\n          const typeNode = /** @type {import('jsdoc-type-pratt-parser').ObjectFieldResult} */ (nde);\n          if ((objectFieldQuote ||\n            (typeof typeNode.key === 'string' && !(/\\s/v).test(typeNode.key))) &&\n            typeNode.meta.quote !== (objectFieldQuote ?? undefined)\n          ) {\n            typeNode.meta.quote = objectFieldQuote ?? undefined;\n            errorMessage = `Inconsistent object field quotes ${objectFieldQuote}`;\n          }\n\n          break;\n        }\n\n        case 'JsdocTypeProperty': {\n          const typeNode = /** @type {import('jsdoc-type-pratt-parser').PropertyResult} */ (nde);\n\n          if ((propertyQuotes ||\n            (typeof typeNode.value === 'string' && !(/\\s/v).test(typeNode.value))) &&\n            typeNode.meta.quote !== (propertyQuotes ?? undefined)\n          ) {\n            typeNode.meta.quote = propertyQuotes ?? undefined;\n            errorMessage = `Inconsistent ${propertyQuotes} property quotes usage`;\n          }\n\n          break;\n        }\n\n        case 'JsdocTypeStringValue': {\n          const typeNode = /** @type {import('jsdoc-type-pratt-parser').StringValueResult} */ (nde);\n          if (typeNode.meta.quote !== stringQuotes) {\n            typeNode.meta.quote = stringQuotes;\n            errorMessage = `Inconsistent ${stringQuotes} string quotes usage`;\n          }\n\n          break;\n        }\n\n        case 'JsdocTypeUnion': {\n          const typeNode = /** @type {import('jsdoc-type-pratt-parser').UnionResult} */ (nde);\n          /* c8 ignore next -- Guard */\n          if ((typeNode.meta?.spacing ?? ' ') !== unionSpacing) {\n            typeNode.meta = {\n              spacing: unionSpacing,\n            };\n            errorMessage = `Inconsistent \"${unionSpacing}\" union spacing usage`;\n          }\n\n          break;\n        }\n\n        default:\n          break;\n      }\n\n      if (errorMessage) {\n        errorMessages.push(errorMessage);\n      }\n    });\n\n    const differentResult = tag.type !==\n      typeBracketSpacing + stringify(parsedType) + typeBracketSpacing;\n\n    if (errorMessages.length && differentResult) {\n      for (const errorMessage of errorMessages) {\n        utils.reportJSDoc(\n          errorMessage, tag, enableFixer ? fix : null,\n        );\n      }\n    // Stringification may have been equal previously (and thus no error reported)\n    //   because the stringification doesn't preserve everything\n    } else if (differentResult) {\n      utils.reportJSDoc(\n        'There was an error with type formatting', tag, enableFixer ? fix : null,\n      );\n    }\n  };\n\n  const tags = utils.getPresentTags([\n    'param',\n    'returns',\n    'type',\n    'typedef',\n  ]);\n  for (const tag of tags) {\n    if (tag.type) {\n      checkTypeFormats(tag);\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Formats JSDoc type values.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/type-formatting.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          arrayBrackets: {\n            enum: [\n              'angle',\n              'square',\n            ],\n          },\n          enableFixer: {\n            type: 'boolean',\n          },\n          genericDot: {\n            type: 'boolean',\n          },\n          objectFieldIndent: {\n            type: 'string',\n          },\n          objectFieldQuote: {\n            enum: [\n              'double',\n              'single',\n              null,\n            ],\n          },\n          objectFieldSeparator: {\n            enum: [\n              'comma',\n              'comma-and-linebreak',\n              'linebreak',\n              'semicolon',\n              'semicolon-and-linebreak',\n            ],\n          },\n          objectFieldSeparatorTrailingPunctuation: {\n            type: 'boolean',\n          },\n          propertyQuotes: {\n            enum: [\n              'double',\n              'single',\n              null,\n            ],\n          },\n          separatorForSingleObjectField: {\n            type: 'boolean',\n          },\n          stringQuotes: {\n            enum: [\n              'double',\n              'single',\n            ],\n          },\n          typeBracketSpacing: {\n            type: 'string',\n          },\n          unionSpacing: {\n            type: 'string',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AAK8B,SAAAD,uBAAAG,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,IAAAG,QAAA,GAAAC,OAAA,CAAAF,OAAA,GAEf,IAAAG,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,MAAM;EACNC,KAAK;EACLC,QAAQ;EACRC;AACF,CAAC,KAAK;EACJ,MAAM;IACJC,aAAa,GAAG,QAAQ;IACxBC,WAAW,GAAG,IAAI;IAClBC,UAAU,GAAG,KAAK;IAClBC,iBAAiB,GAAG,EAAE;IACtBC,gBAAgB,GAAG,IAAI;IACvBC,oBAAoB,GAAG,OAAO;IAC9BC,uCAAuC,GAAG,KAAK;IAC/CC,cAAc,GAAG,IAAI;IACrBC,6BAA6B,GAAG,KAAK;IACrCC,YAAY,GAAG,QAAQ;IACvBC,kBAAkB,GAAG,EAAE;IACvBC,YAAY,GAAG;EACjB,CAAC,GAAGhB,OAAO,CAACiB,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,MAAM;IACJC;EACF,CAAC,GAAGf,QAAQ;;EAEZ;AACF;AACA;EACE,MAAMgB,gBAAgB,GAAIC,GAAG,IAAK;IAChC,MAAMC,aAAa,GAAGD,GAAG,CAACE,IAAI;IAC9B,IAAIC,UAAU;IACd,IAAI;MACFA,UAAU,GAAGL,IAAI,KAAK,YAAY,GAChC,IAAAM,sBAAY,EAAC,qBAAuBH,aAAc,CAAC,GACnD,IAAAI,mBAAS,EAAC,qBAAuBJ,aAAa,EAAGH,IAAI,CAAC;IAC1D,CAAC,CAAC,MAAM;MACN;IACF;IAEA,MAAMQ,GAAG,GAAGA,CAAA,KAAM;MAChB,MAAMC,SAAS,GAAG,IAAAC,uBAAS,EAACL,UAAU,CAAC,CAACM,KAAK,CAAC,IAAI,CAAC;MACnD,MAAMC,aAAa,GAAGH,SAAS,CAACI,KAAK,CAAC,CAAC;MACvC,MAAMC,YAAY,GAAGL,SAAS,CAACM,GAAG,CAAC,CAAC;MAEpC,MAAMC,kBAAkB,GAAGd,GAAG,CAACe,MAAM,CAACC,SAAS,CAAC,CAAC;QAC/CC;MACF,CAAC,KAAK;QACJ,OAAOA,MAAM,CAACC,IAAI,IAAID,MAAM,CAACE,WAAW;MAC1C,CAAC,CAAC;MAEF,MAAMC,WAAW,GAAGN,kBAAkB,KAAK,CAAC,CAAC,GAC3C,IAAI,GACJd,GAAG,CAACe,MAAM,CAACM,KAAK,CAACP,kBAAkB,CAAC;MAEtC,MAAMQ,aAAa,GAAGtB,GAAG,CAACe,MAAM,CAAC,CAAC,CAAC,CAACQ,MAAM;MAC1C,MAAMC,GAAG,GAAG;MACV;MACA;QACED,MAAM,EAAED,aAAa;QACrBP,MAAM,EAAE,EAAE;QACVE,MAAM,EAAE;UACN,GAAGjB,GAAG,CAACe,MAAM,CAAC,CAAC,CAAC,CAACE,MAAM;UACvB,IAAIV,SAAS,CAACkB,MAAM,IAAIb,YAAY,GAAG;YACrCc,GAAG,EAAE,EAAE;YACPR,IAAI,EAAE,EAAE;YACRS,QAAQ,EAAE,EAAE;YACZC,QAAQ,EAAE;UACZ,CAAC,GAAG,CAAC,CAAC,CAAC;UACP1B,IAAI,EAAE,GAAG,GAAGP,kBAAkB,GAAGe,aAAa,IAAI,CAACH,SAAS,CAACkB,MAAM,IAAIb,YAAY,KAAKiB,SAAS,GAAGlC,kBAAkB,GAAG,GAAG,GAAG,EAAE;QACnI;MACF,CAAC;MACD;MACA,IAAIY,SAAS,CAACkB,MAAM,GAAGlB,SAAS,CAACuB,GAAG,CAAC,CAACC,QAAQ,EAAEC,GAAG,KAAK;QACtD,OAAO;UACLT,MAAM,EAAED,aAAa,GAAGU,GAAG,GAAG,CAAC;UAC/BjB,MAAM,EAAE,EAAE;UACVE,MAAM,EAAE;YACN;YACA,GAAGjB,GAAG,CAACe,MAAM,CAAC,CAAC,CAAC,CAACE,MAAM;YACvBgB,SAAS,EAAEjC,GAAG,CAACe,MAAM,CAAC,CAAC,CAAC,CAACE,MAAM,CAACgB,SAAS,KAAK,KAAK,GAAG,GAAG,GAAGjC,GAAG,CAACe,MAAM,CAAC,CAAC,CAAC,CAACE,MAAM,CAACgB,SAAS;YAC1FP,GAAG,EAAE,EAAE;YACPR,IAAI,EAAE,EAAE;YACRS,QAAQ,EAAE,EAAE;YACZO,OAAO,EAAE,EAAE;YACXN,QAAQ,EAAE,EAAE;YACZO,KAAK,EAAEtD,MAAM,GAAG,GAAG;YACnBmB,GAAG,EAAE,EAAE;YACPE,IAAI,EAAE6B;UACR;QACF,CAAC;MACH,CAAC,CAAC,GAAG,EAAE,CAAC,CACT;;MAED;MACA;MACE;MACAX,WAAW,IAAIN,kBAAkB,GAAG,CAAC,EACrC;QACAU,GAAG,CAACY,IAAI,CAAC;UACPb,MAAM,EAAEC,GAAG,CAACC,MAAM,GAAG,CAAC;UACtBV,MAAM,EAAE,EAAE;UACVE,MAAM,EAAE;YACN,GAAGG,WAAW,CAAC,CAAC,CAAC,CAACH,MAAM;YACxBf,IAAI,EAAEU,YAAY,GAAGjB,kBAAkB,GAAG;UAC5C;QACF,CAAC,CAAC;QAEF;QACE;QACAyB,WAAW,CAACK,MAAM,GAAG,CAAC,EACtB;UACAD,GAAG,CAACY,IAAI,CACN,GAAGhB,WAAW,CAACC,KAAK,CAAC,CAAC,CAAC,CAACS,GAAG,CAAC,CAAC;YAC3Bf,MAAM;YACNE;UACF,CAAC,EAAEe,GAAG,KAAK;YACT,OAAO;cACLT,MAAM,EAAEC,GAAG,CAACC,MAAM,GAAGO,GAAG,GAAG,CAAC;cAC5BjB,MAAM;cACNE;YACF,CAAC;UACH,CAAC,CACH,CAAC;QACH;MACF,CAAC,MAAM,IAAIG,WAAW,EAAE;QACtB,IAAIR,YAAY,EAAE;UAChBY,GAAG,CAACY,IAAI,CAAC;YACPb,MAAM,EAAEC,GAAG,CAACC,MAAM,GAAG,CAAC;YACtBV,MAAM,EAAE,EAAE;YACVE,MAAM,EAAE;cACN,GAAGG,WAAW,CAAC,CAAC,CAAC,CAACH,MAAM;cACxBgB,SAAS,EAAEb,WAAW,CAAC,CAAC,CAAC,CAACH,MAAM,CAACgB,SAAS,KAAK,KAAK,GAAG,GAAG,GAAGb,WAAW,CAAC,CAAC,CAAC,CAACH,MAAM,CAACgB,SAAS;cAC5FC,OAAO,EAAE,EAAE;cACXC,KAAK,EAAEtD,MAAM,GAAG,GAAG;cACnBmB,GAAG,EAAE,EAAE;cACPE,IAAI,EAAEU,YAAY,GAAGjB,kBAAkB,GAAG;YAC5C;UACF,CAAC,CAAC;QACJ;QAEA;QACE;QACAyB,WAAW,CAACK,MAAM,GAAG,CAAC,EACtB;UACAD,GAAG,CAACY,IAAI,CACN,GAAGhB,WAAW,CAACC,KAAK,CAAC,CAAC,CAAC,CAACS,GAAG,CAAC,CAAC;YAC3Bf,MAAM;YACNE;UACF,CAAC,EAAEe,GAAG,KAAK;YACT,OAAO;cACLT,MAAM,EAAEC,GAAG,CAACC,MAAM,GAAGO,GAAG,GAAG,CAAC;cAC5BjB,MAAM;cACNE;YACF,CAAC;UACH,CAAC,CACH,CAAC;QACH;MACF;MAEAjB,GAAG,CAACe,MAAM,GAAGS,GAAG;;MAEhB;MACA,MAAMa,WAAW,GAAGvD,KAAK,CAACiC,MAAM,CAACC,SAAS,CAAC,CAAC;QAC1CC,MAAM,EAAE;UACNjB,GAAG,EAAEsC;QACP;MACF,CAAC,KAAK;QACJ,OAAOA,EAAE;MACX,CAAC,CAAC;MAEF,MAAMC,gBAAgB,GAAGzD,KAAK,CAACiC,MAAM,CAACyB,IAAI,CAAC,CAAC;QAC1CvB,MAAM,EAAE;UACNS;QACF;MACF,CAAC,KAAK;QACJ,OAAOA,GAAG;MACZ,CAAC,CAAC;MAEF5C,KAAK,CAACiC,MAAM,GAAG,CACb,GAAGjC,KAAK,CAACiC,MAAM,CAACM,KAAK,CAAC,CAAC,EAAEgB,WAAW,CAAC,EACrC,GAAGvD,KAAK,CAAC2D,IAAI,CAACC,OAAO,CAAC,CAAC;QACrB3B;MACF,CAAC,KAAK;QACJ,OAAOA,MAAM;MACf,CAAC,CAAC,CACH;MAED,IAAIwB,gBAAgB,IAAI,CAACzD,KAAK,CAACiC,MAAM,CAAC4B,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE1B,MAAM,EAAES,GAAG,EAAE;QACzD5C,KAAK,CAACiC,MAAM,CAACqB,IAAI,CAACG,gBAAgB,CAAC;MACrC;IACF,CAAC;;IAED;IACA,MAAMK,aAAa,GAAG,EAAE;IAExB,IAAIjD,kBAAkB,KAAK,CAACK,GAAG,CAACE,IAAI,CAAC2C,UAAU,CAAClD,kBAAkB,CAAC,IAAI,CAACK,GAAG,CAACE,IAAI,CAAC4C,QAAQ,CAACnD,kBAAkB,CAAC,CAAC,EAAE;MAC9GiD,aAAa,CAACR,IAAI,CAAC,gCAAgCzC,kBAAkB,WAAW,CAAC;IACnF,CAAC,MAAM,IAAI,CAACA,kBAAkB,KAAM,MAAM,CAAEoD,IAAI,CAAC/C,GAAG,CAACE,IAAI,CAAC,IAAK,MAAM,CAAE6C,IAAI,CAAC/C,GAAG,CAACE,IAAI,CAAC,CAAC,EAAE;MACtF0C,aAAa,CAACR,IAAI,CAAC,8BAA8B,CAAC;IACpD;;IAEA;IACA,IAAAY,sBAAQ,EAAC7C,UAAU,EAAG8C,GAAG,IAAK;MAC5B,IAAIC,YAAY,GAAG,EAAE;MAErB,QAAQD,GAAG,CAAC/C,IAAI;QACd,KAAK,kBAAkB;UAAE;YACvB,MAAMiD,QAAQ,GAAG,8DAAgEF,GAAI;YACrF,IAAI,OAAO,IAAIE,QAAQ,CAACC,IAAI,IAAID,QAAQ,CAACC,IAAI,CAACC,KAAK,KAAK,OAAO,EAAE;cAC/D,IAAIF,QAAQ,CAACG,IAAI,CAACC,QAAQ,KAAKtE,aAAa,EAAE;gBAC5CkE,QAAQ,CAACG,IAAI,CAACC,QAAQ,GAAGtE,aAAa;gBACtCiE,YAAY,GAAG,iCAAiCjE,aAAa,EAAE;cACjE;YACF,CAAC,MAAM,IAAIkE,QAAQ,CAACG,IAAI,CAACE,GAAG,KAAKrE,UAAU,EAAE;cAC3CgE,QAAQ,CAACG,IAAI,CAACE,GAAG,GAAGrE,UAAU;cAC9B+D,YAAY,GAAG,uBAAuB/D,UAAU,EAAE;YACpD;YAEA;UACF;QAEA,KAAK,iBAAiB;UAAE;YACtB,MAAMgE,QAAQ,GAAG,6DAA+DF,GAAI;YACpF,IACE;YACA,CAACE,QAAQ,CAACG,IAAI,CAACG,SAAS,IAAI,OAAO,MAAMnE,oBAAoB,IAC7D,CAAC6D,QAAQ,CAACG,IAAI,CAAC7D,6BAA6B,IAAI,KAAK,MAAMA,6BAA6B,IACxF,CAAC0D,QAAQ,CAACG,IAAI,CAACI,cAAc,IAAI,EAAE,MAAMtE,iBAAiB,IAC1D,CAAC+D,QAAQ,CAACG,IAAI,CAACK,mBAAmB,IAAI,KAAK,MAAMpE,uCAAuC,EACxF;cACA4D,QAAQ,CAACG,IAAI,CAACG,SAAS,GAAGnE,oBAAoB;cAC9C6D,QAAQ,CAACG,IAAI,CAAC7D,6BAA6B,GAAGA,6BAA6B;cAC3E0D,QAAQ,CAACG,IAAI,CAACI,cAAc,GAAGtE,iBAAiB;cAChD+D,QAAQ,CAACG,IAAI,CAACK,mBAAmB,GAAGpE,uCAAuC;cAC3E2D,YAAY,GAAG,gBAAgB5D,oBAAoB,kBAAkB;YACvE;YAEA;UACF;QAEA,KAAK,sBAAsB;UAAE;YAC3B,MAAM6D,QAAQ,GAAG,kEAAoEF,GAAI;YACzF,IAAI,CAAC5D,gBAAgB,IAClB,OAAO8D,QAAQ,CAACS,GAAG,KAAK,QAAQ,IAAI,CAAE,KAAK,CAAEb,IAAI,CAACI,QAAQ,CAACS,GAAG,CAAE,KACjET,QAAQ,CAACG,IAAI,CAACO,KAAK,MAAMxE,gBAAgB,IAAIwC,SAAS,CAAC,EACvD;cACAsB,QAAQ,CAACG,IAAI,CAACO,KAAK,GAAGxE,gBAAgB,IAAIwC,SAAS;cACnDqB,YAAY,GAAG,oCAAoC7D,gBAAgB,EAAE;YACvE;YAEA;UACF;QAEA,KAAK,mBAAmB;UAAE;YACxB,MAAM8D,QAAQ,GAAG,+DAAiEF,GAAI;YAEtF,IAAI,CAACzD,cAAc,IAChB,OAAO2D,QAAQ,CAACE,KAAK,KAAK,QAAQ,IAAI,CAAE,KAAK,CAAEN,IAAI,CAACI,QAAQ,CAACE,KAAK,CAAE,KACrEF,QAAQ,CAACG,IAAI,CAACO,KAAK,MAAMrE,cAAc,IAAIqC,SAAS,CAAC,EACrD;cACAsB,QAAQ,CAACG,IAAI,CAACO,KAAK,GAAGrE,cAAc,IAAIqC,SAAS;cACjDqB,YAAY,GAAG,gBAAgB1D,cAAc,wBAAwB;YACvE;YAEA;UACF;QAEA,KAAK,sBAAsB;UAAE;YAC3B,MAAM2D,QAAQ,GAAG,kEAAoEF,GAAI;YACzF,IAAIE,QAAQ,CAACG,IAAI,CAACO,KAAK,KAAKnE,YAAY,EAAE;cACxCyD,QAAQ,CAACG,IAAI,CAACO,KAAK,GAAGnE,YAAY;cAClCwD,YAAY,GAAG,gBAAgBxD,YAAY,sBAAsB;YACnE;YAEA;UACF;QAEA,KAAK,gBAAgB;UAAE;YACrB,MAAMyD,QAAQ,GAAG,4DAA8DF,GAAI;YACnF;YACA,IAAI,CAACE,QAAQ,CAACG,IAAI,EAAEQ,OAAO,IAAI,GAAG,MAAMlE,YAAY,EAAE;cACpDuD,QAAQ,CAACG,IAAI,GAAG;gBACdQ,OAAO,EAAElE;cACX,CAAC;cACDsD,YAAY,GAAG,iBAAiBtD,YAAY,uBAAuB;YACrE;YAEA;UACF;QAEA;UACE;MACJ;MAEA,IAAIsD,YAAY,EAAE;QAChBN,aAAa,CAACR,IAAI,CAACc,YAAY,CAAC;MAClC;IACF,CAAC,CAAC;IAEF,MAAMa,eAAe,GAAG/D,GAAG,CAACE,IAAI,KAC9BP,kBAAkB,GAAG,IAAAa,uBAAS,EAACL,UAAU,CAAC,GAAGR,kBAAkB;IAEjE,IAAIiD,aAAa,CAACnB,MAAM,IAAIsC,eAAe,EAAE;MAC3C,KAAK,MAAMb,YAAY,IAAIN,aAAa,EAAE;QACxC5D,KAAK,CAACgF,WAAW,CACfd,YAAY,EAAElD,GAAG,EAAEd,WAAW,GAAGoB,GAAG,GAAG,IACzC,CAAC;MACH;MACF;MACA;IACA,CAAC,MAAM,IAAIyD,eAAe,EAAE;MAC1B/E,KAAK,CAACgF,WAAW,CACf,yCAAyC,EAAEhE,GAAG,EAAEd,WAAW,GAAGoB,GAAG,GAAG,IACtE,CAAC;IACH;EACF,CAAC;EAED,MAAMmC,IAAI,GAAGzD,KAAK,CAACiF,cAAc,CAAC,CAChC,OAAO,EACP,SAAS,EACT,MAAM,EACN,SAAS,CACV,CAAC;EACF,KAAK,MAAMjE,GAAG,IAAIyC,IAAI,EAAE;IACtB,IAAIzC,GAAG,CAACE,IAAI,EAAE;MACZH,gBAAgB,CAACC,GAAG,CAAC;IACvB;EACF;AACF,CAAC,EAAE;EACDkE,gBAAgB,EAAE,IAAI;EACtBZ,IAAI,EAAE;IACJa,IAAI,EAAE;MACJhD,WAAW,EAAE,4BAA4B;MACzCiD,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVvF,aAAa,EAAE;UACbwF,IAAI,EAAE,CACJ,OAAO,EACP,QAAQ;QAEZ,CAAC;QACDvF,WAAW,EAAE;UACXgB,IAAI,EAAE;QACR,CAAC;QACDf,UAAU,EAAE;UACVe,IAAI,EAAE;QACR,CAAC;QACDd,iBAAiB,EAAE;UACjBc,IAAI,EAAE;QACR,CAAC;QACDb,gBAAgB,EAAE;UAChBoF,IAAI,EAAE,CACJ,QAAQ,EACR,QAAQ,EACR,IAAI;QAER,CAAC;QACDnF,oBAAoB,EAAE;UACpBmF,IAAI,EAAE,CACJ,OAAO,EACP,qBAAqB,EACrB,WAAW,EACX,WAAW,EACX,yBAAyB;QAE7B,CAAC;QACDlF,uCAAuC,EAAE;UACvCW,IAAI,EAAE;QACR,CAAC;QACDV,cAAc,EAAE;UACdiF,IAAI,EAAE,CACJ,QAAQ,EACR,QAAQ,EACR,IAAI;QAER,CAAC;QACDhF,6BAA6B,EAAE;UAC7BS,IAAI,EAAE;QACR,CAAC;QACDR,YAAY,EAAE;UACZ+E,IAAI,EAAE,CACJ,QAAQ,EACR,QAAQ;QAEZ,CAAC;QACD9E,kBAAkB,EAAE;UAClBO,IAAI,EAAE;QACR,CAAC;QACDN,YAAY,EAAE;UACZM,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAwE,MAAA,CAAAhG,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}

package/dist/rules.d.ts

@@ -765,16 +765,13 @@ export interface Rules {
           genericDot?: boolean;
           objectFieldIndent?: string;
           objectFieldQuote?: "double" | "single" | null;
-          objectFieldSeparator?:
-            | "comma"
-            | "comma-and-linebreak"
-            | "linebreak"
-            | "semicolon"
-            | "semicolon-and-linebreak"
-            | null;
+          objectFieldSeparator?: "comma" | "comma-and-linebreak" | "linebreak" | "semicolon" | "semicolon-and-linebreak";
+          objectFieldSeparatorTrailingPunctuation?: boolean;
           propertyQuotes?: "double" | "single" | null;
           separatorForSingleObjectField?: boolean;
           stringQuotes?: "double" | "single";
+          typeBracketSpacing?: string;
+          unionSpacing?: string;
         }
       ];
 

package/package.json

@@ -5,7 +5,7 @@
     "url": "http://gajus.com"
   },
   "dependencies": {
-    "@es-joy/jsdoccomment": "~0.57.0",
+    "@es-joy/jsdoccomment": "~0.58.0",
     "are-docs-informative": "^0.0.2",
     "comment-parser": "1.4.1",
     "debug": "^4.4.1",
@@ -56,7 +56,7 @@
     "glob": "^11.0.3",
     "globals": "^16.4.0",
     "husky": "^9.1.7",
-    "jsdoc-type-pratt-parser": "^5.2.0",
+    "jsdoc-type-pratt-parser": "^5.4.0",
     "json-schema": "^0.4.0",
     "json-schema-to-typescript": "^15.0.4",
     "lint-staged": "^16.1.6",
@@ -64,7 +64,7 @@
     "open-editor": "^5.1.0",
     "replace": "^1.2.2",
     "rimraf": "^6.0.1",
-    "semantic-release": "^24.2.7",
+    "semantic-release": "^24.2.8",
     "typescript": "5.9.2",
     "typescript-eslint": "^8.43.0"
   },
@@ -160,5 +160,5 @@
     "test-cov": "TIMING=1 c8 --reporter text pnpm run test-no-cov",
     "test-index": "pnpm run test-no-cov test/rules/index.js"
   },
-  "version": "55.3.0"
+  "version": "55.4.0"
 }

package/src/rules/typeFormatting.js

@@ -19,10 +19,13 @@ export default iterateJsdoc(({
     genericDot = false,
     objectFieldIndent = '',
     objectFieldQuote = null,
-    objectFieldSeparator = null,
+    objectFieldSeparator = 'comma',
+    objectFieldSeparatorTrailingPunctuation = false,
     propertyQuotes = null,
     separatorForSingleObjectField = false,
     stringQuotes = 'single',
+    typeBracketSpacing = '',
+    unionSpacing = ' ',
   } = context.options[0] || {};
 
   const {
@@ -54,7 +57,10 @@ export default iterateJsdoc(({
         return tokens.name || tokens.description;
       });
 
-      const nameAndDesc = tag.source.slice(beginNameOrDescIdx);
+      const nameAndDesc = beginNameOrDescIdx === -1 ?
+        null :
+        tag.source.slice(beginNameOrDescIdx);
+
       const initialNumber = tag.source[0].number;
       const src = [
         // Get inevitably present tag from first `tag.source`
@@ -69,7 +75,7 @@ export default iterateJsdoc(({
               postName: '',
               postType: '',
             } : {}),
-            type: '{' + firstTypeLine + (!typeLines.length && lastTypeLine === undefined ? '}' : ''),
+            type: '{' + typeBracketSpacing + firstTypeLine + (!typeLines.length && lastTypeLine === undefined ? typeBracketSpacing + '}' : ''),
           },
         },
         // Get any intervening type lines
@@ -97,14 +103,14 @@ export default iterateJsdoc(({
       // Merge any final type line and name and description
       if (
         // Name and description may be already included if present with the tag
-        beginNameOrDescIdx > 0
+        nameAndDesc && beginNameOrDescIdx > 0
       ) {
         src.push({
           number: src.length + 1,
           source: '',
           tokens: {
             ...nameAndDesc[0].tokens,
-            type: lastTypeLine + '}',
+            type: lastTypeLine + typeBracketSpacing + '}',
           },
         });
 
@@ -125,7 +131,7 @@ export default iterateJsdoc(({
             }),
           );
         }
-      } else {
+      } else if (nameAndDesc) {
         if (lastTypeLine) {
           src.push({
             number: src.length + 1,
@@ -136,7 +142,7 @@ export default iterateJsdoc(({
               postTag: '',
               start: indent + ' ',
               tag: '',
-              type: lastTypeLine + '}',
+              type: lastTypeLine + typeBracketSpacing + '}',
             },
           });
         }
@@ -171,6 +177,14 @@ export default iterateJsdoc(({
         return tg;
       });
 
+      const initialEndSource = jsdoc.source.find(({
+        tokens: {
+          end,
+        },
+      }) => {
+        return end;
+      });
+
       jsdoc.source = [
         ...jsdoc.source.slice(0, firstTagIdx),
         ...jsdoc.tags.flatMap(({
@@ -179,24 +193,34 @@ export default iterateJsdoc(({
           return source;
         }),
       ];
+
+      if (initialEndSource && !jsdoc.source.at(-1)?.tokens?.end) {
+        jsdoc.source.push(initialEndSource);
+      }
     };
 
     /** @type {string[]} */
     const errorMessages = [];
-    let needToReport = false;
+
+    if (typeBracketSpacing && (!tag.type.startsWith(typeBracketSpacing) || !tag.type.endsWith(typeBracketSpacing))) {
+      errorMessages.push(`Must have initial and final "${typeBracketSpacing}" spacing`);
+    } else if (!typeBracketSpacing && ((/^\s/v).test(tag.type) || (/\s$/v).test(tag.type))) {
+      errorMessages.push('Must have no initial spacing');
+    }
+
+    // eslint-disable-next-line complexity -- Todo
     traverse(parsedType, (nde) => {
-      let typeFound = true;
       let errorMessage = '';
-      const initialType = stringify(
-        /** @type {import('jsdoc-type-pratt-parser').RootResult} */ (nde),
-      );
+
       switch (nde.type) {
         case 'JsdocTypeGeneric': {
           const typeNode = /** @type {import('jsdoc-type-pratt-parser').GenericResult} */ (nde);
           if ('value' in typeNode.left && typeNode.left.value === 'Array') {
-            typeNode.meta.brackets = arrayBrackets;
-            errorMessage = `Array bracket style should be ${arrayBrackets}`;
-          } else {
+            if (typeNode.meta.brackets !== arrayBrackets) {
+              typeNode.meta.brackets = arrayBrackets;
+              errorMessage = `Array bracket style should be ${arrayBrackets}`;
+            }
+          } else if (typeNode.meta.dot !== genericDot) {
             typeNode.meta.dot = genericDot;
             errorMessage = `Dot usage should be ${genericDot}`;
           }
@@ -206,22 +230,31 @@ export default iterateJsdoc(({
 
         case 'JsdocTypeObject': {
           const typeNode = /** @type {import('jsdoc-type-pratt-parser').ObjectResult} */ (nde);
-          typeNode.meta.separator = objectFieldSeparator ?? undefined;
-          typeNode.meta.separatorForSingleObjectField = separatorForSingleObjectField;
-          typeNode.meta.propertyIndent = objectFieldIndent;
-          errorMessage = `Inconsistent ${objectFieldSeparator} usage`;
+          if (
+            /* c8 ignore next -- Guard */
+            (typeNode.meta.separator ?? 'comma') !== objectFieldSeparator ||
+            (typeNode.meta.separatorForSingleObjectField ?? false) !== separatorForSingleObjectField ||
+            (typeNode.meta.propertyIndent ?? '') !== objectFieldIndent ||
+            (typeNode.meta.trailingPunctuation ?? false) !== objectFieldSeparatorTrailingPunctuation
+          ) {
+            typeNode.meta.separator = objectFieldSeparator;
+            typeNode.meta.separatorForSingleObjectField = separatorForSingleObjectField;
+            typeNode.meta.propertyIndent = objectFieldIndent;
+            typeNode.meta.trailingPunctuation = objectFieldSeparatorTrailingPunctuation;
+            errorMessage = `Inconsistent ${objectFieldSeparator} separator usage`;
+          }
+
           break;
         }
 
         case 'JsdocTypeObjectField': {
           const typeNode = /** @type {import('jsdoc-type-pratt-parser').ObjectFieldResult} */ (nde);
-          if (objectFieldQuote ||
-            (typeof typeNode.key === 'string' && !(/\s/v).test(typeNode.key))
+          if ((objectFieldQuote ||
+            (typeof typeNode.key === 'string' && !(/\s/v).test(typeNode.key))) &&
+            typeNode.meta.quote !== (objectFieldQuote ?? undefined)
           ) {
             typeNode.meta.quote = objectFieldQuote ?? undefined;
             errorMessage = `Inconsistent object field quotes ${objectFieldQuote}`;
-          } else {
-            typeFound = false;
           }
 
           break;
@@ -230,13 +263,12 @@ export default iterateJsdoc(({
         case 'JsdocTypeProperty': {
           const typeNode = /** @type {import('jsdoc-type-pratt-parser').PropertyResult} */ (nde);
 
-          if (propertyQuotes ||
-            (typeof typeNode.value === 'string' && !(/\s/v).test(typeNode.value))
+          if ((propertyQuotes ||
+            (typeof typeNode.value === 'string' && !(/\s/v).test(typeNode.value))) &&
+            typeNode.meta.quote !== (propertyQuotes ?? undefined)
           ) {
             typeNode.meta.quote = propertyQuotes ?? undefined;
             errorMessage = `Inconsistent ${propertyQuotes} property quotes usage`;
-          } else {
-            typeFound = false;
           }
 
           break;
@@ -244,40 +276,64 @@ export default iterateJsdoc(({
 
         case 'JsdocTypeStringValue': {
           const typeNode = /** @type {import('jsdoc-type-pratt-parser').StringValueResult} */ (nde);
-          typeNode.meta.quote = stringQuotes;
-          errorMessage = `Inconsistent ${stringQuotes} string quotes usage`;
+          if (typeNode.meta.quote !== stringQuotes) {
+            typeNode.meta.quote = stringQuotes;
+            errorMessage = `Inconsistent ${stringQuotes} string quotes usage`;
+          }
+
+          break;
+        }
+
+        case 'JsdocTypeUnion': {
+          const typeNode = /** @type {import('jsdoc-type-pratt-parser').UnionResult} */ (nde);
+          /* c8 ignore next -- Guard */
+          if ((typeNode.meta?.spacing ?? ' ') !== unionSpacing) {
+            typeNode.meta = {
+              spacing: unionSpacing,
+            };
+            errorMessage = `Inconsistent "${unionSpacing}" union spacing usage`;
+          }
+
           break;
         }
 
         default:
-          typeFound = false;
           break;
       }
 
-      if (typeFound) {
-        const convertedType = stringify(/** @type {import('jsdoc-type-pratt-parser').RootResult} */ (nde));
-        if (initialType !== convertedType) {
-          needToReport = true;
-          errorMessages.push(errorMessage);
-        }
+      if (errorMessage) {
+        errorMessages.push(errorMessage);
       }
     });
 
-    if (needToReport) {
+    const differentResult = tag.type !==
+      typeBracketSpacing + stringify(parsedType) + typeBracketSpacing;
+
+    if (errorMessages.length && differentResult) {
       for (const errorMessage of errorMessages) {
         utils.reportJSDoc(
-          errorMessage, tag, enableFixer ? fix : null, true,
+          errorMessage, tag, enableFixer ? fix : null,
         );
       }
+    // Stringification may have been equal previously (and thus no error reported)
+    //   because the stringification doesn't preserve everything
+    } else if (differentResult) {
+      utils.reportJSDoc(
+        'There was an error with type formatting', tag, enableFixer ? fix : null,
+      );
     }
   };
 
   const tags = utils.getPresentTags([
     'param',
     'returns',
+    'type',
+    'typedef',
   ]);
   for (const tag of tags) {
-    checkTypeFormats(tag);
+    if (tag.type) {
+      checkTypeFormats(tag);
+    }
   }
 }, {
   iterateAllJsdocs: true,
@@ -320,9 +376,11 @@ export default iterateJsdoc(({
               'linebreak',
               'semicolon',
               'semicolon-and-linebreak',
-              null,
             ],
           },
+          objectFieldSeparatorTrailingPunctuation: {
+            type: 'boolean',
+          },
           propertyQuotes: {
             enum: [
               'double',
@@ -339,6 +397,12 @@ export default iterateJsdoc(({
               'single',
             ],
           },
+          typeBracketSpacing: {
+            type: 'string',
+          },
+          unionSpacing: {
+            type: 'string',
+          },
         },
         type: 'object',
       },

package/src/rules.d.ts

@@ -765,16 +765,13 @@ export interface Rules {
           genericDot?: boolean;
           objectFieldIndent?: string;
           objectFieldQuote?: "double" | "single" | null;
-          objectFieldSeparator?:
-            | "comma"
-            | "comma-and-linebreak"
-            | "linebreak"
-            | "semicolon"
-            | "semicolon-and-linebreak"
-            | null;
+          objectFieldSeparator?: "comma" | "comma-and-linebreak" | "linebreak" | "semicolon" | "semicolon-and-linebreak";
+          objectFieldSeparatorTrailingPunctuation?: boolean;
           propertyQuotes?: "double" | "single" | null;
           separatorForSingleObjectField?: boolean;
           stringQuotes?: "double" | "single";
+          typeBracketSpacing?: string;
+          unionSpacing?: string;
         }
       ];