eslint-plugin-jsdoc 52.0.4 → 53.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 +18 -35
  2. package/dist/WarnSettings.cjs.map +1 -1
  3. package/dist/WarnSettings.js +20 -0
  4. package/dist/WarnSettings.js.map +1 -0
  5. package/dist/_virtual/rolldown_runtime.cjs +32 -0
  6. package/dist/_virtual/rolldown_runtime.js +11 -0
  7. package/dist/alignTransform.cjs +224 -305
  8. package/dist/alignTransform.cjs.map +1 -1
  9. package/dist/alignTransform.js +241 -0
  10. package/dist/alignTransform.js.map +1 -0
  11. package/dist/defaultTagOrder.cjs +132 -43
  12. package/dist/defaultTagOrder.cjs.map +1 -1
  13. package/dist/defaultTagOrder.js +134 -0
  14. package/dist/defaultTagOrder.js.map +1 -0
  15. package/dist/exportParser.cjs +478 -696
  16. package/dist/exportParser.cjs.map +1 -1
  17. package/dist/exportParser.js +518 -0
  18. package/dist/exportParser.js.map +1 -0
  19. package/dist/getDefaultTagStructureForMode.cjs +184 -288
  20. package/dist/getDefaultTagStructureForMode.cjs.map +1 -1
  21. package/dist/getDefaultTagStructureForMode.js +188 -0
  22. package/dist/getDefaultTagStructureForMode.js.map +1 -0
  23. package/dist/getJsdocProcessorPlugin.cjs +364 -550
  24. package/dist/getJsdocProcessorPlugin.cjs.map +1 -1
  25. package/dist/getJsdocProcessorPlugin.d.cts +70 -0
  26. package/dist/getJsdocProcessorPlugin.d.cts.map +1 -0
  27. package/dist/getJsdocProcessorPlugin.d.ts +68 -65
  28. package/dist/getJsdocProcessorPlugin.d.ts.map +1 -1
  29. package/dist/getJsdocProcessorPlugin.js +383 -0
  30. package/dist/getJsdocProcessorPlugin.js.map +1 -0
  31. package/dist/index.cjs +2 -410
  32. package/dist/index.d.cts +2 -0
  33. package/dist/index.d.ts +2 -17
  34. package/dist/index.js +3 -0
  35. package/dist/iterateJsdoc.cjs +1528 -1988
  36. package/dist/iterateJsdoc.cjs.map +1 -1
  37. package/dist/iterateJsdoc.d.cts +471 -0
  38. package/dist/iterateJsdoc.d.cts.map +1 -0
  39. package/dist/iterateJsdoc.d.ts +358 -349
  40. package/dist/iterateJsdoc.d.ts.map +1 -1
  41. package/dist/iterateJsdoc.js +1617 -0
  42. package/dist/iterateJsdoc.js.map +1 -0
  43. package/dist/jsdocUtils.cjs +1009 -1376
  44. package/dist/jsdocUtils.cjs.map +1 -1
  45. package/dist/jsdocUtils.js +1123 -0
  46. package/dist/jsdocUtils.js.map +1 -0
  47. package/dist/plugin.cjs +427 -0
  48. package/dist/plugin.cjs.map +1 -0
  49. package/dist/plugin.js +427 -0
  50. package/dist/plugin.js.map +1 -0
  51. package/dist/rules/checkAccess.cjs +29 -36
  52. package/dist/rules/checkAccess.cjs.map +1 -1
  53. package/dist/rules/checkAccess.js +33 -0
  54. package/dist/rules/checkAccess.js.map +1 -0
  55. package/dist/rules/checkAlignment.cjs +41 -54
  56. package/dist/rules/checkAlignment.cjs.map +1 -1
  57. package/dist/rules/checkAlignment.js +47 -0
  58. package/dist/rules/checkAlignment.js.map +1 -0
  59. package/dist/rules/checkExamples.cjs +327 -484
  60. package/dist/rules/checkExamples.cjs.map +1 -1
  61. package/dist/rules/checkExamples.js +348 -0
  62. package/dist/rules/checkExamples.js.map +1 -0
  63. package/dist/rules/checkIndentation.cjs +50 -65
  64. package/dist/rules/checkIndentation.cjs.map +1 -1
  65. package/dist/rules/checkIndentation.js +59 -0
  66. package/dist/rules/checkIndentation.js.map +1 -0
  67. package/dist/rules/checkLineAlignment.cjs +220 -311
  68. package/dist/rules/checkLineAlignment.cjs.map +1 -1
  69. package/dist/rules/checkLineAlignment.js +229 -0
  70. package/dist/rules/checkLineAlignment.js.map +1 -0
  71. package/dist/rules/checkParamNames.cjs +227 -335
  72. package/dist/rules/checkParamNames.cjs.map +1 -1
  73. package/dist/rules/checkParamNames.js +237 -0
  74. package/dist/rules/checkParamNames.js.map +1 -0
  75. package/dist/rules/checkPropertyNames.cjs +78 -106
  76. package/dist/rules/checkPropertyNames.cjs.map +1 -1
  77. package/dist/rules/checkPropertyNames.js +88 -0
  78. package/dist/rules/checkPropertyNames.js.map +1 -0
  79. package/dist/rules/checkSyntax.cjs +21 -34
  80. package/dist/rules/checkSyntax.cjs.map +1 -1
  81. package/dist/rules/checkSyntax.js +25 -0
  82. package/dist/rules/checkSyntax.js.map +1 -0
  83. package/dist/rules/checkTagNames.cjs +188 -210
  84. package/dist/rules/checkTagNames.cjs.map +1 -1
  85. package/dist/rules/checkTagNames.js +191 -0
  86. package/dist/rules/checkTagNames.js.map +1 -0
  87. package/dist/rules/checkTemplateNames.cjs +121 -178
  88. package/dist/rules/checkTemplateNames.cjs.map +1 -1
  89. package/dist/rules/checkTemplateNames.js +124 -0
  90. package/dist/rules/checkTemplateNames.js.map +1 -0
  91. package/dist/rules/checkTypes.cjs +291 -385
  92. package/dist/rules/checkTypes.cjs.map +1 -1
  93. package/dist/rules/checkTypes.js +299 -0
  94. package/dist/rules/checkTypes.js.map +1 -0
  95. package/dist/rules/checkValues.cjs +100 -146
  96. package/dist/rules/checkValues.cjs.map +1 -1
  97. package/dist/rules/checkValues.js +103 -0
  98. package/dist/rules/checkValues.js.map +1 -0
  99. package/dist/rules/convertToJsdocComments.cjs +228 -306
  100. package/dist/rules/convertToJsdocComments.cjs.map +1 -1
  101. package/dist/rules/convertToJsdocComments.js +231 -0
  102. package/dist/rules/convertToJsdocComments.js.map +1 -0
  103. package/dist/rules/emptyTags.cjs +62 -72
  104. package/dist/rules/emptyTags.cjs.map +1 -1
  105. package/dist/rules/emptyTags.js +67 -0
  106. package/dist/rules/emptyTags.js.map +1 -0
  107. package/dist/rules/implementsOnClasses.cjs +36 -56
  108. package/dist/rules/implementsOnClasses.cjs.map +1 -1
  109. package/dist/rules/implementsOnClasses.js +40 -0
  110. package/dist/rules/implementsOnClasses.js.map +1 -0
  111. package/dist/rules/importsAsDependencies.cjs +62 -99
  112. package/dist/rules/importsAsDependencies.cjs.map +1 -1
  113. package/dist/rules/importsAsDependencies.js +68 -0
  114. package/dist/rules/importsAsDependencies.js.map +1 -0
  115. package/dist/rules/informativeDocs.cjs +105 -142
  116. package/dist/rules/informativeDocs.cjs.map +1 -1
  117. package/dist/rules/informativeDocs.js +110 -0
  118. package/dist/rules/informativeDocs.js.map +1 -0
  119. package/dist/rules/linesBeforeBlock.cjs +70 -105
  120. package/dist/rules/linesBeforeBlock.cjs.map +1 -1
  121. package/dist/rules/linesBeforeBlock.js +75 -0
  122. package/dist/rules/linesBeforeBlock.js.map +1 -0
  123. package/dist/rules/matchDescription.cjs +160 -222
  124. package/dist/rules/matchDescription.cjs.map +1 -1
  125. package/dist/rules/matchDescription.js +167 -0
  126. package/dist/rules/matchDescription.js.map +1 -0
  127. package/dist/rules/matchName.cjs +73 -128
  128. package/dist/rules/matchName.cjs.map +1 -1
  129. package/dist/rules/matchName.js +77 -0
  130. package/dist/rules/matchName.js.map +1 -0
  131. package/dist/rules/multilineBlocks.cjs +235 -352
  132. package/dist/rules/multilineBlocks.cjs.map +1 -1
  133. package/dist/rules/multilineBlocks.js +245 -0
  134. package/dist/rules/multilineBlocks.js.map +1 -0
  135. package/dist/rules/noBadBlocks.cjs +63 -86
  136. package/dist/rules/noBadBlocks.cjs.map +1 -1
  137. package/dist/rules/noBadBlocks.js +68 -0
  138. package/dist/rules/noBadBlocks.js.map +1 -0
  139. package/dist/rules/noBlankBlockDescriptions.cjs +35 -57
  140. package/dist/rules/noBlankBlockDescriptions.cjs.map +1 -1
  141. package/dist/rules/noBlankBlockDescriptions.js +41 -0
  142. package/dist/rules/noBlankBlockDescriptions.js.map +1 -0
  143. package/dist/rules/noBlankBlocks.cjs +26 -48
  144. package/dist/rules/noBlankBlocks.cjs.map +1 -1
  145. package/dist/rules/noBlankBlocks.js +30 -0
  146. package/dist/rules/noBlankBlocks.js.map +1 -0
  147. package/dist/rules/noDefaults.cjs +52 -79
  148. package/dist/rules/noDefaults.cjs.map +1 -1
  149. package/dist/rules/noDefaults.js +56 -0
  150. package/dist/rules/noDefaults.js.map +1 -0
  151. package/dist/rules/noMissingSyntax.cjs +115 -165
  152. package/dist/rules/noMissingSyntax.cjs.map +1 -1
  153. package/dist/rules/noMissingSyntax.js +126 -0
  154. package/dist/rules/noMissingSyntax.js.map +1 -0
  155. package/dist/rules/noMultiAsterisks.cjs +48 -89
  156. package/dist/rules/noMultiAsterisks.cjs.map +1 -1
  157. package/dist/rules/noMultiAsterisks.js +58 -0
  158. package/dist/rules/noMultiAsterisks.js.map +1 -0
  159. package/dist/rules/noRestrictedSyntax.cjs +45 -79
  160. package/dist/rules/noRestrictedSyntax.cjs.map +1 -1
  161. package/dist/rules/noRestrictedSyntax.js +49 -0
  162. package/dist/rules/noRestrictedSyntax.js.map +1 -0
  163. package/dist/rules/noTypes.cjs +59 -80
  164. package/dist/rules/noTypes.cjs.map +1 -1
  165. package/dist/rules/noTypes.js +65 -0
  166. package/dist/rules/noTypes.js.map +1 -0
  167. package/dist/rules/noUndefinedTypes.cjs +297 -388
  168. package/dist/rules/noUndefinedTypes.cjs.map +1 -1
  169. package/dist/rules/noUndefinedTypes.js +303 -0
  170. package/dist/rules/noUndefinedTypes.js.map +1 -0
  171. package/dist/rules/requireAsteriskPrefix.cjs +108 -159
  172. package/dist/rules/requireAsteriskPrefix.cjs.map +1 -1
  173. package/dist/rules/requireAsteriskPrefix.js +112 -0
  174. package/dist/rules/requireAsteriskPrefix.js.map +1 -0
  175. package/dist/rules/requireDescription.cjs +89 -129
  176. package/dist/rules/requireDescription.cjs.map +1 -1
  177. package/dist/rules/requireDescription.js +95 -0
  178. package/dist/rules/requireDescription.js.map +1 -0
  179. package/dist/rules/requireDescriptionCompleteSentence.cjs +201 -262
  180. package/dist/rules/requireDescriptionCompleteSentence.cjs.map +1 -1
  181. package/dist/rules/requireDescriptionCompleteSentence.js +220 -0
  182. package/dist/rules/requireDescriptionCompleteSentence.js.map +1 -0
  183. package/dist/rules/requireExample.cjs +73 -104
  184. package/dist/rules/requireExample.cjs.map +1 -1
  185. package/dist/rules/requireExample.js +77 -0
  186. package/dist/rules/requireExample.js.map +1 -0
  187. package/dist/rules/requireFileOverview.cjs +75 -129
  188. package/dist/rules/requireFileOverview.cjs.map +1 -1
  189. package/dist/rules/requireFileOverview.js +81 -0
  190. package/dist/rules/requireFileOverview.js.map +1 -0
  191. package/dist/rules/requireHyphenBeforeParamDescription.cjs +85 -133
  192. package/dist/rules/requireHyphenBeforeParamDescription.cjs.map +1 -1
  193. package/dist/rules/requireHyphenBeforeParamDescription.js +89 -0
  194. package/dist/rules/requireHyphenBeforeParamDescription.js.map +1 -0
  195. package/dist/rules/requireJsdoc.cjs +384 -557
  196. package/dist/rules/requireJsdoc.cjs.map +1 -1
  197. package/dist/rules/requireJsdoc.js +404 -0
  198. package/dist/rules/requireJsdoc.js.map +1 -0
  199. package/dist/rules/requireParam.cjs +336 -526
  200. package/dist/rules/requireParam.cjs.map +1 -1
  201. package/dist/rules/requireParam.js +344 -0
  202. package/dist/rules/requireParam.js.map +1 -0
  203. package/dist/rules/requireParamDescription.cjs +55 -80
  204. package/dist/rules/requireParamDescription.cjs.map +1 -1
  205. package/dist/rules/requireParamDescription.js +59 -0
  206. package/dist/rules/requireParamDescription.js.map +1 -0
  207. package/dist/rules/requireParamName.cjs +32 -50
  208. package/dist/rules/requireParamName.cjs.map +1 -1
  209. package/dist/rules/requireParamName.js +36 -0
  210. package/dist/rules/requireParamName.js.map +1 -0
  211. package/dist/rules/requireParamType.cjs +55 -80
  212. package/dist/rules/requireParamType.cjs.map +1 -1
  213. package/dist/rules/requireParamType.js +59 -0
  214. package/dist/rules/requireParamType.js.map +1 -0
  215. package/dist/rules/requireProperty.cjs +31 -42
  216. package/dist/rules/requireProperty.cjs.map +1 -1
  217. package/dist/rules/requireProperty.js +35 -0
  218. package/dist/rules/requireProperty.js.map +1 -0
  219. package/dist/rules/requirePropertyDescription.cjs +17 -25
  220. package/dist/rules/requirePropertyDescription.cjs.map +1 -1
  221. package/dist/rules/requirePropertyDescription.js +21 -0
  222. package/dist/rules/requirePropertyDescription.js.map +1 -0
  223. package/dist/rules/requirePropertyName.cjs +17 -25
  224. package/dist/rules/requirePropertyName.cjs.map +1 -1
  225. package/dist/rules/requirePropertyName.js +21 -0
  226. package/dist/rules/requirePropertyName.js.map +1 -0
  227. package/dist/rules/requirePropertyType.cjs +17 -25
  228. package/dist/rules/requirePropertyType.cjs.map +1 -1
  229. package/dist/rules/requirePropertyType.js +21 -0
  230. package/dist/rules/requirePropertyType.js.map +1 -0
  231. package/dist/rules/requireReturns.cjs +125 -203
  232. package/dist/rules/requireReturns.cjs.map +1 -1
  233. package/dist/rules/requireReturns.js +131 -0
  234. package/dist/rules/requireReturns.js.map +1 -0
  235. package/dist/rules/requireReturnsCheck.cjs +60 -103
  236. package/dist/rules/requireReturnsCheck.cjs.map +1 -1
  237. package/dist/rules/requireReturnsCheck.js +66 -0
  238. package/dist/rules/requireReturnsCheck.js.map +1 -0
  239. package/dist/rules/requireReturnsDescription.cjs +39 -54
  240. package/dist/rules/requireReturnsDescription.cjs.map +1 -1
  241. package/dist/rules/requireReturnsDescription.js +43 -0
  242. package/dist/rules/requireReturnsDescription.js.map +1 -0
  243. package/dist/rules/requireReturnsType.cjs +32 -50
  244. package/dist/rules/requireReturnsType.cjs.map +1 -1
  245. package/dist/rules/requireReturnsType.js +36 -0
  246. package/dist/rules/requireReturnsType.js.map +1 -0
  247. package/dist/rules/requireTemplate.cjs +119 -178
  248. package/dist/rules/requireTemplate.cjs.map +1 -1
  249. package/dist/rules/requireTemplate.js +122 -0
  250. package/dist/rules/requireTemplate.js.map +1 -0
  251. package/dist/rules/requireThrows.cjs +61 -95
  252. package/dist/rules/requireThrows.cjs.map +1 -1
  253. package/dist/rules/requireThrows.js +67 -0
  254. package/dist/rules/requireThrows.js.map +1 -0
  255. package/dist/rules/requireYields.cjs +106 -166
  256. package/dist/rules/requireYields.cjs.map +1 -1
  257. package/dist/rules/requireYields.js +115 -0
  258. package/dist/rules/requireYields.js.map +1 -0
  259. package/dist/rules/requireYieldsCheck.cjs +96 -152
  260. package/dist/rules/requireYieldsCheck.cjs.map +1 -1
  261. package/dist/rules/requireYieldsCheck.js +105 -0
  262. package/dist/rules/requireYieldsCheck.js.map +1 -0
  263. package/dist/rules/sortTags.cjs +258 -444
  264. package/dist/rules/sortTags.cjs.map +1 -1
  265. package/dist/rules/sortTags.js +262 -0
  266. package/dist/rules/sortTags.js.map +1 -0
  267. package/dist/rules/tagLines.cjs +179 -266
  268. package/dist/rules/tagLines.cjs.map +1 -1
  269. package/dist/rules/tagLines.js +183 -0
  270. package/dist/rules/tagLines.js.map +1 -0
  271. package/dist/rules/textEscaping.cjs +92 -127
  272. package/dist/rules/textEscaping.cjs.map +1 -1
  273. package/dist/rules/textEscaping.js +102 -0
  274. package/dist/rules/textEscaping.js.map +1 -0
  275. package/dist/rules/validTypes.cjs +252 -265
  276. package/dist/rules/validTypes.cjs.map +1 -1
  277. package/dist/rules/validTypes.js +259 -0
  278. package/dist/rules/validTypes.js.map +1 -0
  279. package/dist/tagNames.cjs +134 -170
  280. package/dist/tagNames.cjs.map +1 -1
  281. package/dist/tagNames.js +144 -0
  282. package/dist/tagNames.js.map +1 -0
  283. package/dist/utils/hasReturnValue.cjs +246 -474
  284. package/dist/utils/hasReturnValue.cjs.map +1 -1
  285. package/dist/utils/hasReturnValue.js +265 -0
  286. package/dist/utils/hasReturnValue.js.map +1 -0
  287. package/package.json +40 -24
  288. package/dist/generateRule.cjs +0 -242
  289. package/dist/generateRule.cjs.map +0 -1
  290. package/dist/index.cjs.map +0 -1
  291. package/dist/index.d.ts.map +0 -1
  292. package/src/WarnSettings.js +0 -34
  293. package/src/alignTransform.js +0 -358
  294. package/src/defaultTagOrder.js +0 -169
  295. package/src/exportParser.js +0 -978
  296. package/src/getDefaultTagStructureForMode.js +0 -969
  297. package/src/getJsdocProcessorPlugin.js +0 -672
  298. package/src/index.js +0 -530
  299. package/src/iterateJsdoc.js +0 -2518
  300. package/src/jsdocUtils.js +0 -1896
  301. package/src/rules/checkAccess.js +0 -45
  302. package/src/rules/checkAlignment.js +0 -63
  303. package/src/rules/checkExamples.js +0 -589
  304. package/src/rules/checkIndentation.js +0 -75
  305. package/src/rules/checkLineAlignment.js +0 -372
  306. package/src/rules/checkParamNames.js +0 -474
  307. package/src/rules/checkPropertyNames.js +0 -152
  308. package/src/rules/checkSyntax.js +0 -30
  309. package/src/rules/checkTagNames.js +0 -314
  310. package/src/rules/checkTemplateNames.js +0 -204
  311. package/src/rules/checkTypes.js +0 -535
  312. package/src/rules/checkValues.js +0 -248
  313. package/src/rules/convertToJsdocComments.js +0 -398
  314. package/src/rules/emptyTags.js +0 -98
  315. package/src/rules/implementsOnClasses.js +0 -64
  316. package/src/rules/importsAsDependencies.js +0 -133
  317. package/src/rules/informativeDocs.js +0 -189
  318. package/src/rules/linesBeforeBlock.js +0 -134
  319. package/src/rules/matchDescription.js +0 -286
  320. package/src/rules/matchName.js +0 -151
  321. package/src/rules/multilineBlocks.js +0 -493
  322. package/src/rules/noBadBlocks.js +0 -119
  323. package/src/rules/noBlankBlockDescriptions.js +0 -69
  324. package/src/rules/noBlankBlocks.js +0 -53
  325. package/src/rules/noDefaults.js +0 -85
  326. package/src/rules/noMissingSyntax.js +0 -195
  327. package/src/rules/noMultiAsterisks.js +0 -134
  328. package/src/rules/noRestrictedSyntax.js +0 -91
  329. package/src/rules/noTypes.js +0 -93
  330. package/src/rules/noUndefinedTypes.js +0 -543
  331. package/src/rules/requireAsteriskPrefix.js +0 -190
  332. package/src/rules/requireDescription.js +0 -161
  333. package/src/rules/requireDescriptionCompleteSentence.js +0 -335
  334. package/src/rules/requireExample.js +0 -118
  335. package/src/rules/requireFileOverview.js +0 -154
  336. package/src/rules/requireHyphenBeforeParamDescription.js +0 -176
  337. package/src/rules/requireJsdoc.js +0 -743
  338. package/src/rules/requireParam.js +0 -602
  339. package/src/rules/requireParamDescription.js +0 -89
  340. package/src/rules/requireParamName.js +0 -55
  341. package/src/rules/requireParamType.js +0 -89
  342. package/src/rules/requireProperty.js +0 -48
  343. package/src/rules/requirePropertyDescription.js +0 -25
  344. package/src/rules/requirePropertyName.js +0 -25
  345. package/src/rules/requirePropertyType.js +0 -25
  346. package/src/rules/requireReturns.js +0 -238
  347. package/src/rules/requireReturnsCheck.js +0 -145
  348. package/src/rules/requireReturnsDescription.js +0 -59
  349. package/src/rules/requireReturnsType.js +0 -51
  350. package/src/rules/requireTemplate.js +0 -201
  351. package/src/rules/requireThrows.js +0 -111
  352. package/src/rules/requireYields.js +0 -216
  353. package/src/rules/requireYieldsCheck.js +0 -208
  354. package/src/rules/sortTags.js +0 -558
  355. package/src/rules/tagLines.js +0 -359
  356. package/src/rules/textEscaping.js +0 -154
  357. package/src/rules/validTypes.js +0 -401
  358. package/src/tagNames.js +0 -238
  359. package/src/utils/hasReturnValue.js +0 -572
@@ -1,293 +1,189 @@
1
- "use strict";
2
1
 
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.default = void 0;
2
+ //#region src/getDefaultTagStructureForMode.js
7
3
  /**
8
- * @typedef {Map<string, Map<string, (string|boolean)>>} TagStructure
9
- */
4
+ * @typedef {Map<string, Map<string, (string|boolean)>>} TagStructure
5
+ */
10
6
  /**
11
- * @param {import('./jsdocUtils.js').ParserMode} mode
12
- * @returns {TagStructure}
13
- */
14
- const getDefaultTagStructureForMode = mode => {
15
- const isJsdoc = mode === 'jsdoc';
16
- const isClosure = mode === 'closure';
17
- const isTypescript = mode === 'typescript';
18
- const isPermissive = mode === 'permissive';
19
- const isJsdocOrPermissive = isJsdoc || isPermissive;
20
- const isJsdocOrTypescript = isJsdoc || isTypescript;
21
- const isTypescriptOrClosure = isTypescript || isClosure;
22
- const isClosureOrPermissive = isClosure || isPermissive;
23
- const isJsdocTypescriptOrPermissive = isJsdocOrTypescript || isPermissive;
24
-
25
- // Properties:
26
- // `namepathRole` - 'namepath-referencing'|'namepath-defining'|'namepath-or-url-referencing'|'text'|false
27
- // `typeAllowed` - boolean
28
- // `nameRequired` - boolean
29
- // `typeRequired` - boolean
30
- // `typeOrNameRequired` - boolean
31
-
32
- // All of `typeAllowed` have a signature with "type" except for
33
- // `augments`/`extends` ("namepath")
34
- // `param`/`arg`/`argument` (no signature)
35
- // `property`/`prop` (no signature)
36
- // `modifies` (undocumented)
37
-
38
- // None of the `namepathRole: 'namepath-defining'` show as having curly
39
- // brackets for their name/namepath
40
-
41
- // Among `namepath-defining` and `namepath-referencing`, these do not seem
42
- // to allow curly brackets in their doc signature or examples (`modifies`
43
- // references namepaths within its type brackets and `param` is
44
- // name-defining but not namepath-defining, so not part of these groups)
45
-
46
- // Todo: Should support special processing for "name" as distinct from
47
- // "namepath" (e.g., param can't define a namepath)
48
-
49
- // Todo: Should support a `tutorialID` type (for `@tutorial` block and
50
- // inline)
51
-
52
- /**
53
- * @type {TagStructure}
54
- */
55
- return new Map([['alias', new Map(/** @type {[string, string|boolean][]} */[
56
- // Signature seems to require a "namepath" (and no counter-examples)
57
- ['namepathRole', 'namepath-defining'],
58
- // "namepath"
59
- ['typeOrNameRequired', true]])], ['arg', new Map(/** @type {[string, string|boolean][]} */[['namepathRole', 'namepath-defining'],
60
- // See `param`
61
- ['nameRequired', true],
62
- // Has no formal signature in the docs but shows curly brackets
63
- // in the examples
64
- ['typeAllowed', true]])], ['argument', new Map(/** @type {[string, string|boolean][]} */[['namepathRole', 'namepath-defining'],
65
- // See `param`
66
- ['nameRequired', true],
67
- // Has no formal signature in the docs but shows curly brackets
68
- // in the examples
69
- ['typeAllowed', true]])], ['augments', new Map(/** @type {[string, string|boolean][]} */[
70
- // Signature seems to require a "namepath" (and no counter-examples)
71
- ['namepathRole', 'namepath-referencing'],
72
- // Does not show curly brackets in either the signature or examples
73
- ['typeAllowed', true],
74
- // "namepath"
75
- ['typeOrNameRequired', true]])], ['borrows', new Map(/** @type {[string, string|boolean][]} */[
76
- // `borrows` has a different format, however, so needs special parsing;
77
- // seems to require both, and as "namepath"'s
78
- ['namepathRole', 'namepath-referencing'],
79
- // "namepath"
80
- ['typeOrNameRequired', true]])], ['callback', new Map(/** @type {[string, string|boolean][]} */[
81
- // Seems to require a "namepath" in the signature (with no
82
- // counter-examples); TypeScript does not enforce but seems
83
- // problematic as not attached so presumably not useable without it
84
- ['namepathRole', 'namepath-defining'],
85
- // "namepath"
86
- ['nameRequired', true]])], ['class', new Map(/** @type {[string, string|boolean][]} */[
87
- // Not in use, but should be this value if using to power `empty-tags`
88
- ['nameAllowed', true],
89
- // Allows for "name"'s in signature, but indicated as optional
90
- ['namepathRole', 'namepath-defining'], ['typeAllowed', true]])], ['const', new Map(/** @type {[string, string|boolean][]} */[
91
- // Allows for "name"'s in signature, but indicated as optional
92
- ['namepathRole', 'namepath-defining'], ['typeAllowed', true]])], ['constant', new Map(/** @type {[string, string|boolean][]} */[
93
- // Allows for "name"'s in signature, but indicated as optional
94
- ['namepathRole', 'namepath-defining'], ['typeAllowed', true]])], ['constructor', new Map(/** @type {[string, string|boolean][]} */[
95
- // Allows for "name"'s in signature, but indicated as optional
96
- ['namepathRole', 'namepath-defining'], ['typeAllowed', true]])], ['constructs', new Map(/** @type {[string, string|boolean][]} */[
97
- // Allows for "name"'s in signature, but indicated as optional
98
- ['namepathRole', 'namepath-defining'], ['nameRequired', false], ['typeAllowed', false]])], ['define', new Map(/** @type {[string, string|boolean][]} */[['typeRequired', isClosure]])], ['emits', new Map(/** @type {[string, string|boolean][]} */[
99
- // Signature seems to require a "name" (of an event) and no counter-examples
100
- ['namepathRole', 'namepath-referencing'], ['nameRequired', true], ['typeAllowed', false]])], ['enum', new Map(/** @type {[string, string|boolean][]} */[
101
- // Has example showing curly brackets but not in doc signature
102
- ['typeAllowed', true]])], ['event', new Map(/** @type {[string, string|boolean][]} */[
103
- // Appears to require a "name" in its signature, albeit somewhat
104
- // different from other "name"'s (including as described
105
- // at https://jsdoc.app/about-namepaths.html )
106
- ['namepathRole', 'namepath-defining'],
107
- // The doc signature of `event` seems to require a "name"
108
- ['nameRequired', true]])], ['exception', new Map(/** @type {[string, string|boolean][]} */[
109
- // Shows curly brackets in the signature and in the examples
110
- ['typeAllowed', true]])],
111
- // Closure
112
- ['export', new Map(/** @type {[string, string|boolean][]} */[['typeAllowed', isClosureOrPermissive]])], ['exports', new Map(/** @type {[string, string|boolean][]} */[['namepathRole', 'namepath-defining'], ['nameRequired', isJsdoc], ['typeAllowed', isClosureOrPermissive]])], ['extends', new Map(/** @type {[string, string|boolean][]} */[
113
- // Signature seems to require a "namepath" (and no counter-examples)
114
- ['namepathRole', 'namepath-referencing'], ['nameRequired', isJsdoc],
115
- // Does not show curly brackets in either the signature or examples
116
- ['typeAllowed', isTypescriptOrClosure || isPermissive],
117
- // "namepath"
118
- ['typeOrNameRequired', isTypescriptOrClosure || isPermissive]])], ['external', new Map(/** @type {[string, string|boolean][]} */[
119
- // Appears to require a "name" in its signature, albeit somewhat
120
- // different from other "name"'s (including as described
121
- // at https://jsdoc.app/about-namepaths.html )
122
- ['namepathRole', 'namepath-defining'],
123
- // "name" (and a special syntax for the `external` name)
124
- ['nameRequired', true], ['typeAllowed', false]])], ['fires', new Map(/** @type {[string, string|boolean][]} */[
125
- // Signature seems to require a "name" (of an event) and no
126
- // counter-examples
127
- ['namepathRole', 'namepath-referencing'], ['nameRequired', true], ['typeAllowed', false]])], ['func', new Map(/** @type {[string, string|boolean][]} */[
128
- // Allows for "name"'s in signature, but indicated as optional
129
- ['namepathRole', 'namepath-defining']])], ['function', new Map(/** @type {[string, string|boolean][]} */[
130
- // Allows for "name"'s in signature, but indicated as optional
131
- ['namepathRole', 'namepath-defining'], ['nameRequired', false], ['typeAllowed', false]])], ['host', new Map(/** @type {[string, string|boolean][]} */[
132
- // Appears to require a "name" in its signature, albeit somewhat
133
- // different from other "name"'s (including as described
134
- // at https://jsdoc.app/about-namepaths.html )
135
- ['namepathRole', 'namepath-defining'],
136
- // See `external`
137
- ['nameRequired', true], ['typeAllowed', false]])], ['implements', new Map(/** @type {[string, string|boolean][]} */[
138
- // Shows curly brackets in the doc signature and examples
139
- // "typeExpression"
140
- ['typeRequired', true]])], ['interface', new Map(/** @type {[string, string|boolean][]} */[
141
- // Not in use, but should be this value if using to power `empty-tags`
142
- ['nameAllowed', isClosure],
143
- // Allows for "name" in signature, but indicates as optional
144
- ['namepathRole', isJsdocTypescriptOrPermissive ? 'namepath-defining' : false], ['typeAllowed', false]])], ['internal', new Map(/** @type {[string, string|boolean][]} */[
145
- // Not in use, but should be this value if using to power `empty-tags`
146
- ['nameAllowed', false],
147
- // https://www.typescriptlang.org/tsconfig/#stripInternal
148
- ['namepathRole', false]])], ['lends', new Map(/** @type {[string, string|boolean][]} */[
149
- // Signature seems to require a "namepath" (and no counter-examples)
150
- ['namepathRole', 'namepath-referencing'],
151
- // "namepath"
152
- ['typeOrNameRequired', true]])], ['link', new Map(/** @type {[string, string|boolean][]} */[
153
- // Signature seems to require a namepath OR URL and might be checked as such.
154
- ['namepathRole', 'namepath-or-url-referencing']])], ['linkcode', new Map(/** @type {[string, string|boolean][]} */[
155
- // Synonym for "link"
156
- // Signature seems to require a namepath OR URL and might be checked as such.
157
- ['namepathRole', 'namepath-or-url-referencing']])], ['linkplain', new Map(/** @type {[string, string|boolean][]} */[
158
- // Synonym for "link"
159
- // Signature seems to require a namepath OR URL and might be checked as such.
160
- ['namepathRole', 'namepath-or-url-referencing']])], ['listens', new Map(/** @type {[string, string|boolean][]} */[
161
- // Signature seems to require a "name" (of an event) and no
162
- // counter-examples
163
- ['namepathRole', 'namepath-referencing'], ['nameRequired', true], ['typeAllowed', false]])], ['member', new Map(/** @type {[string, string|boolean][]} */[
164
- // Allows for "name"'s in signature, but indicated as optional
165
- ['namepathRole', 'namepath-defining'],
166
- // Has example showing curly brackets but not in doc signature
167
- ['typeAllowed', true]])], ['memberof!', new Map(/** @type {[string, string|boolean][]} */[
168
- // Signature seems to require a "namepath" (and no counter-examples),
169
- // though it allows an incomplete namepath ending with connecting symbol
170
- ['namepathRole', 'namepath-referencing'],
171
- // "namepath"
172
- ['typeOrNameRequired', true]])], ['memberof', new Map(/** @type {[string, string|boolean][]} */[
173
- // Signature seems to require a "namepath" (and no counter-examples),
174
- // though it allows an incomplete namepath ending with connecting symbol
175
- ['namepathRole', 'namepath-referencing'],
176
- // "namepath"
177
- ['typeOrNameRequired', true]])], ['method', new Map(/** @type {[string, string|boolean][]} */[
178
- // Allows for "name"'s in signature, but indicated as optional
179
- ['namepathRole', 'namepath-defining']])], ['mixes', new Map(/** @type {[string, string|boolean][]} */[
180
- // Signature seems to require a "OtherObjectPath" with no
181
- // counter-examples
182
- ['namepathRole', 'namepath-referencing'],
183
- // "OtherObjectPath"
184
- ['typeOrNameRequired', true]])], ['mixin', new Map(/** @type {[string, string|boolean][]} */[
185
- // Allows for "name"'s in signature, but indicated as optional
186
- ['namepathRole', 'namepath-defining'], ['nameRequired', false], ['typeAllowed', false]])], ['modifies', new Map(/** @type {[string, string|boolean][]} */[
187
- // Has no documentation, but test example has curly brackets, and
188
- // "name" would be suggested rather than "namepath" based on example;
189
- // not sure if name is required
190
- ['typeAllowed', true]])], ['module', new Map(/** @type {[string, string|boolean][]} */[
191
- // Optional "name" and no curly brackets
192
- // this block impacts `no-undefined-types` and `valid-types` (search for
193
- // "isNamepathDefiningTag|tagMightHaveNamepath|tagMightHaveEitherTypeOrNamePosition")
194
- ['namepathRole', isJsdoc ? 'namepath-defining' : 'text'],
195
- // Shows the signature with curly brackets but not in the example
196
- ['typeAllowed', true]])], ['name', new Map(/** @type {[string, string|boolean][]} */[
197
- // Seems to require a "namepath" in the signature (with no
198
- // counter-examples)
199
- ['namepathRole', 'namepath-defining'],
200
- // "namepath"
201
- ['nameRequired', true],
202
- // "namepath"
203
- ['typeOrNameRequired', true]])], ['namespace', new Map(/** @type {[string, string|boolean][]} */[
204
- // Allows for "name"'s in signature, but indicated as optional
205
- ['namepathRole', 'namepath-defining'],
206
- // Shows the signature with curly brackets but not in the example
207
- ['typeAllowed', true]])], ['package', new Map(/** @type {[string, string|boolean][]} */[
208
- // Shows the signature with curly brackets but not in the example
209
- // "typeExpression"
210
- ['typeAllowed', isClosureOrPermissive]])], ['param', new Map(/** @type {[string, string|boolean][]} */[['namepathRole', 'namepath-defining'],
211
- // Though no signature provided requiring, per
212
- // https://jsdoc.app/tags-param.html:
213
- // "The @param tag requires you to specify the name of the parameter you
214
- // are documenting."
215
- ['nameRequired', true],
216
- // Has no formal signature in the docs but shows curly brackets
217
- // in the examples
218
- ['typeAllowed', true]])], ['private', new Map(/** @type {[string, string|boolean][]} */[
219
- // Shows the signature with curly brackets but not in the example
220
- // "typeExpression"
221
- ['typeAllowed', isClosureOrPermissive]])], ['prop', new Map(/** @type {[string, string|boolean][]} */[['namepathRole', 'namepath-defining'],
222
- // See `property`
223
- ['nameRequired', true],
224
- // Has no formal signature in the docs but shows curly brackets
225
- // in the examples
226
- ['typeAllowed', true]])], ['property', new Map(/** @type {[string, string|boolean][]} */[['namepathRole', 'namepath-defining'],
227
- // No docs indicate required, but since parallel to `param`, we treat as
228
- // such:
229
- ['nameRequired', true],
230
- // Has no formal signature in the docs but shows curly brackets
231
- // in the examples
232
- ['typeAllowed', true]])], ['protected', new Map(/** @type {[string, string|boolean][]} */[
233
- // Shows the signature with curly brackets but not in the example
234
- // "typeExpression"
235
- ['typeAllowed', isClosureOrPermissive]])], ['public', new Map(/** @type {[string, string|boolean][]} */[
236
- // Does not show a signature nor show curly brackets in the example
237
- ['typeAllowed', isClosureOrPermissive]])], ['requires', new Map(/** @type {[string, string|boolean][]} */[
238
- // <someModuleName>
239
- ['namepathRole', 'namepath-referencing'], ['nameRequired', true], ['typeAllowed', false]])], ['return', new Map(/** @type {[string, string|boolean][]} */[
240
- // Shows curly brackets in the signature and in the examples
241
- ['typeAllowed', true]])], ['returns', new Map(/** @type {[string, string|boolean][]} */[
242
- // Shows curly brackets in the signature and in the examples
243
- ['typeAllowed', true]])], ['satisfies', new Map(/** @type {[string, string|boolean][]} */[
244
- // Shows curly brackets in the doc signature and examples
245
- ['typeRequired', true]])], ['see', new Map(/** @type {[string, string|boolean][]} */[
246
- // Signature allows for "namepath" or text, so user must configure to
247
- // 'namepath-referencing' to enforce checks
248
- ['namepathRole', 'text']])], ['static', new Map(/** @type {[string, string|boolean][]} */[
249
- // Does not show a signature nor show curly brackets in the example
250
- ['typeAllowed', isClosureOrPermissive]])], ['suppress', new Map(/** @type {[string, string|boolean][]} */[['namepathRole', !isClosure], ['typeRequired', isClosure]])], ['template', new Map(/** @type {[string, string|boolean][]} */[['namepathRole', isJsdoc ? 'text' : 'namepath-referencing'], ['nameRequired', !isJsdoc],
251
- // Though defines `namepathRole: 'namepath-defining'` in a sense, it is
252
- // not parseable in the same way for template (e.g., allowing commas),
253
- // so not adding
254
- ['typeAllowed', isTypescriptOrClosure || isPermissive]])], ['this', new Map(/** @type {[string, string|boolean][]} */[
255
- // Signature seems to require a "namepath" (and no counter-examples)
256
- // Not used with namepath in Closure/TypeScript, however
257
- ['namepathRole', isJsdoc ? 'namepath-referencing' : false],
258
- // namepath
259
- ['typeOrNameRequired', isJsdoc], ['typeRequired', isTypescriptOrClosure]])], ['throws', new Map(/** @type {[string, string|boolean][]} */[
260
- // Shows curly brackets in the signature and in the examples
261
- ['typeAllowed', true]])], ['tutorial', new Map(/** @type {[string, string|boolean][]} */[
262
- // (a tutorial ID)
263
- ['nameRequired', true], ['typeAllowed', false]])], ['type', new Map(/** @type {[string, string|boolean][]} */[
264
- // Shows curly brackets in the doc signature and examples
265
- // "typeName"
266
- ['typeRequired', true]])], ['typedef', new Map(/** @type {[string, string|boolean][]} */[
267
- // Seems to require a "namepath" in the signature (with no
268
- // counter-examples)
269
- ['namepathRole', 'namepath-defining'],
270
- // TypeScript may allow it to be dropped if followed by @property or @member;
271
- // also shown as missing in Closure
272
- // "namepath"
273
- ['nameRequired', isJsdocOrPermissive],
274
- // Is not `typeRequired` for TypeScript because it gives an error:
275
- // JSDoc '@typedef' tag should either have a type annotation or be followed by '@property' or '@member' tags.
276
-
277
- // Has example showing curly brackets but not in doc signature
278
- ['typeAllowed', true],
279
- // TypeScript may allow it to be dropped if followed by @property or @member
280
- // "namepath"
281
- ['typeOrNameRequired', !isTypescript]])], ['var', new Map(/** @type {[string, string|boolean][]} */[
282
- // Allows for "name"'s in signature, but indicated as optional
283
- ['namepathRole', 'namepath-defining'],
284
- // Has example showing curly brackets but not in doc signature
285
- ['typeAllowed', true]])], ['yield', new Map(/** @type {[string, string|boolean][]} */[
286
- // Shows curly brackets in the signature and in the examples
287
- ['typeAllowed', true]])], ['yields', new Map(/** @type {[string, string|boolean][]} */[
288
- // Shows curly brackets in the signature and in the examples
289
- ['typeAllowed', true]])]]);
7
+ * @param {import('./jsdocUtils.js').ParserMode} mode
8
+ * @returns {TagStructure}
9
+ */
10
+ const getDefaultTagStructureForMode = (mode) => {
11
+ const isJsdoc = mode === "jsdoc";
12
+ const isClosure = mode === "closure";
13
+ const isTypescript = mode === "typescript";
14
+ const isPermissive = mode === "permissive";
15
+ const isJsdocOrPermissive = isJsdoc || isPermissive;
16
+ const isJsdocOrTypescript = isJsdoc || isTypescript;
17
+ const isTypescriptOrClosure = isTypescript || isClosure;
18
+ const isClosureOrPermissive = isClosure || isPermissive;
19
+ const isJsdocTypescriptOrPermissive = isJsdocOrTypescript || isPermissive;
20
+ /**
21
+ * @type {TagStructure}
22
+ */
23
+ return new Map([
24
+ ["alias", new Map([["namepathRole", "namepath-defining"], ["typeOrNameRequired", true]])],
25
+ ["arg", new Map([
26
+ ["namepathRole", "namepath-defining"],
27
+ ["nameRequired", true],
28
+ ["typeAllowed", true]
29
+ ])],
30
+ ["argument", new Map([
31
+ ["namepathRole", "namepath-defining"],
32
+ ["nameRequired", true],
33
+ ["typeAllowed", true]
34
+ ])],
35
+ ["augments", new Map([
36
+ ["namepathRole", "namepath-referencing"],
37
+ ["typeAllowed", true],
38
+ ["typeOrNameRequired", true]
39
+ ])],
40
+ ["borrows", new Map([["namepathRole", "namepath-referencing"], ["typeOrNameRequired", true]])],
41
+ ["callback", new Map([["namepathRole", "namepath-defining"], ["nameRequired", true]])],
42
+ ["class", new Map([
43
+ ["nameAllowed", true],
44
+ ["namepathRole", "namepath-defining"],
45
+ ["typeAllowed", true]
46
+ ])],
47
+ ["const", new Map([["namepathRole", "namepath-defining"], ["typeAllowed", true]])],
48
+ ["constant", new Map([["namepathRole", "namepath-defining"], ["typeAllowed", true]])],
49
+ ["constructor", new Map([["namepathRole", "namepath-defining"], ["typeAllowed", true]])],
50
+ ["constructs", new Map([
51
+ ["namepathRole", "namepath-defining"],
52
+ ["nameRequired", false],
53
+ ["typeAllowed", false]
54
+ ])],
55
+ ["define", new Map([["typeRequired", isClosure]])],
56
+ ["emits", new Map([
57
+ ["namepathRole", "namepath-referencing"],
58
+ ["nameRequired", true],
59
+ ["typeAllowed", false]
60
+ ])],
61
+ ["enum", new Map([["typeAllowed", true]])],
62
+ ["event", new Map([["namepathRole", "namepath-defining"], ["nameRequired", true]])],
63
+ ["exception", new Map([["typeAllowed", true]])],
64
+ ["export", new Map([["typeAllowed", isClosureOrPermissive]])],
65
+ ["exports", new Map([
66
+ ["namepathRole", "namepath-defining"],
67
+ ["nameRequired", isJsdoc],
68
+ ["typeAllowed", isClosureOrPermissive]
69
+ ])],
70
+ ["extends", new Map([
71
+ ["namepathRole", "namepath-referencing"],
72
+ ["nameRequired", isJsdoc],
73
+ ["typeAllowed", isTypescriptOrClosure || isPermissive],
74
+ ["typeOrNameRequired", isTypescriptOrClosure || isPermissive]
75
+ ])],
76
+ ["external", new Map([
77
+ ["namepathRole", "namepath-defining"],
78
+ ["nameRequired", true],
79
+ ["typeAllowed", false]
80
+ ])],
81
+ ["fires", new Map([
82
+ ["namepathRole", "namepath-referencing"],
83
+ ["nameRequired", true],
84
+ ["typeAllowed", false]
85
+ ])],
86
+ ["func", new Map([["namepathRole", "namepath-defining"]])],
87
+ ["function", new Map([
88
+ ["namepathRole", "namepath-defining"],
89
+ ["nameRequired", false],
90
+ ["typeAllowed", false]
91
+ ])],
92
+ ["host", new Map([
93
+ ["namepathRole", "namepath-defining"],
94
+ ["nameRequired", true],
95
+ ["typeAllowed", false]
96
+ ])],
97
+ ["implements", new Map([["typeRequired", true]])],
98
+ ["interface", new Map([
99
+ ["nameAllowed", isClosure],
100
+ ["namepathRole", isJsdocTypescriptOrPermissive ? "namepath-defining" : false],
101
+ ["typeAllowed", false]
102
+ ])],
103
+ ["internal", new Map([["nameAllowed", false], ["namepathRole", false]])],
104
+ ["lends", new Map([["namepathRole", "namepath-referencing"], ["typeOrNameRequired", true]])],
105
+ ["link", new Map([["namepathRole", "namepath-or-url-referencing"]])],
106
+ ["linkcode", new Map([["namepathRole", "namepath-or-url-referencing"]])],
107
+ ["linkplain", new Map([["namepathRole", "namepath-or-url-referencing"]])],
108
+ ["listens", new Map([
109
+ ["namepathRole", "namepath-referencing"],
110
+ ["nameRequired", true],
111
+ ["typeAllowed", false]
112
+ ])],
113
+ ["member", new Map([["namepathRole", "namepath-defining"], ["typeAllowed", true]])],
114
+ ["memberof!", new Map([["namepathRole", "namepath-referencing"], ["typeOrNameRequired", true]])],
115
+ ["memberof", new Map([["namepathRole", "namepath-referencing"], ["typeOrNameRequired", true]])],
116
+ ["method", new Map([["namepathRole", "namepath-defining"]])],
117
+ ["mixes", new Map([["namepathRole", "namepath-referencing"], ["typeOrNameRequired", true]])],
118
+ ["mixin", new Map([
119
+ ["namepathRole", "namepath-defining"],
120
+ ["nameRequired", false],
121
+ ["typeAllowed", false]
122
+ ])],
123
+ ["modifies", new Map([["typeAllowed", true]])],
124
+ ["module", new Map([["namepathRole", isJsdoc ? "namepath-defining" : "text"], ["typeAllowed", true]])],
125
+ ["name", new Map([
126
+ ["namepathRole", "namepath-defining"],
127
+ ["nameRequired", true],
128
+ ["typeOrNameRequired", true]
129
+ ])],
130
+ ["namespace", new Map([["namepathRole", "namepath-defining"], ["typeAllowed", true]])],
131
+ ["package", new Map([["typeAllowed", isClosureOrPermissive]])],
132
+ ["param", new Map([
133
+ ["namepathRole", "namepath-defining"],
134
+ ["nameRequired", true],
135
+ ["typeAllowed", true]
136
+ ])],
137
+ ["private", new Map([["typeAllowed", isClosureOrPermissive]])],
138
+ ["prop", new Map([
139
+ ["namepathRole", "namepath-defining"],
140
+ ["nameRequired", true],
141
+ ["typeAllowed", true]
142
+ ])],
143
+ ["property", new Map([
144
+ ["namepathRole", "namepath-defining"],
145
+ ["nameRequired", true],
146
+ ["typeAllowed", true]
147
+ ])],
148
+ ["protected", new Map([["typeAllowed", isClosureOrPermissive]])],
149
+ ["public", new Map([["typeAllowed", isClosureOrPermissive]])],
150
+ ["requires", new Map([
151
+ ["namepathRole", "namepath-referencing"],
152
+ ["nameRequired", true],
153
+ ["typeAllowed", false]
154
+ ])],
155
+ ["return", new Map([["typeAllowed", true]])],
156
+ ["returns", new Map([["typeAllowed", true]])],
157
+ ["satisfies", new Map([["typeRequired", true]])],
158
+ ["see", new Map([["namepathRole", "text"]])],
159
+ ["static", new Map([["typeAllowed", isClosureOrPermissive]])],
160
+ ["suppress", new Map([["namepathRole", !isClosure], ["typeRequired", isClosure]])],
161
+ ["template", new Map([
162
+ ["namepathRole", isJsdoc ? "text" : "namepath-referencing"],
163
+ ["nameRequired", !isJsdoc],
164
+ ["typeAllowed", isTypescriptOrClosure || isPermissive]
165
+ ])],
166
+ ["this", new Map([
167
+ ["namepathRole", isJsdoc ? "namepath-referencing" : false],
168
+ ["typeOrNameRequired", isJsdoc],
169
+ ["typeRequired", isTypescriptOrClosure]
170
+ ])],
171
+ ["throws", new Map([["typeAllowed", true]])],
172
+ ["tutorial", new Map([["nameRequired", true], ["typeAllowed", false]])],
173
+ ["type", new Map([["typeRequired", true]])],
174
+ ["typedef", new Map([
175
+ ["namepathRole", "namepath-defining"],
176
+ ["nameRequired", isJsdocOrPermissive],
177
+ ["typeAllowed", true],
178
+ ["typeOrNameRequired", !isTypescript]
179
+ ])],
180
+ ["var", new Map([["namepathRole", "namepath-defining"], ["typeAllowed", true]])],
181
+ ["yield", new Map([["typeAllowed", true]])],
182
+ ["yields", new Map([["typeAllowed", true]])]
183
+ ]);
290
184
  };
291
- var _default = exports.default = getDefaultTagStructureForMode;
292
- module.exports = exports.default;
185
+ var getDefaultTagStructureForMode_default = getDefaultTagStructureForMode;
186
+
187
+ //#endregion
188
+ exports.default = getDefaultTagStructureForMode_default;
293
189
  //# sourceMappingURL=getDefaultTagStructureForMode.cjs.map