eslint-plugin-jsdoc 63.3.3 → 64.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (270) hide show
  1. package/dist/index.d.ts +14 -0
  2. package/package.json +23 -48
  3. package/src/index.js +22 -6
  4. package/dist/WarnSettings.cjs +0 -38
  5. package/dist/WarnSettings.cjs.map +0 -1
  6. package/dist/alignTransform.cjs +0 -402
  7. package/dist/alignTransform.cjs.map +0 -1
  8. package/dist/buildForbidRuleDefinition.cjs +0 -101
  9. package/dist/buildForbidRuleDefinition.cjs.map +0 -1
  10. package/dist/buildRejectOrPreferRuleDefinition.cjs +0 -352
  11. package/dist/buildRejectOrPreferRuleDefinition.cjs.map +0 -1
  12. package/dist/cjs/WarnSettings.d.ts +0 -16
  13. package/dist/cjs/alignTransform.d.ts +0 -33
  14. package/dist/cjs/buildForbidRuleDefinition.d.ts +0 -14
  15. package/dist/cjs/buildRejectOrPreferRuleDefinition.d.ts +0 -8
  16. package/dist/cjs/defaultTagOrder.d.ts +0 -4
  17. package/dist/cjs/exportParser.d.ts +0 -40
  18. package/dist/cjs/getDefaultTagStructureForMode.d.ts +0 -10
  19. package/dist/cjs/getJsdocProcessorPlugin.d.cts +0 -5
  20. package/dist/cjs/getJsdocProcessorPlugin.d.ts +0 -66
  21. package/dist/cjs/index-cjs.d.ts +0 -26
  22. package/dist/cjs/index.cjs.d.cts +0 -2
  23. package/dist/cjs/iterateJsdoc.d.cts +0 -7
  24. package/dist/cjs/iterateJsdoc.d.ts +0 -495
  25. package/dist/cjs/jsdocUtils.d.ts +0 -500
  26. package/dist/cjs/rules/checkAccess.d.ts +0 -2
  27. package/dist/cjs/rules/checkAlignment.d.ts +0 -2
  28. package/dist/cjs/rules/checkExamples.d.ts +0 -3
  29. package/dist/cjs/rules/checkIndentation.d.ts +0 -2
  30. package/dist/cjs/rules/checkLineAlignment.d.ts +0 -9
  31. package/dist/cjs/rules/checkParamNames.d.ts +0 -2
  32. package/dist/cjs/rules/checkPropertyNames.d.ts +0 -2
  33. package/dist/cjs/rules/checkSyntax.d.ts +0 -2
  34. package/dist/cjs/rules/checkTagNames.d.ts +0 -2
  35. package/dist/cjs/rules/checkTemplateNames.d.ts +0 -2
  36. package/dist/cjs/rules/checkTypes.d.ts +0 -7
  37. package/dist/cjs/rules/checkValues.d.ts +0 -2
  38. package/dist/cjs/rules/convertToJsdocComments.d.ts +0 -266
  39. package/dist/cjs/rules/emptyTags.d.ts +0 -2
  40. package/dist/cjs/rules/escapeInlineTags.d.ts +0 -2
  41. package/dist/cjs/rules/implementsOnClasses.d.ts +0 -2
  42. package/dist/cjs/rules/importsAsDependencies.d.ts +0 -2
  43. package/dist/cjs/rules/informativeDocs.d.ts +0 -2
  44. package/dist/cjs/rules/linesBeforeBlock.d.ts +0 -2
  45. package/dist/cjs/rules/matchDescription.d.ts +0 -2
  46. package/dist/cjs/rules/matchName.d.ts +0 -2
  47. package/dist/cjs/rules/multilineBlocks.d.ts +0 -2
  48. package/dist/cjs/rules/noBadBlocks.d.ts +0 -2
  49. package/dist/cjs/rules/noBlankBlockDescriptions.d.ts +0 -2
  50. package/dist/cjs/rules/noBlankBlocks.d.ts +0 -2
  51. package/dist/cjs/rules/noDefaults.d.ts +0 -2
  52. package/dist/cjs/rules/noMissingSyntax.d.ts +0 -9
  53. package/dist/cjs/rules/noMultiAsterisks.d.ts +0 -2
  54. package/dist/cjs/rules/noRestrictedSyntax.d.ts +0 -2
  55. package/dist/cjs/rules/noTypes.d.ts +0 -2
  56. package/dist/cjs/rules/noUndefinedTypes.d.ts +0 -2
  57. package/dist/cjs/rules/normalizeSeeLinks.d.ts +0 -2
  58. package/dist/cjs/rules/preferImportTag.d.ts +0 -2
  59. package/dist/cjs/rules/requireAsteriskPrefix.d.ts +0 -2
  60. package/dist/cjs/rules/requireDescription.d.ts +0 -2
  61. package/dist/cjs/rules/requireDescriptionCompleteSentence.d.ts +0 -2
  62. package/dist/cjs/rules/requireExample.d.ts +0 -2
  63. package/dist/cjs/rules/requireFileOverview.d.ts +0 -2
  64. package/dist/cjs/rules/requireHyphenBeforeParamDescription.d.ts +0 -2
  65. package/dist/cjs/rules/requireJsdoc.d.ts +0 -24
  66. package/dist/cjs/rules/requireParam.d.ts +0 -3
  67. package/dist/cjs/rules/requireParamDescription.d.ts +0 -2
  68. package/dist/cjs/rules/requireParamName.d.ts +0 -2
  69. package/dist/cjs/rules/requireParamType.d.ts +0 -2
  70. package/dist/cjs/rules/requireProperty.d.ts +0 -2
  71. package/dist/cjs/rules/requirePropertyDescription.d.ts +0 -2
  72. package/dist/cjs/rules/requirePropertyName.d.ts +0 -2
  73. package/dist/cjs/rules/requirePropertyType.d.ts +0 -2
  74. package/dist/cjs/rules/requireRejects.d.ts +0 -2
  75. package/dist/cjs/rules/requireReturns.d.ts +0 -2
  76. package/dist/cjs/rules/requireReturnsCheck.d.ts +0 -2
  77. package/dist/cjs/rules/requireReturnsDescription.d.ts +0 -2
  78. package/dist/cjs/rules/requireReturnsType.d.ts +0 -2
  79. package/dist/cjs/rules/requireTags.d.ts +0 -2
  80. package/dist/cjs/rules/requireTemplate.d.ts +0 -2
  81. package/dist/cjs/rules/requireThrows.d.ts +0 -2
  82. package/dist/cjs/rules/requireYields.d.ts +0 -2
  83. package/dist/cjs/rules/requireYieldsCheck.d.ts +0 -2
  84. package/dist/cjs/rules/sortTags.d.ts +0 -2
  85. package/dist/cjs/rules/tagLines.d.ts +0 -2
  86. package/dist/cjs/rules/textEscaping.d.ts +0 -2
  87. package/dist/cjs/rules/tsMethodSignatureStyle.d.ts +0 -2
  88. package/dist/cjs/rules/tsNoEmptyObjectType.d.ts +0 -2
  89. package/dist/cjs/rules/tsNoUnnecessaryTemplateExpression.d.ts +0 -2
  90. package/dist/cjs/rules/tsPreferFunctionType.d.ts +0 -2
  91. package/dist/cjs/rules/typeFormatting.d.ts +0 -2
  92. package/dist/cjs/rules/validTypes.d.ts +0 -2
  93. package/dist/cjs/tagNames.d.ts +0 -15
  94. package/dist/cjs/utils/hasReturnValue.d.ts +0 -19
  95. package/dist/defaultTagOrder.cjs +0 -46
  96. package/dist/defaultTagOrder.cjs.map +0 -1
  97. package/dist/exportParser.cjs +0 -732
  98. package/dist/exportParser.cjs.map +0 -1
  99. package/dist/generateDocs.cjs +0 -342
  100. package/dist/generateDocs.cjs.map +0 -1
  101. package/dist/generateOptions.cjs +0 -62
  102. package/dist/generateOptions.cjs.map +0 -1
  103. package/dist/generateRule.cjs +0 -248
  104. package/dist/generateRule.cjs.map +0 -1
  105. package/dist/generateRuleTypes.cjs +0 -24
  106. package/dist/generateRuleTypes.cjs.map +0 -1
  107. package/dist/getDefaultTagStructureForMode.cjs +0 -289
  108. package/dist/getDefaultTagStructureForMode.cjs.map +0 -1
  109. package/dist/getJsdocProcessorPlugin.cjs +0 -587
  110. package/dist/getJsdocProcessorPlugin.cjs.map +0 -1
  111. package/dist/getJsdocProcessorPlugin.cts +0 -5
  112. package/dist/index-cjs.cjs +0 -600
  113. package/dist/index-cjs.cjs.map +0 -1
  114. package/dist/index-cjs.d.ts +0 -27
  115. package/dist/index-esm.cjs +0 -162
  116. package/dist/index-esm.cjs.map +0 -1
  117. package/dist/index-esm.d.ts +0 -72
  118. package/dist/index.cjs +0 -748
  119. package/dist/index.cjs.cts +0 -3
  120. package/dist/index.cjs.map +0 -1
  121. package/dist/iterateJsdoc.cjs +0 -2150
  122. package/dist/iterateJsdoc.cjs.map +0 -1
  123. package/dist/iterateJsdoc.cts +0 -7
  124. package/dist/jsdocUtils.cjs +0 -1786
  125. package/dist/jsdocUtils.cjs.map +0 -1
  126. package/dist/rules/checkAccess.cjs +0 -40
  127. package/dist/rules/checkAccess.cjs.map +0 -1
  128. package/dist/rules/checkAlignment.cjs +0 -78
  129. package/dist/rules/checkAlignment.cjs.map +0 -1
  130. package/dist/rules/checkExamples.cjs +0 -521
  131. package/dist/rules/checkExamples.cjs.map +0 -1
  132. package/dist/rules/checkIndentation.cjs +0 -170
  133. package/dist/rules/checkIndentation.cjs.map +0 -1
  134. package/dist/rules/checkLineAlignment.cjs +0 -398
  135. package/dist/rules/checkLineAlignment.cjs.map +0 -1
  136. package/dist/rules/checkParamNames.cjs +0 -407
  137. package/dist/rules/checkParamNames.cjs.map +0 -1
  138. package/dist/rules/checkPropertyNames.cjs +0 -135
  139. package/dist/rules/checkPropertyNames.cjs.map +0 -1
  140. package/dist/rules/checkSyntax.cjs +0 -38
  141. package/dist/rules/checkSyntax.cjs.map +0 -1
  142. package/dist/rules/checkTagNames.cjs +0 -312
  143. package/dist/rules/checkTagNames.cjs.map +0 -1
  144. package/dist/rules/checkTemplateNames.cjs +0 -192
  145. package/dist/rules/checkTemplateNames.cjs.map +0 -1
  146. package/dist/rules/checkTypes.cjs +0 -111
  147. package/dist/rules/checkTypes.cjs.map +0 -1
  148. package/dist/rules/checkValues.cjs +0 -166
  149. package/dist/rules/checkValues.cjs.map +0 -1
  150. package/dist/rules/convertToJsdocComments.cjs +0 -356
  151. package/dist/rules/convertToJsdocComments.cjs.map +0 -1
  152. package/dist/rules/emptyTags.cjs +0 -98
  153. package/dist/rules/emptyTags.cjs.map +0 -1
  154. package/dist/rules/escapeInlineTags.cjs +0 -234
  155. package/dist/rules/escapeInlineTags.cjs.map +0 -1
  156. package/dist/rules/implementsOnClasses.cjs +0 -74
  157. package/dist/rules/implementsOnClasses.cjs.map +0 -1
  158. package/dist/rules/importsAsDependencies.cjs +0 -104
  159. package/dist/rules/importsAsDependencies.cjs.map +0 -1
  160. package/dist/rules/informativeDocs.cjs +0 -187
  161. package/dist/rules/informativeDocs.cjs.map +0 -1
  162. package/dist/rules/linesBeforeBlock.cjs +0 -120
  163. package/dist/rules/linesBeforeBlock.cjs.map +0 -1
  164. package/dist/rules/matchDescription.cjs +0 -356
  165. package/dist/rules/matchDescription.cjs.map +0 -1
  166. package/dist/rules/matchName.cjs +0 -160
  167. package/dist/rules/matchName.cjs.map +0 -1
  168. package/dist/rules/multilineBlocks.cjs +0 -431
  169. package/dist/rules/multilineBlocks.cjs.map +0 -1
  170. package/dist/rules/noBadBlocks.cjs +0 -100
  171. package/dist/rules/noBadBlocks.cjs.map +0 -1
  172. package/dist/rules/noBlankBlockDescriptions.cjs +0 -63
  173. package/dist/rules/noBlankBlockDescriptions.cjs.map +0 -1
  174. package/dist/rules/noBlankBlocks.cjs +0 -54
  175. package/dist/rules/noBlankBlocks.cjs.map +0 -1
  176. package/dist/rules/noDefaults.cjs +0 -102
  177. package/dist/rules/noDefaults.cjs.map +0 -1
  178. package/dist/rules/noMissingSyntax.cjs +0 -196
  179. package/dist/rules/noMissingSyntax.cjs.map +0 -1
  180. package/dist/rules/noMultiAsterisks.cjs +0 -126
  181. package/dist/rules/noMultiAsterisks.cjs.map +0 -1
  182. package/dist/rules/noRestrictedSyntax.cjs +0 -68
  183. package/dist/rules/noRestrictedSyntax.cjs.map +0 -1
  184. package/dist/rules/noTypes.cjs +0 -101
  185. package/dist/rules/noTypes.cjs.map +0 -1
  186. package/dist/rules/noUndefinedTypes.cjs +0 -616
  187. package/dist/rules/noUndefinedTypes.cjs.map +0 -1
  188. package/dist/rules/normalizeSeeLinks.cjs +0 -271
  189. package/dist/rules/normalizeSeeLinks.cjs.map +0 -1
  190. package/dist/rules/preferImportTag.cjs +0 -362
  191. package/dist/rules/preferImportTag.cjs.map +0 -1
  192. package/dist/rules/requireAsteriskPrefix.cjs +0 -190
  193. package/dist/rules/requireAsteriskPrefix.cjs.map +0 -1
  194. package/dist/rules/requireDescription.cjs +0 -164
  195. package/dist/rules/requireDescription.cjs.map +0 -1
  196. package/dist/rules/requireDescriptionCompleteSentence.cjs +0 -321
  197. package/dist/rules/requireDescriptionCompleteSentence.cjs.map +0 -1
  198. package/dist/rules/requireExample.cjs +0 -136
  199. package/dist/rules/requireExample.cjs.map +0 -1
  200. package/dist/rules/requireFileOverview.cjs +0 -194
  201. package/dist/rules/requireFileOverview.cjs.map +0 -1
  202. package/dist/rules/requireHyphenBeforeParamDescription.cjs +0 -166
  203. package/dist/rules/requireHyphenBeforeParamDescription.cjs.map +0 -1
  204. package/dist/rules/requireJsdoc.cjs +0 -721
  205. package/dist/rules/requireJsdoc.cjs.map +0 -1
  206. package/dist/rules/requireParam.cjs +0 -772
  207. package/dist/rules/requireParam.cjs.map +0 -1
  208. package/dist/rules/requireParamDescription.cjs +0 -105
  209. package/dist/rules/requireParamDescription.cjs.map +0 -1
  210. package/dist/rules/requireParamName.cjs +0 -68
  211. package/dist/rules/requireParamName.cjs.map +0 -1
  212. package/dist/rules/requireParamType.cjs +0 -104
  213. package/dist/rules/requireParamType.cjs.map +0 -1
  214. package/dist/rules/requireProperty.cjs +0 -63
  215. package/dist/rules/requireProperty.cjs.map +0 -1
  216. package/dist/rules/requirePropertyDescription.cjs +0 -29
  217. package/dist/rules/requirePropertyDescription.cjs.map +0 -1
  218. package/dist/rules/requirePropertyName.cjs +0 -29
  219. package/dist/rules/requirePropertyName.cjs.map +0 -1
  220. package/dist/rules/requirePropertyType.cjs +0 -29
  221. package/dist/rules/requirePropertyType.cjs.map +0 -1
  222. package/dist/rules/requireRejects.cjs +0 -226
  223. package/dist/rules/requireRejects.cjs.map +0 -1
  224. package/dist/rules/requireReturns.cjs +0 -262
  225. package/dist/rules/requireReturns.cjs.map +0 -1
  226. package/dist/rules/requireReturnsCheck.cjs +0 -225
  227. package/dist/rules/requireReturnsCheck.cjs.map +0 -1
  228. package/dist/rules/requireReturnsDescription.cjs +0 -72
  229. package/dist/rules/requireReturnsDescription.cjs.map +0 -1
  230. package/dist/rules/requireReturnsType.cjs +0 -68
  231. package/dist/rules/requireReturnsType.cjs.map +0 -1
  232. package/dist/rules/requireTags.cjs +0 -74
  233. package/dist/rules/requireTags.cjs.map +0 -1
  234. package/dist/rules/requireTemplate.cjs +0 -220
  235. package/dist/rules/requireTemplate.cjs.map +0 -1
  236. package/dist/rules/requireThrows.cjs +0 -118
  237. package/dist/rules/requireThrows.cjs.map +0 -1
  238. package/dist/rules/requireYields.cjs +0 -224
  239. package/dist/rules/requireYields.cjs.map +0 -1
  240. package/dist/rules/requireYieldsCheck.cjs +0 -179
  241. package/dist/rules/requireYieldsCheck.cjs.map +0 -1
  242. package/dist/rules/sortTags.cjs +0 -656
  243. package/dist/rules/sortTags.cjs.map +0 -1
  244. package/dist/rules/tagLines.cjs +0 -374
  245. package/dist/rules/tagLines.cjs.map +0 -1
  246. package/dist/rules/textEscaping.cjs +0 -141
  247. package/dist/rules/textEscaping.cjs.map +0 -1
  248. package/dist/rules/tsMethodSignatureStyle.cjs +0 -240
  249. package/dist/rules/tsMethodSignatureStyle.cjs.map +0 -1
  250. package/dist/rules/tsNoEmptyObjectType.cjs +0 -62
  251. package/dist/rules/tsNoEmptyObjectType.cjs.map +0 -1
  252. package/dist/rules/tsNoUnnecessaryTemplateExpression.cjs +0 -104
  253. package/dist/rules/tsNoUnnecessaryTemplateExpression.cjs.map +0 -1
  254. package/dist/rules/tsPreferFunctionType.cjs +0 -110
  255. package/dist/rules/tsPreferFunctionType.cjs.map +0 -1
  256. package/dist/rules/typeFormatting.cjs +0 -607
  257. package/dist/rules/typeFormatting.cjs.map +0 -1
  258. package/dist/rules/validTypes.cjs +0 -324
  259. package/dist/rules/validTypes.cjs.map +0 -1
  260. package/dist/tagNames.cjs +0 -244
  261. package/dist/tagNames.cjs.map +0 -1
  262. package/dist/to-valid-identifier.cjs +0 -263
  263. package/dist/utils/hasReturnValue.cjs +0 -495
  264. package/dist/utils/hasReturnValue.cjs.map +0 -1
  265. package/rollup.config.js +0 -16
  266. package/src/getJsdocProcessorPlugin.cts +0 -5
  267. package/src/index-cjs.js +0 -760
  268. package/src/index-esm.js +0 -196
  269. package/src/index.cjs.cts +0 -3
  270. package/src/iterateJsdoc.cts +0 -7
@@ -1,240 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.default = void 0;
7
- var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
8
- var _jsdocUtils = require("../jsdocUtils.cjs");
9
- var _jsdoccomment = require("@es-joy/jsdoccomment");
10
- function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
11
- var _default = exports.default = (0, _iterateJsdoc.default)(({
12
- context,
13
- indent,
14
- jsdoc,
15
- utils
16
- }) => {
17
- const functionType = context.options[0] ?? 'property';
18
- const {
19
- enableFixer = true
20
- } = context.options[1] ?? {};
21
-
22
- /**
23
- * @param {import('@es-joy/jsdoccomment').JsdocTagWithInline} tag
24
- */
25
- const checkType = tag => {
26
- const potentialType = tag.type;
27
- let parsedType;
28
- try {
29
- parsedType = (0, _jsdoccomment.parse)(/** @type {string} */potentialType, 'typescript');
30
- } catch {
31
- return;
32
- }
33
- (0, _jsdoccomment.traverse)(parsedType, (nde, parentNode) => {
34
- // @ts-expect-error Adding our own property for use below
35
- nde.parentNode = parentNode;
36
- });
37
- (0, _jsdoccomment.traverse)(parsedType, (nde, parentNode, property, idx) => {
38
- switch (nde.type) {
39
- case 'JsdocTypeFunction':
40
- {
41
- if (functionType !== 'method') {
42
- break;
43
- }
44
- if (parentNode?.type === 'JsdocTypeObjectField' && typeof parentNode.key === 'string') {
45
- utils.reportJSDoc('Found function property; prefer method signature.', tag, enableFixer ? () => {
46
- const objectField = parentNode;
47
- const obj =
48
- /**
49
- * @type {import('jsdoc-type-pratt-parser').ObjectFieldResult & {
50
- * parentNode: import('jsdoc-type-pratt-parser').ObjectResult
51
- * }}
52
- */
53
- objectField.parentNode;
54
- const index = obj.elements.indexOf(parentNode);
55
- obj.elements[index] = {
56
- /* c8 ignore next 5 -- Guard */
57
- meta: nde.meta ? {
58
- quote: objectField.meta.quote,
59
- ...nde.meta
60
- } : {
61
- quote: objectField.meta.quote
62
- },
63
- name: (/** @type {string} */objectField.key),
64
- parameters: nde.parameters,
65
- returnType: (/** @type {import('jsdoc-type-pratt-parser').RootResult} */
66
- nde.returnType),
67
- type: 'JsdocTypeMethodSignature',
68
- typeParameters: nde.typeParameters
69
- };
70
- (0, _jsdocUtils.rewireByParsedType)(jsdoc, tag, parsedType, indent);
71
- } : null);
72
- break;
73
- }
74
- if (parentNode?.type === 'JsdocTypeParenthesis' &&
75
- // @ts-expect-error Our own added API
76
- parentNode.parentNode?.type === 'JsdocTypeIntersection' &&
77
- // @ts-expect-error Our own added API
78
- parentNode.parentNode.parentNode.type === 'JsdocTypeObjectField' &&
79
- // @ts-expect-error Our own added API
80
- typeof parentNode.parentNode.parentNode.key === 'string') {
81
- // @ts-expect-error Our own added API
82
- const intersection = parentNode.parentNode;
83
- const objectField = intersection.parentNode;
84
- const object = objectField.parentNode;
85
- // const objFieldIndex = object.elements.indexOf(objectField);
86
-
87
- /**
88
- * @param {import('jsdoc-type-pratt-parser').FunctionResult} func
89
- */
90
- const convertToMethod = func => {
91
- return /** @type {import('jsdoc-type-pratt-parser').MethodSignatureResult} */{
92
- /* c8 ignore next 5 -- Guard */
93
- meta: func.meta ? {
94
- quote: objectField.meta.quote,
95
- ...func.meta
96
- } : {
97
- quote: objectField.meta.quote
98
- },
99
- name: (/** @type {string} */objectField.key),
100
- parameters: func.parameters,
101
- returnType: (/** @type {import('jsdoc-type-pratt-parser').RootResult} */
102
- func.returnType),
103
- type: 'JsdocTypeMethodSignature',
104
- typeParameters: func.typeParameters
105
- };
106
- };
107
-
108
- /** @type {import('jsdoc-type-pratt-parser').MethodSignatureResult[]} */
109
- const methods = [];
110
- /** @type {number[]} */
111
- const methodIndexes = [];
112
- for (const [index, element] of intersection.elements.entries()) {
113
- if (element.type !== 'JsdocTypeParenthesis' || element.element.type !== 'JsdocTypeFunction') {
114
- return;
115
- }
116
- methods.push(convertToMethod(element.element));
117
- methodIndexes.push(index);
118
- }
119
- utils.reportJSDoc('Found function property; prefer method signature.', tag, enableFixer ? () => {
120
- for (const methodIndex of methodIndexes.toReversed()) {
121
- object.elements.splice(methodIndex, 1);
122
- }
123
- object.elements.splice(methodIndexes[0], 0, ...methods);
124
- (0, _jsdocUtils.rewireByParsedType)(jsdoc, tag, parsedType, indent);
125
- } : null);
126
- }
127
- break;
128
- }
129
- case 'JsdocTypeMethodSignature':
130
- {
131
- if (functionType !== 'property') {
132
- break;
133
- }
134
-
135
- /**
136
- * @param {import('jsdoc-type-pratt-parser').MethodSignatureResult} node
137
- */
138
- const convertToFunction = node => {
139
- return {
140
- arrow: true,
141
- constructor: false,
142
- meta: (/** @type {Required<import('jsdoc-type-pratt-parser').MethodSignatureResult['meta']>} */
143
- node.meta),
144
- parameters: node.parameters,
145
- parenthesis: true,
146
- returnType: node.returnType,
147
- type: 'JsdocTypeFunction',
148
- typeParameters: node.typeParameters
149
- };
150
- };
151
- utils.reportJSDoc('Found method signature; prefer function property.', tag, enableFixer ? () => {
152
- /* c8 ignore next 3 -- TS guard */
153
- if (!parentNode || !property || typeof idx !== 'number') {
154
- throw new Error('Unexpected lack of parent or property');
155
- }
156
- const object = /** @type {import('jsdoc-type-pratt-parser').ObjectResult} */
157
- parentNode;
158
- const funcs = [];
159
- const removals = [];
160
- for (const [index, element] of object.elements.entries()) {
161
- if (element.type === 'JsdocTypeMethodSignature' && element.name === nde.name) {
162
- funcs.push(convertToFunction(element));
163
- if (index !== idx) {
164
- removals.push(index);
165
- }
166
- }
167
- }
168
- if (funcs.length === 1) {
169
- object.elements[idx] = /** @type {import('jsdoc-type-pratt-parser').ObjectFieldResult} */{
170
- key: nde.name,
171
- meta: nde.meta,
172
- optional: false,
173
- readonly: false,
174
- right: funcs[0],
175
- type: 'JsdocTypeObjectField'
176
- };
177
- } else {
178
- for (const removal of removals.toReversed()) {
179
- object.elements.splice(removal, 1);
180
- }
181
- object.elements[idx] = {
182
- key: nde.name,
183
- meta: nde.meta,
184
- optional: false,
185
- readonly: false,
186
- right: {
187
- elements: funcs.map(func => {
188
- return /** @type {import('jsdoc-type-pratt-parser').ParenthesisResult} */{
189
- element: func,
190
- type: 'JsdocTypeParenthesis'
191
- };
192
- }),
193
- type: 'JsdocTypeIntersection'
194
- },
195
- type: 'JsdocTypeObjectField'
196
- };
197
- }
198
- (0, _jsdocUtils.rewireByParsedType)(jsdoc, tag, parsedType, indent);
199
- } : null);
200
- }
201
- break;
202
- }
203
- });
204
- };
205
- const tags = utils.filterTags(({
206
- tag
207
- }) => {
208
- return Boolean(tag !== 'import' && utils.tagMightHaveTypePosition(tag));
209
- });
210
- for (const tag of tags) {
211
- if (tag.type) {
212
- checkType(tag);
213
- }
214
- }
215
- }, {
216
- iterateAllJsdocs: true,
217
- meta: {
218
- docs: {
219
- description: 'Prefers either function properties or method signatures',
220
- url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/ts-method-signature-style.md#repos-sticky-header'
221
- },
222
- fixable: 'code',
223
- schema: [{
224
- enum: ['method', 'property'],
225
- type: 'string'
226
- }, {
227
- additionalProperties: false,
228
- properties: {
229
- enableFixer: {
230
- description: 'Whether to enable the fixer. Defaults to `true`.',
231
- type: 'boolean'
232
- }
233
- },
234
- type: 'object'
235
- }],
236
- type: 'suggestion'
237
- }
238
- });
239
- module.exports = exports.default;
240
- //# sourceMappingURL=tsMethodSignatureStyle.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"tsMethodSignatureStyle.cjs","names":["iterateJsdoc","parseType","traverse","rewireByParsedType"],"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;AACA;AAGA;AAG8B;AAAA,iCAEf,IAAAA,qBAAY,EAAC,CAAC;EAC3B,OAAO;EACP,MAAM;EACN,KAAK;EACL;AACF,CAAC,KAAK;EACJ,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,UAAU;EACrD,MAAM;IACJ,WAAW,GAAG;EAChB,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;;EAE5B;AACF;AACA;EACE,MAAM,SAAS,GAAI,GAAG,IAAK;IACzB,MAAM,aAAa,GAAG,GAAG,CAAC,IAAI;IAC9B,IAAI,UAAU;IACd,IAAI;MACF,UAAU,GAAG,IAAAC,mBAAS,EACpB,qBAAuB,aAAa,EAAG,YACzC,CAAC;IACH,CAAC,CAAC,MAAM;MACN;IACF;IAEA,IAAAC,cAAA,QAAQ,EAAC,UAAU,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK;MACxC;MACA,GAAG,CAAC,UAAU,GAAG,UAAU;IAC7B,CAAC,CAAC;IAEF,IAAAA,cAAA,QAAQ,EAAC,UAAU,EAAE,CAAC,GAAG,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,KAAK;MACvD,QAAQ,GAAG,CAAC,IAAI;QACd,KAAK,mBAAmB;UAAE;YACxB,IAAI,YAAY,KAAK,QAAQ,EAAE;cAC7B;YACF;YAEA,IAAI,UAAU,EAAE,IAAI,KAAK,sBAAsB,IAC7C,OAAO,UAAU,CAAC,GAAG,KAAK,QAAQ,EAClC;cACA,KAAK,CAAC,WAAW,CACf,mDAAmD,EACnD,GAAG,EACH,WAAW,GAAG,MAAM;gBAClB,MAAM,WAAW,GAAG,UAAU;gBAC9B,MAAM,GAAG;gBACP;AAClB;AACA;AACA;AACA;gBACmB,WAAW,CAAE,UAAU;gBAE1B,MAAM,KAAK,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC;gBAE9C,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG;kBACpB;kBACA,IAAI,EAAE,GAAG,CAAC,IAAI,GACZ;oBACE,KAAK,EAAE,WAAW,CAAC,IAAI,CAAC,KAAK;oBAC7B,GAAG,GAAG,CAAC;kBACT,CAAC,GACD;oBACE,KAAK,EAAE,WAAW,CAAC,IAAI,CAAC;kBAC1B,CAAC;kBACH,IAAI,GAAE,qBAAuB,WAAW,CAAC,GAAG,CAAC;kBAC7C,UAAU,EAAE,GAAG,CAAC,UAAU;kBAC1B,UAAU,GAAE;kBACV,GAAG,CAAC,UAAU,CACf;kBACD,IAAI,EAAE,0BAA0B;kBAChC,cAAc,EAAE,GAAG,CAAC;gBACtB,CAAC;gBAED,IAAAC,YAAA,kBAAkB,EAAC,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,CAAC;cACpD,CAAC,GAAG,IACN,CAAC;cACD;YACF;YAEA,IAAI,UAAU,EAAE,IAAI,KAAK,sBAAsB;YAC7C;YACA,UAAU,CAAC,UAAU,EAAE,IAAI,KAAK,uBAAuB;YACvD;YACA,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,KAAK,sBAAsB;YAChE;YACA,OAAO,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,KAAK,QAAQ,EACxD;cACA;cACA,MAAM,YAAY,GAAG,UAAU,CAAC,UAAU;cAC1C,MAAM,WAAW,GAAG,YAAY,CAAC,UAAU;cAC3C,MAAM,MAAM,GAAG,WAAW,CAAC,UAAU;cACrC;;cAEA;AACZ;AACA;cACY,MAAM,eAAe,GAAI,IAAI,IAAK;gBAChC,OAAO,sEAAwE;kBAC7E;kBACA,IAAI,EAAE,IAAI,CAAC,IAAI,GACb;oBACE,KAAK,EAAE,WAAW,CAAC,IAAI,CAAC,KAAK;oBAC7B,GAAG,IAAI,CAAC;kBACV,CAAC,GACD;oBACE,KAAK,EAAE,WAAW,CAAC,IAAI,CAAC;kBAC1B,CAAC;kBACH,IAAI,GAAE,qBAAuB,WAAW,CAAC,GAAG,CAAC;kBAC7C,UAAU,EAAE,IAAI,CAAC,UAAU;kBAC3B,UAAU,GAAE;kBACV,IAAI,CAAC,UAAU,CAChB;kBACD,IAAI,EAAE,0BAA0B;kBAChC,cAAc,EAAE,IAAI,CAAC;gBACvB,CAAC;cACH,CAAC;;cAED;cACA,MAAM,OAAO,GAAG,EAAE;cAClB;cACA,MAAM,aAAa,GAAG,EAAE;cACxB,KAAK,MAAM,CACT,KAAK,EACL,OAAO,CACR,IAAI,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE;gBACpC,IACE,OAAO,CAAC,IAAI,KAAK,sBAAsB,IACvC,OAAO,CAAC,OAAO,CAAC,IAAI,KAAK,mBAAmB,EAC5C;kBACA;gBACF;gBAEA,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBAC9C,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC;cAC3B;cAEA,KAAK,CAAC,WAAW,CACf,mDAAmD,EACnD,GAAG,EACH,WAAW,GAAG,MAAM;gBAClB,KAAK,MAAM,WAAW,IAAI,aAAa,CAAC,UAAU,CAAC,CAAC,EAAE;kBACpD,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;gBACxC;gBAEA,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC;gBAEvD,IAAAA,YAAA,kBAAkB,EAAC,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,CAAC;cACpD,CAAC,GAAG,IACN,CAAC;YACH;YAEA;UACF;QAEA,KAAK,0BAA0B;UAAE;YAC/B,IAAI,YAAY,KAAK,UAAU,EAAE;cAC/B;YACF;;YAEA;AACV;AACA;YACU,MAAM,iBAAiB,GAAI,IAAI,IAAK;cAClC,OAAO;gBACL,KAAK,EAAE,IAAI;gBACX,WAAW,EAAE,KAAK;gBAClB,IAAI,GAAE;gBACJ,IAAI,CAAC,IAAI,CACV;gBACD,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,WAAW,EAAE,IAAI;gBACjB,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,IAAI,EAAE,mBAAmB;gBACzB,cAAc,EAAE,IAAI,CAAC;cACvB,CAAC;YACH,CAAC;YAED,KAAK,CAAC,WAAW,CACf,mDAAmD,EACnD,GAAG,EACH,WAAW,GAAG,MAAM;cAClB;cACA,IAAI,CAAC,UAAU,IAAI,CAAC,QAAQ,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;gBACvD,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC;cAC1D;cAEA,MAAM,MAAM,GAAG;cACb,UACD;cAED,MAAM,KAAK,GAAG,EAAE;cAChB,MAAM,QAAQ,GAAG,EAAE;cAEnB,KAAK,MAAM,CACT,KAAK,EACL,OAAO,CACR,IAAI,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE;gBAC9B,IAAI,OAAO,CAAC,IAAI,KAAK,0BAA0B,IAC7C,OAAO,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,EACzB;kBACA,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;kBACtC,IAAI,KAAK,KAAK,GAAG,EAAE;oBACjB,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;kBACtB;gBACF;cACF;cAEA,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;gBACtB,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,kEAAoE;kBACzF,GAAG,EAAE,GAAG,CAAC,IAAI;kBACb,IAAI,EAAE,GAAG,CAAC,IAAI;kBACd,QAAQ,EAAE,KAAK;kBACf,QAAQ,EAAE,KAAK;kBACf,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;kBACf,IAAI,EAAE;gBACR,CAAE;cACJ,CAAC,MAAM;gBACL,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,UAAU,CAAC,CAAC,EAAE;kBAC3C,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;gBACpC;gBAEA,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG;kBACrB,GAAG,EAAE,GAAG,CAAC,IAAI;kBACb,IAAI,EAAE,GAAG,CAAC,IAAI;kBACd,QAAQ,EAAE,KAAK;kBACf,QAAQ,EAAE,KAAK;kBACf,KAAK,EAAE;oBACL,QAAQ,EAAE,KAAK,CAAC,GAAG,CAAE,IAAI,IAAK;sBAC5B,OAAO,kEAAoE;wBACzE,OAAO,EAAE,IAAI;wBACb,IAAI,EAAE;sBACR,CAAC;oBACH,CAAC,CAAC;oBACF,IAAI,EAAE;kBACR,CAAC;kBACD,IAAI,EAAE;gBACR,CAAC;cACH;cAEA,IAAAA,YAAA,kBAAkB,EAAC,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,CAAC;YACpD,CAAC,GAAG,IACN,CAAC;UACH;UAEE;MACJ;IACF,CAAC,CAAC;EACJ,CAAC;EAED,MAAM,IAAI,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;IAC7B;EACF,CAAC,KAAK;IACJ,OAAO,OAAO,CAAC,GAAG,KAAK,QAAQ,IAAI,KAAK,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;EACzE,CAAC,CAAC;EAEF,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;IACtB,IAAI,GAAG,CAAC,IAAI,EAAE;MACZ,SAAS,CAAC,GAAG,CAAC;IAChB;EACF;AACF,CAAC,EAAE;EACD,gBAAgB,EAAE,IAAI;EACtB,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EAAE,yDAAyD;MACtE,GAAG,EAAE;IACP,CAAC;IACD,OAAO,EAAE,MAAM;IACf,MAAM,EAAE,CACN;MACE,IAAI,EAAE,CACJ,QAAQ,EACR,UAAU,CACX;MACD,IAAI,EAAE;IACR,CAAC,EACD;MACE,oBAAoB,EAAE,KAAK;MAC3B,UAAU,EAAE;QACV,WAAW,EAAE;UACX,WAAW,EAAE,kDAAkD;UAC/D,IAAI,EAAE;QACR;MACF,CAAC;MACD,IAAI,EAAE;IACR,CAAC,CACF;IACD,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA","ignoreList":[]}
@@ -1,62 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.default = void 0;
7
- var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
8
- var _jsdoccomment = require("@es-joy/jsdoccomment");
9
- function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
10
- var _default = exports.default = (0, _iterateJsdoc.default)(({
11
- settings,
12
- utils
13
- }) => {
14
- if (settings.mode !== 'typescript') {
15
- return;
16
- }
17
-
18
- /**
19
- * @param {import('@es-joy/jsdoccomment').JsdocTagWithInline} tag
20
- */
21
- const checkType = tag => {
22
- const potentialType = tag.type;
23
- let parsedType;
24
- try {
25
- parsedType = (0, _jsdoccomment.parse)(/** @type {string} */potentialType, 'typescript');
26
- } catch {
27
- return;
28
- }
29
- (0, _jsdoccomment.traverse)(parsedType, nde => {
30
- switch (nde.type) {
31
- case 'JsdocTypeObject':
32
- {
33
- if (!nde.elements.length) {
34
- utils.reportJSDoc('No empty object type.', tag);
35
- }
36
- }
37
- }
38
- });
39
- };
40
- const tags = utils.filterTags(({
41
- tag
42
- }) => {
43
- return Boolean(tag !== 'import' && utils.tagMightHaveTypePosition(tag));
44
- });
45
- for (const tag of tags) {
46
- if (tag.type) {
47
- checkType(tag);
48
- }
49
- }
50
- }, {
51
- iterateAllJsdocs: true,
52
- meta: {
53
- docs: {
54
- description: 'Warns against use of the empty object type',
55
- url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/ts-no-empty-object-type.md#repos-sticky-header'
56
- },
57
- schema: [],
58
- type: 'suggestion'
59
- }
60
- });
61
- module.exports = exports.default;
62
- //# sourceMappingURL=tsNoEmptyObjectType.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"tsNoEmptyObjectType.cjs","names":["iterateJsdoc","parseType","traverse"],"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;AACA;AAG8B;AAAA,iCAEf,IAAAA,qBAAY,EAAC,CAAC;EAC3B,QAAQ;EACR;AACF,CAAC,KAAK;EACJ,IAAI,QAAQ,CAAC,IAAI,KAAK,YAAY,EAAE;IAClC;EACF;;EAEA;AACF;AACA;EACE,MAAM,SAAS,GAAI,GAAG,IAAK;IACzB,MAAM,aAAa,GAAG,GAAG,CAAC,IAAI;IAC9B,IAAI,UAAU;IACd,IAAI;MACF,UAAU,GAAG,IAAAC,mBAAS,EACpB,qBAAuB,aAAa,EAAG,YACzC,CAAC;IACH,CAAC,CAAC,MAAM;MACN;IACF;IAEA,IAAAC,cAAA,QAAQ,EAAC,UAAU,EAAG,GAAG,IAAK;MAC5B,QAAQ,GAAG,CAAC,IAAI;QACd,KAAK,iBAAiB;UAAE;YACtB,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE;cACxB,KAAK,CAAC,WAAW,CAAC,uBAAuB,EAAE,GAAG,CAAC;YACjD;UACF;MACF;IACF,CAAC,CAAC;EACJ,CAAC;EAED,MAAM,IAAI,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;IAC7B;EACF,CAAC,KAAK;IACJ,OAAO,OAAO,CAAC,GAAG,KAAK,QAAQ,IAAI,KAAK,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;EACzE,CAAC,CAAC;EAEF,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;IACtB,IAAI,GAAG,CAAC,IAAI,EAAE;MACZ,SAAS,CAAC,GAAG,CAAC;IAChB;EACF;AACF,CAAC,EAAE;EACD,gBAAgB,EAAE,IAAI;EACtB,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EAAE,4CAA4C;MACzD,GAAG,EAAE;IACP,CAAC;IACD,MAAM,EAAE,EAAE;IACV,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA","ignoreList":[]}
@@ -1,104 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.default = void 0;
7
- var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
8
- var _jsdocUtils = require("../jsdocUtils.cjs");
9
- var _jsdoccomment = require("@es-joy/jsdoccomment");
10
- function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
11
- var _default = exports.default = (0, _iterateJsdoc.default)(({
12
- context,
13
- indent,
14
- jsdoc,
15
- settings,
16
- utils
17
- }) => {
18
- if (settings.mode !== 'typescript') {
19
- return;
20
- }
21
- const {
22
- enableFixer = true
23
- } = context.options[0] ?? {};
24
-
25
- /**
26
- * @param {import('@es-joy/jsdoccomment').JsdocTagWithInline} tag
27
- */
28
- const checkType = tag => {
29
- const potentialType = tag.type;
30
- /** @type {import('jsdoc-type-pratt-parser').RootResult} */
31
- let parsedType;
32
- try {
33
- parsedType = (0, _jsdoccomment.parse)(/** @type {string} */potentialType, 'typescript');
34
- } catch {
35
- return;
36
- }
37
- (0, _jsdoccomment.traverse)(parsedType, (nde, parentNode, property, index) => {
38
- switch (nde.type) {
39
- case 'JsdocTypeTemplateLiteral':
40
- {
41
- const stringInterpolationIndex = nde.interpolations.findIndex(interpolation => {
42
- return interpolation.type === 'JsdocTypeStringValue';
43
- });
44
- if (stringInterpolationIndex > -1) {
45
- utils.reportJSDoc('Found an unnecessary string literal within a template.', tag, enableFixer ? () => {
46
- nde.literals.splice(stringInterpolationIndex, 2, nde.literals[stringInterpolationIndex] + /** @type {import('jsdoc-type-pratt-parser').StringValueResult} */
47
- nde.interpolations[stringInterpolationIndex].value + nde.literals[stringInterpolationIndex + 1]);
48
- nde.interpolations.splice(stringInterpolationIndex, 1);
49
- (0, _jsdocUtils.rewireByParsedType)(jsdoc, tag, parsedType, indent);
50
- } : null);
51
- } else if (nde.literals.length === 2 && nde.literals[0] === '' && nde.literals[1] === '') {
52
- utils.reportJSDoc('Found a lone template expression within a template.', tag, enableFixer ? () => {
53
- const interpolation = nde.interpolations[0];
54
- if (parentNode && property) {
55
- if (typeof index === 'number') {
56
- // @ts-expect-error Safe
57
- parentNode[property][index] = interpolation;
58
- } else {
59
- // @ts-expect-error Safe
60
- parentNode[property] = interpolation;
61
- }
62
- } else {
63
- parsedType = interpolation;
64
- }
65
- (0, _jsdocUtils.rewireByParsedType)(jsdoc, tag, parsedType, indent);
66
- } : null);
67
- }
68
- }
69
- }
70
- });
71
- };
72
- const tags = utils.filterTags(({
73
- tag
74
- }) => {
75
- return Boolean(tag !== 'import' && utils.tagMightHaveTypePosition(tag));
76
- });
77
- for (const tag of tags) {
78
- if (tag.type) {
79
- checkType(tag);
80
- }
81
- }
82
- }, {
83
- iterateAllJsdocs: true,
84
- meta: {
85
- docs: {
86
- description: 'Catches unnecessary template expressions such as string expressions within a template literal.',
87
- url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/ts-no-unnecessary-template-expression.md#repos-sticky-header'
88
- },
89
- fixable: 'code',
90
- schema: [{
91
- additionalProperties: false,
92
- properties: {
93
- enableFixer: {
94
- description: 'Whether to enable the fixer. Defaults to `true`.',
95
- type: 'boolean'
96
- }
97
- },
98
- type: 'object'
99
- }],
100
- type: 'suggestion'
101
- }
102
- });
103
- module.exports = exports.default;
104
- //# sourceMappingURL=tsNoUnnecessaryTemplateExpression.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"tsNoUnnecessaryTemplateExpression.cjs","names":["iterateJsdoc","parseType","traverse","rewireByParsedType"],"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;AACA;AAGA;AAG8B;AAAA,iCAEf,IAAAA,qBAAY,EAAC,CAAC;EAC3B,OAAO;EACP,MAAM;EACN,KAAK;EACL,QAAQ;EACR;AACF,CAAC,KAAK;EACJ,IAAI,QAAQ,CAAC,IAAI,KAAK,YAAY,EAAE;IAClC;EACF;EAEA,MAAM;IACJ,WAAW,GAAG;EAChB,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;;EAE5B;AACF;AACA;EACE,MAAM,SAAS,GAAI,GAAG,IAAK;IACzB,MAAM,aAAa,GAAG,GAAG,CAAC,IAAI;IAC9B;IACA,IAAI,UAAU;IACd,IAAI;MACF,UAAU,GAAG,IAAAC,mBAAS,EACpB,qBAAuB,aAAa,EAAG,YACzC,CAAC;IACH,CAAC,CAAC,MAAM;MACN;IACF;IAEA,IAAAC,cAAA,QAAQ,EAAC,UAAU,EAAE,CAAC,GAAG,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK,KAAK;MACzD,QAAQ,GAAG,CAAC,IAAI;QACd,KAAK,0BAA0B;UAAE;YAC/B,MAAM,wBAAwB,GAAG,GAAG,CAAC,cAAc,CAAC,SAAS,CAAE,aAAa,IAAK;cAC/E,OAAO,aAAa,CAAC,IAAI,KAAK,sBAAsB;YACtD,CAAC,CAAC;YACF,IAAI,wBAAwB,GAAG,CAAC,CAAC,EAAE;cACjC,KAAK,CAAC,WAAW,CACf,wDAAwD,EACxD,GAAG,EACH,WAAW,GAAG,MAAM;gBAClB,GAAG,CAAC,QAAQ,CAAC,MAAM,CACjB,wBAAwB,EACxB,CAAC,EACD,GAAG,CAAC,QAAQ,CAAC,wBAAwB,CAAC,GACpC;gBACC,GAAG,CAAC,cAAc,CAAC,wBAAwB,CAAC,CAAE,KAAK,GACpD,GAAG,CAAC,QAAQ,CAAC,wBAAwB,GAAG,CAAC,CAC7C,CAAC;gBAED,GAAG,CAAC,cAAc,CAAC,MAAM,CACvB,wBAAwB,EAAE,CAC5B,CAAC;gBAED,IAAAC,YAAA,kBAAkB,EAAC,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,CAAC;cACpD,CAAC,GAAG,IACN,CAAC;YACH,CAAC,MAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,EAAE,IAC5D,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,EAAE,EACtB;cACA,KAAK,CAAC,WAAW,CACf,qDAAqD,EACrD,GAAG,EACH,WAAW,GAAG,MAAM;gBAClB,MAAM,aAAa,GAAG,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC;gBAE3C,IAAI,UAAU,IAAI,QAAQ,EAAE;kBAC1B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;oBAC7B;oBACA,UAAU,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,GAAG,aAAa;kBAC7C,CAAC,MAAM;oBACL;oBACA,UAAU,CAAC,QAAQ,CAAC,GAAG,aAAa;kBACtC;gBACF,CAAC,MAAM;kBACL,UAAU,GAAG,aAAa;gBAC5B;gBAEA,IAAAA,YAAA,kBAAkB,EAAC,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,CAAC;cACpD,CAAC,GAAG,IACN,CAAC;YACH;UACF;MACF;IACF,CAAC,CAAC;EACJ,CAAC;EAED,MAAM,IAAI,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;IAC7B;EACF,CAAC,KAAK;IACJ,OAAO,OAAO,CAAC,GAAG,KAAK,QAAQ,IAAI,KAAK,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;EACzE,CAAC,CAAC;EAEF,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;IACtB,IAAI,GAAG,CAAC,IAAI,EAAE;MACZ,SAAS,CAAC,GAAG,CAAC;IAChB;EACF;AACF,CAAC,EAAE;EACD,gBAAgB,EAAE,IAAI;EACtB,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EAAE,gGAAgG;MAC7G,GAAG,EAAE;IACP,CAAC;IACD,OAAO,EAAE,MAAM;IACf,MAAM,EAAE,CACN;MACE,oBAAoB,EAAE,KAAK;MAC3B,UAAU,EAAE;QACV,WAAW,EAAE;UACX,WAAW,EAAE,kDAAkD;UAC/D,IAAI,EAAE;QACR;MACF,CAAC;MACD,IAAI,EAAE;IACR,CAAC,CACF;IACD,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA","ignoreList":[]}
@@ -1,110 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.default = void 0;
7
- var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
8
- var _jsdocUtils = require("../jsdocUtils.cjs");
9
- var _jsdoccomment = require("@es-joy/jsdoccomment");
10
- function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
11
- var _default = exports.default = (0, _iterateJsdoc.default)(({
12
- context,
13
- indent,
14
- jsdoc,
15
- utils
16
- }) => {
17
- const {
18
- enableFixer = true
19
- } = context.options[0] || {};
20
-
21
- /**
22
- * @param {import('@es-joy/jsdoccomment').JsdocTagWithInline} tag
23
- */
24
- const checkType = tag => {
25
- const potentialType = tag.type;
26
-
27
- /** @type {import('jsdoc-type-pratt-parser').RootResult} */
28
- let parsedType;
29
- try {
30
- parsedType = (0, _jsdoccomment.parse)(/** @type {string} */potentialType, 'typescript');
31
- } catch {
32
- return;
33
- }
34
- (0, _jsdoccomment.traverse)(parsedType, (nde, parentNode) => {
35
- // @ts-expect-error Adding our own property for use below
36
- nde.parentNode = parentNode;
37
- });
38
- (0, _jsdoccomment.traverse)(parsedType, (nde, parentNode, property, index) => {
39
- switch (nde.type) {
40
- case 'JsdocTypeCallSignature':
41
- {
42
- const object = /** @type {import('jsdoc-type-pratt-parser').ObjectResult} */
43
- parentNode;
44
- if (typeof index === 'number' && object.elements.length === 1) {
45
- utils.reportJSDoc('Call signature found; function type preferred.', tag, enableFixer ? () => {
46
- const func = /** @type {import('jsdoc-type-pratt-parser').FunctionResult} */{
47
- arrow: true,
48
- constructor: false,
49
- meta: (/** @type {Required<import('jsdoc-type-pratt-parser').MethodSignatureResult['meta']>} */
50
- nde.meta),
51
- parameters: nde.parameters,
52
- parenthesis: true,
53
- returnType: nde.returnType,
54
- type: 'JsdocTypeFunction',
55
- typeParameters: nde.typeParameters
56
- };
57
- if (property && 'parentNode' in object && object.parentNode) {
58
- if (typeof object.parentNode === 'object' && 'elements' in object.parentNode && Array.isArray(object.parentNode.elements)) {
59
- const idx = object.parentNode.elements.indexOf(object);
60
- object.parentNode.elements[idx] = func;
61
- /* c8 ignore next 6 -- Guard */
62
- } else {
63
- throw new Error(
64
- // @ts-expect-error Ok
65
- `Rule currently unable to handle type ${object.parentNode.type}`);
66
- }
67
- } else {
68
- parsedType = func;
69
- }
70
- (0, _jsdocUtils.rewireByParsedType)(jsdoc, tag, parsedType, indent);
71
- } : null);
72
- }
73
- break;
74
- }
75
- }
76
- });
77
- };
78
- const tags = utils.filterTags(({
79
- tag
80
- }) => {
81
- return Boolean(tag !== 'import' && utils.tagMightHaveTypePosition(tag));
82
- });
83
- for (const tag of tags) {
84
- if (tag.type) {
85
- checkType(tag);
86
- }
87
- }
88
- }, {
89
- iterateAllJsdocs: true,
90
- meta: {
91
- docs: {
92
- description: 'Prefers function types over call signatures when there are no other properties.',
93
- url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/ts-prefer-function-type.md#repos-sticky-header'
94
- },
95
- fixable: 'code',
96
- schema: [{
97
- additionalProperties: false,
98
- properties: {
99
- enableFixer: {
100
- description: 'Whether to enable the fixer or not',
101
- type: 'boolean'
102
- }
103
- },
104
- type: 'object'
105
- }],
106
- type: 'suggestion'
107
- }
108
- });
109
- module.exports = exports.default;
110
- //# sourceMappingURL=tsPreferFunctionType.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"tsPreferFunctionType.cjs","names":["iterateJsdoc","parseType","traverse","rewireByParsedType"],"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;AACA;AAGA;AAG8B;AAAA,iCAEf,IAAAA,qBAAY,EAAC,CAAC;EAC3B,OAAO;EACP,MAAM;EACN,KAAK;EACL;AACF,CAAC,KAAK;EACJ,MAAM;IACJ,WAAW,GAAG;EAChB,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;;EAE5B;AACF;AACA;EACE,MAAM,SAAS,GAAI,GAAG,IAAK;IACzB,MAAM,aAAa,GAAG,GAAG,CAAC,IAAI;;IAE9B;IACA,IAAI,UAAU;IACd,IAAI;MACF,UAAU,GAAG,IAAAC,mBAAS,EACpB,qBAAuB,aAAa,EAAG,YACzC,CAAC;IACH,CAAC,CAAC,MAAM;MACN;IACF;IAEA,IAAAC,cAAA,QAAQ,EAAC,UAAU,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK;MACxC;MACA,GAAG,CAAC,UAAU,GAAG,UAAU;IAC7B,CAAC,CAAC;IAEF,IAAAA,cAAA,QAAQ,EAAC,UAAU,EAAE,CAAC,GAAG,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK,KAAK;MACzD,QAAQ,GAAG,CAAC,IAAI;QACd,KAAK,wBAAwB;UAAE;YAC7B,MAAM,MAAM,GAAG;YACb,UACD;YACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;cAC7D,KAAK,CAAC,WAAW,CACf,gDAAgD,EAChD,GAAG,EACH,WAAW,GAAG,MAAM;gBAClB,MAAM,IAAI,GAAG,+DAAiE;kBAC5E,KAAK,EAAE,IAAI;kBACX,WAAW,EAAE,KAAK;kBAClB,IAAI,GAAE;kBACJ,GAAG,CAAC,IAAI,CACT;kBACD,UAAU,EAAE,GAAG,CAAC,UAAU;kBAC1B,WAAW,EAAE,IAAI;kBACjB,UAAU,EAAE,GAAG,CAAC,UAAU;kBAC1B,IAAI,EAAE,mBAAmB;kBACzB,cAAc,EAAE,GAAG,CAAC;gBACtB,CAAE;gBAEF,IAAI,QAAQ,IAAI,YAAY,IAAI,MAAM,IAAI,MAAM,CAAC,UAAU,EAAE;kBAC3D,IAAI,OAAO,MAAM,CAAC,UAAU,KAAK,QAAQ,IACrC,UAAU,IAAI,MAAM,CAAC,UAAU,IAC/B,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,EAC3C;oBACA,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC;oBACtD,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI;oBACxC;kBACA,CAAC,MAAM;oBACL,MAAM,IAAI,KAAK;oBACb;oBACA,wCAAwC,MAAM,CAAC,UAAU,CAAC,IAAI,EAChE,CAAC;kBACH;gBACF,CAAC,MAAM;kBACL,UAAU,GAAG,IAAI;gBACnB;gBAEA,IAAAC,YAAA,kBAAkB,EAAC,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,CAAC;cACpD,CAAC,GAAG,IACN,CAAC;YACH;YAEA;UACF;MACF;IACF,CAAC,CAAC;EACJ,CAAC;EAED,MAAM,IAAI,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;IAC7B;EACF,CAAC,KAAK;IACJ,OAAO,OAAO,CAAC,GAAG,KAAK,QAAQ,IAAI,KAAK,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;EACzE,CAAC,CAAC;EAEF,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;IACtB,IAAI,GAAG,CAAC,IAAI,EAAE;MACZ,SAAS,CAAC,GAAG,CAAC;IAChB;EACF;AACF,CAAC,EAAE;EACD,gBAAgB,EAAE,IAAI;EACtB,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EAAE,iFAAiF;MAC9F,GAAG,EAAE;IACP,CAAC;IACD,OAAO,EAAE,MAAM;IACf,MAAM,EAAE,CACN;MACE,oBAAoB,EAAE,KAAK;MAC3B,UAAU,EAAE;QACV,WAAW,EAAE;UACX,WAAW,EAAE,oCAAoC;UACjD,IAAI,EAAE;QACR;MACF,CAAC;MACD,IAAI,EAAE;IACR,CAAC,CACF;IACD,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA","ignoreList":[]}