eslint-plugin-jsdoc 61.0.1 → 61.1.0

package/dist/rules/tsMethodSignatureStyle.cjs

@@ -0,0 +1,240 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
+var _jsdocUtils = require("../jsdocUtils.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,
+  utils
+}) => {
+  const functionType = context.options[0] ?? 'property';
+  const {
+    enableFixer = true
+  } = context.options[1] ?? {};
+
+  /**
+   * @param {import('@es-joy/jsdoccomment').JsdocTagWithInline} tag
+   */
+  const checkType = tag => {
+    const potentialType = tag.type;
+    let parsedType;
+    try {
+      parsedType = (0, _jsdoccomment.parse)(/** @type {string} */potentialType, 'typescript');
+    } catch {
+      return;
+    }
+    (0, _jsdoccomment.traverse)(parsedType, (nde, parentNode) => {
+      // @ts-expect-error Adding our own property for use below
+      nde.parentNode = parentNode;
+    });
+    (0, _jsdoccomment.traverse)(parsedType, (nde, parentNode, property, idx) => {
+      switch (nde.type) {
+        case 'JsdocTypeFunction':
+          {
+            if (functionType !== 'method') {
+              break;
+            }
+            if (parentNode?.type === 'JsdocTypeObjectField' && typeof parentNode.key === 'string') {
+              utils.reportJSDoc('Found function property; prefer method signature.', tag, enableFixer ? () => {
+                const objectField = parentNode;
+                const obj =
+                /**
+                 * @type {import('jsdoc-type-pratt-parser').ObjectFieldResult & {
+                 *   parentNode: import('jsdoc-type-pratt-parser').ObjectResult
+                 * }}
+                 */
+                objectField.parentNode;
+                const index = obj.elements.indexOf(parentNode);
+                obj.elements[index] = {
+                  /* c8 ignore next 5 -- Guard */
+                  meta: nde.meta ? {
+                    quote: objectField.meta.quote,
+                    ...nde.meta
+                  } : {
+                    quote: objectField.meta.quote
+                  },
+                  name: (/** @type {string} */objectField.key),
+                  parameters: nde.parameters,
+                  returnType: (/** @type {import('jsdoc-type-pratt-parser').RootResult} */
+                  nde.returnType),
+                  type: 'JsdocTypeMethodSignature',
+                  typeParameters: nde.typeParameters
+                };
+                (0, _jsdocUtils.rewireByParsedType)(jsdoc, tag, parsedType, indent);
+              } : null);
+              break;
+            }
+            if (parentNode?.type === 'JsdocTypeParenthesis' &&
+            // @ts-expect-error Our own added API
+            parentNode.parentNode?.type === 'JsdocTypeIntersection' &&
+            // @ts-expect-error Our own added API
+            parentNode.parentNode.parentNode.type === 'JsdocTypeObjectField' &&
+            // @ts-expect-error Our own added API
+            typeof parentNode.parentNode.parentNode.key === 'string') {
+              // @ts-expect-error Our own added API
+              const intersection = parentNode.parentNode;
+              const objectField = intersection.parentNode;
+              const object = objectField.parentNode;
+              // const objFieldIndex = object.elements.indexOf(objectField);
+
+              /**
+               * @param {import('jsdoc-type-pratt-parser').FunctionResult} func
+               */
+              const convertToMethod = func => {
+                return /** @type {import('jsdoc-type-pratt-parser').MethodSignatureResult} */{
+                  /* c8 ignore next 5 -- Guard */
+                  meta: func.meta ? {
+                    quote: objectField.meta.quote,
+                    ...func.meta
+                  } : {
+                    quote: objectField.meta.quote
+                  },
+                  name: (/** @type {string} */objectField.key),
+                  parameters: func.parameters,
+                  returnType: (/** @type {import('jsdoc-type-pratt-parser').RootResult} */
+                  func.returnType),
+                  type: 'JsdocTypeMethodSignature',
+                  typeParameters: func.typeParameters
+                };
+              };
+
+              /** @type {import('jsdoc-type-pratt-parser').MethodSignatureResult[]} */
+              const methods = [];
+              /** @type {number[]} */
+              const methodIndexes = [];
+              for (const [index, element] of intersection.elements.entries()) {
+                if (element.type !== 'JsdocTypeParenthesis' || element.element.type !== 'JsdocTypeFunction') {
+                  return;
+                }
+                methods.push(convertToMethod(element.element));
+                methodIndexes.push(index);
+              }
+              utils.reportJSDoc('Found function property; prefer method signature.', tag, enableFixer ? () => {
+                for (const methodIndex of methodIndexes.toReversed()) {
+                  object.elements.splice(methodIndex, 1);
+                }
+                object.elements.splice(methodIndexes[0], 0, ...methods);
+                (0, _jsdocUtils.rewireByParsedType)(jsdoc, tag, parsedType, indent);
+              } : null);
+            }
+            break;
+          }
+        case 'JsdocTypeMethodSignature':
+          {
+            if (functionType !== 'property') {
+              break;
+            }
+
+            /**
+             * @param {import('jsdoc-type-pratt-parser').MethodSignatureResult} node
+             */
+            const convertToFunction = node => {
+              return {
+                arrow: true,
+                constructor: false,
+                meta: (/** @type {Required<import('jsdoc-type-pratt-parser').MethodSignatureResult['meta']>} */
+                node.meta),
+                parameters: node.parameters,
+                parenthesis: true,
+                returnType: node.returnType,
+                type: 'JsdocTypeFunction',
+                typeParameters: node.typeParameters
+              };
+            };
+            utils.reportJSDoc('Found method signature; prefer function property.', tag, enableFixer ? () => {
+              /* c8 ignore next 3 -- TS guard */
+              if (!parentNode || !property || typeof idx !== 'number') {
+                throw new Error('Unexpected lack of parent or property');
+              }
+              const object = /** @type {import('jsdoc-type-pratt-parser').ObjectResult} */
+              parentNode;
+              const funcs = [];
+              const removals = [];
+              for (const [index, element] of object.elements.entries()) {
+                if (element.type === 'JsdocTypeMethodSignature' && element.name === nde.name) {
+                  funcs.push(convertToFunction(element));
+                  if (index !== idx) {
+                    removals.push(index);
+                  }
+                }
+              }
+              if (funcs.length === 1) {
+                object.elements[idx] = /** @type {import('jsdoc-type-pratt-parser').ObjectFieldResult} */{
+                  key: nde.name,
+                  meta: nde.meta,
+                  optional: false,
+                  readonly: false,
+                  right: funcs[0],
+                  type: 'JsdocTypeObjectField'
+                };
+              } else {
+                for (const removal of removals.toReversed()) {
+                  object.elements.splice(removal, 1);
+                }
+                object.elements[idx] = {
+                  key: nde.name,
+                  meta: nde.meta,
+                  optional: false,
+                  readonly: false,
+                  right: {
+                    elements: funcs.map(func => {
+                      return /** @type {import('jsdoc-type-pratt-parser').ParenthesisResult} */{
+                        element: func,
+                        type: 'JsdocTypeParenthesis'
+                      };
+                    }),
+                    type: 'JsdocTypeIntersection'
+                  },
+                  type: 'JsdocTypeObjectField'
+                };
+              }
+              (0, _jsdocUtils.rewireByParsedType)(jsdoc, tag, parsedType, indent);
+            } : null);
+          }
+          break;
+      }
+    });
+  };
+  const tags = utils.filterTags(({
+    tag
+  }) => {
+    return Boolean(tag !== 'import' && utils.tagMightHaveTypePosition(tag));
+  });
+  for (const tag of tags) {
+    if (tag.type) {
+      checkType(tag);
+    }
+  }
+}, {
+  iterateAllJsdocs: true,
+  meta: {
+    docs: {
+      description: 'Prefers either function properties or method signatures',
+      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/ts-method-signature-style.md#repos-sticky-header'
+    },
+    fixable: 'code',
+    schema: [{
+      enum: ['method', 'property'],
+      type: 'string'
+    }, {
+      additionalProperties: false,
+      properties: {
+        enableFixer: {
+          description: 'Whether to enable the fixer. Defaults to `true`.',
+          type: 'boolean'
+        }
+      },
+      type: 'object'
+    }],
+    type: 'suggestion'
+  }
+});
+module.exports = exports.default;
+//# sourceMappingURL=tsMethodSignatureStyle.cjs.map

package/dist/rules/tsMethodSignatureStyle.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"tsMethodSignatureStyle.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","_jsdocUtils","_jsdoccomment","e","__esModule","default","_default","exports","iterateJsdoc","context","indent","jsdoc","utils","functionType","options","enableFixer","checkType","tag","potentialType","type","parsedType","parseType","traverse","nde","parentNode","property","idx","key","reportJSDoc","objectField","obj","index","elements","indexOf","meta","quote","name","parameters","returnType","typeParameters","rewireByParsedType","intersection","object","convertToMethod","func","methods","methodIndexes","element","entries","push","methodIndex","toReversed","splice","convertToFunction","node","arrow","constructor","parenthesis","Error","funcs","removals","length","optional","readonly","right","removal","map","tags","filterTags","Boolean","tagMightHaveTypePosition","iterateAllJsdocs","docs","description","url","fixable","schema","enum","additionalProperties","properties","module"],"sources":["../../src/rules/tsMethodSignatureStyle.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  rewireByParsedType,\n} from '../jsdocUtils.js';\nimport {\n  parse as parseType,\n  traverse,\n} from '@es-joy/jsdoccomment';\n\nexport default iterateJsdoc(({\n  context,\n  indent,\n  jsdoc,\n  utils,\n}) => {\n  const functionType = context.options[0] ?? 'property';\n  const {\n    enableFixer = true,\n  } = context.options[1] ?? {};\n\n  /**\n   * @param {import('@es-joy/jsdoccomment').JsdocTagWithInline} tag\n   */\n  const checkType = (tag) => {\n    const potentialType = tag.type;\n    let parsedType;\n    try {\n      parsedType = parseType(\n        /** @type {string} */ (potentialType), 'typescript',\n      );\n    } catch {\n      return;\n    }\n\n    traverse(parsedType, (nde, parentNode) => {\n      // @ts-expect-error Adding our own property for use below\n      nde.parentNode = parentNode;\n    });\n\n    traverse(parsedType, (nde, parentNode, property, idx) => {\n      switch (nde.type) {\n        case 'JsdocTypeFunction': {\n          if (functionType !== 'method') {\n            break;\n          }\n\n          if (parentNode?.type === 'JsdocTypeObjectField' &&\n            typeof parentNode.key === 'string'\n          ) {\n            utils.reportJSDoc(\n              'Found function property; prefer method signature.',\n              tag,\n              enableFixer ? () => {\n                const objectField = parentNode;\n                const obj =\n                  /**\n                   * @type {import('jsdoc-type-pratt-parser').ObjectFieldResult & {\n                   *   parentNode: import('jsdoc-type-pratt-parser').ObjectResult\n                   * }}\n                   */\n                  (objectField).parentNode;\n\n                const index = obj.elements.indexOf(parentNode);\n\n                obj.elements[index] = {\n                  /* c8 ignore next 5 -- Guard */\n                  meta: nde.meta ?\n                    {\n                      quote: objectField.meta.quote,\n                      ...nde.meta,\n                    } :\n                    {\n                      quote: objectField.meta.quote,\n                    },\n                  name: /** @type {string} */ (objectField.key),\n                  parameters: nde.parameters,\n                  returnType: /** @type {import('jsdoc-type-pratt-parser').RootResult} */ (\n                    nde.returnType\n                  ),\n                  type: 'JsdocTypeMethodSignature',\n                  typeParameters: nde.typeParameters,\n                };\n\n                rewireByParsedType(jsdoc, tag, parsedType, indent);\n              } : null,\n            );\n            break;\n          }\n\n          if (parentNode?.type === 'JsdocTypeParenthesis' &&\n            // @ts-expect-error Our own added API\n            parentNode.parentNode?.type === 'JsdocTypeIntersection' &&\n            // @ts-expect-error Our own added API\n            parentNode.parentNode.parentNode.type === 'JsdocTypeObjectField' &&\n            // @ts-expect-error Our own added API\n            typeof parentNode.parentNode.parentNode.key === 'string'\n          ) {\n            // @ts-expect-error Our own added API\n            const intersection = parentNode.parentNode;\n            const objectField = intersection.parentNode;\n            const object = objectField.parentNode;\n            // const objFieldIndex = object.elements.indexOf(objectField);\n\n            /**\n             * @param {import('jsdoc-type-pratt-parser').FunctionResult} func\n             */\n            const convertToMethod = (func) => {\n              return /** @type {import('jsdoc-type-pratt-parser').MethodSignatureResult} */ ({\n                /* c8 ignore next 5 -- Guard */\n                meta: func.meta ?\n                  {\n                    quote: objectField.meta.quote,\n                    ...func.meta,\n                  } :\n                  {\n                    quote: objectField.meta.quote,\n                  },\n                name: /** @type {string} */ (objectField.key),\n                parameters: func.parameters,\n                returnType: /** @type {import('jsdoc-type-pratt-parser').RootResult} */ (\n                  func.returnType\n                ),\n                type: 'JsdocTypeMethodSignature',\n                typeParameters: func.typeParameters,\n              });\n            };\n\n            /** @type {import('jsdoc-type-pratt-parser').MethodSignatureResult[]} */\n            const methods = [];\n            /** @type {number[]} */\n            const methodIndexes = [];\n            for (const [\n              index,\n              element,\n            ] of intersection.elements.entries()) {\n              if (\n                element.type !== 'JsdocTypeParenthesis' ||\n                element.element.type !== 'JsdocTypeFunction'\n              ) {\n                return;\n              }\n\n              methods.push(convertToMethod(element.element));\n              methodIndexes.push(index);\n            }\n\n            utils.reportJSDoc(\n              'Found function property; prefer method signature.',\n              tag,\n              enableFixer ? () => {\n                for (const methodIndex of methodIndexes.toReversed()) {\n                  object.elements.splice(methodIndex, 1);\n                }\n\n                object.elements.splice(methodIndexes[0], 0, ...methods);\n\n                rewireByParsedType(jsdoc, tag, parsedType, indent);\n              } : null,\n            );\n          }\n\n          break;\n        }\n\n        case 'JsdocTypeMethodSignature': {\n          if (functionType !== 'property') {\n            break;\n          }\n\n          /**\n           * @param {import('jsdoc-type-pratt-parser').MethodSignatureResult} node\n           */\n          const convertToFunction = (node) => {\n            return {\n              arrow: true,\n              constructor: false,\n              meta: /** @type {Required<import('jsdoc-type-pratt-parser').MethodSignatureResult['meta']>} */ (\n                node.meta\n              ),\n              parameters: node.parameters,\n              parenthesis: true,\n              returnType: node.returnType,\n              type: 'JsdocTypeFunction',\n              typeParameters: node.typeParameters,\n            };\n          };\n\n          utils.reportJSDoc(\n            'Found method signature; prefer function property.',\n            tag,\n            enableFixer ? () => {\n              /* c8 ignore next 3 -- TS guard */\n              if (!parentNode || !property || typeof idx !== 'number') {\n                throw new Error('Unexpected lack of parent or property');\n              }\n\n              const object = /** @type {import('jsdoc-type-pratt-parser').ObjectResult} */ (\n                parentNode\n              );\n\n              const funcs = [];\n              const removals = [];\n\n              for (const [\n                index,\n                element,\n              ] of object.elements.entries()) {\n                if (element.type === 'JsdocTypeMethodSignature' &&\n                  element.name === nde.name\n                ) {\n                  funcs.push(convertToFunction(element));\n                  if (index !== idx) {\n                    removals.push(index);\n                  }\n                }\n              }\n\n              if (funcs.length === 1) {\n                object.elements[idx] = /** @type {import('jsdoc-type-pratt-parser').ObjectFieldResult} */ ({\n                  key: nde.name,\n                  meta: nde.meta,\n                  optional: false,\n                  readonly: false,\n                  right: funcs[0],\n                  type: 'JsdocTypeObjectField',\n                });\n              } else {\n                for (const removal of removals.toReversed()) {\n                  object.elements.splice(removal, 1);\n                }\n\n                object.elements[idx] = {\n                  key: nde.name,\n                  meta: nde.meta,\n                  optional: false,\n                  readonly: false,\n                  right: {\n                    elements: funcs.map((func) => {\n                      return /** @type {import('jsdoc-type-pratt-parser').ParenthesisResult} */ ({\n                        element: func,\n                        type: 'JsdocTypeParenthesis',\n                      });\n                    }),\n                    type: 'JsdocTypeIntersection',\n                  },\n                  type: 'JsdocTypeObjectField',\n                };\n              }\n\n              rewireByParsedType(jsdoc, tag, parsedType, indent);\n            } : null,\n          );\n        }\n\n          break;\n      }\n    });\n  };\n\n  const tags = utils.filterTags(({\n    tag,\n  }) => {\n    return Boolean(tag !== 'import' && utils.tagMightHaveTypePosition(tag));\n  });\n\n  for (const tag of tags) {\n    if (tag.type) {\n      checkType(tag);\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Prefers either function properties or method signatures',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/ts-method-signature-style.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        enum: [\n          'method',\n          'property',\n        ],\n        type: 'string',\n      },\n      {\n        additionalProperties: false,\n        properties: {\n          enableFixer: {\n            description: 'Whether to enable the fixer. Defaults to `true`.',\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,WAAA,GAAAD,OAAA;AAGA,IAAAE,aAAA,GAAAF,OAAA;AAG8B,SAAAD,uBAAAI,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;AACF,CAAC,KAAK;EACJ,MAAMC,YAAY,GAAGJ,OAAO,CAACK,OAAO,CAAC,CAAC,CAAC,IAAI,UAAU;EACrD,MAAM;IACJC,WAAW,GAAG;EAChB,CAAC,GAAGN,OAAO,CAACK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;;EAE5B;AACF;AACA;EACE,MAAME,SAAS,GAAIC,GAAG,IAAK;IACzB,MAAMC,aAAa,GAAGD,GAAG,CAACE,IAAI;IAC9B,IAAIC,UAAU;IACd,IAAI;MACFA,UAAU,GAAG,IAAAC,mBAAS,EACpB,qBAAuBH,aAAa,EAAG,YACzC,CAAC;IACH,CAAC,CAAC,MAAM;MACN;IACF;IAEA,IAAAI,sBAAQ,EAACF,UAAU,EAAE,CAACG,GAAG,EAAEC,UAAU,KAAK;MACxC;MACAD,GAAG,CAACC,UAAU,GAAGA,UAAU;IAC7B,CAAC,CAAC;IAEF,IAAAF,sBAAQ,EAACF,UAAU,EAAE,CAACG,GAAG,EAAEC,UAAU,EAAEC,QAAQ,EAAEC,GAAG,KAAK;MACvD,QAAQH,GAAG,CAACJ,IAAI;QACd,KAAK,mBAAmB;UAAE;YACxB,IAAIN,YAAY,KAAK,QAAQ,EAAE;cAC7B;YACF;YAEA,IAAIW,UAAU,EAAEL,IAAI,KAAK,sBAAsB,IAC7C,OAAOK,UAAU,CAACG,GAAG,KAAK,QAAQ,EAClC;cACAf,KAAK,CAACgB,WAAW,CACf,mDAAmD,EACnDX,GAAG,EACHF,WAAW,GAAG,MAAM;gBAClB,MAAMc,WAAW,GAAGL,UAAU;gBAC9B,MAAMM,GAAG;gBACP;AAClB;AACA;AACA;AACA;gBACmBD,WAAW,CAAEL,UAAU;gBAE1B,MAAMO,KAAK,GAAGD,GAAG,CAACE,QAAQ,CAACC,OAAO,CAACT,UAAU,CAAC;gBAE9CM,GAAG,CAACE,QAAQ,CAACD,KAAK,CAAC,GAAG;kBACpB;kBACAG,IAAI,EAAEX,GAAG,CAACW,IAAI,GACZ;oBACEC,KAAK,EAAEN,WAAW,CAACK,IAAI,CAACC,KAAK;oBAC7B,GAAGZ,GAAG,CAACW;kBACT,CAAC,GACD;oBACEC,KAAK,EAAEN,WAAW,CAACK,IAAI,CAACC;kBAC1B,CAAC;kBACHC,IAAI,GAAE,qBAAuBP,WAAW,CAACF,GAAG,CAAC;kBAC7CU,UAAU,EAAEd,GAAG,CAACc,UAAU;kBAC1BC,UAAU,GAAE;kBACVf,GAAG,CAACe,UAAU,CACf;kBACDnB,IAAI,EAAE,0BAA0B;kBAChCoB,cAAc,EAAEhB,GAAG,CAACgB;gBACtB,CAAC;gBAED,IAAAC,8BAAkB,EAAC7B,KAAK,EAAEM,GAAG,EAAEG,UAAU,EAAEV,MAAM,CAAC;cACpD,CAAC,GAAG,IACN,CAAC;cACD;YACF;YAEA,IAAIc,UAAU,EAAEL,IAAI,KAAK,sBAAsB;YAC7C;YACAK,UAAU,CAACA,UAAU,EAAEL,IAAI,KAAK,uBAAuB;YACvD;YACAK,UAAU,CAACA,UAAU,CAACA,UAAU,CAACL,IAAI,KAAK,sBAAsB;YAChE;YACA,OAAOK,UAAU,CAACA,UAAU,CAACA,UAAU,CAACG,GAAG,KAAK,QAAQ,EACxD;cACA;cACA,MAAMc,YAAY,GAAGjB,UAAU,CAACA,UAAU;cAC1C,MAAMK,WAAW,GAAGY,YAAY,CAACjB,UAAU;cAC3C,MAAMkB,MAAM,GAAGb,WAAW,CAACL,UAAU;cACrC;;cAEA;AACZ;AACA;cACY,MAAMmB,eAAe,GAAIC,IAAI,IAAK;gBAChC,OAAO,sEAAwE;kBAC7E;kBACAV,IAAI,EAAEU,IAAI,CAACV,IAAI,GACb;oBACEC,KAAK,EAAEN,WAAW,CAACK,IAAI,CAACC,KAAK;oBAC7B,GAAGS,IAAI,CAACV;kBACV,CAAC,GACD;oBACEC,KAAK,EAAEN,WAAW,CAACK,IAAI,CAACC;kBAC1B,CAAC;kBACHC,IAAI,GAAE,qBAAuBP,WAAW,CAACF,GAAG,CAAC;kBAC7CU,UAAU,EAAEO,IAAI,CAACP,UAAU;kBAC3BC,UAAU,GAAE;kBACVM,IAAI,CAACN,UAAU,CAChB;kBACDnB,IAAI,EAAE,0BAA0B;kBAChCoB,cAAc,EAAEK,IAAI,CAACL;gBACvB,CAAC;cACH,CAAC;;cAED;cACA,MAAMM,OAAO,GAAG,EAAE;cAClB;cACA,MAAMC,aAAa,GAAG,EAAE;cACxB,KAAK,MAAM,CACTf,KAAK,EACLgB,OAAO,CACR,IAAIN,YAAY,CAACT,QAAQ,CAACgB,OAAO,CAAC,CAAC,EAAE;gBACpC,IACED,OAAO,CAAC5B,IAAI,KAAK,sBAAsB,IACvC4B,OAAO,CAACA,OAAO,CAAC5B,IAAI,KAAK,mBAAmB,EAC5C;kBACA;gBACF;gBAEA0B,OAAO,CAACI,IAAI,CAACN,eAAe,CAACI,OAAO,CAACA,OAAO,CAAC,CAAC;gBAC9CD,aAAa,CAACG,IAAI,CAAClB,KAAK,CAAC;cAC3B;cAEAnB,KAAK,CAACgB,WAAW,CACf,mDAAmD,EACnDX,GAAG,EACHF,WAAW,GAAG,MAAM;gBAClB,KAAK,MAAMmC,WAAW,IAAIJ,aAAa,CAACK,UAAU,CAAC,CAAC,EAAE;kBACpDT,MAAM,CAACV,QAAQ,CAACoB,MAAM,CAACF,WAAW,EAAE,CAAC,CAAC;gBACxC;gBAEAR,MAAM,CAACV,QAAQ,CAACoB,MAAM,CAACN,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAGD,OAAO,CAAC;gBAEvD,IAAAL,8BAAkB,EAAC7B,KAAK,EAAEM,GAAG,EAAEG,UAAU,EAAEV,MAAM,CAAC;cACpD,CAAC,GAAG,IACN,CAAC;YACH;YAEA;UACF;QAEA,KAAK,0BAA0B;UAAE;YAC/B,IAAIG,YAAY,KAAK,UAAU,EAAE;cAC/B;YACF;;YAEA;AACV;AACA;YACU,MAAMwC,iBAAiB,GAAIC,IAAI,IAAK;cAClC,OAAO;gBACLC,KAAK,EAAE,IAAI;gBACXC,WAAW,EAAE,KAAK;gBAClBtB,IAAI,GAAE;gBACJoB,IAAI,CAACpB,IAAI,CACV;gBACDG,UAAU,EAAEiB,IAAI,CAACjB,UAAU;gBAC3BoB,WAAW,EAAE,IAAI;gBACjBnB,UAAU,EAAEgB,IAAI,CAAChB,UAAU;gBAC3BnB,IAAI,EAAE,mBAAmB;gBACzBoB,cAAc,EAAEe,IAAI,CAACf;cACvB,CAAC;YACH,CAAC;YAED3B,KAAK,CAACgB,WAAW,CACf,mDAAmD,EACnDX,GAAG,EACHF,WAAW,GAAG,MAAM;cAClB;cACA,IAAI,CAACS,UAAU,IAAI,CAACC,QAAQ,IAAI,OAAOC,GAAG,KAAK,QAAQ,EAAE;gBACvD,MAAM,IAAIgC,KAAK,CAAC,uCAAuC,CAAC;cAC1D;cAEA,MAAMhB,MAAM,GAAG;cACblB,UACD;cAED,MAAMmC,KAAK,GAAG,EAAE;cAChB,MAAMC,QAAQ,GAAG,EAAE;cAEnB,KAAK,MAAM,CACT7B,KAAK,EACLgB,OAAO,CACR,IAAIL,MAAM,CAACV,QAAQ,CAACgB,OAAO,CAAC,CAAC,EAAE;gBAC9B,IAAID,OAAO,CAAC5B,IAAI,KAAK,0BAA0B,IAC7C4B,OAAO,CAACX,IAAI,KAAKb,GAAG,CAACa,IAAI,EACzB;kBACAuB,KAAK,CAACV,IAAI,CAACI,iBAAiB,CAACN,OAAO,CAAC,CAAC;kBACtC,IAAIhB,KAAK,KAAKL,GAAG,EAAE;oBACjBkC,QAAQ,CAACX,IAAI,CAAClB,KAAK,CAAC;kBACtB;gBACF;cACF;cAEA,IAAI4B,KAAK,CAACE,MAAM,KAAK,CAAC,EAAE;gBACtBnB,MAAM,CAACV,QAAQ,CAACN,GAAG,CAAC,GAAG,kEAAoE;kBACzFC,GAAG,EAAEJ,GAAG,CAACa,IAAI;kBACbF,IAAI,EAAEX,GAAG,CAACW,IAAI;kBACd4B,QAAQ,EAAE,KAAK;kBACfC,QAAQ,EAAE,KAAK;kBACfC,KAAK,EAAEL,KAAK,CAAC,CAAC,CAAC;kBACfxC,IAAI,EAAE;gBACR,CAAE;cACJ,CAAC,MAAM;gBACL,KAAK,MAAM8C,OAAO,IAAIL,QAAQ,CAACT,UAAU,CAAC,CAAC,EAAE;kBAC3CT,MAAM,CAACV,QAAQ,CAACoB,MAAM,CAACa,OAAO,EAAE,CAAC,CAAC;gBACpC;gBAEAvB,MAAM,CAACV,QAAQ,CAACN,GAAG,CAAC,GAAG;kBACrBC,GAAG,EAAEJ,GAAG,CAACa,IAAI;kBACbF,IAAI,EAAEX,GAAG,CAACW,IAAI;kBACd4B,QAAQ,EAAE,KAAK;kBACfC,QAAQ,EAAE,KAAK;kBACfC,KAAK,EAAE;oBACLhC,QAAQ,EAAE2B,KAAK,CAACO,GAAG,CAAEtB,IAAI,IAAK;sBAC5B,OAAO,kEAAoE;wBACzEG,OAAO,EAAEH,IAAI;wBACbzB,IAAI,EAAE;sBACR,CAAC;oBACH,CAAC,CAAC;oBACFA,IAAI,EAAE;kBACR,CAAC;kBACDA,IAAI,EAAE;gBACR,CAAC;cACH;cAEA,IAAAqB,8BAAkB,EAAC7B,KAAK,EAAEM,GAAG,EAAEG,UAAU,EAAEV,MAAM,CAAC;YACpD,CAAC,GAAG,IACN,CAAC;UACH;UAEE;MACJ;IACF,CAAC,CAAC;EACJ,CAAC;EAED,MAAMyD,IAAI,GAAGvD,KAAK,CAACwD,UAAU,CAAC,CAAC;IAC7BnD;EACF,CAAC,KAAK;IACJ,OAAOoD,OAAO,CAACpD,GAAG,KAAK,QAAQ,IAAIL,KAAK,CAAC0D,wBAAwB,CAACrD,GAAG,CAAC,CAAC;EACzE,CAAC,CAAC;EAEF,KAAK,MAAMA,GAAG,IAAIkD,IAAI,EAAE;IACtB,IAAIlD,GAAG,CAACE,IAAI,EAAE;MACZH,SAAS,CAACC,GAAG,CAAC;IAChB;EACF;AACF,CAAC,EAAE;EACDsD,gBAAgB,EAAE,IAAI;EACtBrC,IAAI,EAAE;IACJsC,IAAI,EAAE;MACJC,WAAW,EAAE,yDAAyD;MACtEC,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,IAAI,EAAE,CACJ,QAAQ,EACR,UAAU,CACX;MACD1D,IAAI,EAAE;IACR,CAAC,EACD;MACE2D,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVhE,WAAW,EAAE;UACX0D,WAAW,EAAE,kDAAkD;UAC/DtD,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA6D,MAAA,CAAAzE,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}

package/dist/rules/tsMethodSignatureStyle.d.ts

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

package/dist/rules/tsNoEmptyObjectType.cjs

@@ -0,0 +1,62 @@
+"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)(({
+  settings,
+  utils
+}) => {
+  if (settings.mode !== 'typescript') {
+    return;
+  }
+
+  /**
+   * @param {import('@es-joy/jsdoccomment').JsdocTagWithInline} tag
+   */
+  const checkType = tag => {
+    const potentialType = tag.type;
+    let parsedType;
+    try {
+      parsedType = (0, _jsdoccomment.parse)(/** @type {string} */potentialType, 'typescript');
+    } catch {
+      return;
+    }
+    (0, _jsdoccomment.traverse)(parsedType, nde => {
+      switch (nde.type) {
+        case 'JsdocTypeObject':
+          {
+            if (!nde.elements.length) {
+              utils.reportJSDoc('No empty object type.', tag);
+            }
+          }
+      }
+    });
+  };
+  const tags = utils.filterTags(({
+    tag
+  }) => {
+    return Boolean(tag !== 'import' && utils.tagMightHaveTypePosition(tag));
+  });
+  for (const tag of tags) {
+    if (tag.type) {
+      checkType(tag);
+    }
+  }
+}, {
+  iterateAllJsdocs: true,
+  meta: {
+    docs: {
+      description: 'Warns against use of the empty object type',
+      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/ts-no-empty-object-type.md#repos-sticky-header'
+    },
+    schema: [],
+    type: 'suggestion'
+  }
+});
+module.exports = exports.default;
+//# sourceMappingURL=tsNoEmptyObjectType.cjs.map

package/dist/rules/tsNoEmptyObjectType.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"tsNoEmptyObjectType.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","_jsdoccomment","e","__esModule","default","_default","exports","iterateJsdoc","settings","utils","mode","checkType","tag","potentialType","type","parsedType","parseType","traverse","nde","elements","length","reportJSDoc","tags","filterTags","Boolean","tagMightHaveTypePosition","iterateAllJsdocs","meta","docs","description","url","schema","module"],"sources":["../../src/rules/tsNoEmptyObjectType.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  parse as parseType,\n  traverse,\n} from '@es-joy/jsdoccomment';\n\nexport default iterateJsdoc(({\n  settings,\n  utils,\n}) => {\n  if (settings.mode !== 'typescript') {\n    return;\n  }\n\n  /**\n   * @param {import('@es-joy/jsdoccomment').JsdocTagWithInline} tag\n   */\n  const checkType = (tag) => {\n    const potentialType = tag.type;\n    let parsedType;\n    try {\n      parsedType = parseType(\n        /** @type {string} */ (potentialType), 'typescript',\n      );\n    } catch {\n      return;\n    }\n\n    traverse(parsedType, (nde) => {\n      switch (nde.type) {\n        case 'JsdocTypeObject': {\n          if (!nde.elements.length) {\n            utils.reportJSDoc('No empty object type.', tag);\n          }\n        }\n      }\n    });\n  };\n\n  const tags = utils.filterTags(({\n    tag,\n  }) => {\n    return Boolean(tag !== 'import' && utils.tagMightHaveTypePosition(tag));\n  });\n\n  for (const tag of tags) {\n    if (tag.type) {\n      checkType(tag);\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Warns against use of the empty object type',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/ts-no-empty-object-type.md#repos-sticky-header',\n    },\n    schema: [],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AAG8B,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,QAAQ;EACRC;AACF,CAAC,KAAK;EACJ,IAAID,QAAQ,CAACE,IAAI,KAAK,YAAY,EAAE;IAClC;EACF;;EAEA;AACF;AACA;EACE,MAAMC,SAAS,GAAIC,GAAG,IAAK;IACzB,MAAMC,aAAa,GAAGD,GAAG,CAACE,IAAI;IAC9B,IAAIC,UAAU;IACd,IAAI;MACFA,UAAU,GAAG,IAAAC,mBAAS,EACpB,qBAAuBH,aAAa,EAAG,YACzC,CAAC;IACH,CAAC,CAAC,MAAM;MACN;IACF;IAEA,IAAAI,sBAAQ,EAACF,UAAU,EAAGG,GAAG,IAAK;MAC5B,QAAQA,GAAG,CAACJ,IAAI;QACd,KAAK,iBAAiB;UAAE;YACtB,IAAI,CAACI,GAAG,CAACC,QAAQ,CAACC,MAAM,EAAE;cACxBX,KAAK,CAACY,WAAW,CAAC,uBAAuB,EAAET,GAAG,CAAC;YACjD;UACF;MACF;IACF,CAAC,CAAC;EACJ,CAAC;EAED,MAAMU,IAAI,GAAGb,KAAK,CAACc,UAAU,CAAC,CAAC;IAC7BX;EACF,CAAC,KAAK;IACJ,OAAOY,OAAO,CAACZ,GAAG,KAAK,QAAQ,IAAIH,KAAK,CAACgB,wBAAwB,CAACb,GAAG,CAAC,CAAC;EACzE,CAAC,CAAC;EAEF,KAAK,MAAMA,GAAG,IAAIU,IAAI,EAAE;IACtB,IAAIV,GAAG,CAACE,IAAI,EAAE;MACZH,SAAS,CAACC,GAAG,CAAC;IAChB;EACF;AACF,CAAC,EAAE;EACDc,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,4CAA4C;MACzDC,GAAG,EAAE;IACP,CAAC;IACDC,MAAM,EAAE,EAAE;IACVjB,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAkB,MAAA,CAAA1B,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}

package/dist/rules/tsNoEmptyObjectType.d.ts

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

package/dist/rules/tsNoUnnecessaryTemplateExpression.cjs

@@ -0,0 +1,104 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
+var _jsdocUtils = require("../jsdocUtils.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
+}) => {
+  if (settings.mode !== 'typescript') {
+    return;
+  }
+  const {
+    enableFixer = true
+  } = context.options[0] ?? {};
+
+  /**
+   * @param {import('@es-joy/jsdoccomment').JsdocTagWithInline} tag
+   */
+  const checkType = tag => {
+    const potentialType = tag.type;
+    /** @type {import('jsdoc-type-pratt-parser').RootResult} */
+    let parsedType;
+    try {
+      parsedType = (0, _jsdoccomment.parse)(/** @type {string} */potentialType, 'typescript');
+    } catch {
+      return;
+    }
+    (0, _jsdoccomment.traverse)(parsedType, (nde, parentNode, property, index) => {
+      switch (nde.type) {
+        case 'JsdocTypeTemplateLiteral':
+          {
+            const stringInterpolationIndex = nde.interpolations.findIndex(interpolation => {
+              return interpolation.type === 'JsdocTypeStringValue';
+            });
+            if (stringInterpolationIndex > -1) {
+              utils.reportJSDoc('Found an unnecessary string literal within a template.', tag, enableFixer ? () => {
+                nde.literals.splice(stringInterpolationIndex, 2, nde.literals[stringInterpolationIndex] + /** @type {import('jsdoc-type-pratt-parser').StringValueResult} */
+                nde.interpolations[stringInterpolationIndex].value + nde.literals[stringInterpolationIndex + 1]);
+                nde.interpolations.splice(stringInterpolationIndex, 1);
+                (0, _jsdocUtils.rewireByParsedType)(jsdoc, tag, parsedType, indent);
+              } : null);
+            } else if (nde.literals.length === 2 && nde.literals[0] === '' && nde.literals[1] === '') {
+              utils.reportJSDoc('Found a lone template expression within a template.', tag, enableFixer ? () => {
+                const interpolation = nde.interpolations[0];
+                if (parentNode && property) {
+                  if (typeof index === 'number') {
+                    // @ts-expect-error Safe
+                    parentNode[property][index] = interpolation;
+                  } else {
+                    // @ts-expect-error Safe
+                    parentNode[property] = interpolation;
+                  }
+                } else {
+                  parsedType = interpolation;
+                }
+                (0, _jsdocUtils.rewireByParsedType)(jsdoc, tag, parsedType, indent);
+              } : null);
+            }
+          }
+      }
+    });
+  };
+  const tags = utils.filterTags(({
+    tag
+  }) => {
+    return Boolean(tag !== 'import' && utils.tagMightHaveTypePosition(tag));
+  });
+  for (const tag of tags) {
+    if (tag.type) {
+      checkType(tag);
+    }
+  }
+}, {
+  iterateAllJsdocs: true,
+  meta: {
+    docs: {
+      description: 'Catches unnecessary template expressions such as string expressions within a template literal.',
+      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/ts-no-unnecessary-template-expression.md#repos-sticky-header'
+    },
+    fixable: 'code',
+    schema: [{
+      additionalProperties: false,
+      properties: {
+        enableFixer: {
+          description: 'Whether to enable the fixer. Defaults to `true`.',
+          type: 'boolean'
+        }
+      },
+      type: 'object'
+    }],
+    type: 'suggestion'
+  }
+});
+module.exports = exports.default;
+//# sourceMappingURL=tsNoUnnecessaryTemplateExpression.cjs.map

package/dist/rules/tsNoUnnecessaryTemplateExpression.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"tsNoUnnecessaryTemplateExpression.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","_jsdocUtils","_jsdoccomment","e","__esModule","default","_default","exports","iterateJsdoc","context","indent","jsdoc","settings","utils","mode","enableFixer","options","checkType","tag","potentialType","type","parsedType","parseType","traverse","nde","parentNode","property","index","stringInterpolationIndex","interpolations","findIndex","interpolation","reportJSDoc","literals","splice","value","rewireByParsedType","length","tags","filterTags","Boolean","tagMightHaveTypePosition","iterateAllJsdocs","meta","docs","description","url","fixable","schema","additionalProperties","properties","module"],"sources":["../../src/rules/tsNoUnnecessaryTemplateExpression.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  rewireByParsedType,\n} from '../jsdocUtils.js';\nimport {\n  parse as parseType,\n  traverse,\n} from '@es-joy/jsdoccomment';\n\nexport default iterateJsdoc(({\n  context,\n  indent,\n  jsdoc,\n  settings,\n  utils,\n}) => {\n  if (settings.mode !== 'typescript') {\n    return;\n  }\n\n  const {\n    enableFixer = true,\n  } = context.options[0] ?? {};\n\n  /**\n   * @param {import('@es-joy/jsdoccomment').JsdocTagWithInline} tag\n   */\n  const checkType = (tag) => {\n    const potentialType = tag.type;\n    /** @type {import('jsdoc-type-pratt-parser').RootResult} */\n    let parsedType;\n    try {\n      parsedType = parseType(\n        /** @type {string} */ (potentialType), 'typescript',\n      );\n    } catch {\n      return;\n    }\n\n    traverse(parsedType, (nde, parentNode, property, index) => {\n      switch (nde.type) {\n        case 'JsdocTypeTemplateLiteral': {\n          const stringInterpolationIndex = nde.interpolations.findIndex((interpolation) => {\n            return interpolation.type === 'JsdocTypeStringValue';\n          });\n          if (stringInterpolationIndex > -1) {\n            utils.reportJSDoc(\n              'Found an unnecessary string literal within a template.',\n              tag,\n              enableFixer ? () => {\n                nde.literals.splice(\n                  stringInterpolationIndex,\n                  2,\n                  nde.literals[stringInterpolationIndex] +\n                    /** @type {import('jsdoc-type-pratt-parser').StringValueResult} */\n                    (nde.interpolations[stringInterpolationIndex]).value +\n                    nde.literals[stringInterpolationIndex + 1],\n                );\n\n                nde.interpolations.splice(\n                  stringInterpolationIndex, 1,\n                );\n\n                rewireByParsedType(jsdoc, tag, parsedType, indent);\n              } : null,\n            );\n          } else if (nde.literals.length === 2 && nde.literals[0] === '' &&\n            nde.literals[1] === ''\n          ) {\n            utils.reportJSDoc(\n              'Found a lone template expression within a template.',\n              tag,\n              enableFixer ? () => {\n                const interpolation = nde.interpolations[0];\n\n                if (parentNode && property) {\n                  if (typeof index === 'number') {\n                    // @ts-expect-error Safe\n                    parentNode[property][index] = interpolation;\n                  } else {\n                    // @ts-expect-error Safe\n                    parentNode[property] = interpolation;\n                  }\n                } else {\n                  parsedType = interpolation;\n                }\n\n                rewireByParsedType(jsdoc, tag, parsedType, indent);\n              } : null,\n            );\n          }\n        }\n      }\n    });\n  };\n\n  const tags = utils.filterTags(({\n    tag,\n  }) => {\n    return Boolean(tag !== 'import' && utils.tagMightHaveTypePosition(tag));\n  });\n\n  for (const tag of tags) {\n    if (tag.type) {\n      checkType(tag);\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Catches unnecessary template expressions such as string expressions within a template literal.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/ts-no-unnecessary-template-expression.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          enableFixer: {\n            description: 'Whether to enable the fixer. Defaults to `true`.',\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,WAAA,GAAAD,OAAA;AAGA,IAAAE,aAAA,GAAAF,OAAA;AAG8B,SAAAD,uBAAAI,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,IAAID,QAAQ,CAACE,IAAI,KAAK,YAAY,EAAE;IAClC;EACF;EAEA,MAAM;IACJC,WAAW,GAAG;EAChB,CAAC,GAAGN,OAAO,CAACO,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;;EAE5B;AACF;AACA;EACE,MAAMC,SAAS,GAAIC,GAAG,IAAK;IACzB,MAAMC,aAAa,GAAGD,GAAG,CAACE,IAAI;IAC9B;IACA,IAAIC,UAAU;IACd,IAAI;MACFA,UAAU,GAAG,IAAAC,mBAAS,EACpB,qBAAuBH,aAAa,EAAG,YACzC,CAAC;IACH,CAAC,CAAC,MAAM;MACN;IACF;IAEA,IAAAI,sBAAQ,EAACF,UAAU,EAAE,CAACG,GAAG,EAAEC,UAAU,EAAEC,QAAQ,EAAEC,KAAK,KAAK;MACzD,QAAQH,GAAG,CAACJ,IAAI;QACd,KAAK,0BAA0B;UAAE;YAC/B,MAAMQ,wBAAwB,GAAGJ,GAAG,CAACK,cAAc,CAACC,SAAS,CAAEC,aAAa,IAAK;cAC/E,OAAOA,aAAa,CAACX,IAAI,KAAK,sBAAsB;YACtD,CAAC,CAAC;YACF,IAAIQ,wBAAwB,GAAG,CAAC,CAAC,EAAE;cACjCf,KAAK,CAACmB,WAAW,CACf,wDAAwD,EACxDd,GAAG,EACHH,WAAW,GAAG,MAAM;gBAClBS,GAAG,CAACS,QAAQ,CAACC,MAAM,CACjBN,wBAAwB,EACxB,CAAC,EACDJ,GAAG,CAACS,QAAQ,CAACL,wBAAwB,CAAC,GACpC;gBACCJ,GAAG,CAACK,cAAc,CAACD,wBAAwB,CAAC,CAAEO,KAAK,GACpDX,GAAG,CAACS,QAAQ,CAACL,wBAAwB,GAAG,CAAC,CAC7C,CAAC;gBAEDJ,GAAG,CAACK,cAAc,CAACK,MAAM,CACvBN,wBAAwB,EAAE,CAC5B,CAAC;gBAED,IAAAQ,8BAAkB,EAACzB,KAAK,EAAEO,GAAG,EAAEG,UAAU,EAAEX,MAAM,CAAC;cACpD,CAAC,GAAG,IACN,CAAC;YACH,CAAC,MAAM,IAAIc,GAAG,CAACS,QAAQ,CAACI,MAAM,KAAK,CAAC,IAAIb,GAAG,CAACS,QAAQ,CAAC,CAAC,CAAC,KAAK,EAAE,IAC5DT,GAAG,CAACS,QAAQ,CAAC,CAAC,CAAC,KAAK,EAAE,EACtB;cACApB,KAAK,CAACmB,WAAW,CACf,qDAAqD,EACrDd,GAAG,EACHH,WAAW,GAAG,MAAM;gBAClB,MAAMgB,aAAa,GAAGP,GAAG,CAACK,cAAc,CAAC,CAAC,CAAC;gBAE3C,IAAIJ,UAAU,IAAIC,QAAQ,EAAE;kBAC1B,IAAI,OAAOC,KAAK,KAAK,QAAQ,EAAE;oBAC7B;oBACAF,UAAU,CAACC,QAAQ,CAAC,CAACC,KAAK,CAAC,GAAGI,aAAa;kBAC7C,CAAC,MAAM;oBACL;oBACAN,UAAU,CAACC,QAAQ,CAAC,GAAGK,aAAa;kBACtC;gBACF,CAAC,MAAM;kBACLV,UAAU,GAAGU,aAAa;gBAC5B;gBAEA,IAAAK,8BAAkB,EAACzB,KAAK,EAAEO,GAAG,EAAEG,UAAU,EAAEX,MAAM,CAAC;cACpD,CAAC,GAAG,IACN,CAAC;YACH;UACF;MACF;IACF,CAAC,CAAC;EACJ,CAAC;EAED,MAAM4B,IAAI,GAAGzB,KAAK,CAAC0B,UAAU,CAAC,CAAC;IAC7BrB;EACF,CAAC,KAAK;IACJ,OAAOsB,OAAO,CAACtB,GAAG,KAAK,QAAQ,IAAIL,KAAK,CAAC4B,wBAAwB,CAACvB,GAAG,CAAC,CAAC;EACzE,CAAC,CAAC;EAEF,KAAK,MAAMA,GAAG,IAAIoB,IAAI,EAAE;IACtB,IAAIpB,GAAG,CAACE,IAAI,EAAE;MACZH,SAAS,CAACC,GAAG,CAAC;IAChB;EACF;AACF,CAAC,EAAE;EACDwB,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,gGAAgG;MAC7GC,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVnC,WAAW,EAAE;UACX8B,WAAW,EAAE,kDAAkD;UAC/DzB,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA+B,MAAA,CAAA5C,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}

package/dist/rules/tsNoUnnecessaryTemplateExpression.d.ts

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

package/dist/rules/tsPreferFunctionType.cjs

@@ -0,0 +1,110 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
+var _jsdocUtils = require("../jsdocUtils.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,
+  utils
+}) => {
+  const {
+    enableFixer = true
+  } = context.options[0] || {};
+
+  /**
+   * @param {import('@es-joy/jsdoccomment').JsdocTagWithInline} tag
+   */
+  const checkType = tag => {
+    const potentialType = tag.type;
+
+    /** @type {import('jsdoc-type-pratt-parser').RootResult} */
+    let parsedType;
+    try {
+      parsedType = (0, _jsdoccomment.parse)(/** @type {string} */potentialType, 'typescript');
+    } catch {
+      return;
+    }
+    (0, _jsdoccomment.traverse)(parsedType, (nde, parentNode) => {
+      // @ts-expect-error Adding our own property for use below
+      nde.parentNode = parentNode;
+    });
+    (0, _jsdoccomment.traverse)(parsedType, (nde, parentNode, property, index) => {
+      switch (nde.type) {
+        case 'JsdocTypeCallSignature':
+          {
+            const object = /** @type {import('jsdoc-type-pratt-parser').ObjectResult} */
+            parentNode;
+            if (typeof index === 'number' && object.elements.length === 1) {
+              utils.reportJSDoc('Call signature found; function type preferred.', tag, enableFixer ? () => {
+                const func = /** @type {import('jsdoc-type-pratt-parser').FunctionResult} */{
+                  arrow: true,
+                  constructor: false,
+                  meta: (/** @type {Required<import('jsdoc-type-pratt-parser').MethodSignatureResult['meta']>} */
+                  nde.meta),
+                  parameters: nde.parameters,
+                  parenthesis: true,
+                  returnType: nde.returnType,
+                  type: 'JsdocTypeFunction',
+                  typeParameters: nde.typeParameters
+                };
+                if (property && 'parentNode' in object && object.parentNode) {
+                  if (typeof object.parentNode === 'object' && 'elements' in object.parentNode && Array.isArray(object.parentNode.elements)) {
+                    const idx = object.parentNode.elements.indexOf(object);
+                    object.parentNode.elements[idx] = func;
+                    /* c8 ignore next 6 -- Guard */
+                  } else {
+                    throw new Error(
+                    // @ts-expect-error Ok
+                    `Rule currently unable to handle type ${object.parentNode.type}`);
+                  }
+                } else {
+                  parsedType = func;
+                }
+                (0, _jsdocUtils.rewireByParsedType)(jsdoc, tag, parsedType, indent);
+              } : null);
+            }
+            break;
+          }
+      }
+    });
+  };
+  const tags = utils.filterTags(({
+    tag
+  }) => {
+    return Boolean(tag !== 'import' && utils.tagMightHaveTypePosition(tag));
+  });
+  for (const tag of tags) {
+    if (tag.type) {
+      checkType(tag);
+    }
+  }
+}, {
+  iterateAllJsdocs: true,
+  meta: {
+    docs: {
+      description: 'Prefers function types over call signatures when there are no other properties.',
+      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/ts-prefer-function-type.md#repos-sticky-header'
+    },
+    fixable: 'code',
+    schema: [{
+      additionalProperties: false,
+      properties: {
+        enableFixer: {
+          description: 'Whether to enable the fixer or not',
+          type: 'boolean'
+        }
+      },
+      type: 'object'
+    }],
+    type: 'suggestion'
+  }
+});
+module.exports = exports.default;
+//# sourceMappingURL=tsPreferFunctionType.cjs.map

package/dist/rules/tsPreferFunctionType.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"tsPreferFunctionType.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","_jsdocUtils","_jsdoccomment","e","__esModule","default","_default","exports","iterateJsdoc","context","indent","jsdoc","utils","enableFixer","options","checkType","tag","potentialType","type","parsedType","parseType","traverse","nde","parentNode","property","index","object","elements","length","reportJSDoc","func","arrow","constructor","meta","parameters","parenthesis","returnType","typeParameters","Array","isArray","idx","indexOf","Error","rewireByParsedType","tags","filterTags","Boolean","tagMightHaveTypePosition","iterateAllJsdocs","docs","description","url","fixable","schema","additionalProperties","properties","module"],"sources":["../../src/rules/tsPreferFunctionType.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  rewireByParsedType,\n} from '../jsdocUtils.js';\nimport {\n  parse as parseType,\n  traverse,\n} from '@es-joy/jsdoccomment';\n\nexport default iterateJsdoc(({\n  context,\n  indent,\n  jsdoc,\n  utils,\n}) => {\n  const {\n    enableFixer = true,\n  } = context.options[0] || {};\n\n  /**\n   * @param {import('@es-joy/jsdoccomment').JsdocTagWithInline} tag\n   */\n  const checkType = (tag) => {\n    const potentialType = tag.type;\n\n    /** @type {import('jsdoc-type-pratt-parser').RootResult} */\n    let parsedType;\n    try {\n      parsedType = parseType(\n        /** @type {string} */ (potentialType), 'typescript',\n      );\n    } catch {\n      return;\n    }\n\n    traverse(parsedType, (nde, parentNode) => {\n      // @ts-expect-error Adding our own property for use below\n      nde.parentNode = parentNode;\n    });\n\n    traverse(parsedType, (nde, parentNode, property, index) => {\n      switch (nde.type) {\n        case 'JsdocTypeCallSignature': {\n          const object = /** @type {import('jsdoc-type-pratt-parser').ObjectResult} */ (\n            parentNode\n          );\n          if (typeof index === 'number' && object.elements.length === 1) {\n            utils.reportJSDoc(\n              'Call signature found; function type preferred.',\n              tag,\n              enableFixer ? () => {\n                const func = /** @type {import('jsdoc-type-pratt-parser').FunctionResult} */ ({\n                  arrow: true,\n                  constructor: false,\n                  meta: /** @type {Required<import('jsdoc-type-pratt-parser').MethodSignatureResult['meta']>} */ (\n                    nde.meta\n                  ),\n                  parameters: nde.parameters,\n                  parenthesis: true,\n                  returnType: nde.returnType,\n                  type: 'JsdocTypeFunction',\n                  typeParameters: nde.typeParameters,\n                });\n\n                if (property && 'parentNode' in object && object.parentNode) {\n                  if (typeof object.parentNode === 'object' &&\n                      'elements' in object.parentNode &&\n                      Array.isArray(object.parentNode.elements)\n                  ) {\n                    const idx = object.parentNode.elements.indexOf(object);\n                    object.parentNode.elements[idx] = func;\n                  /* c8 ignore next 6 -- Guard */\n                  } else {\n                    throw new Error(\n                      // @ts-expect-error Ok\n                      `Rule currently unable to handle type ${object.parentNode.type}`,\n                    );\n                  }\n                } else {\n                  parsedType = func;\n                }\n\n                rewireByParsedType(jsdoc, tag, parsedType, indent);\n              } : null,\n            );\n          }\n\n          break;\n        }\n      }\n    });\n  };\n\n  const tags = utils.filterTags(({\n    tag,\n  }) => {\n    return Boolean(tag !== 'import' && utils.tagMightHaveTypePosition(tag));\n  });\n\n  for (const tag of tags) {\n    if (tag.type) {\n      checkType(tag);\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Prefers function types over call signatures when there are no other properties.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/ts-prefer-function-type.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          enableFixer: {\n            description: 'Whether to enable the fixer or not',\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,WAAA,GAAAD,OAAA;AAGA,IAAAE,aAAA,GAAAF,OAAA;AAG8B,SAAAD,uBAAAI,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;AACF,CAAC,KAAK;EACJ,MAAM;IACJC,WAAW,GAAG;EAChB,CAAC,GAAGJ,OAAO,CAACK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;;EAE5B;AACF;AACA;EACE,MAAMC,SAAS,GAAIC,GAAG,IAAK;IACzB,MAAMC,aAAa,GAAGD,GAAG,CAACE,IAAI;;IAE9B;IACA,IAAIC,UAAU;IACd,IAAI;MACFA,UAAU,GAAG,IAAAC,mBAAS,EACpB,qBAAuBH,aAAa,EAAG,YACzC,CAAC;IACH,CAAC,CAAC,MAAM;MACN;IACF;IAEA,IAAAI,sBAAQ,EAACF,UAAU,EAAE,CAACG,GAAG,EAAEC,UAAU,KAAK;MACxC;MACAD,GAAG,CAACC,UAAU,GAAGA,UAAU;IAC7B,CAAC,CAAC;IAEF,IAAAF,sBAAQ,EAACF,UAAU,EAAE,CAACG,GAAG,EAAEC,UAAU,EAAEC,QAAQ,EAAEC,KAAK,KAAK;MACzD,QAAQH,GAAG,CAACJ,IAAI;QACd,KAAK,wBAAwB;UAAE;YAC7B,MAAMQ,MAAM,GAAG;YACbH,UACD;YACD,IAAI,OAAOE,KAAK,KAAK,QAAQ,IAAIC,MAAM,CAACC,QAAQ,CAACC,MAAM,KAAK,CAAC,EAAE;cAC7DhB,KAAK,CAACiB,WAAW,CACf,gDAAgD,EAChDb,GAAG,EACHH,WAAW,GAAG,MAAM;gBAClB,MAAMiB,IAAI,GAAG,+DAAiE;kBAC5EC,KAAK,EAAE,IAAI;kBACXC,WAAW,EAAE,KAAK;kBAClBC,IAAI,GAAE;kBACJX,GAAG,CAACW,IAAI,CACT;kBACDC,UAAU,EAAEZ,GAAG,CAACY,UAAU;kBAC1BC,WAAW,EAAE,IAAI;kBACjBC,UAAU,EAAEd,GAAG,CAACc,UAAU;kBAC1BlB,IAAI,EAAE,mBAAmB;kBACzBmB,cAAc,EAAEf,GAAG,CAACe;gBACtB,CAAE;gBAEF,IAAIb,QAAQ,IAAI,YAAY,IAAIE,MAAM,IAAIA,MAAM,CAACH,UAAU,EAAE;kBAC3D,IAAI,OAAOG,MAAM,CAACH,UAAU,KAAK,QAAQ,IACrC,UAAU,IAAIG,MAAM,CAACH,UAAU,IAC/Be,KAAK,CAACC,OAAO,CAACb,MAAM,CAACH,UAAU,CAACI,QAAQ,CAAC,EAC3C;oBACA,MAAMa,GAAG,GAAGd,MAAM,CAACH,UAAU,CAACI,QAAQ,CAACc,OAAO,CAACf,MAAM,CAAC;oBACtDA,MAAM,CAACH,UAAU,CAACI,QAAQ,CAACa,GAAG,CAAC,GAAGV,IAAI;oBACxC;kBACA,CAAC,MAAM;oBACL,MAAM,IAAIY,KAAK;oBACb;oBACA,wCAAwChB,MAAM,CAACH,UAAU,CAACL,IAAI,EAChE,CAAC;kBACH;gBACF,CAAC,MAAM;kBACLC,UAAU,GAAGW,IAAI;gBACnB;gBAEA,IAAAa,8BAAkB,EAAChC,KAAK,EAAEK,GAAG,EAAEG,UAAU,EAAET,MAAM,CAAC;cACpD,CAAC,GAAG,IACN,CAAC;YACH;YAEA;UACF;MACF;IACF,CAAC,CAAC;EACJ,CAAC;EAED,MAAMkC,IAAI,GAAGhC,KAAK,CAACiC,UAAU,CAAC,CAAC;IAC7B7B;EACF,CAAC,KAAK;IACJ,OAAO8B,OAAO,CAAC9B,GAAG,KAAK,QAAQ,IAAIJ,KAAK,CAACmC,wBAAwB,CAAC/B,GAAG,CAAC,CAAC;EACzE,CAAC,CAAC;EAEF,KAAK,MAAMA,GAAG,IAAI4B,IAAI,EAAE;IACtB,IAAI5B,GAAG,CAACE,IAAI,EAAE;MACZH,SAAS,CAACC,GAAG,CAAC;IAChB;EACF;AACF,CAAC,EAAE;EACDgC,gBAAgB,EAAE,IAAI;EACtBf,IAAI,EAAE;IACJgB,IAAI,EAAE;MACJC,WAAW,EAAE,iFAAiF;MAC9FC,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACV1C,WAAW,EAAE;UACXqC,WAAW,EAAE,oCAAoC;UACjDhC,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAsC,MAAA,CAAAjD,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}

package/dist/rules/tsPreferFunctionType.d.ts

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