eslint-plugin-jsdoc 55.2.0 → 55.3.0

package/dist/rules/typeFormatting.cjs

@@ -0,0 +1,289 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
+var _jsdoccomment = require("@es-joy/jsdoccomment");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+var _default = exports.default = (0, _iterateJsdoc.default)(({
+  context,
+  indent,
+  jsdoc,
+  settings,
+  utils
+}) => {
+  const {
+    arrayBrackets = 'square',
+    enableFixer = true,
+    genericDot = false,
+    objectFieldIndent = '',
+    objectFieldQuote = null,
+    objectFieldSeparator = null,
+    propertyQuotes = null,
+    separatorForSingleObjectField = false,
+    stringQuotes = 'single'
+  } = context.options[0] || {};
+  const {
+    mode
+  } = settings;
+
+  /**
+   * @param {import('@es-joy/jsdoccomment').JsdocTagWithInline} tag
+   */
+  const checkTypeFormats = tag => {
+    const potentialType = tag.type;
+    let parsedType;
+    try {
+      parsedType = mode === 'permissive' ? (0, _jsdoccomment.tryParse)(/** @type {string} */potentialType) : (0, _jsdoccomment.parse)(/** @type {string} */potentialType, mode);
+    } catch {
+      return;
+    }
+    const fix = () => {
+      const typeLines = (0, _jsdoccomment.stringify)(parsedType).split('\n');
+      const firstTypeLine = typeLines.shift();
+      const lastTypeLine = typeLines.pop();
+      const beginNameOrDescIdx = tag.source.findIndex(({
+        tokens
+      }) => {
+        return tokens.name || tokens.description;
+      });
+      const nameAndDesc = tag.source.slice(beginNameOrDescIdx);
+      const initialNumber = tag.source[0].number;
+      const src = [
+      // Get inevitably present tag from first `tag.source`
+      {
+        number: initialNumber,
+        source: '',
+        tokens: {
+          ...tag.source[0].tokens,
+          ...(typeLines.length || lastTypeLine ? {
+            end: '',
+            name: '',
+            postName: '',
+            postType: ''
+          } : {}),
+          type: '{' + firstTypeLine + (!typeLines.length && lastTypeLine === undefined ? '}' : '')
+        }
+      },
+      // Get any intervening type lines
+      ...(typeLines.length ? typeLines.map((typeLine, idx) => {
+        return {
+          number: initialNumber + idx + 1,
+          source: '',
+          tokens: {
+            // Grab any delimiter info from first item
+            ...tag.source[0].tokens,
+            delimiter: tag.source[0].tokens.delimiter === '/**' ? '*' : tag.source[0].tokens.delimiter,
+            end: '',
+            name: '',
+            postName: '',
+            postTag: '',
+            postType: '',
+            start: indent + ' ',
+            tag: '',
+            type: typeLine
+          }
+        };
+      }) : [])];
+
+      // Merge any final type line and name and description
+      if (
+      // Name and description may be already included if present with the tag
+      beginNameOrDescIdx > 0) {
+        src.push({
+          number: src.length + 1,
+          source: '',
+          tokens: {
+            ...nameAndDesc[0].tokens,
+            type: lastTypeLine + '}'
+          }
+        });
+        if (
+        // Get any remaining description lines
+        nameAndDesc.length > 1) {
+          src.push(...nameAndDesc.slice(1).map(({
+            source,
+            tokens
+          }, idx) => {
+            return {
+              number: src.length + idx + 2,
+              source,
+              tokens
+            };
+          }));
+        }
+      } else {
+        if (lastTypeLine) {
+          src.push({
+            number: src.length + 1,
+            source: '',
+            tokens: {
+              ...nameAndDesc[0].tokens,
+              delimiter: nameAndDesc[0].tokens.delimiter === '/**' ? '*' : nameAndDesc[0].tokens.delimiter,
+              postTag: '',
+              start: indent + ' ',
+              tag: '',
+              type: lastTypeLine + '}'
+            }
+          });
+        }
+        if (
+        // Get any remaining description lines
+        nameAndDesc.length > 1) {
+          src.push(...nameAndDesc.slice(1).map(({
+            source,
+            tokens
+          }, idx) => {
+            return {
+              number: src.length + idx + 2,
+              source,
+              tokens
+            };
+          }));
+        }
+      }
+      tag.source = src;
+
+      // Properly rewire `jsdoc.source`
+      const firstTagIdx = jsdoc.source.findIndex(({
+        tokens: {
+          tag: tg
+        }
+      }) => {
+        return tg;
+      });
+      jsdoc.source = [...jsdoc.source.slice(0, firstTagIdx), ...jsdoc.tags.flatMap(({
+        source
+      }) => {
+        return source;
+      })];
+    };
+
+    /** @type {string[]} */
+    const errorMessages = [];
+    let needToReport = false;
+    (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 {
+              typeNode.meta.dot = genericDot;
+              errorMessage = `Dot usage should be ${genericDot}`;
+            }
+            break;
+          }
+        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`;
+            break;
+          }
+        case 'JsdocTypeObjectField':
+          {
+            const typeNode = /** @type {import('jsdoc-type-pratt-parser').ObjectFieldResult} */nde;
+            if (objectFieldQuote || typeof typeNode.key === 'string' && !/\s/v.test(typeNode.key)) {
+              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)) {
+              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`;
+            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 (needToReport) {
+      for (const errorMessage of errorMessages) {
+        utils.reportJSDoc(errorMessage, tag, enableFixer ? fix : null, true);
+      }
+    }
+  };
+  const tags = utils.getPresentTags(['param', 'returns']);
+  for (const tag of tags) {
+    checkTypeFormats(tag);
+  }
+}, {
+  iterateAllJsdocs: true,
+  meta: {
+    docs: {
+      description: 'Formats JSDoc type values.',
+      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/type-formatting.md#repos-sticky-header'
+    },
+    fixable: 'code',
+    schema: [{
+      additionalProperties: false,
+      properties: {
+        arrayBrackets: {
+          enum: ['angle', 'square']
+        },
+        enableFixer: {
+          type: 'boolean'
+        },
+        genericDot: {
+          type: 'boolean'
+        },
+        objectFieldIndent: {
+          type: 'string'
+        },
+        objectFieldQuote: {
+          enum: ['double', 'single', null]
+        },
+        objectFieldSeparator: {
+          enum: ['comma', 'comma-and-linebreak', 'linebreak', 'semicolon', 'semicolon-and-linebreak', null]
+        },
+        propertyQuotes: {
+          enum: ['double', 'single', null]
+        },
+        separatorForSingleObjectField: {
+          type: 'boolean'
+        },
+        stringQuotes: {
+          enum: ['double', 'single']
+        }
+      },
+      type: 'object'
+    }],
+    type: 'suggestion'
+  }
+});
+module.exports = exports.default;
+//# sourceMappingURL=typeFormatting.cjs.map

package/dist/rules/typeFormatting.cjs.map

@@ -0,0 +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":[]}

package/dist/rules/typeFormatting.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("eslint").Rule.RuleModule;
+export default _default;
+//# sourceMappingURL=typeFormatting.d.ts.map

package/dist/rules.d.ts

@@ -756,6 +756,28 @@ export interface Rules {
         }
       ];
 
+  "jsdoc/type-formatting": 
+    | []
+    | [
+        {
+          arrayBrackets?: "angle" | "square";
+          enableFixer?: boolean;
+          genericDot?: boolean;
+          objectFieldIndent?: string;
+          objectFieldQuote?: "double" | "single" | null;
+          objectFieldSeparator?:
+            | "comma"
+            | "comma-and-linebreak"
+            | "linebreak"
+            | "semicolon"
+            | "semicolon-and-linebreak"
+            | null;
+          propertyQuotes?: "double" | "single" | null;
+          separatorForSingleObjectField?: boolean;
+          stringQuotes?: "double" | "single";
+        }
+      ];
+
   "jsdoc/valid-types": 
     | []
     | [

package/package.json

@@ -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.2.0"
+  "version": "55.3.0"
 }

package/src/index-cjs.js

@@ -57,6 +57,7 @@ import requireYieldsCheck from './rules/requireYieldsCheck.js';
 import sortTags from './rules/sortTags.js';
 import tagLines from './rules/tagLines.js';
 import textEscaping from './rules/textEscaping.js';
+import typeFormatting from './rules/typeFormatting.js';
 import validTypes from './rules/validTypes.js';
 
 /* eslint-disable jsdoc/valid-types -- Bug */
@@ -129,6 +130,7 @@ index.rules = {
   'sort-tags': sortTags,
   'tag-lines': tagLines,
   'text-escaping': textEscaping,
+  'type-formatting': typeFormatting,
   'valid-types': validTypes,
 };
 
@@ -206,6 +208,7 @@ const createRecommendedRuleset = (warnOrError, flatName) => {
       'jsdoc/sort-tags': 'off',
       'jsdoc/tag-lines': warnOrError,
       'jsdoc/text-escaping': 'off',
+      'jsdoc/type-formatting': 'off',
       'jsdoc/valid-types': warnOrError,
     },
   };

package/src/index.js

@@ -63,6 +63,7 @@ import requireYieldsCheck from './rules/requireYieldsCheck.js';
 import sortTags from './rules/sortTags.js';
 import tagLines from './rules/tagLines.js';
 import textEscaping from './rules/textEscaping.js';
+import typeFormatting from './rules/typeFormatting.js';
 import validTypes from './rules/validTypes.js';
 
 /* eslint-disable jsdoc/valid-types -- Bug */
@@ -135,6 +136,7 @@ index.rules = {
   'sort-tags': sortTags,
   'tag-lines': tagLines,
   'text-escaping': textEscaping,
+  'type-formatting': typeFormatting,
   'valid-types': validTypes,
 };
 
@@ -212,6 +214,7 @@ const createRecommendedRuleset = (warnOrError, flatName) => {
       'jsdoc/sort-tags': 'off',
       'jsdoc/tag-lines': warnOrError,
       'jsdoc/text-escaping': 'off',
+      'jsdoc/type-formatting': 'off',
       'jsdoc/valid-types': warnOrError,
     },
   };