@depup/eslint-plugin-jsdoc 62.8.0-depup.0

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 (430) hide show
  1. package/LICENSE +24 -0
  2. package/README.md +33 -0
  3. package/changes.json +18 -0
  4. package/dist/WarnSettings.cjs +38 -0
  5. package/dist/WarnSettings.cjs.map +1 -0
  6. package/dist/WarnSettings.d.ts +17 -0
  7. package/dist/alignTransform.cjs +402 -0
  8. package/dist/alignTransform.cjs.map +1 -0
  9. package/dist/alignTransform.d.ts +34 -0
  10. package/dist/buildForbidRuleDefinition.cjs +101 -0
  11. package/dist/buildForbidRuleDefinition.cjs.map +1 -0
  12. package/dist/buildForbidRuleDefinition.d.ts +15 -0
  13. package/dist/buildRejectOrPreferRuleDefinition.cjs +352 -0
  14. package/dist/buildRejectOrPreferRuleDefinition.cjs.map +1 -0
  15. package/dist/buildRejectOrPreferRuleDefinition.d.ts +9 -0
  16. package/dist/cjs/WarnSettings.d.ts +16 -0
  17. package/dist/cjs/alignTransform.d.ts +33 -0
  18. package/dist/cjs/buildForbidRuleDefinition.d.ts +14 -0
  19. package/dist/cjs/buildRejectOrPreferRuleDefinition.d.ts +8 -0
  20. package/dist/cjs/defaultTagOrder.d.ts +4 -0
  21. package/dist/cjs/exportParser.d.ts +40 -0
  22. package/dist/cjs/getDefaultTagStructureForMode.d.ts +10 -0
  23. package/dist/cjs/getJsdocProcessorPlugin.d.cts +5 -0
  24. package/dist/cjs/getJsdocProcessorPlugin.d.ts +66 -0
  25. package/dist/cjs/index-cjs.d.ts +23 -0
  26. package/dist/cjs/index.cjs.d.cts +2 -0
  27. package/dist/cjs/iterateJsdoc.d.cts +7 -0
  28. package/dist/cjs/iterateJsdoc.d.ts +495 -0
  29. package/dist/cjs/jsdocUtils.d.ts +493 -0
  30. package/dist/cjs/rules/checkAccess.d.ts +2 -0
  31. package/dist/cjs/rules/checkAlignment.d.ts +2 -0
  32. package/dist/cjs/rules/checkExamples.d.ts +3 -0
  33. package/dist/cjs/rules/checkIndentation.d.ts +2 -0
  34. package/dist/cjs/rules/checkLineAlignment.d.ts +9 -0
  35. package/dist/cjs/rules/checkParamNames.d.ts +2 -0
  36. package/dist/cjs/rules/checkPropertyNames.d.ts +2 -0
  37. package/dist/cjs/rules/checkSyntax.d.ts +2 -0
  38. package/dist/cjs/rules/checkTagNames.d.ts +2 -0
  39. package/dist/cjs/rules/checkTemplateNames.d.ts +2 -0
  40. package/dist/cjs/rules/checkTypes.d.ts +7 -0
  41. package/dist/cjs/rules/checkValues.d.ts +2 -0
  42. package/dist/cjs/rules/convertToJsdocComments.d.ts +266 -0
  43. package/dist/cjs/rules/emptyTags.d.ts +2 -0
  44. package/dist/cjs/rules/escapeInlineTags.d.ts +2 -0
  45. package/dist/cjs/rules/implementsOnClasses.d.ts +2 -0
  46. package/dist/cjs/rules/importsAsDependencies.d.ts +2 -0
  47. package/dist/cjs/rules/informativeDocs.d.ts +2 -0
  48. package/dist/cjs/rules/linesBeforeBlock.d.ts +2 -0
  49. package/dist/cjs/rules/matchDescription.d.ts +2 -0
  50. package/dist/cjs/rules/matchName.d.ts +2 -0
  51. package/dist/cjs/rules/multilineBlocks.d.ts +2 -0
  52. package/dist/cjs/rules/noBadBlocks.d.ts +2 -0
  53. package/dist/cjs/rules/noBlankBlockDescriptions.d.ts +2 -0
  54. package/dist/cjs/rules/noBlankBlocks.d.ts +2 -0
  55. package/dist/cjs/rules/noDefaults.d.ts +2 -0
  56. package/dist/cjs/rules/noMissingSyntax.d.ts +9 -0
  57. package/dist/cjs/rules/noMultiAsterisks.d.ts +2 -0
  58. package/dist/cjs/rules/noRestrictedSyntax.d.ts +2 -0
  59. package/dist/cjs/rules/noTypes.d.ts +2 -0
  60. package/dist/cjs/rules/noUndefinedTypes.d.ts +2 -0
  61. package/dist/cjs/rules/preferImportTag.d.ts +2 -0
  62. package/dist/cjs/rules/requireAsteriskPrefix.d.ts +2 -0
  63. package/dist/cjs/rules/requireDescription.d.ts +2 -0
  64. package/dist/cjs/rules/requireDescriptionCompleteSentence.d.ts +2 -0
  65. package/dist/cjs/rules/requireExample.d.ts +2 -0
  66. package/dist/cjs/rules/requireFileOverview.d.ts +2 -0
  67. package/dist/cjs/rules/requireHyphenBeforeParamDescription.d.ts +2 -0
  68. package/dist/cjs/rules/requireJsdoc.d.ts +24 -0
  69. package/dist/cjs/rules/requireParam.d.ts +3 -0
  70. package/dist/cjs/rules/requireParamDescription.d.ts +2 -0
  71. package/dist/cjs/rules/requireParamName.d.ts +2 -0
  72. package/dist/cjs/rules/requireParamType.d.ts +2 -0
  73. package/dist/cjs/rules/requireProperty.d.ts +2 -0
  74. package/dist/cjs/rules/requirePropertyDescription.d.ts +2 -0
  75. package/dist/cjs/rules/requirePropertyName.d.ts +2 -0
  76. package/dist/cjs/rules/requirePropertyType.d.ts +2 -0
  77. package/dist/cjs/rules/requireRejects.d.ts +2 -0
  78. package/dist/cjs/rules/requireReturns.d.ts +2 -0
  79. package/dist/cjs/rules/requireReturnsCheck.d.ts +2 -0
  80. package/dist/cjs/rules/requireReturnsDescription.d.ts +2 -0
  81. package/dist/cjs/rules/requireReturnsType.d.ts +2 -0
  82. package/dist/cjs/rules/requireTags.d.ts +2 -0
  83. package/dist/cjs/rules/requireTemplate.d.ts +2 -0
  84. package/dist/cjs/rules/requireThrows.d.ts +2 -0
  85. package/dist/cjs/rules/requireYields.d.ts +2 -0
  86. package/dist/cjs/rules/requireYieldsCheck.d.ts +2 -0
  87. package/dist/cjs/rules/sortTags.d.ts +2 -0
  88. package/dist/cjs/rules/tagLines.d.ts +2 -0
  89. package/dist/cjs/rules/textEscaping.d.ts +2 -0
  90. package/dist/cjs/rules/tsMethodSignatureStyle.d.ts +2 -0
  91. package/dist/cjs/rules/tsNoEmptyObjectType.d.ts +2 -0
  92. package/dist/cjs/rules/tsNoUnnecessaryTemplateExpression.d.ts +2 -0
  93. package/dist/cjs/rules/tsPreferFunctionType.d.ts +2 -0
  94. package/dist/cjs/rules/typeFormatting.d.ts +2 -0
  95. package/dist/cjs/rules/validTypes.d.ts +2 -0
  96. package/dist/cjs/tagNames.d.ts +15 -0
  97. package/dist/cjs/utils/hasReturnValue.d.ts +19 -0
  98. package/dist/defaultTagOrder.cjs +46 -0
  99. package/dist/defaultTagOrder.cjs.map +1 -0
  100. package/dist/defaultTagOrder.d.ts +5 -0
  101. package/dist/exportParser.cjs +732 -0
  102. package/dist/exportParser.cjs.map +1 -0
  103. package/dist/exportParser.d.ts +41 -0
  104. package/dist/generateDocs.cjs +342 -0
  105. package/dist/generateDocs.cjs.map +1 -0
  106. package/dist/generateOptions.cjs +62 -0
  107. package/dist/generateOptions.cjs.map +1 -0
  108. package/dist/generateRule.cjs +248 -0
  109. package/dist/generateRule.cjs.map +1 -0
  110. package/dist/generateRuleTypes.cjs +24 -0
  111. package/dist/generateRuleTypes.cjs.map +1 -0
  112. package/dist/getDefaultTagStructureForMode.cjs +289 -0
  113. package/dist/getDefaultTagStructureForMode.cjs.map +1 -0
  114. package/dist/getDefaultTagStructureForMode.d.ts +11 -0
  115. package/dist/getJsdocProcessorPlugin.cjs +587 -0
  116. package/dist/getJsdocProcessorPlugin.cjs.map +1 -0
  117. package/dist/getJsdocProcessorPlugin.cts +5 -0
  118. package/dist/getJsdocProcessorPlugin.d.ts +67 -0
  119. package/dist/index-cjs.cjs +595 -0
  120. package/dist/index-cjs.cjs.map +1 -0
  121. package/dist/index-cjs.d.ts +24 -0
  122. package/dist/index-esm.cjs +162 -0
  123. package/dist/index-esm.cjs.map +1 -0
  124. package/dist/index-esm.d.ts +72 -0
  125. package/dist/index.cjs +743 -0
  126. package/dist/index.cjs.cts +3 -0
  127. package/dist/index.cjs.map +1 -0
  128. package/dist/index.d.ts +93 -0
  129. package/dist/iterateJsdoc.cjs +2150 -0
  130. package/dist/iterateJsdoc.cjs.map +1 -0
  131. package/dist/iterateJsdoc.cts +7 -0
  132. package/dist/iterateJsdoc.d.ts +496 -0
  133. package/dist/jsdocUtils.cjs +1725 -0
  134. package/dist/jsdocUtils.cjs.map +1 -0
  135. package/dist/jsdocUtils.d.ts +494 -0
  136. package/dist/rules/checkAccess.cjs +40 -0
  137. package/dist/rules/checkAccess.cjs.map +1 -0
  138. package/dist/rules/checkAccess.d.ts +3 -0
  139. package/dist/rules/checkAlignment.cjs +78 -0
  140. package/dist/rules/checkAlignment.cjs.map +1 -0
  141. package/dist/rules/checkAlignment.d.ts +3 -0
  142. package/dist/rules/checkExamples.cjs +521 -0
  143. package/dist/rules/checkExamples.cjs.map +1 -0
  144. package/dist/rules/checkExamples.d.ts +4 -0
  145. package/dist/rules/checkIndentation.cjs +170 -0
  146. package/dist/rules/checkIndentation.cjs.map +1 -0
  147. package/dist/rules/checkIndentation.d.ts +3 -0
  148. package/dist/rules/checkLineAlignment.cjs +398 -0
  149. package/dist/rules/checkLineAlignment.cjs.map +1 -0
  150. package/dist/rules/checkLineAlignment.d.ts +10 -0
  151. package/dist/rules/checkParamNames.cjs +407 -0
  152. package/dist/rules/checkParamNames.cjs.map +1 -0
  153. package/dist/rules/checkParamNames.d.ts +3 -0
  154. package/dist/rules/checkPropertyNames.cjs +135 -0
  155. package/dist/rules/checkPropertyNames.cjs.map +1 -0
  156. package/dist/rules/checkPropertyNames.d.ts +3 -0
  157. package/dist/rules/checkSyntax.cjs +38 -0
  158. package/dist/rules/checkSyntax.cjs.map +1 -0
  159. package/dist/rules/checkSyntax.d.ts +3 -0
  160. package/dist/rules/checkTagNames.cjs +312 -0
  161. package/dist/rules/checkTagNames.cjs.map +1 -0
  162. package/dist/rules/checkTagNames.d.ts +3 -0
  163. package/dist/rules/checkTemplateNames.cjs +185 -0
  164. package/dist/rules/checkTemplateNames.cjs.map +1 -0
  165. package/dist/rules/checkTemplateNames.d.ts +3 -0
  166. package/dist/rules/checkTypes.cjs +111 -0
  167. package/dist/rules/checkTypes.cjs.map +1 -0
  168. package/dist/rules/checkTypes.d.ts +8 -0
  169. package/dist/rules/checkValues.cjs +166 -0
  170. package/dist/rules/checkValues.cjs.map +1 -0
  171. package/dist/rules/checkValues.d.ts +3 -0
  172. package/dist/rules/convertToJsdocComments.cjs +356 -0
  173. package/dist/rules/convertToJsdocComments.cjs.map +1 -0
  174. package/dist/rules/convertToJsdocComments.d.ts +267 -0
  175. package/dist/rules/emptyTags.cjs +85 -0
  176. package/dist/rules/emptyTags.cjs.map +1 -0
  177. package/dist/rules/emptyTags.d.ts +3 -0
  178. package/dist/rules/escapeInlineTags.cjs +149 -0
  179. package/dist/rules/escapeInlineTags.cjs.map +1 -0
  180. package/dist/rules/escapeInlineTags.d.ts +3 -0
  181. package/dist/rules/implementsOnClasses.cjs +74 -0
  182. package/dist/rules/implementsOnClasses.cjs.map +1 -0
  183. package/dist/rules/implementsOnClasses.d.ts +3 -0
  184. package/dist/rules/importsAsDependencies.cjs +104 -0
  185. package/dist/rules/importsAsDependencies.cjs.map +1 -0
  186. package/dist/rules/importsAsDependencies.d.ts +3 -0
  187. package/dist/rules/informativeDocs.cjs +187 -0
  188. package/dist/rules/informativeDocs.cjs.map +1 -0
  189. package/dist/rules/informativeDocs.d.ts +3 -0
  190. package/dist/rules/linesBeforeBlock.cjs +120 -0
  191. package/dist/rules/linesBeforeBlock.cjs.map +1 -0
  192. package/dist/rules/linesBeforeBlock.d.ts +3 -0
  193. package/dist/rules/matchDescription.cjs +356 -0
  194. package/dist/rules/matchDescription.cjs.map +1 -0
  195. package/dist/rules/matchDescription.d.ts +3 -0
  196. package/dist/rules/matchName.cjs +160 -0
  197. package/dist/rules/matchName.cjs.map +1 -0
  198. package/dist/rules/matchName.d.ts +3 -0
  199. package/dist/rules/multilineBlocks.cjs +431 -0
  200. package/dist/rules/multilineBlocks.cjs.map +1 -0
  201. package/dist/rules/multilineBlocks.d.ts +3 -0
  202. package/dist/rules/noBadBlocks.cjs +100 -0
  203. package/dist/rules/noBadBlocks.cjs.map +1 -0
  204. package/dist/rules/noBadBlocks.d.ts +3 -0
  205. package/dist/rules/noBlankBlockDescriptions.cjs +63 -0
  206. package/dist/rules/noBlankBlockDescriptions.cjs.map +1 -0
  207. package/dist/rules/noBlankBlockDescriptions.d.ts +3 -0
  208. package/dist/rules/noBlankBlocks.cjs +54 -0
  209. package/dist/rules/noBlankBlocks.cjs.map +1 -0
  210. package/dist/rules/noBlankBlocks.d.ts +3 -0
  211. package/dist/rules/noDefaults.cjs +102 -0
  212. package/dist/rules/noDefaults.cjs.map +1 -0
  213. package/dist/rules/noDefaults.d.ts +3 -0
  214. package/dist/rules/noMissingSyntax.cjs +196 -0
  215. package/dist/rules/noMissingSyntax.cjs.map +1 -0
  216. package/dist/rules/noMissingSyntax.d.ts +10 -0
  217. package/dist/rules/noMultiAsterisks.cjs +126 -0
  218. package/dist/rules/noMultiAsterisks.cjs.map +1 -0
  219. package/dist/rules/noMultiAsterisks.d.ts +3 -0
  220. package/dist/rules/noRestrictedSyntax.cjs +68 -0
  221. package/dist/rules/noRestrictedSyntax.cjs.map +1 -0
  222. package/dist/rules/noRestrictedSyntax.d.ts +3 -0
  223. package/dist/rules/noTypes.cjs +101 -0
  224. package/dist/rules/noTypes.cjs.map +1 -0
  225. package/dist/rules/noTypes.d.ts +3 -0
  226. package/dist/rules/noUndefinedTypes.cjs +588 -0
  227. package/dist/rules/noUndefinedTypes.cjs.map +1 -0
  228. package/dist/rules/noUndefinedTypes.d.ts +3 -0
  229. package/dist/rules/preferImportTag.cjs +362 -0
  230. package/dist/rules/preferImportTag.cjs.map +1 -0
  231. package/dist/rules/preferImportTag.d.ts +3 -0
  232. package/dist/rules/requireAsteriskPrefix.cjs +190 -0
  233. package/dist/rules/requireAsteriskPrefix.cjs.map +1 -0
  234. package/dist/rules/requireAsteriskPrefix.d.ts +3 -0
  235. package/dist/rules/requireDescription.cjs +164 -0
  236. package/dist/rules/requireDescription.cjs.map +1 -0
  237. package/dist/rules/requireDescription.d.ts +3 -0
  238. package/dist/rules/requireDescriptionCompleteSentence.cjs +321 -0
  239. package/dist/rules/requireDescriptionCompleteSentence.cjs.map +1 -0
  240. package/dist/rules/requireDescriptionCompleteSentence.d.ts +3 -0
  241. package/dist/rules/requireExample.cjs +133 -0
  242. package/dist/rules/requireExample.cjs.map +1 -0
  243. package/dist/rules/requireExample.d.ts +3 -0
  244. package/dist/rules/requireFileOverview.cjs +194 -0
  245. package/dist/rules/requireFileOverview.cjs.map +1 -0
  246. package/dist/rules/requireFileOverview.d.ts +3 -0
  247. package/dist/rules/requireHyphenBeforeParamDescription.cjs +166 -0
  248. package/dist/rules/requireHyphenBeforeParamDescription.cjs.map +1 -0
  249. package/dist/rules/requireHyphenBeforeParamDescription.d.ts +3 -0
  250. package/dist/rules/requireJsdoc.cjs +722 -0
  251. package/dist/rules/requireJsdoc.cjs.map +1 -0
  252. package/dist/rules/requireJsdoc.d.ts +25 -0
  253. package/dist/rules/requireParam.cjs +772 -0
  254. package/dist/rules/requireParam.cjs.map +1 -0
  255. package/dist/rules/requireParam.d.ts +4 -0
  256. package/dist/rules/requireParamDescription.cjs +105 -0
  257. package/dist/rules/requireParamDescription.cjs.map +1 -0
  258. package/dist/rules/requireParamDescription.d.ts +3 -0
  259. package/dist/rules/requireParamName.cjs +68 -0
  260. package/dist/rules/requireParamName.cjs.map +1 -0
  261. package/dist/rules/requireParamName.d.ts +3 -0
  262. package/dist/rules/requireParamType.cjs +104 -0
  263. package/dist/rules/requireParamType.cjs.map +1 -0
  264. package/dist/rules/requireParamType.d.ts +3 -0
  265. package/dist/rules/requireProperty.cjs +63 -0
  266. package/dist/rules/requireProperty.cjs.map +1 -0
  267. package/dist/rules/requireProperty.d.ts +3 -0
  268. package/dist/rules/requirePropertyDescription.cjs +29 -0
  269. package/dist/rules/requirePropertyDescription.cjs.map +1 -0
  270. package/dist/rules/requirePropertyDescription.d.ts +3 -0
  271. package/dist/rules/requirePropertyName.cjs +29 -0
  272. package/dist/rules/requirePropertyName.cjs.map +1 -0
  273. package/dist/rules/requirePropertyName.d.ts +3 -0
  274. package/dist/rules/requirePropertyType.cjs +29 -0
  275. package/dist/rules/requirePropertyType.cjs.map +1 -0
  276. package/dist/rules/requirePropertyType.d.ts +3 -0
  277. package/dist/rules/requireRejects.cjs +226 -0
  278. package/dist/rules/requireRejects.cjs.map +1 -0
  279. package/dist/rules/requireRejects.d.ts +3 -0
  280. package/dist/rules/requireReturns.cjs +262 -0
  281. package/dist/rules/requireReturns.cjs.map +1 -0
  282. package/dist/rules/requireReturns.d.ts +3 -0
  283. package/dist/rules/requireReturnsCheck.cjs +140 -0
  284. package/dist/rules/requireReturnsCheck.cjs.map +1 -0
  285. package/dist/rules/requireReturnsCheck.d.ts +3 -0
  286. package/dist/rules/requireReturnsDescription.cjs +72 -0
  287. package/dist/rules/requireReturnsDescription.cjs.map +1 -0
  288. package/dist/rules/requireReturnsDescription.d.ts +3 -0
  289. package/dist/rules/requireReturnsType.cjs +68 -0
  290. package/dist/rules/requireReturnsType.cjs.map +1 -0
  291. package/dist/rules/requireReturnsType.d.ts +3 -0
  292. package/dist/rules/requireTags.cjs +74 -0
  293. package/dist/rules/requireTags.cjs.map +1 -0
  294. package/dist/rules/requireTags.d.ts +3 -0
  295. package/dist/rules/requireTemplate.cjs +220 -0
  296. package/dist/rules/requireTemplate.cjs.map +1 -0
  297. package/dist/rules/requireTemplate.d.ts +3 -0
  298. package/dist/rules/requireThrows.cjs +118 -0
  299. package/dist/rules/requireThrows.cjs.map +1 -0
  300. package/dist/rules/requireThrows.d.ts +3 -0
  301. package/dist/rules/requireYields.cjs +224 -0
  302. package/dist/rules/requireYields.cjs.map +1 -0
  303. package/dist/rules/requireYields.d.ts +3 -0
  304. package/dist/rules/requireYieldsCheck.cjs +179 -0
  305. package/dist/rules/requireYieldsCheck.cjs.map +1 -0
  306. package/dist/rules/requireYieldsCheck.d.ts +3 -0
  307. package/dist/rules/sortTags.cjs +656 -0
  308. package/dist/rules/sortTags.cjs.map +1 -0
  309. package/dist/rules/sortTags.d.ts +3 -0
  310. package/dist/rules/tagLines.cjs +374 -0
  311. package/dist/rules/tagLines.cjs.map +1 -0
  312. package/dist/rules/tagLines.d.ts +3 -0
  313. package/dist/rules/textEscaping.cjs +141 -0
  314. package/dist/rules/textEscaping.cjs.map +1 -0
  315. package/dist/rules/textEscaping.d.ts +3 -0
  316. package/dist/rules/tsMethodSignatureStyle.cjs +240 -0
  317. package/dist/rules/tsMethodSignatureStyle.cjs.map +1 -0
  318. package/dist/rules/tsMethodSignatureStyle.d.ts +3 -0
  319. package/dist/rules/tsNoEmptyObjectType.cjs +62 -0
  320. package/dist/rules/tsNoEmptyObjectType.cjs.map +1 -0
  321. package/dist/rules/tsNoEmptyObjectType.d.ts +3 -0
  322. package/dist/rules/tsNoUnnecessaryTemplateExpression.cjs +104 -0
  323. package/dist/rules/tsNoUnnecessaryTemplateExpression.cjs.map +1 -0
  324. package/dist/rules/tsNoUnnecessaryTemplateExpression.d.ts +3 -0
  325. package/dist/rules/tsPreferFunctionType.cjs +110 -0
  326. package/dist/rules/tsPreferFunctionType.cjs.map +1 -0
  327. package/dist/rules/tsPreferFunctionType.d.ts +3 -0
  328. package/dist/rules/typeFormatting.cjs +607 -0
  329. package/dist/rules/typeFormatting.cjs.map +1 -0
  330. package/dist/rules/typeFormatting.d.ts +3 -0
  331. package/dist/rules/validTypes.cjs +328 -0
  332. package/dist/rules/validTypes.cjs.map +1 -0
  333. package/dist/rules/validTypes.d.ts +3 -0
  334. package/dist/rules.d.ts +3203 -0
  335. package/dist/tagNames.cjs +244 -0
  336. package/dist/tagNames.cjs.map +1 -0
  337. package/dist/tagNames.d.ts +16 -0
  338. package/dist/to-valid-identifier.cjs +263 -0
  339. package/dist/utils/hasReturnValue.cjs +495 -0
  340. package/dist/utils/hasReturnValue.cjs.map +1 -0
  341. package/dist/utils/hasReturnValue.d.ts +20 -0
  342. package/package.json +220 -0
  343. package/rollup.config.js +16 -0
  344. package/src/WarnSettings.js +34 -0
  345. package/src/alignTransform.js +444 -0
  346. package/src/buildForbidRuleDefinition.js +106 -0
  347. package/src/buildRejectOrPreferRuleDefinition.js +481 -0
  348. package/src/defaultTagOrder.js +169 -0
  349. package/src/exportParser.js +973 -0
  350. package/src/getDefaultTagStructureForMode.js +968 -0
  351. package/src/getJsdocProcessorPlugin.cts +5 -0
  352. package/src/getJsdocProcessorPlugin.js +692 -0
  353. package/src/index-cjs.js +755 -0
  354. package/src/index-esm.js +196 -0
  355. package/src/index.cjs.cts +3 -0
  356. package/src/index.js +940 -0
  357. package/src/iterateJsdoc.cts +7 -0
  358. package/src/iterateJsdoc.js +2612 -0
  359. package/src/jsdocUtils.js +2158 -0
  360. package/src/rules/checkAccess.js +45 -0
  361. package/src/rules/checkAlignment.js +82 -0
  362. package/src/rules/checkExamples.js +613 -0
  363. package/src/rules/checkIndentation.js +176 -0
  364. package/src/rules/checkLineAlignment.js +453 -0
  365. package/src/rules/checkParamNames.js +541 -0
  366. package/src/rules/checkPropertyNames.js +174 -0
  367. package/src/rules/checkSyntax.js +30 -0
  368. package/src/rules/checkTagNames.js +414 -0
  369. package/src/rules/checkTemplateNames.js +208 -0
  370. package/src/rules/checkTypes.js +130 -0
  371. package/src/rules/checkValues.js +264 -0
  372. package/src/rules/convertToJsdocComments.js +444 -0
  373. package/src/rules/emptyTags.js +106 -0
  374. package/src/rules/escapeInlineTags.js +189 -0
  375. package/src/rules/implementsOnClasses.js +78 -0
  376. package/src/rules/importsAsDependencies.js +132 -0
  377. package/src/rules/informativeDocs.js +228 -0
  378. package/src/rules/linesBeforeBlock.js +144 -0
  379. package/src/rules/matchDescription.js +413 -0
  380. package/src/rules/matchName.js +179 -0
  381. package/src/rules/multilineBlocks.js +562 -0
  382. package/src/rules/noBadBlocks.js +127 -0
  383. package/src/rules/noBlankBlockDescriptions.js +69 -0
  384. package/src/rules/noBlankBlocks.js +55 -0
  385. package/src/rules/noDefaults.js +104 -0
  386. package/src/rules/noMissingSyntax.js +215 -0
  387. package/src/rules/noMultiAsterisks.js +162 -0
  388. package/src/rules/noRestrictedSyntax.js +72 -0
  389. package/src/rules/noTypes.js +108 -0
  390. package/src/rules/noUndefinedTypes.js +797 -0
  391. package/src/rules/preferImportTag.js +521 -0
  392. package/src/rules/requireAsteriskPrefix.js +217 -0
  393. package/src/rules/requireDescription.js +190 -0
  394. package/src/rules/requireDescriptionCompleteSentence.js +376 -0
  395. package/src/rules/requireExample.js +143 -0
  396. package/src/rules/requireFileOverview.js +213 -0
  397. package/src/rules/requireHyphenBeforeParamDescription.js +210 -0
  398. package/src/rules/requireJsdoc.js +897 -0
  399. package/src/rules/requireParam.js +848 -0
  400. package/src/rules/requireParamDescription.js +110 -0
  401. package/src/rules/requireParamName.js +69 -0
  402. package/src/rules/requireParamType.js +109 -0
  403. package/src/rules/requireProperty.js +66 -0
  404. package/src/rules/requirePropertyDescription.js +25 -0
  405. package/src/rules/requirePropertyName.js +25 -0
  406. package/src/rules/requirePropertyType.js +25 -0
  407. package/src/rules/requireRejects.js +246 -0
  408. package/src/rules/requireReturns.js +291 -0
  409. package/src/rules/requireReturnsCheck.js +180 -0
  410. package/src/rules/requireReturnsDescription.js +73 -0
  411. package/src/rules/requireReturnsType.js +65 -0
  412. package/src/rules/requireTags.js +85 -0
  413. package/src/rules/requireTemplate.js +246 -0
  414. package/src/rules/requireThrows.js +128 -0
  415. package/src/rules/requireYields.js +265 -0
  416. package/src/rules/requireYieldsCheck.js +226 -0
  417. package/src/rules/sortTags.js +766 -0
  418. package/src/rules/tagLines.js +486 -0
  419. package/src/rules/textEscaping.js +158 -0
  420. package/src/rules/tsMethodSignatureStyle.js +300 -0
  421. package/src/rules/tsNoEmptyObjectType.js +61 -0
  422. package/src/rules/tsNoUnnecessaryTemplateExpression.js +130 -0
  423. package/src/rules/tsPreferFunctionType.js +127 -0
  424. package/src/rules/typeFormatting.js +690 -0
  425. package/src/rules/validTypes.js +466 -0
  426. package/src/rules.d.ts +3203 -0
  427. package/src/tagNames.js +301 -0
  428. package/src/utils/hasReturnValue.js +572 -0
  429. package/typings/babel__eslint-parser.d.ts +1 -0
  430. package/typings/gitdown.d.ts +16 -0
@@ -0,0 +1 @@
1
+ {"version":3,"file":"textEscaping.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","htmlRegex","markdownRegex","htmlReplacer","desc","replaceAll","RegExp","_","markdownReplacer","backticks","encapsed","bookend","repeat","length","_default","exports","iterateJsdoc","context","jsdoc","utils","escapeHTML","escapeMarkdown","options","report","loc","end","column","line","start","message","descriptions","getDescription","some","test","setDescriptionLines","reportJSDoc","tag","tags","getTagDescription","setTagDescription","source","number","iterateAllJsdocs","meta","docs","description","url","fixable","schema","additionalProperties","properties","type","module"],"sources":["../../src/rules/textEscaping.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n// We could disallow raw gt, quot, and apos, but allow for parity; but we do\n// not allow hex or decimal character references\nconst htmlRegex = /(<|&(?!(?:amp|lt|gt|quot|apos);))(?=\\S)/v;\nconst markdownRegex = /(?<!\\\\)(`+)([^`]+)\\1(?!`)/v;\n\n/**\n * @param {string} desc\n * @returns {string}\n */\nconst htmlReplacer = (desc) => {\n return desc.replaceAll(new RegExp(htmlRegex, 'gv'), (_) => {\n if (_ === '<') {\n return '&lt;';\n }\n\n return '&amp;';\n });\n};\n\n/**\n * @param {string} desc\n * @returns {string}\n */\nconst markdownReplacer = (desc) => {\n return desc.replaceAll(new RegExp(markdownRegex, 'gv'), (_, backticks, encapsed) => {\n const bookend = '`'.repeat(backticks.length);\n return `\\\\${bookend}${encapsed}${bookend}`;\n });\n};\n\nexport default iterateJsdoc(({\n context,\n jsdoc,\n utils,\n}) => {\n const {\n escapeHTML,\n escapeMarkdown,\n } = context.options[0] || {};\n\n if (!escapeHTML && !escapeMarkdown) {\n context.report({\n loc: {\n end: {\n column: 1,\n line: 1,\n },\n start: {\n column: 1,\n line: 1,\n },\n },\n message: 'You must include either `escapeHTML` or `escapeMarkdown`',\n });\n return;\n }\n\n const {\n descriptions,\n } = utils.getDescription();\n\n if (escapeHTML) {\n if (descriptions.some((desc) => {\n return htmlRegex.test(desc);\n })) {\n const line = utils.setDescriptionLines(htmlRegex, htmlReplacer);\n utils.reportJSDoc('You have unescaped HTML characters < or &', {\n line,\n }, () => {}, true);\n return;\n }\n\n for (const tag of jsdoc.tags) {\n if (tag.tag === 'example') {\n continue;\n }\n\n if (/** @type {string[]} */ (\n utils.getTagDescription(tag, true)\n ).some((desc) => {\n return htmlRegex.test(desc);\n })) {\n const line = utils.setTagDescription(tag, htmlRegex, htmlReplacer) +\n tag.source[0].number;\n utils.reportJSDoc('You have unescaped HTML characters < or & in a tag', {\n line,\n }, () => {}, true);\n }\n }\n\n return;\n }\n\n if (descriptions.some((desc) => {\n return markdownRegex.test(desc);\n })) {\n const line = utils.setDescriptionLines(markdownRegex, markdownReplacer);\n utils.reportJSDoc('You have unescaped Markdown backtick sequences', {\n line,\n }, () => {}, true);\n return;\n }\n\n for (const tag of jsdoc.tags) {\n if (tag.tag === 'example') {\n continue;\n }\n\n if (/** @type {string[]} */ (\n utils.getTagDescription(tag, true)\n ).some((desc) => {\n return markdownRegex.test(desc);\n })) {\n const line = utils.setTagDescription(\n tag, markdownRegex, markdownReplacer,\n ) + tag.source[0].number;\n utils.reportJSDoc(\n 'You have unescaped Markdown backtick sequences in a tag',\n {\n line,\n },\n () => {},\n true,\n );\n }\n }\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Auto-escape certain characters that are input within block and tag descriptions.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/text-escaping.md#repos-sticky-header',\n },\n fixable: 'code',\n schema: [\n {\n additionalProperties: false,\n properties: {\n escapeHTML: {\n description: `This option escapes all \\`<\\` and \\`&\\` characters (except those followed by\nwhitespace which are treated as literals by Visual Studio Code). Defaults to\n\\`false\\`.`,\n type: 'boolean',\n },\n escapeMarkdown: {\n description: `This option escapes the first backtick (\\`\\` \\` \\`\\`) in a paired sequence.\nDefaults to \\`false\\`.`,\n type: 'boolean',\n },\n },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE9C;AACA;AACA,MAAMG,SAAS,GAAG,0CAA0C;AAC5D,MAAMC,aAAa,GAAG,4BAA4B;;AAElD;AACA;AACA;AACA;AACA,MAAMC,YAAY,GAAIC,IAAI,IAAK;EAC7B,OAAOA,IAAI,CAACC,UAAU,CAAC,IAAIC,MAAM,CAACL,SAAS,EAAE,IAAI,CAAC,EAAGM,CAAC,IAAK;IACzD,IAAIA,CAAC,KAAK,GAAG,EAAE;MACb,OAAO,MAAM;IACf;IAEA,OAAO,OAAO;EAChB,CAAC,CAAC;AACJ,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAMC,gBAAgB,GAAIJ,IAAI,IAAK;EACjC,OAAOA,IAAI,CAACC,UAAU,CAAC,IAAIC,MAAM,CAACJ,aAAa,EAAE,IAAI,CAAC,EAAE,CAACK,CAAC,EAAEE,SAAS,EAAEC,QAAQ,KAAK;IAClF,MAAMC,OAAO,GAAG,GAAG,CAACC,MAAM,CAACH,SAAS,CAACI,MAAM,CAAC;IAC5C,OAAO,KAAKF,OAAO,GAAGD,QAAQ,GAAGC,OAAO,EAAE;EAC5C,CAAC,CAAC;AACJ,CAAC;AAAC,IAAAG,QAAA,GAAAC,OAAA,CAAAf,OAAA,GAEa,IAAAgB,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,KAAK;EACLC;AACF,CAAC,KAAK;EACJ,MAAM;IACJC,UAAU;IACVC;EACF,CAAC,GAAGJ,OAAO,CAACK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,IAAI,CAACF,UAAU,IAAI,CAACC,cAAc,EAAE;IAClCJ,OAAO,CAACM,MAAM,CAAC;MACbC,GAAG,EAAE;QACHC,GAAG,EAAE;UACHC,MAAM,EAAE,CAAC;UACTC,IAAI,EAAE;QACR,CAAC;QACDC,KAAK,EAAE;UACLF,MAAM,EAAE,CAAC;UACTC,IAAI,EAAE;QACR;MACF,CAAC;MACDE,OAAO,EAAE;IACX,CAAC,CAAC;IACF;EACF;EAEA,MAAM;IACJC;EACF,CAAC,GAAGX,KAAK,CAACY,cAAc,CAAC,CAAC;EAE1B,IAAIX,UAAU,EAAE;IACd,IAAIU,YAAY,CAACE,IAAI,CAAE5B,IAAI,IAAK;MAC9B,OAAOH,SAAS,CAACgC,IAAI,CAAC7B,IAAI,CAAC;IAC7B,CAAC,CAAC,EAAE;MACF,MAAMuB,IAAI,GAAGR,KAAK,CAACe,mBAAmB,CAACjC,SAAS,EAAEE,YAAY,CAAC;MAC/DgB,KAAK,CAACgB,WAAW,CAAC,2CAA2C,EAAE;QAC7DR;MACF,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC;MAClB;IACF;IAEA,KAAK,MAAMS,GAAG,IAAIlB,KAAK,CAACmB,IAAI,EAAE;MAC5B,IAAID,GAAG,CAACA,GAAG,KAAK,SAAS,EAAE;QACzB;MACF;MAEA,IAAI,uBACFjB,KAAK,CAACmB,iBAAiB,CAACF,GAAG,EAAE,IAAI,CAAC,CAClCJ,IAAI,CAAE5B,IAAI,IAAK;QACf,OAAOH,SAAS,CAACgC,IAAI,CAAC7B,IAAI,CAAC;MAC7B,CAAC,CAAC,EAAE;QACF,MAAMuB,IAAI,GAAGR,KAAK,CAACoB,iBAAiB,CAACH,GAAG,EAAEnC,SAAS,EAAEE,YAAY,CAAC,GAChEiC,GAAG,CAACI,MAAM,CAAC,CAAC,CAAC,CAACC,MAAM;QACtBtB,KAAK,CAACgB,WAAW,CAAC,oDAAoD,EAAE;UACtER;QACF,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC;MACpB;IACF;IAEA;EACF;EAEA,IAAIG,YAAY,CAACE,IAAI,CAAE5B,IAAI,IAAK;IAC9B,OAAOF,aAAa,CAAC+B,IAAI,CAAC7B,IAAI,CAAC;EACjC,CAAC,CAAC,EAAE;IACF,MAAMuB,IAAI,GAAGR,KAAK,CAACe,mBAAmB,CAAChC,aAAa,EAAEM,gBAAgB,CAAC;IACvEW,KAAK,CAACgB,WAAW,CAAC,gDAAgD,EAAE;MAClER;IACF,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC;IAClB;EACF;EAEA,KAAK,MAAMS,GAAG,IAAIlB,KAAK,CAACmB,IAAI,EAAE;IAC5B,IAAID,GAAG,CAACA,GAAG,KAAK,SAAS,EAAE;MACzB;IACF;IAEA,IAAI,uBACFjB,KAAK,CAACmB,iBAAiB,CAACF,GAAG,EAAE,IAAI,CAAC,CAClCJ,IAAI,CAAE5B,IAAI,IAAK;MACf,OAAOF,aAAa,CAAC+B,IAAI,CAAC7B,IAAI,CAAC;IACjC,CAAC,CAAC,EAAE;MACF,MAAMuB,IAAI,GAAGR,KAAK,CAACoB,iBAAiB,CAClCH,GAAG,EAAElC,aAAa,EAAEM,gBACtB,CAAC,GAAG4B,GAAG,CAACI,MAAM,CAAC,CAAC,CAAC,CAACC,MAAM;MACxBtB,KAAK,CAACgB,WAAW,CACf,yDAAyD,EACzD;QACER;MACF,CAAC,EACD,MAAM,CAAC,CAAC,EACR,IACF,CAAC;IACH;EACF;AACF,CAAC,EAAE;EACDe,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,kFAAkF;MAC/FC,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACV9B,UAAU,EAAE;UACVyB,WAAW,EAAE;AACzB;AACA,WAAW;UACCM,IAAI,EAAE;QACR,CAAC;QACD9B,cAAc,EAAE;UACdwB,WAAW,EAAE;AACzB,uBAAuB;UACXM,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAC,MAAA,CAAArC,OAAA,GAAAA,OAAA,CAAAf,OAAA","ignoreList":[]}
@@ -0,0 +1,3 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
3
+ //# sourceMappingURL=textEscaping.d.ts.map
@@ -0,0 +1,240 @@
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
@@ -0,0 +1 @@
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":[]}
@@ -0,0 +1,3 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
3
+ //# sourceMappingURL=tsMethodSignatureStyle.d.ts.map
@@ -0,0 +1,62 @@
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
@@ -0,0 +1 @@
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":[]}
@@ -0,0 +1,3 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
3
+ //# sourceMappingURL=tsNoEmptyObjectType.d.ts.map
@@ -0,0 +1,104 @@
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
@@ -0,0 +1 @@
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":[]}
@@ -0,0 +1,3 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
3
+ //# sourceMappingURL=tsNoUnnecessaryTemplateExpression.d.ts.map
@@ -0,0 +1,110 @@
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
@@ -0,0 +1 @@
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":[]}
@@ -0,0 +1,3 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
3
+ //# sourceMappingURL=tsPreferFunctionType.d.ts.map