eslint-plugin-jsdoc 53.0.1 → 54.0.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 (359) hide show
  1. package/dist/WarnSettings.cjs +35 -18
  2. package/dist/WarnSettings.cjs.map +1 -1
  3. package/dist/alignTransform.cjs +305 -224
  4. package/dist/alignTransform.cjs.map +1 -1
  5. package/dist/defaultTagOrder.cjs +43 -132
  6. package/dist/defaultTagOrder.cjs.map +1 -1
  7. package/dist/exportParser.cjs +696 -478
  8. package/dist/exportParser.cjs.map +1 -1
  9. package/dist/generateRule.cjs +242 -0
  10. package/dist/generateRule.cjs.map +1 -0
  11. package/dist/getDefaultTagStructureForMode.cjs +288 -184
  12. package/dist/getDefaultTagStructureForMode.cjs.map +1 -1
  13. package/dist/getJsdocProcessorPlugin.cjs +550 -364
  14. package/dist/getJsdocProcessorPlugin.cjs.map +1 -1
  15. package/dist/getJsdocProcessorPlugin.d.ts +65 -68
  16. package/dist/getJsdocProcessorPlugin.d.ts.map +1 -1
  17. package/dist/index.cjs +410 -2
  18. package/dist/index.cjs.map +1 -0
  19. package/dist/index.d.ts +17 -2
  20. package/dist/index.d.ts.map +1 -0
  21. package/dist/iterateJsdoc.cjs +2005 -1539
  22. package/dist/iterateJsdoc.cjs.map +1 -1
  23. package/dist/iterateJsdoc.d.ts +350 -359
  24. package/dist/iterateJsdoc.d.ts.map +1 -1
  25. package/dist/jsdocUtils.cjs +1376 -1009
  26. package/dist/jsdocUtils.cjs.map +1 -1
  27. package/dist/rules/checkAccess.cjs +36 -29
  28. package/dist/rules/checkAccess.cjs.map +1 -1
  29. package/dist/rules/checkAlignment.cjs +54 -41
  30. package/dist/rules/checkAlignment.cjs.map +1 -1
  31. package/dist/rules/checkExamples.cjs +484 -327
  32. package/dist/rules/checkExamples.cjs.map +1 -1
  33. package/dist/rules/checkIndentation.cjs +65 -50
  34. package/dist/rules/checkIndentation.cjs.map +1 -1
  35. package/dist/rules/checkLineAlignment.cjs +311 -220
  36. package/dist/rules/checkLineAlignment.cjs.map +1 -1
  37. package/dist/rules/checkParamNames.cjs +335 -227
  38. package/dist/rules/checkParamNames.cjs.map +1 -1
  39. package/dist/rules/checkPropertyNames.cjs +106 -78
  40. package/dist/rules/checkPropertyNames.cjs.map +1 -1
  41. package/dist/rules/checkSyntax.cjs +34 -21
  42. package/dist/rules/checkSyntax.cjs.map +1 -1
  43. package/dist/rules/checkTagNames.cjs +210 -188
  44. package/dist/rules/checkTagNames.cjs.map +1 -1
  45. package/dist/rules/checkTemplateNames.cjs +178 -121
  46. package/dist/rules/checkTemplateNames.cjs.map +1 -1
  47. package/dist/rules/checkTypes.cjs +385 -291
  48. package/dist/rules/checkTypes.cjs.map +1 -1
  49. package/dist/rules/checkValues.cjs +146 -100
  50. package/dist/rules/checkValues.cjs.map +1 -1
  51. package/dist/rules/convertToJsdocComments.cjs +306 -228
  52. package/dist/rules/convertToJsdocComments.cjs.map +1 -1
  53. package/dist/rules/emptyTags.cjs +72 -62
  54. package/dist/rules/emptyTags.cjs.map +1 -1
  55. package/dist/rules/implementsOnClasses.cjs +56 -36
  56. package/dist/rules/implementsOnClasses.cjs.map +1 -1
  57. package/dist/rules/importsAsDependencies.cjs +99 -62
  58. package/dist/rules/importsAsDependencies.cjs.map +1 -1
  59. package/dist/rules/informativeDocs.cjs +142 -105
  60. package/dist/rules/informativeDocs.cjs.map +1 -1
  61. package/dist/rules/linesBeforeBlock.cjs +105 -70
  62. package/dist/rules/linesBeforeBlock.cjs.map +1 -1
  63. package/dist/rules/matchDescription.cjs +222 -160
  64. package/dist/rules/matchDescription.cjs.map +1 -1
  65. package/dist/rules/matchName.cjs +128 -73
  66. package/dist/rules/matchName.cjs.map +1 -1
  67. package/dist/rules/multilineBlocks.cjs +352 -235
  68. package/dist/rules/multilineBlocks.cjs.map +1 -1
  69. package/dist/rules/noBadBlocks.cjs +86 -63
  70. package/dist/rules/noBadBlocks.cjs.map +1 -1
  71. package/dist/rules/noBlankBlockDescriptions.cjs +57 -35
  72. package/dist/rules/noBlankBlockDescriptions.cjs.map +1 -1
  73. package/dist/rules/noBlankBlocks.cjs +48 -26
  74. package/dist/rules/noBlankBlocks.cjs.map +1 -1
  75. package/dist/rules/noDefaults.cjs +79 -52
  76. package/dist/rules/noDefaults.cjs.map +1 -1
  77. package/dist/rules/noMissingSyntax.cjs +165 -115
  78. package/dist/rules/noMissingSyntax.cjs.map +1 -1
  79. package/dist/rules/noMultiAsterisks.cjs +89 -48
  80. package/dist/rules/noMultiAsterisks.cjs.map +1 -1
  81. package/dist/rules/noRestrictedSyntax.cjs +79 -45
  82. package/dist/rules/noRestrictedSyntax.cjs.map +1 -1
  83. package/dist/rules/noTypes.cjs +80 -59
  84. package/dist/rules/noTypes.cjs.map +1 -1
  85. package/dist/rules/noUndefinedTypes.cjs +388 -297
  86. package/dist/rules/noUndefinedTypes.cjs.map +1 -1
  87. package/dist/rules/requireAsteriskPrefix.cjs +159 -108
  88. package/dist/rules/requireAsteriskPrefix.cjs.map +1 -1
  89. package/dist/rules/requireDescription.cjs +129 -89
  90. package/dist/rules/requireDescription.cjs.map +1 -1
  91. package/dist/rules/requireDescriptionCompleteSentence.cjs +262 -201
  92. package/dist/rules/requireDescriptionCompleteSentence.cjs.map +1 -1
  93. package/dist/rules/requireExample.cjs +104 -73
  94. package/dist/rules/requireExample.cjs.map +1 -1
  95. package/dist/rules/requireFileOverview.cjs +129 -75
  96. package/dist/rules/requireFileOverview.cjs.map +1 -1
  97. package/dist/rules/requireHyphenBeforeParamDescription.cjs +133 -85
  98. package/dist/rules/requireHyphenBeforeParamDescription.cjs.map +1 -1
  99. package/dist/rules/requireJsdoc.cjs +557 -384
  100. package/dist/rules/requireJsdoc.cjs.map +1 -1
  101. package/dist/rules/requireParam.cjs +526 -336
  102. package/dist/rules/requireParam.cjs.map +1 -1
  103. package/dist/rules/requireParamDescription.cjs +80 -55
  104. package/dist/rules/requireParamDescription.cjs.map +1 -1
  105. package/dist/rules/requireParamName.cjs +50 -32
  106. package/dist/rules/requireParamName.cjs.map +1 -1
  107. package/dist/rules/requireParamType.cjs +80 -55
  108. package/dist/rules/requireParamType.cjs.map +1 -1
  109. package/dist/rules/requireProperty.cjs +42 -31
  110. package/dist/rules/requireProperty.cjs.map +1 -1
  111. package/dist/rules/requirePropertyDescription.cjs +25 -17
  112. package/dist/rules/requirePropertyDescription.cjs.map +1 -1
  113. package/dist/rules/requirePropertyName.cjs +25 -17
  114. package/dist/rules/requirePropertyName.cjs.map +1 -1
  115. package/dist/rules/requirePropertyType.cjs +25 -17
  116. package/dist/rules/requirePropertyType.cjs.map +1 -1
  117. package/dist/rules/requireReturns.cjs +203 -125
  118. package/dist/rules/requireReturns.cjs.map +1 -1
  119. package/dist/rules/requireReturnsCheck.cjs +103 -60
  120. package/dist/rules/requireReturnsCheck.cjs.map +1 -1
  121. package/dist/rules/requireReturnsDescription.cjs +54 -39
  122. package/dist/rules/requireReturnsDescription.cjs.map +1 -1
  123. package/dist/rules/requireReturnsType.cjs +50 -32
  124. package/dist/rules/requireReturnsType.cjs.map +1 -1
  125. package/dist/rules/requireTemplate.cjs +178 -119
  126. package/dist/rules/requireTemplate.cjs.map +1 -1
  127. package/dist/rules/requireThrows.cjs +95 -61
  128. package/dist/rules/requireThrows.cjs.map +1 -1
  129. package/dist/rules/requireYields.cjs +166 -106
  130. package/dist/rules/requireYields.cjs.map +1 -1
  131. package/dist/rules/requireYieldsCheck.cjs +152 -96
  132. package/dist/rules/requireYieldsCheck.cjs.map +1 -1
  133. package/dist/rules/sortTags.cjs +444 -258
  134. package/dist/rules/sortTags.cjs.map +1 -1
  135. package/dist/rules/tagLines.cjs +266 -179
  136. package/dist/rules/tagLines.cjs.map +1 -1
  137. package/dist/rules/textEscaping.cjs +127 -92
  138. package/dist/rules/textEscaping.cjs.map +1 -1
  139. package/dist/rules/validTypes.cjs +265 -252
  140. package/dist/rules/validTypes.cjs.map +1 -1
  141. package/dist/tagNames.cjs +170 -134
  142. package/dist/tagNames.cjs.map +1 -1
  143. package/dist/utils/hasReturnValue.cjs +474 -246
  144. package/dist/utils/hasReturnValue.cjs.map +1 -1
  145. package/package.json +24 -40
  146. package/src/WarnSettings.js +34 -0
  147. package/src/alignTransform.js +358 -0
  148. package/src/defaultTagOrder.js +169 -0
  149. package/src/exportParser.js +978 -0
  150. package/src/getDefaultTagStructureForMode.js +969 -0
  151. package/src/getJsdocProcessorPlugin.js +672 -0
  152. package/src/index.js +530 -0
  153. package/src/iterateJsdoc.js +2541 -0
  154. package/src/jsdocUtils.js +1896 -0
  155. package/src/rules/checkAccess.js +45 -0
  156. package/src/rules/checkAlignment.js +63 -0
  157. package/src/rules/checkExamples.js +589 -0
  158. package/src/rules/checkIndentation.js +75 -0
  159. package/src/rules/checkLineAlignment.js +372 -0
  160. package/src/rules/checkParamNames.js +474 -0
  161. package/src/rules/checkPropertyNames.js +152 -0
  162. package/src/rules/checkSyntax.js +30 -0
  163. package/src/rules/checkTagNames.js +314 -0
  164. package/src/rules/checkTemplateNames.js +204 -0
  165. package/src/rules/checkTypes.js +535 -0
  166. package/src/rules/checkValues.js +248 -0
  167. package/src/rules/convertToJsdocComments.js +398 -0
  168. package/src/rules/emptyTags.js +98 -0
  169. package/src/rules/implementsOnClasses.js +64 -0
  170. package/src/rules/importsAsDependencies.js +133 -0
  171. package/src/rules/informativeDocs.js +189 -0
  172. package/src/rules/linesBeforeBlock.js +134 -0
  173. package/src/rules/matchDescription.js +286 -0
  174. package/src/rules/matchName.js +151 -0
  175. package/src/rules/multilineBlocks.js +493 -0
  176. package/src/rules/noBadBlocks.js +119 -0
  177. package/src/rules/noBlankBlockDescriptions.js +69 -0
  178. package/src/rules/noBlankBlocks.js +53 -0
  179. package/src/rules/noDefaults.js +85 -0
  180. package/src/rules/noMissingSyntax.js +195 -0
  181. package/src/rules/noMultiAsterisks.js +134 -0
  182. package/src/rules/noRestrictedSyntax.js +91 -0
  183. package/src/rules/noTypes.js +93 -0
  184. package/src/rules/noUndefinedTypes.js +543 -0
  185. package/src/rules/requireAsteriskPrefix.js +190 -0
  186. package/src/rules/requireDescription.js +161 -0
  187. package/src/rules/requireDescriptionCompleteSentence.js +335 -0
  188. package/src/rules/requireExample.js +118 -0
  189. package/src/rules/requireFileOverview.js +154 -0
  190. package/src/rules/requireHyphenBeforeParamDescription.js +176 -0
  191. package/src/rules/requireJsdoc.js +743 -0
  192. package/src/rules/requireParam.js +602 -0
  193. package/src/rules/requireParamDescription.js +89 -0
  194. package/src/rules/requireParamName.js +55 -0
  195. package/src/rules/requireParamType.js +89 -0
  196. package/src/rules/requireProperty.js +48 -0
  197. package/src/rules/requirePropertyDescription.js +25 -0
  198. package/src/rules/requirePropertyName.js +25 -0
  199. package/src/rules/requirePropertyType.js +25 -0
  200. package/src/rules/requireReturns.js +238 -0
  201. package/src/rules/requireReturnsCheck.js +145 -0
  202. package/src/rules/requireReturnsDescription.js +59 -0
  203. package/src/rules/requireReturnsType.js +51 -0
  204. package/src/rules/requireTemplate.js +201 -0
  205. package/src/rules/requireThrows.js +111 -0
  206. package/src/rules/requireYields.js +216 -0
  207. package/src/rules/requireYieldsCheck.js +208 -0
  208. package/src/rules/sortTags.js +558 -0
  209. package/src/rules/tagLines.js +359 -0
  210. package/src/rules/textEscaping.js +154 -0
  211. package/src/rules/validTypes.js +401 -0
  212. package/src/tagNames.js +238 -0
  213. package/src/utils/hasReturnValue.js +572 -0
  214. package/dist/WarnSettings.js +0 -20
  215. package/dist/WarnSettings.js.map +0 -1
  216. package/dist/_virtual/rolldown_runtime.cjs +0 -32
  217. package/dist/_virtual/rolldown_runtime.js +0 -11
  218. package/dist/alignTransform.js +0 -241
  219. package/dist/alignTransform.js.map +0 -1
  220. package/dist/defaultTagOrder.js +0 -134
  221. package/dist/defaultTagOrder.js.map +0 -1
  222. package/dist/exportParser.js +0 -518
  223. package/dist/exportParser.js.map +0 -1
  224. package/dist/getDefaultTagStructureForMode.js +0 -188
  225. package/dist/getDefaultTagStructureForMode.js.map +0 -1
  226. package/dist/getJsdocProcessorPlugin.d.cts +0 -70
  227. package/dist/getJsdocProcessorPlugin.d.cts.map +0 -1
  228. package/dist/getJsdocProcessorPlugin.js +0 -383
  229. package/dist/getJsdocProcessorPlugin.js.map +0 -1
  230. package/dist/index.d.cts +0 -2
  231. package/dist/index.js +0 -3
  232. package/dist/iterateJsdoc.d.cts +0 -472
  233. package/dist/iterateJsdoc.d.cts.map +0 -1
  234. package/dist/iterateJsdoc.js +0 -1628
  235. package/dist/iterateJsdoc.js.map +0 -1
  236. package/dist/jsdocUtils.js +0 -1123
  237. package/dist/jsdocUtils.js.map +0 -1
  238. package/dist/plugin.cjs +0 -427
  239. package/dist/plugin.cjs.map +0 -1
  240. package/dist/plugin.js +0 -427
  241. package/dist/plugin.js.map +0 -1
  242. package/dist/rules/checkAccess.js +0 -33
  243. package/dist/rules/checkAccess.js.map +0 -1
  244. package/dist/rules/checkAlignment.js +0 -47
  245. package/dist/rules/checkAlignment.js.map +0 -1
  246. package/dist/rules/checkExamples.js +0 -348
  247. package/dist/rules/checkExamples.js.map +0 -1
  248. package/dist/rules/checkIndentation.js +0 -59
  249. package/dist/rules/checkIndentation.js.map +0 -1
  250. package/dist/rules/checkLineAlignment.js +0 -229
  251. package/dist/rules/checkLineAlignment.js.map +0 -1
  252. package/dist/rules/checkParamNames.js +0 -237
  253. package/dist/rules/checkParamNames.js.map +0 -1
  254. package/dist/rules/checkPropertyNames.js +0 -88
  255. package/dist/rules/checkPropertyNames.js.map +0 -1
  256. package/dist/rules/checkSyntax.js +0 -25
  257. package/dist/rules/checkSyntax.js.map +0 -1
  258. package/dist/rules/checkTagNames.js +0 -191
  259. package/dist/rules/checkTagNames.js.map +0 -1
  260. package/dist/rules/checkTemplateNames.js +0 -124
  261. package/dist/rules/checkTemplateNames.js.map +0 -1
  262. package/dist/rules/checkTypes.js +0 -299
  263. package/dist/rules/checkTypes.js.map +0 -1
  264. package/dist/rules/checkValues.js +0 -103
  265. package/dist/rules/checkValues.js.map +0 -1
  266. package/dist/rules/convertToJsdocComments.js +0 -231
  267. package/dist/rules/convertToJsdocComments.js.map +0 -1
  268. package/dist/rules/emptyTags.js +0 -67
  269. package/dist/rules/emptyTags.js.map +0 -1
  270. package/dist/rules/implementsOnClasses.js +0 -40
  271. package/dist/rules/implementsOnClasses.js.map +0 -1
  272. package/dist/rules/importsAsDependencies.js +0 -68
  273. package/dist/rules/importsAsDependencies.js.map +0 -1
  274. package/dist/rules/informativeDocs.js +0 -110
  275. package/dist/rules/informativeDocs.js.map +0 -1
  276. package/dist/rules/linesBeforeBlock.js +0 -75
  277. package/dist/rules/linesBeforeBlock.js.map +0 -1
  278. package/dist/rules/matchDescription.js +0 -167
  279. package/dist/rules/matchDescription.js.map +0 -1
  280. package/dist/rules/matchName.js +0 -77
  281. package/dist/rules/matchName.js.map +0 -1
  282. package/dist/rules/multilineBlocks.js +0 -245
  283. package/dist/rules/multilineBlocks.js.map +0 -1
  284. package/dist/rules/noBadBlocks.js +0 -68
  285. package/dist/rules/noBadBlocks.js.map +0 -1
  286. package/dist/rules/noBlankBlockDescriptions.js +0 -41
  287. package/dist/rules/noBlankBlockDescriptions.js.map +0 -1
  288. package/dist/rules/noBlankBlocks.js +0 -30
  289. package/dist/rules/noBlankBlocks.js.map +0 -1
  290. package/dist/rules/noDefaults.js +0 -56
  291. package/dist/rules/noDefaults.js.map +0 -1
  292. package/dist/rules/noMissingSyntax.js +0 -126
  293. package/dist/rules/noMissingSyntax.js.map +0 -1
  294. package/dist/rules/noMultiAsterisks.js +0 -58
  295. package/dist/rules/noMultiAsterisks.js.map +0 -1
  296. package/dist/rules/noRestrictedSyntax.js +0 -49
  297. package/dist/rules/noRestrictedSyntax.js.map +0 -1
  298. package/dist/rules/noTypes.js +0 -65
  299. package/dist/rules/noTypes.js.map +0 -1
  300. package/dist/rules/noUndefinedTypes.js +0 -303
  301. package/dist/rules/noUndefinedTypes.js.map +0 -1
  302. package/dist/rules/requireAsteriskPrefix.js +0 -112
  303. package/dist/rules/requireAsteriskPrefix.js.map +0 -1
  304. package/dist/rules/requireDescription.js +0 -95
  305. package/dist/rules/requireDescription.js.map +0 -1
  306. package/dist/rules/requireDescriptionCompleteSentence.js +0 -220
  307. package/dist/rules/requireDescriptionCompleteSentence.js.map +0 -1
  308. package/dist/rules/requireExample.js +0 -77
  309. package/dist/rules/requireExample.js.map +0 -1
  310. package/dist/rules/requireFileOverview.js +0 -81
  311. package/dist/rules/requireFileOverview.js.map +0 -1
  312. package/dist/rules/requireHyphenBeforeParamDescription.js +0 -89
  313. package/dist/rules/requireHyphenBeforeParamDescription.js.map +0 -1
  314. package/dist/rules/requireJsdoc.js +0 -404
  315. package/dist/rules/requireJsdoc.js.map +0 -1
  316. package/dist/rules/requireParam.js +0 -344
  317. package/dist/rules/requireParam.js.map +0 -1
  318. package/dist/rules/requireParamDescription.js +0 -59
  319. package/dist/rules/requireParamDescription.js.map +0 -1
  320. package/dist/rules/requireParamName.js +0 -36
  321. package/dist/rules/requireParamName.js.map +0 -1
  322. package/dist/rules/requireParamType.js +0 -59
  323. package/dist/rules/requireParamType.js.map +0 -1
  324. package/dist/rules/requireProperty.js +0 -35
  325. package/dist/rules/requireProperty.js.map +0 -1
  326. package/dist/rules/requirePropertyDescription.js +0 -21
  327. package/dist/rules/requirePropertyDescription.js.map +0 -1
  328. package/dist/rules/requirePropertyName.js +0 -21
  329. package/dist/rules/requirePropertyName.js.map +0 -1
  330. package/dist/rules/requirePropertyType.js +0 -21
  331. package/dist/rules/requirePropertyType.js.map +0 -1
  332. package/dist/rules/requireReturns.js +0 -131
  333. package/dist/rules/requireReturns.js.map +0 -1
  334. package/dist/rules/requireReturnsCheck.js +0 -66
  335. package/dist/rules/requireReturnsCheck.js.map +0 -1
  336. package/dist/rules/requireReturnsDescription.js +0 -43
  337. package/dist/rules/requireReturnsDescription.js.map +0 -1
  338. package/dist/rules/requireReturnsType.js +0 -36
  339. package/dist/rules/requireReturnsType.js.map +0 -1
  340. package/dist/rules/requireTemplate.js +0 -122
  341. package/dist/rules/requireTemplate.js.map +0 -1
  342. package/dist/rules/requireThrows.js +0 -67
  343. package/dist/rules/requireThrows.js.map +0 -1
  344. package/dist/rules/requireYields.js +0 -115
  345. package/dist/rules/requireYields.js.map +0 -1
  346. package/dist/rules/requireYieldsCheck.js +0 -105
  347. package/dist/rules/requireYieldsCheck.js.map +0 -1
  348. package/dist/rules/sortTags.js +0 -262
  349. package/dist/rules/sortTags.js.map +0 -1
  350. package/dist/rules/tagLines.js +0 -183
  351. package/dist/rules/tagLines.js.map +0 -1
  352. package/dist/rules/textEscaping.js +0 -102
  353. package/dist/rules/textEscaping.js.map +0 -1
  354. package/dist/rules/validTypes.js +0 -259
  355. package/dist/rules/validTypes.js.map +0 -1
  356. package/dist/tagNames.js +0 -144
  357. package/dist/tagNames.js.map +0 -1
  358. package/dist/utils/hasReturnValue.js +0 -265
  359. package/dist/utils/hasReturnValue.js.map +0 -1
@@ -1,304 +1,395 @@
1
- const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
2
- const require_iterateJsdoc = require('../iterateJsdoc.cjs');
3
- const __es_joy_jsdoccomment = require_rolldown_runtime.__toESM(require("@es-joy/jsdoccomment"));
4
- const parse_imports_exports = require_rolldown_runtime.__toESM(require("parse-imports-exports"));
1
+ "use strict";
5
2
 
6
- //#region src/rules/noUndefinedTypes.js
7
- const extraTypes = [
8
- "null",
9
- "undefined",
10
- "void",
11
- "string",
12
- "boolean",
13
- "object",
14
- "function",
15
- "symbol",
16
- "number",
17
- "bigint",
18
- "NaN",
19
- "Infinity",
20
- "any",
21
- "*",
22
- "never",
23
- "unknown",
24
- "const",
25
- "this",
26
- "true",
27
- "false",
28
- "Array",
29
- "Object",
30
- "RegExp",
31
- "Date",
32
- "Function",
33
- "Intl"
34
- ];
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.default = void 0;
7
+ var _iterateJsdoc = _interopRequireWildcard(require("../iterateJsdoc.cjs"));
8
+ var _jsdoccomment = require("@es-joy/jsdoccomment");
9
+ var _parseImportsExports = require("parse-imports-exports");
10
+ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
11
+ const extraTypes = ['null', 'undefined', 'void', 'string', 'boolean', 'object', 'function', 'symbol', 'number', 'bigint', 'NaN', 'Infinity', 'any', '*', 'never', 'unknown', 'const', 'this', 'true', 'false', 'Array', 'Object', 'RegExp', 'Date', 'Function', 'Intl'];
35
12
  const typescriptGlobals = [
36
- "Awaited",
37
- "Partial",
38
- "Required",
39
- "Readonly",
40
- "Record",
41
- "Pick",
42
- "Omit",
43
- "Exclude",
44
- "Extract",
45
- "NonNullable",
46
- "Parameters",
47
- "ConstructorParameters",
48
- "ReturnType",
49
- "InstanceType",
50
- "ThisParameterType",
51
- "OmitThisParameter",
52
- "ThisType",
53
- "Uppercase",
54
- "Lowercase",
55
- "Capitalize",
56
- "Uncapitalize"
57
- ];
13
+ // https://www.typescriptlang.org/docs/handbook/utility-types.html
14
+ 'Awaited', 'Partial', 'Required', 'Readonly', 'Record', 'Pick', 'Omit', 'Exclude', 'Extract', 'NonNullable', 'Parameters', 'ConstructorParameters', 'ReturnType', 'InstanceType', 'ThisParameterType', 'OmitThisParameter', 'ThisType', 'Uppercase', 'Lowercase', 'Capitalize', 'Uncapitalize'];
15
+
58
16
  /**
59
- * @param {string|false|undefined} [str]
60
- * @returns {undefined|string|false}
61
- */
62
- const stripPseudoTypes = (str) => {
63
- return str && str.replace(/(?:\.|<>|\.<>|\[\])$/v, "");
17
+ * @param {string|false|undefined} [str]
18
+ * @returns {undefined|string|false}
19
+ */
20
+ const stripPseudoTypes = str => {
21
+ return str && str.replace(/(?:\.|<>|\.<>|\[\])$/v, '');
64
22
  };
65
- var noUndefinedTypes_default = require_iterateJsdoc.default(({ context, node, report, settings, sourceCode, utils }) => {
66
- const { scopeManager } = sourceCode;
67
- const globalScope = scopeManager.globalScope;
68
- const { definedTypes = [], disableReporting = false, markVariablesAsUsed = true } = context.options[0] || {};
69
- /** @type {(string|undefined)[]} */
70
- let definedPreferredTypes = [];
71
- const { mode, preferredTypes, structuredTags } = settings;
72
- if (Object.keys(preferredTypes).length) definedPreferredTypes = Object.values(preferredTypes).map((preferredType) => {
73
- if (typeof preferredType === "string") return stripPseudoTypes(preferredType);
74
- if (!preferredType) return void 0;
75
- if (typeof preferredType !== "object") utils.reportSettings("Invalid `settings.jsdoc.preferredTypes`. Values must be falsy, a string, or an object.");
76
- return stripPseudoTypes(preferredType.replacement);
77
- }).filter(Boolean);
78
- const allComments = sourceCode.getAllComments();
79
- const comments = allComments.filter((comment) => {
80
- return /^\*\s/v.test(comment.value);
81
- }).map((commentNode) => {
82
- return (0, __es_joy_jsdoccomment.parseComment)(commentNode, "");
83
- });
84
- const globals = allComments.filter((comment) => {
85
- return /^\s*globals/v.test(comment.value);
86
- }).flatMap((commentNode) => {
87
- return commentNode.value.replace(/^\s*globals/v, "").trim().split(/,\s*/v);
88
- }).concat(Object.keys(context.languageOptions.globals ?? []));
89
- const typedefDeclarations = comments.flatMap((doc) => {
90
- return doc.tags.filter(({ tag }) => {
91
- return utils.isNamepathDefiningTag(tag);
92
- });
93
- }).map((tag) => {
94
- return tag.name;
95
- });
96
- const importTags = settings.mode === "typescript" ? comments.flatMap((doc) => {
97
- return doc.tags.filter(({ tag }) => {
98
- return tag === "import";
99
- });
100
- }).flatMap((tag) => {
101
- const { description, name, type } = tag;
102
- const typePart = type ? `{${type}} ` : "";
103
- const imprt = "import " + (description ? `${typePart}${name} ${description}` : `${typePart}${name}`);
104
- const importsExports = (0, parse_imports_exports.parseImportsExports)(imprt.trim());
105
- const types = [];
106
- const namedImports = Object.values(importsExports.namedImports || {})[0]?.[0];
107
- if (namedImports) {
108
- if (namedImports.default) types.push(namedImports.default);
109
- if (namedImports.names) types.push(...Object.keys(namedImports.names));
110
- }
111
- const namespaceImports = Object.values(importsExports.namespaceImports || {})[0]?.[0];
112
- if (namespaceImports) {
113
- if (namespaceImports.namespace) types.push(namespaceImports.namespace);
114
- if (namespaceImports.default) types.push(namespaceImports.default);
115
- }
116
- return types;
117
- }).filter(Boolean) : [];
118
- const ancestorNodes = [];
119
- let currentNode = node;
120
- while (currentNode?.parent) {
121
- ancestorNodes.push(currentNode);
122
- currentNode = currentNode.parent;
123
- }
124
- /**
125
- * @param {import('eslint').Rule.Node} ancestorNode
126
- * @returns {import('comment-parser').Spec[]}
127
- */
128
- const getTemplateTags = function(ancestorNode) {
129
- const commentNode = (0, __es_joy_jsdoccomment.getJSDocComment)(sourceCode, ancestorNode, settings);
130
- if (!commentNode) return [];
131
- const jsdoc = (0, __es_joy_jsdoccomment.parseComment)(commentNode, "");
132
- return jsdoc.tags.filter((tag) => {
133
- return tag.tag === "template";
134
- });
135
- };
136
- const templateTags = ancestorNodes.length ? ancestorNodes.flatMap((ancestorNode) => {
137
- return getTemplateTags(ancestorNode);
138
- }) : utils.getPresentTags(["template"]);
139
- const closureGenericTypes = templateTags.flatMap((tag) => {
140
- return utils.parseClosureTemplateTag(tag);
141
- });
142
- const cjsOrESMScope = globalScope.childScopes[0]?.block?.type === "Program";
143
- /**
144
- * @param {import("eslint").Scope.Scope | null} scope
145
- * @returns {Set<string>}
146
- */
147
- const getValidRuntimeIdentifiers = (scope) => {
148
- const result = /* @__PURE__ */ new Set();
149
- let scp = scope;
150
- while (scp) {
151
- for (const { name } of scp.variables) result.add(name);
152
- scp = scp.upper;
153
- }
154
- return result;
155
- };
156
- /**
157
- * We treat imports differently as we can't introspect their children.
158
- * @type {string[]}
159
- */
160
- const imports = [];
161
- const allDefinedTypes = new Set(globalScope.variables.map(({ name }) => {
162
- return name;
163
- }).concat(cjsOrESMScope ? globalScope.childScopes.flatMap(({ variables }) => {
164
- return variables;
165
- }).flatMap(({ identifiers, name }) => {
166
- const globalItem = (identifiers?.[0])?.parent;
167
- switch (globalItem?.type) {
168
- case "ClassDeclaration": return [name, ...globalItem.body.body.map((item) => {
169
- const property = (item?.key)?.name;
170
- /* c8 ignore next 3 -- Guard */
171
- if (!property) return "";
172
- return `${name}.${property}`;
173
- }).filter(Boolean)];
174
- case "ImportDefaultSpecifier":
175
- case "ImportNamespaceSpecifier":
176
- case "ImportSpecifier":
177
- imports.push(name);
178
- break;
179
- case "TSInterfaceDeclaration": return [name, ...globalItem.body.body.map((item) => {
180
- const property = (item?.key)?.name;
181
- /* c8 ignore next 3 -- Guard */
182
- if (!property) return "";
183
- return `${name}.${property}`;
184
- }).filter(Boolean)];
185
- case "VariableDeclarator":
186
- if (((globalItem?.init)?.callee)?.name === "require") {
187
- imports.push(
188
- /** @type {import('@typescript-eslint/types').TSESTree.Identifier} */
189
- globalItem.id.name
190
- );
191
- break;
192
- }
193
- return [];
194
- }
195
- return [name];
196
- /* c8 ignore next */
197
- }) : []).concat(extraTypes).concat(typedefDeclarations).concat(importTags).concat(definedTypes).concat(definedPreferredTypes).concat((() => {
198
- if (node?.type === "MethodDefinition") return node.parent.body.flatMap((methodOrProp) => {
199
- if (methodOrProp.type === "MethodDefinition") {
200
- if (methodOrProp.key.type === "Identifier") return [methodOrProp.key.name, `${(node.parent?.parent)?.id?.name}.${methodOrProp.key.name}`];
201
- }
202
- if (methodOrProp.type === "PropertyDefinition") {
203
- if (methodOrProp.key.type === "Identifier") return [methodOrProp.key.name, `${(node.parent?.parent)?.id?.name}.${methodOrProp.key.name}`];
204
- }
205
- /* c8 ignore next 2 -- Not yet built */
206
- return "";
207
- }).filter(Boolean);
208
- return [];
209
- })()).concat(...getValidRuntimeIdentifiers(node && (sourceCode.getScope && sourceCode.getScope(node) || context.getScope()))).concat(settings.mode === "jsdoc" ? [] : [...settings.mode === "typescript" ? typescriptGlobals : [], ...closureGenericTypes]));
210
- /**
211
- * @typedef {{
212
- * parsedType: import('jsdoc-type-pratt-parser').RootResult;
213
- * tag: import('comment-parser').Spec|import('@es-joy/jsdoccomment').JsdocInlineTagNoType & {
214
- * line?: import('../iterateJsdoc.js').Integer
215
- * }
216
- * }} TypeAndTagInfo
217
- */
218
- /**
219
- * @param {string} propertyName
220
- * @returns {(tag: (import('@es-joy/jsdoccomment').JsdocInlineTagNoType & {
221
- * name?: string,
222
- * type?: string,
223
- * line?: import('../iterateJsdoc.js').Integer
224
- * })|import('comment-parser').Spec & {
225
- * namepathOrURL?: string
226
- * }
227
- * ) => undefined|TypeAndTagInfo}
228
- */
229
- const tagToParsedType = (propertyName) => {
230
- return (tag) => {
231
- try {
232
- const potentialType = tag[propertyName];
233
- return {
234
- parsedType: mode === "permissive" ? (0, __es_joy_jsdoccomment.tryParse)(potentialType) : (0, __es_joy_jsdoccomment.parse)(potentialType, mode),
235
- tag
236
- };
237
- } catch {
238
- return void 0;
239
- }
240
- };
241
- };
242
- const typeTags = utils.filterTags(({ tag }) => {
243
- return tag !== "import" && utils.tagMightHaveTypePosition(tag) && (tag !== "suppress" || settings.mode !== "closure");
244
- }).map(tagToParsedType("type"));
245
- const namepathReferencingTags = utils.filterTags(({ tag }) => {
246
- return utils.isNamepathReferencingTag(tag);
247
- }).map(tagToParsedType("name"));
248
- const namepathOrUrlReferencingTags = utils.filterAllTags(({ tag }) => {
249
- return utils.isNamepathOrUrlReferencingTag(tag);
250
- }).map(tagToParsedType("namepathOrURL"));
251
- const tagsWithTypes = [
252
- ...typeTags,
253
- ...namepathReferencingTags,
254
- ...namepathOrUrlReferencingTags
255
- ].filter(Boolean);
256
- for (const { parsedType, tag } of tagsWithTypes) (0, __es_joy_jsdoccomment.traverse)(parsedType, (nde, parentNode) => {
257
- /**
258
- * @type {import('jsdoc-type-pratt-parser').NameResult & {
259
- * _parent?: import('jsdoc-type-pratt-parser').NonRootResult
260
- * }}
261
- */
262
- nde._parent = parentNode;
263
- const { type, value } = nde;
264
- let val = value;
265
- /** @type {import('jsdoc-type-pratt-parser').NonRootResult|undefined} */
266
- let currNode = nde;
267
- do {
268
- currNode = currNode._parent;
269
- if (!imports.includes(val) && !globals.includes(val) && !importTags.includes(val) && !extraTypes.includes(val) && !typedefDeclarations.includes(val) && currNode && "right" in currNode && currNode.right?.type === "JsdocTypeProperty") val = val + "." + currNode.right.value;
270
- } while (currNode?.type === "JsdocTypeNamePath");
271
- if (type === "JsdocTypeName") {
272
- const structuredTypes = structuredTags[tag.tag]?.type;
273
- if (!allDefinedTypes.has(val) && (!Array.isArray(structuredTypes) || !structuredTypes.includes(val))) {
274
- if (!disableReporting) report(`The type '${val}' is undefined.`, null, tag);
275
- } else if (markVariablesAsUsed && !extraTypes.includes(val)) if (sourceCode.markVariableAsUsed) sourceCode.markVariableAsUsed(val);
276
- else context.markVariableAsUsed(val);
277
- }
278
- });
23
+ var _default = exports.default = (0, _iterateJsdoc.default)(({
24
+ context,
25
+ node,
26
+ report,
27
+ settings,
28
+ sourceCode,
29
+ utils
30
+ }) => {
31
+ const {
32
+ scopeManager
33
+ } = sourceCode;
34
+
35
+ // When is this ever `null`?
36
+ const globalScope = /** @type {import('eslint').Scope.Scope} */
37
+ scopeManager.globalScope;
38
+ const
39
+ /**
40
+ * @type {{
41
+ * definedTypes: string[],
42
+ * disableReporting: boolean,
43
+ * markVariablesAsUsed: boolean
44
+ * }}
45
+ */
46
+ {
47
+ definedTypes = [],
48
+ disableReporting = false,
49
+ markVariablesAsUsed = true
50
+ } = context.options[0] || {};
51
+
52
+ /** @type {(string|undefined)[]} */
53
+ let definedPreferredTypes = [];
54
+ const {
55
+ mode,
56
+ preferredTypes,
57
+ structuredTags
58
+ } = settings;
59
+ if (Object.keys(preferredTypes).length) {
60
+ definedPreferredTypes = /** @type {string[]} */Object.values(preferredTypes).map(preferredType => {
61
+ if (typeof preferredType === 'string') {
62
+ // May become an empty string but will be filtered out below
63
+ return stripPseudoTypes(preferredType);
64
+ }
65
+ if (!preferredType) {
66
+ return undefined;
67
+ }
68
+ if (typeof preferredType !== 'object') {
69
+ utils.reportSettings('Invalid `settings.jsdoc.preferredTypes`. Values must be falsy, a string, or an object.');
70
+ }
71
+ return stripPseudoTypes(preferredType.replacement);
72
+ }).filter(Boolean);
73
+ }
74
+ const allComments = sourceCode.getAllComments();
75
+ const comments = allComments.filter(comment => {
76
+ return /^\*\s/v.test(comment.value);
77
+ }).map(commentNode => {
78
+ return (0, _iterateJsdoc.parseComment)(commentNode, '');
79
+ });
80
+ const globals = allComments.filter(comment => {
81
+ return /^\s*globals/v.test(comment.value);
82
+ }).flatMap(commentNode => {
83
+ return commentNode.value.replace(/^\s*globals/v, '').trim().split(/,\s*/v);
84
+ }).concat(Object.keys(context.languageOptions.globals ?? []));
85
+ const typedefDeclarations = comments.flatMap(doc => {
86
+ return doc.tags.filter(({
87
+ tag
88
+ }) => {
89
+ return utils.isNamepathDefiningTag(tag);
90
+ });
91
+ }).map(tag => {
92
+ return tag.name;
93
+ });
94
+ const importTags = settings.mode === 'typescript' ? (/** @type {string[]} */comments.flatMap(doc => {
95
+ return doc.tags.filter(({
96
+ tag
97
+ }) => {
98
+ return tag === 'import';
99
+ });
100
+ }).flatMap(tag => {
101
+ const {
102
+ description,
103
+ name,
104
+ type
105
+ } = tag;
106
+ const typePart = type ? `{${type}} ` : '';
107
+ const imprt = 'import ' + (description ? `${typePart}${name} ${description}` : `${typePart}${name}`);
108
+ const importsExports = (0, _parseImportsExports.parseImportsExports)(imprt.trim());
109
+ const types = [];
110
+ const namedImports = Object.values(importsExports.namedImports || {})[0]?.[0];
111
+ if (namedImports) {
112
+ if (namedImports.default) {
113
+ types.push(namedImports.default);
114
+ }
115
+ if (namedImports.names) {
116
+ types.push(...Object.keys(namedImports.names));
117
+ }
118
+ }
119
+ const namespaceImports = Object.values(importsExports.namespaceImports || {})[0]?.[0];
120
+ if (namespaceImports) {
121
+ if (namespaceImports.namespace) {
122
+ types.push(namespaceImports.namespace);
123
+ }
124
+ if (namespaceImports.default) {
125
+ types.push(namespaceImports.default);
126
+ }
127
+ }
128
+ return types;
129
+ }).filter(Boolean)) : [];
130
+ const ancestorNodes = [];
131
+ let currentNode = node;
132
+ // No need for Program node?
133
+ while (currentNode?.parent) {
134
+ ancestorNodes.push(currentNode);
135
+ currentNode = currentNode.parent;
136
+ }
137
+
138
+ /**
139
+ * @param {import('eslint').Rule.Node} ancestorNode
140
+ * @returns {import('comment-parser').Spec[]}
141
+ */
142
+ const getTemplateTags = function (ancestorNode) {
143
+ const commentNode = (0, _jsdoccomment.getJSDocComment)(sourceCode, ancestorNode, settings);
144
+ if (!commentNode) {
145
+ return [];
146
+ }
147
+ const jsdoc = (0, _iterateJsdoc.parseComment)(commentNode, '');
148
+ return jsdoc.tags.filter(tag => {
149
+ return tag.tag === 'template';
150
+ });
151
+ };
152
+
153
+ // `currentScope` may be `null` or `Program`, so in such a case,
154
+ // we look to present tags instead
155
+ const templateTags = ancestorNodes.length ? ancestorNodes.flatMap(ancestorNode => {
156
+ return getTemplateTags(ancestorNode);
157
+ }) : utils.getPresentTags(['template']);
158
+ const closureGenericTypes = templateTags.flatMap(tag => {
159
+ return utils.parseClosureTemplateTag(tag);
160
+ });
161
+
162
+ // In modules, including Node, there is a global scope at top with the
163
+ // Program scope inside
164
+ const cjsOrESMScope = globalScope.childScopes[0]?.block?.type === 'Program';
165
+
166
+ /**
167
+ * @param {import("eslint").Scope.Scope | null} scope
168
+ * @returns {Set<string>}
169
+ */
170
+ const getValidRuntimeIdentifiers = scope => {
171
+ const result = new Set();
172
+ let scp = scope;
173
+ while (scp) {
174
+ for (const {
175
+ name
176
+ } of scp.variables) {
177
+ result.add(name);
178
+ }
179
+ scp = scp.upper;
180
+ }
181
+ return result;
182
+ };
183
+
184
+ /**
185
+ * We treat imports differently as we can't introspect their children.
186
+ * @type {string[]}
187
+ */
188
+ const imports = [];
189
+ const allDefinedTypes = new Set(globalScope.variables.map(({
190
+ name
191
+ }) => {
192
+ return name;
193
+ })
194
+
195
+ // If the file is a module, concat the variables from the module scope.
196
+ .concat(cjsOrESMScope ? globalScope.childScopes.flatMap(({
197
+ variables
198
+ }) => {
199
+ return variables;
200
+ }).flatMap(({
201
+ identifiers,
202
+ name
203
+ }) => {
204
+ const globalItem = /** @type {import('estree').Identifier & {parent: import('@typescript-eslint/types').TSESTree.Node}} */identifiers?.[0]?.parent;
205
+ switch (globalItem?.type) {
206
+ case 'ClassDeclaration':
207
+ return [name, ...globalItem.body.body.map(item => {
208
+ const property = /** @type {import('@typescript-eslint/types').TSESTree.Identifier} */(/** @type {import('@typescript-eslint/types').TSESTree.PropertyDefinition} */item?.key)?.name;
209
+ /* c8 ignore next 3 -- Guard */
210
+ if (!property) {
211
+ return '';
212
+ }
213
+ return `${name}.${property}`;
214
+ }).filter(Boolean)];
215
+ case 'ImportDefaultSpecifier':
216
+ case 'ImportNamespaceSpecifier':
217
+ case 'ImportSpecifier':
218
+ imports.push(name);
219
+ break;
220
+ case 'TSInterfaceDeclaration':
221
+ return [name, ...globalItem.body.body.map(item => {
222
+ const property = /** @type {import('@typescript-eslint/types').TSESTree.Identifier} */(/** @type {import('@typescript-eslint/types').TSESTree.TSPropertySignature} */item?.key)?.name;
223
+ /* c8 ignore next 3 -- Guard */
224
+ if (!property) {
225
+ return '';
226
+ }
227
+ return `${name}.${property}`;
228
+ }).filter(Boolean)];
229
+ case 'VariableDeclarator':
230
+ if (/** @type {import('@typescript-eslint/types').TSESTree.Identifier} */(/** @type {import('@typescript-eslint/types').TSESTree.CallExpression} */globalItem?.init?.callee)?.name === 'require') {
231
+ imports.push(/** @type {import('@typescript-eslint/types').TSESTree.Identifier} */globalItem.id.name);
232
+ break;
233
+ }
234
+ return [];
235
+ }
236
+ return [name];
237
+ /* c8 ignore next */
238
+ }) : []).concat(extraTypes).concat(typedefDeclarations).concat(importTags).concat(definedTypes).concat(/** @type {string[]} */definedPreferredTypes).concat((() => {
239
+ // Other methods are not in scope, but we need them, and we grab them here
240
+ if (node?.type === 'MethodDefinition') {
241
+ return /** @type {import('estree').ClassBody} */node.parent.body.flatMap(methodOrProp => {
242
+ if (methodOrProp.type === 'MethodDefinition') {
243
+ // eslint-disable-next-line unicorn/no-lonely-if -- Pattern
244
+ if (methodOrProp.key.type === 'Identifier') {
245
+ return [methodOrProp.key.name, `${/** @type {import('estree').ClassDeclaration} */node.parent?.parent?.id?.name}.${methodOrProp.key.name}`];
246
+ }
247
+ }
248
+ if (methodOrProp.type === 'PropertyDefinition') {
249
+ // eslint-disable-next-line unicorn/no-lonely-if -- Pattern
250
+ if (methodOrProp.key.type === 'Identifier') {
251
+ return [methodOrProp.key.name, `${/** @type {import('estree').ClassDeclaration} */node.parent?.parent?.id?.name}.${methodOrProp.key.name}`];
252
+ }
253
+ }
254
+ /* c8 ignore next 2 -- Not yet built */
255
+
256
+ return '';
257
+ }).filter(Boolean);
258
+ }
259
+ return [];
260
+ })()).concat(...getValidRuntimeIdentifiers(node && (sourceCode.getScope && /* c8 ignore next 2 */
261
+ sourceCode.getScope(node) || context.getScope()))).concat(settings.mode === 'jsdoc' ? [] : [...(settings.mode === 'typescript' ? typescriptGlobals : []), ...closureGenericTypes]));
262
+
263
+ /**
264
+ * @typedef {{
265
+ * parsedType: import('jsdoc-type-pratt-parser').RootResult;
266
+ * tag: import('comment-parser').Spec|import('@es-joy/jsdoccomment').JsdocInlineTagNoType & {
267
+ * line?: import('../iterateJsdoc.js').Integer
268
+ * }
269
+ * }} TypeAndTagInfo
270
+ */
271
+
272
+ /**
273
+ * @param {string} propertyName
274
+ * @returns {(tag: (import('@es-joy/jsdoccomment').JsdocInlineTagNoType & {
275
+ * name?: string,
276
+ * type?: string,
277
+ * line?: import('../iterateJsdoc.js').Integer
278
+ * })|import('comment-parser').Spec & {
279
+ * namepathOrURL?: string
280
+ * }
281
+ * ) => undefined|TypeAndTagInfo}
282
+ */
283
+ const tagToParsedType = propertyName => {
284
+ return tag => {
285
+ try {
286
+ const potentialType = tag[(/** @type {"type"|"name"|"namepathOrURL"} */propertyName)];
287
+ return {
288
+ parsedType: mode === 'permissive' ? (0, _jsdoccomment.tryParse)(/** @type {string} */potentialType) : (0, _jsdoccomment.parse)(/** @type {string} */potentialType, mode),
289
+ tag
290
+ };
291
+ } catch {
292
+ return undefined;
293
+ }
294
+ };
295
+ };
296
+ const typeTags = utils.filterTags(({
297
+ tag
298
+ }) => {
299
+ return tag !== 'import' && utils.tagMightHaveTypePosition(tag) && (tag !== 'suppress' || settings.mode !== 'closure');
300
+ }).map(tagToParsedType('type'));
301
+ const namepathReferencingTags = utils.filterTags(({
302
+ tag
303
+ }) => {
304
+ return utils.isNamepathReferencingTag(tag);
305
+ }).map(tagToParsedType('name'));
306
+ const namepathOrUrlReferencingTags = utils.filterAllTags(({
307
+ tag
308
+ }) => {
309
+ return utils.isNamepathOrUrlReferencingTag(tag);
310
+ }).map(tagToParsedType('namepathOrURL'));
311
+ const tagsWithTypes = /** @type {TypeAndTagInfo[]} */[...typeTags, ...namepathReferencingTags, ...namepathOrUrlReferencingTags
312
+ // Remove types which failed to parse
313
+ ].filter(Boolean);
314
+ for (const {
315
+ parsedType,
316
+ tag
317
+ } of tagsWithTypes) {
318
+ (0, _jsdoccomment.traverse)(parsedType, (nde, parentNode) => {
319
+ /**
320
+ * @type {import('jsdoc-type-pratt-parser').NameResult & {
321
+ * _parent?: import('jsdoc-type-pratt-parser').NonRootResult
322
+ * }}
323
+ */
324
+ // eslint-disable-next-line canonical/id-match -- Avoid clashes
325
+ nde._parent = parentNode;
326
+ const {
327
+ type,
328
+ value
329
+ } = /** @type {import('jsdoc-type-pratt-parser').NameResult} */nde;
330
+ let val = value;
331
+
332
+ /** @type {import('jsdoc-type-pratt-parser').NonRootResult|undefined} */
333
+ let currNode = nde;
334
+ do {
335
+ currNode =
336
+ /**
337
+ * @type {import('jsdoc-type-pratt-parser').NameResult & {
338
+ * _parent?: import('jsdoc-type-pratt-parser').NonRootResult
339
+ * }}
340
+ */
341
+ currNode._parent;
342
+ if (
343
+ // Avoid appending for imports and globals since we don't want to
344
+ // check their properties which may or may not exist
345
+ !imports.includes(val) && !globals.includes(val) && !importTags.includes(val) && !extraTypes.includes(val) && !typedefDeclarations.includes(val) && currNode && 'right' in currNode && currNode.right?.type === 'JsdocTypeProperty') {
346
+ val = val + '.' + currNode.right.value;
347
+ }
348
+ } while (currNode?.type === 'JsdocTypeNamePath');
349
+ if (type === 'JsdocTypeName') {
350
+ const structuredTypes = structuredTags[tag.tag]?.type;
351
+ if (!allDefinedTypes.has(val) && (!Array.isArray(structuredTypes) || !structuredTypes.includes(val))) {
352
+ if (!disableReporting) {
353
+ report(`The type '${val}' is undefined.`, null, tag);
354
+ }
355
+ } else if (markVariablesAsUsed && !extraTypes.includes(val)) {
356
+ if (sourceCode.markVariableAsUsed) {
357
+ sourceCode.markVariableAsUsed(val);
358
+ /* c8 ignore next 3 */
359
+ } else {
360
+ context.markVariableAsUsed(val);
361
+ }
362
+ }
363
+ }
364
+ });
365
+ }
279
366
  }, {
280
- iterateAllJsdocs: true,
281
- meta: {
282
- docs: {
283
- description: "Checks that types in jsdoc comments are defined.",
284
- url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-undefined-types.md#repos-sticky-header"
285
- },
286
- schema: [{
287
- additionalProperties: false,
288
- properties: {
289
- definedTypes: {
290
- items: { type: "string" },
291
- type: "array"
292
- },
293
- disableReporting: { type: "boolean" },
294
- markVariablesAsUsed: { type: "boolean" }
295
- },
296
- type: "object"
297
- }],
298
- type: "suggestion"
299
- }
367
+ iterateAllJsdocs: true,
368
+ meta: {
369
+ docs: {
370
+ description: 'Checks that types in jsdoc comments are defined.',
371
+ url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-undefined-types.md#repos-sticky-header'
372
+ },
373
+ schema: [{
374
+ additionalProperties: false,
375
+ properties: {
376
+ definedTypes: {
377
+ items: {
378
+ type: 'string'
379
+ },
380
+ type: 'array'
381
+ },
382
+ disableReporting: {
383
+ type: 'boolean'
384
+ },
385
+ markVariablesAsUsed: {
386
+ type: 'boolean'
387
+ }
388
+ },
389
+ type: 'object'
390
+ }],
391
+ type: 'suggestion'
392
+ }
300
393
  });
301
-
302
- //#endregion
303
- exports.default = noUndefinedTypes_default;
394
+ module.exports = exports.default;
304
395
  //# sourceMappingURL=noUndefinedTypes.cjs.map