eslint-plugin-jsdoc 53.0.1 → 54.1.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 +2007 -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 +391 -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 +559 -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 +41 -57
  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 +2542 -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 +545 -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 +744 -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 +0,0 @@
1
- {"version":3,"file":"plugin.cjs","names":["checkAccess","checkAlignment","checkExamples","checkIndentation","checkLineAlignment","checkParamNames","checkPropertyNames","checkSyntax","checkTagNames","checkTemplateNames","checkTypes","checkValues","convertToJsdocComments","emptyTags","implementsOnClasses","importsAsDependencies","informativeDocs","linesBeforeBlock","matchDescription","matchName","multilineBlocks","noBadBlocks","noBlankBlockDescriptions","noBlankBlocks","noDefaults","noMissingSyntax","noMultiAsterisks","noRestrictedSyntax","noTypes","noUndefinedTypes","requireAsteriskPrefix","requireDescription","requireDescriptionCompleteSentence","requireExample","requireFileOverview","requireHyphenBeforeParamDescription","requireJsdoc","requireParam","requireParamDescription","requireParamName","requireParamType","requireProperty","requirePropertyDescription","requirePropertyName","requirePropertyType","requireReturns","requireReturnsCheck","requireReturnsDescription","requireReturnsType","requireTemplate","requireThrows","requireYields","requireYieldsCheck","sortTags","tagLines","textEscaping","validTypes","getJsdocProcessorPlugin"],"sources":["../src/plugin.js"],"sourcesContent":["import {\n getJsdocProcessorPlugin,\n} from './getJsdocProcessorPlugin.js';\nimport checkAccess from './rules/checkAccess.js';\nimport checkAlignment from './rules/checkAlignment.js';\nimport checkExamples from './rules/checkExamples.js';\nimport checkIndentation from './rules/checkIndentation.js';\nimport checkLineAlignment from './rules/checkLineAlignment.js';\nimport checkParamNames from './rules/checkParamNames.js';\nimport checkPropertyNames from './rules/checkPropertyNames.js';\nimport checkSyntax from './rules/checkSyntax.js';\nimport checkTagNames from './rules/checkTagNames.js';\nimport checkTemplateNames from './rules/checkTemplateNames.js';\nimport checkTypes from './rules/checkTypes.js';\nimport checkValues from './rules/checkValues.js';\nimport convertToJsdocComments from './rules/convertToJsdocComments.js';\nimport emptyTags from './rules/emptyTags.js';\nimport implementsOnClasses from './rules/implementsOnClasses.js';\nimport importsAsDependencies from './rules/importsAsDependencies.js';\nimport informativeDocs from './rules/informativeDocs.js';\nimport linesBeforeBlock from './rules/linesBeforeBlock.js';\nimport matchDescription from './rules/matchDescription.js';\nimport matchName from './rules/matchName.js';\nimport multilineBlocks from './rules/multilineBlocks.js';\nimport noBadBlocks from './rules/noBadBlocks.js';\nimport noBlankBlockDescriptions from './rules/noBlankBlockDescriptions.js';\nimport noBlankBlocks from './rules/noBlankBlocks.js';\nimport noDefaults from './rules/noDefaults.js';\nimport noMissingSyntax from './rules/noMissingSyntax.js';\nimport noMultiAsterisks from './rules/noMultiAsterisks.js';\nimport noRestrictedSyntax from './rules/noRestrictedSyntax.js';\nimport noTypes from './rules/noTypes.js';\nimport noUndefinedTypes from './rules/noUndefinedTypes.js';\nimport requireAsteriskPrefix from './rules/requireAsteriskPrefix.js';\nimport requireDescription from './rules/requireDescription.js';\nimport requireDescriptionCompleteSentence from './rules/requireDescriptionCompleteSentence.js';\nimport requireExample from './rules/requireExample.js';\nimport requireFileOverview from './rules/requireFileOverview.js';\nimport requireHyphenBeforeParamDescription from './rules/requireHyphenBeforeParamDescription.js';\nimport requireJsdoc from './rules/requireJsdoc.js';\nimport requireParam from './rules/requireParam.js';\nimport requireParamDescription from './rules/requireParamDescription.js';\nimport requireParamName from './rules/requireParamName.js';\nimport requireParamType from './rules/requireParamType.js';\nimport requireProperty from './rules/requireProperty.js';\nimport requirePropertyDescription from './rules/requirePropertyDescription.js';\nimport requirePropertyName from './rules/requirePropertyName.js';\nimport requirePropertyType from './rules/requirePropertyType.js';\nimport requireReturns from './rules/requireReturns.js';\nimport requireReturnsCheck from './rules/requireReturnsCheck.js';\nimport requireReturnsDescription from './rules/requireReturnsDescription.js';\nimport requireReturnsType from './rules/requireReturnsType.js';\nimport requireTemplate from './rules/requireTemplate.js';\nimport requireThrows from './rules/requireThrows.js';\nimport requireYields from './rules/requireYields.js';\nimport requireYieldsCheck from './rules/requireYieldsCheck.js';\nimport sortTags from './rules/sortTags.js';\nimport tagLines from './rules/tagLines.js';\nimport textEscaping from './rules/textEscaping.js';\nimport validTypes from './rules/validTypes.js';\n\n/**\n * @typedef {\"recommended\" | \"stylistic\" | \"contents\" | \"logical\" | \"requirements\"} ConfigGroups\n * @typedef {\"\" | \"-typescript\" | \"-typescript-flavor\"} ConfigVariants\n * @typedef {\"\" | \"-error\"} ErrorLevelVariants\n */\n\n/* eslint-disable jsdoc/valid-types -- Bug */\n/**\n * @type {import('eslint').ESLint.Plugin & {\n * configs: Record<`flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}`,\n * import('eslint').Linter.Config>\n * }}\n */\n/* eslint-enable jsdoc/valid-types -- Bug */\nconst plugin = {\n // @ts-expect-error Ok\n configs: {},\n rules: {\n 'check-access': checkAccess,\n 'check-alignment': checkAlignment,\n 'check-examples': checkExamples,\n 'check-indentation': checkIndentation,\n 'check-line-alignment': checkLineAlignment,\n 'check-param-names': checkParamNames,\n 'check-property-names': checkPropertyNames,\n 'check-syntax': checkSyntax,\n 'check-tag-names': checkTagNames,\n 'check-template-names': checkTemplateNames,\n 'check-types': checkTypes,\n 'check-values': checkValues,\n 'convert-to-jsdoc-comments': convertToJsdocComments,\n 'empty-tags': emptyTags,\n 'implements-on-classes': implementsOnClasses,\n 'imports-as-dependencies': importsAsDependencies,\n 'informative-docs': informativeDocs,\n 'lines-before-block': linesBeforeBlock,\n 'match-description': matchDescription,\n 'match-name': matchName,\n 'multiline-blocks': multilineBlocks,\n 'no-bad-blocks': noBadBlocks,\n 'no-blank-block-descriptions': noBlankBlockDescriptions,\n 'no-blank-blocks': noBlankBlocks,\n 'no-defaults': noDefaults,\n 'no-missing-syntax': noMissingSyntax,\n 'no-multi-asterisks': noMultiAsterisks,\n 'no-restricted-syntax': noRestrictedSyntax,\n 'no-types': noTypes,\n 'no-undefined-types': noUndefinedTypes,\n 'require-asterisk-prefix': requireAsteriskPrefix,\n 'require-description': requireDescription,\n 'require-description-complete-sentence': requireDescriptionCompleteSentence,\n 'require-example': requireExample,\n 'require-file-overview': requireFileOverview,\n 'require-hyphen-before-param-description': requireHyphenBeforeParamDescription,\n 'require-jsdoc': requireJsdoc,\n 'require-param': requireParam,\n 'require-param-description': requireParamDescription,\n 'require-param-name': requireParamName,\n 'require-param-type': requireParamType,\n 'require-property': requireProperty,\n 'require-property-description': requirePropertyDescription,\n 'require-property-name': requirePropertyName,\n 'require-property-type': requirePropertyType,\n 'require-returns': requireReturns,\n 'require-returns-check': requireReturnsCheck,\n 'require-returns-description': requireReturnsDescription,\n 'require-returns-type': requireReturnsType,\n 'require-template': requireTemplate,\n 'require-throws': requireThrows,\n 'require-yields': requireYields,\n 'require-yields-check': requireYieldsCheck,\n 'sort-tags': sortTags,\n 'tag-lines': tagLines,\n 'text-escaping': textEscaping,\n 'valid-types': validTypes,\n },\n};\n\n/**\n * @param {\"warn\"|\"error\"} warnOrError\n * @param {string} [flatName]\n * @returns {import('eslint').Linter.FlatConfig}\n */\nconst createRecommendedRuleset = (warnOrError, flatName) => {\n return {\n ...(flatName ? {\n name: 'jsdoc/' + flatName,\n } : {}),\n // @ts-expect-error Ok\n plugins:\n flatName ? {\n jsdoc: plugin,\n } : [\n 'jsdoc',\n ],\n rules: {\n 'jsdoc/check-access': warnOrError,\n 'jsdoc/check-alignment': warnOrError,\n 'jsdoc/check-examples': 'off',\n 'jsdoc/check-indentation': 'off',\n 'jsdoc/check-line-alignment': 'off',\n 'jsdoc/check-param-names': warnOrError,\n 'jsdoc/check-property-names': warnOrError,\n 'jsdoc/check-syntax': 'off',\n 'jsdoc/check-tag-names': warnOrError,\n 'jsdoc/check-template-names': 'off',\n 'jsdoc/check-types': warnOrError,\n 'jsdoc/check-values': warnOrError,\n 'jsdoc/convert-to-jsdoc-comments': 'off',\n 'jsdoc/empty-tags': warnOrError,\n 'jsdoc/implements-on-classes': warnOrError,\n 'jsdoc/imports-as-dependencies': 'off',\n 'jsdoc/informative-docs': 'off',\n 'jsdoc/lines-before-block': 'off',\n 'jsdoc/match-description': 'off',\n 'jsdoc/match-name': 'off',\n 'jsdoc/multiline-blocks': warnOrError,\n 'jsdoc/no-bad-blocks': 'off',\n 'jsdoc/no-blank-block-descriptions': 'off',\n 'jsdoc/no-blank-blocks': 'off',\n 'jsdoc/no-defaults': warnOrError,\n 'jsdoc/no-missing-syntax': 'off',\n 'jsdoc/no-multi-asterisks': warnOrError,\n 'jsdoc/no-restricted-syntax': 'off',\n 'jsdoc/no-types': 'off',\n 'jsdoc/no-undefined-types': warnOrError,\n 'jsdoc/require-asterisk-prefix': 'off',\n 'jsdoc/require-description': 'off',\n 'jsdoc/require-description-complete-sentence': 'off',\n 'jsdoc/require-example': 'off',\n 'jsdoc/require-file-overview': 'off',\n 'jsdoc/require-hyphen-before-param-description': 'off',\n 'jsdoc/require-jsdoc': warnOrError,\n 'jsdoc/require-param': warnOrError,\n 'jsdoc/require-param-description': warnOrError,\n 'jsdoc/require-param-name': warnOrError,\n 'jsdoc/require-param-type': warnOrError,\n 'jsdoc/require-property': warnOrError,\n 'jsdoc/require-property-description': warnOrError,\n 'jsdoc/require-property-name': warnOrError,\n 'jsdoc/require-property-type': warnOrError,\n 'jsdoc/require-returns': warnOrError,\n 'jsdoc/require-returns-check': warnOrError,\n 'jsdoc/require-returns-description': warnOrError,\n 'jsdoc/require-returns-type': warnOrError,\n 'jsdoc/require-template': 'off',\n 'jsdoc/require-throws': 'off',\n 'jsdoc/require-yields': warnOrError,\n 'jsdoc/require-yields-check': warnOrError,\n 'jsdoc/sort-tags': 'off',\n 'jsdoc/tag-lines': warnOrError,\n 'jsdoc/text-escaping': 'off',\n 'jsdoc/valid-types': warnOrError,\n },\n };\n};\n\n/**\n * @param {\"warn\"|\"error\"} warnOrError\n * @param {string} [flatName]\n * @returns {import('eslint').Linter.FlatConfig}\n */\nconst createRecommendedTypeScriptRuleset = (warnOrError, flatName) => {\n const ruleset = createRecommendedRuleset(warnOrError, flatName);\n\n return {\n ...ruleset,\n rules: {\n ...ruleset.rules,\n /* eslint-disable @stylistic/indent -- Extra indent to avoid use by auto-rule-editing */\n 'jsdoc/check-tag-names': [\n warnOrError, {\n typed: true,\n },\n ],\n 'jsdoc/no-types': warnOrError,\n 'jsdoc/no-undefined-types': 'off',\n 'jsdoc/require-param-type': 'off',\n 'jsdoc/require-property-type': 'off',\n 'jsdoc/require-returns-type': 'off',\n /* eslint-enable @stylistic/indent */\n },\n };\n};\n\n/**\n * @param {\"warn\"|\"error\"} warnOrError\n * @param {string} [flatName]\n * @returns {import('eslint').Linter.FlatConfig}\n */\nconst createRecommendedTypeScriptFlavorRuleset = (warnOrError, flatName) => {\n const ruleset = createRecommendedRuleset(warnOrError, flatName);\n\n return {\n ...ruleset,\n rules: {\n ...ruleset.rules,\n /* eslint-disable @stylistic/indent -- Extra indent to avoid use by auto-rule-editing */\n 'jsdoc/no-undefined-types': 'off',\n /* eslint-enable @stylistic/indent */\n },\n };\n};\n\n/**\n * @param {(string | unknown[])[]} ruleNames\n */\nconst createStandaloneRulesetFactory = (ruleNames) => {\n /**\n * @param {\"warn\"|\"error\"} warnOrError\n * @param {string} [flatName]\n * @returns {import('eslint').Linter.FlatConfig}\n */\n return (warnOrError, flatName) => {\n return {\n name: 'jsdoc/' + flatName,\n plugins: {\n jsdoc: plugin,\n },\n rules: Object.fromEntries(\n ruleNames.map(\n (ruleName) => {\n return (typeof ruleName === 'string' ?\n [\n ruleName, warnOrError,\n ] :\n [\n ruleName[0], [\n warnOrError, ...ruleName.slice(1),\n ],\n ]);\n },\n ),\n ),\n };\n };\n};\n\nconst contentsRules = [\n 'jsdoc/informative-docs',\n 'jsdoc/match-description',\n 'jsdoc/no-blank-block-descriptions',\n 'jsdoc/no-blank-blocks',\n [\n 'jsdoc/text-escaping', {\n escapeHTML: true,\n },\n ],\n];\n\nconst createContentsTypescriptRuleset = createStandaloneRulesetFactory(contentsRules);\n\nconst createContentsTypescriptFlavorRuleset = createStandaloneRulesetFactory(contentsRules);\n\nconst logicalRules = [\n 'jsdoc/check-access',\n 'jsdoc/check-param-names',\n 'jsdoc/check-property-names',\n 'jsdoc/check-syntax',\n 'jsdoc/check-tag-names',\n 'jsdoc/check-template-names',\n 'jsdoc/check-types',\n 'jsdoc/check-values',\n 'jsdoc/empty-tags',\n 'jsdoc/implements-on-classes',\n 'jsdoc/require-returns-check',\n 'jsdoc/require-yields-check',\n 'jsdoc/no-bad-blocks',\n 'jsdoc/no-defaults',\n 'jsdoc/no-types',\n 'jsdoc/no-undefined-types',\n 'jsdoc/valid-types',\n];\n\nconst createLogicalTypescriptRuleset = createStandaloneRulesetFactory(logicalRules);\n\nconst createLogicalTypescriptFlavorRuleset = createStandaloneRulesetFactory(logicalRules);\n\nconst requirementsRules = [\n 'jsdoc/require-example',\n 'jsdoc/require-jsdoc',\n 'jsdoc/require-param',\n 'jsdoc/require-param-description',\n 'jsdoc/require-param-name',\n 'jsdoc/require-property',\n 'jsdoc/require-property-description',\n 'jsdoc/require-property-name',\n 'jsdoc/require-returns',\n 'jsdoc/require-returns-description',\n 'jsdoc/require-yields',\n];\n\nconst createRequirementsTypeScriptRuleset = createStandaloneRulesetFactory(requirementsRules);\n\nconst createRequirementsTypeScriptFlavorRuleset = createStandaloneRulesetFactory([\n ...requirementsRules,\n 'jsdoc/require-param-type',\n 'jsdoc/require-property-type',\n 'jsdoc/require-returns-type',\n 'jsdoc/require-template',\n]);\n\nconst stylisticRules = [\n 'jsdoc/check-alignment',\n 'jsdoc/check-line-alignment',\n 'jsdoc/lines-before-block',\n 'jsdoc/multiline-blocks',\n 'jsdoc/no-multi-asterisks',\n 'jsdoc/require-asterisk-prefix',\n [\n 'jsdoc/require-hyphen-before-param-description', 'never',\n ],\n 'jsdoc/tag-lines',\n];\n\nconst createStylisticTypeScriptRuleset = createStandaloneRulesetFactory(stylisticRules);\n\nconst createStylisticTypeScriptFlavorRuleset = createStandaloneRulesetFactory(stylisticRules);\n\n/* c8 ignore next 3 -- TS */\nif (!plugin.configs) {\n throw new Error('TypeScript guard');\n}\n\nplugin.configs.recommended = createRecommendedRuleset('warn');\nplugin.configs['recommended-error'] = createRecommendedRuleset('error');\nplugin.configs['recommended-typescript'] = createRecommendedTypeScriptRuleset('warn');\nplugin.configs['recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error');\nplugin.configs['recommended-typescript-flavor'] = createRecommendedTypeScriptFlavorRuleset('warn');\nplugin.configs['recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error');\n\nplugin.configs['flat/recommended'] = createRecommendedRuleset('warn', 'flat/recommended');\nplugin.configs['flat/recommended-error'] = createRecommendedRuleset('error', 'flat/recommended-error');\nplugin.configs['flat/recommended-typescript'] = createRecommendedTypeScriptRuleset('warn', 'flat/recommended-typescript');\nplugin.configs['flat/recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error', 'flat/recommended-typescript-error');\nplugin.configs['flat/recommended-typescript-flavor'] = createRecommendedTypeScriptFlavorRuleset('warn', 'flat/recommended-typescript-flavor');\nplugin.configs['flat/recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error', 'flat/recommended-typescript-flavor-error');\n\nplugin.configs['flat/contents-typescript'] = createContentsTypescriptRuleset('warn', 'flat/contents-typescript');\nplugin.configs['flat/contents-typescript-error'] = createContentsTypescriptRuleset('error', 'flat/contents-typescript-error');\nplugin.configs['flat/contents-typescript-flavor'] = createContentsTypescriptFlavorRuleset('warn', 'flat/contents-typescript-flavor');\nplugin.configs['flat/contents-typescript-flavor-error'] = createContentsTypescriptFlavorRuleset('error', 'flat/contents-typescript-error-flavor');\nplugin.configs['flat/logical-typescript'] = createLogicalTypescriptRuleset('warn', 'flat/logical-typescript');\nplugin.configs['flat/logical-typescript-error'] = createLogicalTypescriptRuleset('error', 'flat/logical-typescript-error');\nplugin.configs['flat/logical-typescript-flavor'] = createLogicalTypescriptFlavorRuleset('warn', 'flat/logical-typescript-flavor');\nplugin.configs['flat/logical-typescript-flavor-error'] = createLogicalTypescriptFlavorRuleset('error', 'flat/logical-typescript-error-flavor');\nplugin.configs['flat/requirements-typescript'] = createRequirementsTypeScriptRuleset('warn', 'flat/requirements-typescript');\nplugin.configs['flat/requirements-typescript-error'] = createRequirementsTypeScriptRuleset('error', 'flat/requirements-typescript-error');\nplugin.configs['flat/requirements-typescript-flavor'] = createRequirementsTypeScriptFlavorRuleset('warn', 'flat/requirements-typescript-flavor');\nplugin.configs['flat/requirements-typescript-flavor-error'] = createRequirementsTypeScriptFlavorRuleset('error', 'flat/requirements-typescript-error-flavor');\nplugin.configs['flat/stylistic-typescript'] = createStylisticTypeScriptRuleset('warn', 'flat/stylistic-typescript');\nplugin.configs['flat/stylistic-typescript-error'] = createStylisticTypeScriptRuleset('error', 'flat/stylistic-typescript-error');\nplugin.configs['flat/stylistic-typescript-flavor'] = createStylisticTypeScriptFlavorRuleset('warn', 'flat/stylistic-typescript-flavor');\nplugin.configs['flat/stylistic-typescript-flavor-error'] = createStylisticTypeScriptFlavorRuleset('error', 'flat/stylistic-typescript-error-flavor');\n\nplugin.configs.examples = /** @type {import('eslint').Linter.FlatConfig[]} */ ([\n {\n files: [\n '**/*.js',\n ],\n name: 'jsdoc/examples/processor',\n plugins: {\n examples: getJsdocProcessorPlugin(),\n },\n processor: 'examples/examples',\n },\n {\n files: [\n '**/*.md/*.js',\n ],\n name: 'jsdoc/examples/rules',\n rules: {\n // \"always\" newline rule at end unlikely in sample code\n 'eol-last': 0,\n\n // Wouldn't generally expect example paths to resolve relative to JS file\n 'import/no-unresolved': 0,\n\n // Snippets likely too short to always include import/export info\n 'import/unambiguous': 0,\n\n 'jsdoc/require-file-overview': 0,\n\n // The end of a multiline comment would end the comment the example is in.\n 'jsdoc/require-jsdoc': 0,\n\n // Unlikely to have inadvertent debugging within examples\n 'no-console': 0,\n\n // Often wish to start `@example` code after newline; also may use\n // empty lines for spacing\n 'no-multiple-empty-lines': 0,\n\n // Many variables in examples will be `undefined`\n 'no-undef': 0,\n\n // Common to define variables for clarity without always using them\n 'no-unused-vars': 0,\n\n // See import/no-unresolved\n 'node/no-missing-import': 0,\n 'node/no-missing-require': 0,\n\n // Can generally look nicer to pad a little even if code imposes more stringency\n 'padded-blocks': 0,\n },\n },\n]);\n\nplugin.configs['default-expressions'] = /** @type {import('eslint').Linter.FlatConfig[]} */ ([\n {\n files: [\n '**/*.js',\n ],\n name: 'jsdoc/default-expressions/processor',\n plugins: {\n examples: getJsdocProcessorPlugin({\n checkDefaults: true,\n checkParams: true,\n checkProperties: true,\n }),\n },\n processor: 'examples/examples',\n },\n {\n files: [\n '**/*.jsdoc-defaults', '**/*.jsdoc-params', '**/*.jsdoc-properties',\n ],\n name: 'jsdoc/default-expressions/rules',\n rules: {\n ...plugin.configs.examples[1].rules,\n 'chai-friendly/no-unused-expressions': 0,\n 'no-empty-function': 0,\n 'no-new': 0,\n 'no-unused-expressions': 0,\n quotes: [\n 'error', 'double',\n ],\n semi: [\n 'error', 'never',\n ],\n strict: 0,\n },\n },\n]);\n\nplugin.configs['examples-and-default-expressions'] = /** @type {import('eslint').Linter.FlatConfig[]} */ ([\n {\n name: 'jsdoc/examples-and-default-expressions',\n plugins: {\n examples: getJsdocProcessorPlugin({\n checkDefaults: true,\n checkParams: true,\n checkProperties: true,\n }),\n },\n },\n ...plugin.configs.examples.map((config) => {\n return {\n ...config,\n plugins: {},\n };\n }),\n ...plugin.configs['default-expressions'].map((config) => {\n return {\n ...config,\n plugins: {},\n };\n }),\n]);\n\nexport default plugin;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2EA,MAAM,SAAS;CAEb,SAAS,CAAE;CACX,OAAO;EACL,gBAAgBA;EAChB,mBAAmBC;EACnB,kBAAkBC;EAClB,qBAAqBC;EACrB,wBAAwBC;EACxB,qBAAqBC;EACrB,wBAAwBC;EACxB,gBAAgBC;EAChB,mBAAmBC;EACnB,wBAAwBC;EACxB,eAAeC;EACf,gBAAgBC;EAChB,6BAA6BC;EAC7B,cAAcC;EACd,yBAAyBC;EACzB,2BAA2BC;EAC3B,oBAAoBC;EACpB,sBAAsBC;EACtB,qBAAqBC;EACrB,cAAcC;EACd,oBAAoBC;EACpB,iBAAiBC;EACjB,+BAA+BC;EAC/B,mBAAmBC;EACnB,eAAeC;EACf,qBAAqBC;EACrB,sBAAsBC;EACtB,wBAAwBC;EACxB,YAAYC;EACZ,sBAAsBC;EACtB,2BAA2BC;EAC3B,uBAAuBC;EACvB,yCAAyCC;EACzC,mBAAmBC;EACnB,yBAAyBC;EACzB,2CAA2CC;EAC3C,iBAAiBC;EACjB,iBAAiBC;EACjB,6BAA6BC;EAC7B,sBAAsBC;EACtB,sBAAsBC;EACtB,oBAAoBC;EACpB,gCAAgCC;EAChC,yBAAyBC;EACzB,yBAAyBC;EACzB,mBAAmBC;EACnB,yBAAyBC;EACzB,+BAA+BC;EAC/B,wBAAwBC;EACxB,oBAAoBC;EACpB,kBAAkBC;EAClB,kBAAkBC;EAClB,wBAAwBC;EACxB,aAAaC;EACb,aAAaC;EACb,iBAAiBC;EACjB,eAAeC;CAChB;AACF;;;;;;AAOD,MAAM,2BAA2B,CAAC,aAAa,aAAa;AAC1D,QAAO;EACL,GAAI,WAAW,EACb,MAAM,WAAW,SAClB,IAAG,CAAE;EAEN,SACE,WAAW,EACT,OAAO,OACR,IAAG,CACF,OACD;EACH,OAAO;GACL,sBAAsB;GACtB,yBAAyB;GACzB,wBAAwB;GACxB,2BAA2B;GAC3B,8BAA8B;GAC9B,2BAA2B;GAC3B,8BAA8B;GAC9B,sBAAsB;GACtB,yBAAyB;GACzB,8BAA8B;GAC9B,qBAAqB;GACrB,sBAAsB;GACtB,mCAAmC;GACnC,oBAAoB;GACpB,+BAA+B;GAC/B,iCAAiC;GACjC,0BAA0B;GAC1B,4BAA4B;GAC5B,2BAA2B;GAC3B,oBAAoB;GACpB,0BAA0B;GAC1B,uBAAuB;GACvB,qCAAqC;GACrC,yBAAyB;GACzB,qBAAqB;GACrB,2BAA2B;GAC3B,4BAA4B;GAC5B,8BAA8B;GAC9B,kBAAkB;GAClB,4BAA4B;GAC5B,iCAAiC;GACjC,6BAA6B;GAC7B,+CAA+C;GAC/C,yBAAyB;GACzB,+BAA+B;GAC/B,iDAAiD;GACjD,uBAAuB;GACvB,uBAAuB;GACvB,mCAAmC;GACnC,4BAA4B;GAC5B,4BAA4B;GAC5B,0BAA0B;GAC1B,sCAAsC;GACtC,+BAA+B;GAC/B,+BAA+B;GAC/B,yBAAyB;GACzB,+BAA+B;GAC/B,qCAAqC;GACrC,8BAA8B;GAC9B,0BAA0B;GAC1B,wBAAwB;GACxB,wBAAwB;GACxB,8BAA8B;GAC9B,mBAAmB;GACnB,mBAAmB;GACnB,uBAAuB;GACvB,qBAAqB;EACtB;CACF;AACF;;;;;;AAOD,MAAM,qCAAqC,CAAC,aAAa,aAAa;CACpE,MAAM,UAAU,yBAAyB,aAAa,SAAS;AAE/D,QAAO;EACL,GAAG;EACH,OAAO;GACL,GAAG,QAAQ;GAET,yBAAyB,CACvB,aAAa,EACX,OAAO,KACR,CACF;GACD,kBAAkB;GAClB,4BAA4B;GAC5B,4BAA4B;GAC5B,+BAA+B;GAC/B,8BAA8B;EAEjC;CACF;AACF;;;;;;AAOD,MAAM,2CAA2C,CAAC,aAAa,aAAa;CAC1E,MAAM,UAAU,yBAAyB,aAAa,SAAS;AAE/D,QAAO;EACL,GAAG;EACH,OAAO;GACL,GAAG,QAAQ;GAET,4BAA4B;EAE/B;CACF;AACF;;;;AAKD,MAAM,iCAAiC,CAAC,cAAc;;;;;;AAMpD,QAAO,CAAC,aAAa,aAAa;AAChC,SAAO;GACL,MAAM,WAAW;GACjB,SAAS,EACP,OAAO,OACR;GACD,OAAO,OAAO,YACZ,UAAU,IACR,CAAC,aAAa;AACZ,WAAQ,OAAO,aAAa,WAC1B,CACE,UAAU,WACX,IACD,CACE,SAAS,IAAI,CACX,aAAa,GAAG,SAAS,MAAM,EAAE,AAClC,CACF;GACJ,EACF,CACF;EACF;CACF;AACF;AAED,MAAM,gBAAgB;CACpB;CACA;CACA;CACA;CACA,CACE,uBAAuB,EACrB,YAAY,KACb,CACF;AACF;AAED,MAAM,kCAAkC,+BAA+B,cAAc;AAErF,MAAM,wCAAwC,+BAA+B,cAAc;AAE3F,MAAM,eAAe;CACnB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD;AAED,MAAM,iCAAiC,+BAA+B,aAAa;AAEnF,MAAM,uCAAuC,+BAA+B,aAAa;AAEzF,MAAM,oBAAoB;CACxB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD;AAED,MAAM,sCAAsC,+BAA+B,kBAAkB;AAE7F,MAAM,4CAA4C,+BAA+B;CAC/E,GAAG;CACH;CACA;CACA;CACA;AACD,EAAC;AAEF,MAAM,iBAAiB;CACrB;CACA;CACA;CACA;CACA;CACA;CACA,CACE,iDAAiD,OAClD;CACD;AACD;AAED,MAAM,mCAAmC,+BAA+B,eAAe;AAEvF,MAAM,yCAAyC,+BAA+B,eAAe;;AAG7F,IAAI,CAAC,OAAO,QACV,OAAM,IAAI,MAAM;AAGlB,OAAO,QAAQ,cAAc,yBAAyB,OAAO;AAC7D,OAAO,QAAQ,uBAAuB,yBAAyB,QAAQ;AACvE,OAAO,QAAQ,4BAA4B,mCAAmC,OAAO;AACrF,OAAO,QAAQ,kCAAkC,mCAAmC,QAAQ;AAC5F,OAAO,QAAQ,mCAAmC,yCAAyC,OAAO;AAClG,OAAO,QAAQ,yCAAyC,yCAAyC,QAAQ;AAEzG,OAAO,QAAQ,sBAAsB,yBAAyB,QAAQ,mBAAmB;AACzF,OAAO,QAAQ,4BAA4B,yBAAyB,SAAS,yBAAyB;AACtG,OAAO,QAAQ,iCAAiC,mCAAmC,QAAQ,8BAA8B;AACzH,OAAO,QAAQ,uCAAuC,mCAAmC,SAAS,oCAAoC;AACtI,OAAO,QAAQ,wCAAwC,yCAAyC,QAAQ,qCAAqC;AAC7I,OAAO,QAAQ,8CAA8C,yCAAyC,SAAS,2CAA2C;AAE1J,OAAO,QAAQ,8BAA8B,gCAAgC,QAAQ,2BAA2B;AAChH,OAAO,QAAQ,oCAAoC,gCAAgC,SAAS,iCAAiC;AAC7H,OAAO,QAAQ,qCAAqC,sCAAsC,QAAQ,kCAAkC;AACpI,OAAO,QAAQ,2CAA2C,sCAAsC,SAAS,wCAAwC;AACjJ,OAAO,QAAQ,6BAA6B,+BAA+B,QAAQ,0BAA0B;AAC7G,OAAO,QAAQ,mCAAmC,+BAA+B,SAAS,gCAAgC;AAC1H,OAAO,QAAQ,oCAAoC,qCAAqC,QAAQ,iCAAiC;AACjI,OAAO,QAAQ,0CAA0C,qCAAqC,SAAS,uCAAuC;AAC9I,OAAO,QAAQ,kCAAkC,oCAAoC,QAAQ,+BAA+B;AAC5H,OAAO,QAAQ,wCAAwC,oCAAoC,SAAS,qCAAqC;AACzI,OAAO,QAAQ,yCAAyC,0CAA0C,QAAQ,sCAAsC;AAChJ,OAAO,QAAQ,+CAA+C,0CAA0C,SAAS,4CAA4C;AAC7J,OAAO,QAAQ,+BAA+B,iCAAiC,QAAQ,4BAA4B;AACnH,OAAO,QAAQ,qCAAqC,iCAAiC,SAAS,kCAAkC;AAChI,OAAO,QAAQ,sCAAsC,uCAAuC,QAAQ,mCAAmC;AACvI,OAAO,QAAQ,4CAA4C,uCAAuC,SAAS,yCAAyC;AAEpJ,OAAO,QAAQ,WAAgE,CAC7E;CACE,OAAO,CACL,SACD;CACD,MAAM;CACN,SAAS,EACP,UAAUC,yDAAyB,CACpC;CACD,WAAW;AACZ,GACD;CACE,OAAO,CACL,cACD;CACD,MAAM;CACN,OAAO;EAEL,YAAY;EAGZ,wBAAwB;EAGxB,sBAAsB;EAEtB,+BAA+B;EAG/B,uBAAuB;EAGvB,cAAc;EAId,2BAA2B;EAG3B,YAAY;EAGZ,kBAAkB;EAGlB,0BAA0B;EAC1B,2BAA2B;EAG3B,iBAAiB;CAClB;AACF,CACF;AAED,OAAO,QAAQ,yBAA8E,CAC3F;CACE,OAAO,CACL,SACD;CACD,MAAM;CACN,SAAS,EACP,UAAUA,wDAAwB;EAChC,eAAe;EACf,aAAa;EACb,iBAAiB;CAClB,EAAC,CACH;CACD,WAAW;AACZ,GACD;CACE,OAAO;EACL;EAAuB;EAAqB;CAC7C;CACD,MAAM;CACN,OAAO;EACL,GAAG,OAAO,QAAQ,SAAS,GAAG;EAC9B,uCAAuC;EACvC,qBAAqB;EACrB,UAAU;EACV,yBAAyB;EACzB,QAAQ,CACN,SAAS,QACV;EACD,MAAM,CACJ,SAAS,OACV;EACD,QAAQ;CACT;AACF,CACF;AAED,OAAO,QAAQ,sCAA2F;CACxG;EACE,MAAM;EACN,SAAS,EACP,UAAUA,wDAAwB;GAChC,eAAe;GACf,aAAa;GACb,iBAAiB;EAClB,EAAC,CACH;CACF;CACD,GAAG,OAAO,QAAQ,SAAS,IAAI,CAAC,WAAW;AACzC,SAAO;GACL,GAAG;GACH,SAAS,CAAE;EACZ;CACF,EAAC;CACF,GAAG,OAAO,QAAQ,uBAAuB,IAAI,CAAC,WAAW;AACvD,SAAO;GACL,GAAG;GACH,SAAS,CAAE;EACZ;CACF,EAAC;AACH;AAED,qBAAe"}
package/dist/plugin.js DELETED
@@ -1,427 +0,0 @@
1
- import { getJsdocProcessorPlugin } from "./getJsdocProcessorPlugin.js";
2
- import checkAccess_default from "./rules/checkAccess.js";
3
- import checkAlignment_default from "./rules/checkAlignment.js";
4
- import checkExamples_default from "./rules/checkExamples.js";
5
- import checkIndentation_default from "./rules/checkIndentation.js";
6
- import checkLineAlignment_default from "./rules/checkLineAlignment.js";
7
- import checkParamNames_default from "./rules/checkParamNames.js";
8
- import checkPropertyNames_default from "./rules/checkPropertyNames.js";
9
- import checkSyntax_default from "./rules/checkSyntax.js";
10
- import checkTagNames_default from "./rules/checkTagNames.js";
11
- import checkTemplateNames_default from "./rules/checkTemplateNames.js";
12
- import checkTypes_default from "./rules/checkTypes.js";
13
- import checkValues_default from "./rules/checkValues.js";
14
- import convertToJsdocComments_default from "./rules/convertToJsdocComments.js";
15
- import emptyTags_default from "./rules/emptyTags.js";
16
- import implementsOnClasses_default from "./rules/implementsOnClasses.js";
17
- import importsAsDependencies_default from "./rules/importsAsDependencies.js";
18
- import informativeDocs_default from "./rules/informativeDocs.js";
19
- import linesBeforeBlock_default from "./rules/linesBeforeBlock.js";
20
- import matchDescription_default from "./rules/matchDescription.js";
21
- import matchName_default from "./rules/matchName.js";
22
- import multilineBlocks_default from "./rules/multilineBlocks.js";
23
- import noBadBlocks_default from "./rules/noBadBlocks.js";
24
- import noBlankBlockDescriptions_default from "./rules/noBlankBlockDescriptions.js";
25
- import noBlankBlocks_default from "./rules/noBlankBlocks.js";
26
- import noDefaults_default from "./rules/noDefaults.js";
27
- import noMissingSyntax_default from "./rules/noMissingSyntax.js";
28
- import noMultiAsterisks_default from "./rules/noMultiAsterisks.js";
29
- import noRestrictedSyntax_default from "./rules/noRestrictedSyntax.js";
30
- import noTypes_default from "./rules/noTypes.js";
31
- import noUndefinedTypes_default from "./rules/noUndefinedTypes.js";
32
- import requireAsteriskPrefix_default from "./rules/requireAsteriskPrefix.js";
33
- import requireDescription_default from "./rules/requireDescription.js";
34
- import requireDescriptionCompleteSentence_default from "./rules/requireDescriptionCompleteSentence.js";
35
- import requireExample_default from "./rules/requireExample.js";
36
- import requireFileOverview_default from "./rules/requireFileOverview.js";
37
- import requireHyphenBeforeParamDescription_default from "./rules/requireHyphenBeforeParamDescription.js";
38
- import requireJsdoc_default from "./rules/requireJsdoc.js";
39
- import requireParam_default from "./rules/requireParam.js";
40
- import requireParamDescription_default from "./rules/requireParamDescription.js";
41
- import requireParamName_default from "./rules/requireParamName.js";
42
- import requireParamType_default from "./rules/requireParamType.js";
43
- import requireProperty_default from "./rules/requireProperty.js";
44
- import requirePropertyDescription_default from "./rules/requirePropertyDescription.js";
45
- import requirePropertyName_default from "./rules/requirePropertyName.js";
46
- import requirePropertyType_default from "./rules/requirePropertyType.js";
47
- import requireReturns_default from "./rules/requireReturns.js";
48
- import requireReturnsCheck_default from "./rules/requireReturnsCheck.js";
49
- import requireReturnsDescription_default from "./rules/requireReturnsDescription.js";
50
- import requireReturnsType_default from "./rules/requireReturnsType.js";
51
- import requireTemplate_default from "./rules/requireTemplate.js";
52
- import requireThrows_default from "./rules/requireThrows.js";
53
- import requireYields_default from "./rules/requireYields.js";
54
- import requireYieldsCheck_default from "./rules/requireYieldsCheck.js";
55
- import sortTags_default from "./rules/sortTags.js";
56
- import tagLines_default from "./rules/tagLines.js";
57
- import textEscaping_default from "./rules/textEscaping.js";
58
- import validTypes_default from "./rules/validTypes.js";
59
-
60
- //#region src/plugin.js
61
- /**
62
- * @typedef {"recommended" | "stylistic" | "contents" | "logical" | "requirements"} ConfigGroups
63
- * @typedef {"" | "-typescript" | "-typescript-flavor"} ConfigVariants
64
- * @typedef {"" | "-error"} ErrorLevelVariants
65
- */
66
- /**
67
- * @type {import('eslint').ESLint.Plugin & {
68
- * configs: Record<`flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}`,
69
- * import('eslint').Linter.Config>
70
- * }}
71
- */
72
- const plugin = {
73
- configs: {},
74
- rules: {
75
- "check-access": checkAccess_default,
76
- "check-alignment": checkAlignment_default,
77
- "check-examples": checkExamples_default,
78
- "check-indentation": checkIndentation_default,
79
- "check-line-alignment": checkLineAlignment_default,
80
- "check-param-names": checkParamNames_default,
81
- "check-property-names": checkPropertyNames_default,
82
- "check-syntax": checkSyntax_default,
83
- "check-tag-names": checkTagNames_default,
84
- "check-template-names": checkTemplateNames_default,
85
- "check-types": checkTypes_default,
86
- "check-values": checkValues_default,
87
- "convert-to-jsdoc-comments": convertToJsdocComments_default,
88
- "empty-tags": emptyTags_default,
89
- "implements-on-classes": implementsOnClasses_default,
90
- "imports-as-dependencies": importsAsDependencies_default,
91
- "informative-docs": informativeDocs_default,
92
- "lines-before-block": linesBeforeBlock_default,
93
- "match-description": matchDescription_default,
94
- "match-name": matchName_default,
95
- "multiline-blocks": multilineBlocks_default,
96
- "no-bad-blocks": noBadBlocks_default,
97
- "no-blank-block-descriptions": noBlankBlockDescriptions_default,
98
- "no-blank-blocks": noBlankBlocks_default,
99
- "no-defaults": noDefaults_default,
100
- "no-missing-syntax": noMissingSyntax_default,
101
- "no-multi-asterisks": noMultiAsterisks_default,
102
- "no-restricted-syntax": noRestrictedSyntax_default,
103
- "no-types": noTypes_default,
104
- "no-undefined-types": noUndefinedTypes_default,
105
- "require-asterisk-prefix": requireAsteriskPrefix_default,
106
- "require-description": requireDescription_default,
107
- "require-description-complete-sentence": requireDescriptionCompleteSentence_default,
108
- "require-example": requireExample_default,
109
- "require-file-overview": requireFileOverview_default,
110
- "require-hyphen-before-param-description": requireHyphenBeforeParamDescription_default,
111
- "require-jsdoc": requireJsdoc_default,
112
- "require-param": requireParam_default,
113
- "require-param-description": requireParamDescription_default,
114
- "require-param-name": requireParamName_default,
115
- "require-param-type": requireParamType_default,
116
- "require-property": requireProperty_default,
117
- "require-property-description": requirePropertyDescription_default,
118
- "require-property-name": requirePropertyName_default,
119
- "require-property-type": requirePropertyType_default,
120
- "require-returns": requireReturns_default,
121
- "require-returns-check": requireReturnsCheck_default,
122
- "require-returns-description": requireReturnsDescription_default,
123
- "require-returns-type": requireReturnsType_default,
124
- "require-template": requireTemplate_default,
125
- "require-throws": requireThrows_default,
126
- "require-yields": requireYields_default,
127
- "require-yields-check": requireYieldsCheck_default,
128
- "sort-tags": sortTags_default,
129
- "tag-lines": tagLines_default,
130
- "text-escaping": textEscaping_default,
131
- "valid-types": validTypes_default
132
- }
133
- };
134
- /**
135
- * @param {"warn"|"error"} warnOrError
136
- * @param {string} [flatName]
137
- * @returns {import('eslint').Linter.FlatConfig}
138
- */
139
- const createRecommendedRuleset = (warnOrError, flatName) => {
140
- return {
141
- ...flatName ? { name: "jsdoc/" + flatName } : {},
142
- plugins: flatName ? { jsdoc: plugin } : ["jsdoc"],
143
- rules: {
144
- "jsdoc/check-access": warnOrError,
145
- "jsdoc/check-alignment": warnOrError,
146
- "jsdoc/check-examples": "off",
147
- "jsdoc/check-indentation": "off",
148
- "jsdoc/check-line-alignment": "off",
149
- "jsdoc/check-param-names": warnOrError,
150
- "jsdoc/check-property-names": warnOrError,
151
- "jsdoc/check-syntax": "off",
152
- "jsdoc/check-tag-names": warnOrError,
153
- "jsdoc/check-template-names": "off",
154
- "jsdoc/check-types": warnOrError,
155
- "jsdoc/check-values": warnOrError,
156
- "jsdoc/convert-to-jsdoc-comments": "off",
157
- "jsdoc/empty-tags": warnOrError,
158
- "jsdoc/implements-on-classes": warnOrError,
159
- "jsdoc/imports-as-dependencies": "off",
160
- "jsdoc/informative-docs": "off",
161
- "jsdoc/lines-before-block": "off",
162
- "jsdoc/match-description": "off",
163
- "jsdoc/match-name": "off",
164
- "jsdoc/multiline-blocks": warnOrError,
165
- "jsdoc/no-bad-blocks": "off",
166
- "jsdoc/no-blank-block-descriptions": "off",
167
- "jsdoc/no-blank-blocks": "off",
168
- "jsdoc/no-defaults": warnOrError,
169
- "jsdoc/no-missing-syntax": "off",
170
- "jsdoc/no-multi-asterisks": warnOrError,
171
- "jsdoc/no-restricted-syntax": "off",
172
- "jsdoc/no-types": "off",
173
- "jsdoc/no-undefined-types": warnOrError,
174
- "jsdoc/require-asterisk-prefix": "off",
175
- "jsdoc/require-description": "off",
176
- "jsdoc/require-description-complete-sentence": "off",
177
- "jsdoc/require-example": "off",
178
- "jsdoc/require-file-overview": "off",
179
- "jsdoc/require-hyphen-before-param-description": "off",
180
- "jsdoc/require-jsdoc": warnOrError,
181
- "jsdoc/require-param": warnOrError,
182
- "jsdoc/require-param-description": warnOrError,
183
- "jsdoc/require-param-name": warnOrError,
184
- "jsdoc/require-param-type": warnOrError,
185
- "jsdoc/require-property": warnOrError,
186
- "jsdoc/require-property-description": warnOrError,
187
- "jsdoc/require-property-name": warnOrError,
188
- "jsdoc/require-property-type": warnOrError,
189
- "jsdoc/require-returns": warnOrError,
190
- "jsdoc/require-returns-check": warnOrError,
191
- "jsdoc/require-returns-description": warnOrError,
192
- "jsdoc/require-returns-type": warnOrError,
193
- "jsdoc/require-template": "off",
194
- "jsdoc/require-throws": "off",
195
- "jsdoc/require-yields": warnOrError,
196
- "jsdoc/require-yields-check": warnOrError,
197
- "jsdoc/sort-tags": "off",
198
- "jsdoc/tag-lines": warnOrError,
199
- "jsdoc/text-escaping": "off",
200
- "jsdoc/valid-types": warnOrError
201
- }
202
- };
203
- };
204
- /**
205
- * @param {"warn"|"error"} warnOrError
206
- * @param {string} [flatName]
207
- * @returns {import('eslint').Linter.FlatConfig}
208
- */
209
- const createRecommendedTypeScriptRuleset = (warnOrError, flatName) => {
210
- const ruleset = createRecommendedRuleset(warnOrError, flatName);
211
- return {
212
- ...ruleset,
213
- rules: {
214
- ...ruleset.rules,
215
- "jsdoc/check-tag-names": [warnOrError, { typed: true }],
216
- "jsdoc/no-types": warnOrError,
217
- "jsdoc/no-undefined-types": "off",
218
- "jsdoc/require-param-type": "off",
219
- "jsdoc/require-property-type": "off",
220
- "jsdoc/require-returns-type": "off"
221
- }
222
- };
223
- };
224
- /**
225
- * @param {"warn"|"error"} warnOrError
226
- * @param {string} [flatName]
227
- * @returns {import('eslint').Linter.FlatConfig}
228
- */
229
- const createRecommendedTypeScriptFlavorRuleset = (warnOrError, flatName) => {
230
- const ruleset = createRecommendedRuleset(warnOrError, flatName);
231
- return {
232
- ...ruleset,
233
- rules: {
234
- ...ruleset.rules,
235
- "jsdoc/no-undefined-types": "off"
236
- }
237
- };
238
- };
239
- /**
240
- * @param {(string | unknown[])[]} ruleNames
241
- */
242
- const createStandaloneRulesetFactory = (ruleNames) => {
243
- /**
244
- * @param {"warn"|"error"} warnOrError
245
- * @param {string} [flatName]
246
- * @returns {import('eslint').Linter.FlatConfig}
247
- */
248
- return (warnOrError, flatName) => {
249
- return {
250
- name: "jsdoc/" + flatName,
251
- plugins: { jsdoc: plugin },
252
- rules: Object.fromEntries(ruleNames.map((ruleName) => {
253
- return typeof ruleName === "string" ? [ruleName, warnOrError] : [ruleName[0], [warnOrError, ...ruleName.slice(1)]];
254
- }))
255
- };
256
- };
257
- };
258
- const contentsRules = [
259
- "jsdoc/informative-docs",
260
- "jsdoc/match-description",
261
- "jsdoc/no-blank-block-descriptions",
262
- "jsdoc/no-blank-blocks",
263
- ["jsdoc/text-escaping", { escapeHTML: true }]
264
- ];
265
- const createContentsTypescriptRuleset = createStandaloneRulesetFactory(contentsRules);
266
- const createContentsTypescriptFlavorRuleset = createStandaloneRulesetFactory(contentsRules);
267
- const logicalRules = [
268
- "jsdoc/check-access",
269
- "jsdoc/check-param-names",
270
- "jsdoc/check-property-names",
271
- "jsdoc/check-syntax",
272
- "jsdoc/check-tag-names",
273
- "jsdoc/check-template-names",
274
- "jsdoc/check-types",
275
- "jsdoc/check-values",
276
- "jsdoc/empty-tags",
277
- "jsdoc/implements-on-classes",
278
- "jsdoc/require-returns-check",
279
- "jsdoc/require-yields-check",
280
- "jsdoc/no-bad-blocks",
281
- "jsdoc/no-defaults",
282
- "jsdoc/no-types",
283
- "jsdoc/no-undefined-types",
284
- "jsdoc/valid-types"
285
- ];
286
- const createLogicalTypescriptRuleset = createStandaloneRulesetFactory(logicalRules);
287
- const createLogicalTypescriptFlavorRuleset = createStandaloneRulesetFactory(logicalRules);
288
- const requirementsRules = [
289
- "jsdoc/require-example",
290
- "jsdoc/require-jsdoc",
291
- "jsdoc/require-param",
292
- "jsdoc/require-param-description",
293
- "jsdoc/require-param-name",
294
- "jsdoc/require-property",
295
- "jsdoc/require-property-description",
296
- "jsdoc/require-property-name",
297
- "jsdoc/require-returns",
298
- "jsdoc/require-returns-description",
299
- "jsdoc/require-yields"
300
- ];
301
- const createRequirementsTypeScriptRuleset = createStandaloneRulesetFactory(requirementsRules);
302
- const createRequirementsTypeScriptFlavorRuleset = createStandaloneRulesetFactory([
303
- ...requirementsRules,
304
- "jsdoc/require-param-type",
305
- "jsdoc/require-property-type",
306
- "jsdoc/require-returns-type",
307
- "jsdoc/require-template"
308
- ]);
309
- const stylisticRules = [
310
- "jsdoc/check-alignment",
311
- "jsdoc/check-line-alignment",
312
- "jsdoc/lines-before-block",
313
- "jsdoc/multiline-blocks",
314
- "jsdoc/no-multi-asterisks",
315
- "jsdoc/require-asterisk-prefix",
316
- ["jsdoc/require-hyphen-before-param-description", "never"],
317
- "jsdoc/tag-lines"
318
- ];
319
- const createStylisticTypeScriptRuleset = createStandaloneRulesetFactory(stylisticRules);
320
- const createStylisticTypeScriptFlavorRuleset = createStandaloneRulesetFactory(stylisticRules);
321
- /* c8 ignore next 3 -- TS */
322
- if (!plugin.configs) throw new Error("TypeScript guard");
323
- plugin.configs.recommended = createRecommendedRuleset("warn");
324
- plugin.configs["recommended-error"] = createRecommendedRuleset("error");
325
- plugin.configs["recommended-typescript"] = createRecommendedTypeScriptRuleset("warn");
326
- plugin.configs["recommended-typescript-error"] = createRecommendedTypeScriptRuleset("error");
327
- plugin.configs["recommended-typescript-flavor"] = createRecommendedTypeScriptFlavorRuleset("warn");
328
- plugin.configs["recommended-typescript-flavor-error"] = createRecommendedTypeScriptFlavorRuleset("error");
329
- plugin.configs["flat/recommended"] = createRecommendedRuleset("warn", "flat/recommended");
330
- plugin.configs["flat/recommended-error"] = createRecommendedRuleset("error", "flat/recommended-error");
331
- plugin.configs["flat/recommended-typescript"] = createRecommendedTypeScriptRuleset("warn", "flat/recommended-typescript");
332
- plugin.configs["flat/recommended-typescript-error"] = createRecommendedTypeScriptRuleset("error", "flat/recommended-typescript-error");
333
- plugin.configs["flat/recommended-typescript-flavor"] = createRecommendedTypeScriptFlavorRuleset("warn", "flat/recommended-typescript-flavor");
334
- plugin.configs["flat/recommended-typescript-flavor-error"] = createRecommendedTypeScriptFlavorRuleset("error", "flat/recommended-typescript-flavor-error");
335
- plugin.configs["flat/contents-typescript"] = createContentsTypescriptRuleset("warn", "flat/contents-typescript");
336
- plugin.configs["flat/contents-typescript-error"] = createContentsTypescriptRuleset("error", "flat/contents-typescript-error");
337
- plugin.configs["flat/contents-typescript-flavor"] = createContentsTypescriptFlavorRuleset("warn", "flat/contents-typescript-flavor");
338
- plugin.configs["flat/contents-typescript-flavor-error"] = createContentsTypescriptFlavorRuleset("error", "flat/contents-typescript-error-flavor");
339
- plugin.configs["flat/logical-typescript"] = createLogicalTypescriptRuleset("warn", "flat/logical-typescript");
340
- plugin.configs["flat/logical-typescript-error"] = createLogicalTypescriptRuleset("error", "flat/logical-typescript-error");
341
- plugin.configs["flat/logical-typescript-flavor"] = createLogicalTypescriptFlavorRuleset("warn", "flat/logical-typescript-flavor");
342
- plugin.configs["flat/logical-typescript-flavor-error"] = createLogicalTypescriptFlavorRuleset("error", "flat/logical-typescript-error-flavor");
343
- plugin.configs["flat/requirements-typescript"] = createRequirementsTypeScriptRuleset("warn", "flat/requirements-typescript");
344
- plugin.configs["flat/requirements-typescript-error"] = createRequirementsTypeScriptRuleset("error", "flat/requirements-typescript-error");
345
- plugin.configs["flat/requirements-typescript-flavor"] = createRequirementsTypeScriptFlavorRuleset("warn", "flat/requirements-typescript-flavor");
346
- plugin.configs["flat/requirements-typescript-flavor-error"] = createRequirementsTypeScriptFlavorRuleset("error", "flat/requirements-typescript-error-flavor");
347
- plugin.configs["flat/stylistic-typescript"] = createStylisticTypeScriptRuleset("warn", "flat/stylistic-typescript");
348
- plugin.configs["flat/stylistic-typescript-error"] = createStylisticTypeScriptRuleset("error", "flat/stylistic-typescript-error");
349
- plugin.configs["flat/stylistic-typescript-flavor"] = createStylisticTypeScriptFlavorRuleset("warn", "flat/stylistic-typescript-flavor");
350
- plugin.configs["flat/stylistic-typescript-flavor-error"] = createStylisticTypeScriptFlavorRuleset("error", "flat/stylistic-typescript-error-flavor");
351
- plugin.configs.examples = [{
352
- files: ["**/*.js"],
353
- name: "jsdoc/examples/processor",
354
- plugins: { examples: getJsdocProcessorPlugin() },
355
- processor: "examples/examples"
356
- }, {
357
- files: ["**/*.md/*.js"],
358
- name: "jsdoc/examples/rules",
359
- rules: {
360
- "eol-last": 0,
361
- "import/no-unresolved": 0,
362
- "import/unambiguous": 0,
363
- "jsdoc/require-file-overview": 0,
364
- "jsdoc/require-jsdoc": 0,
365
- "no-console": 0,
366
- "no-multiple-empty-lines": 0,
367
- "no-undef": 0,
368
- "no-unused-vars": 0,
369
- "node/no-missing-import": 0,
370
- "node/no-missing-require": 0,
371
- "padded-blocks": 0
372
- }
373
- }];
374
- plugin.configs["default-expressions"] = [{
375
- files: ["**/*.js"],
376
- name: "jsdoc/default-expressions/processor",
377
- plugins: { examples: getJsdocProcessorPlugin({
378
- checkDefaults: true,
379
- checkParams: true,
380
- checkProperties: true
381
- }) },
382
- processor: "examples/examples"
383
- }, {
384
- files: [
385
- "**/*.jsdoc-defaults",
386
- "**/*.jsdoc-params",
387
- "**/*.jsdoc-properties"
388
- ],
389
- name: "jsdoc/default-expressions/rules",
390
- rules: {
391
- ...plugin.configs.examples[1].rules,
392
- "chai-friendly/no-unused-expressions": 0,
393
- "no-empty-function": 0,
394
- "no-new": 0,
395
- "no-unused-expressions": 0,
396
- quotes: ["error", "double"],
397
- semi: ["error", "never"],
398
- strict: 0
399
- }
400
- }];
401
- plugin.configs["examples-and-default-expressions"] = [
402
- {
403
- name: "jsdoc/examples-and-default-expressions",
404
- plugins: { examples: getJsdocProcessorPlugin({
405
- checkDefaults: true,
406
- checkParams: true,
407
- checkProperties: true
408
- }) }
409
- },
410
- ...plugin.configs.examples.map((config) => {
411
- return {
412
- ...config,
413
- plugins: {}
414
- };
415
- }),
416
- ...plugin.configs["default-expressions"].map((config) => {
417
- return {
418
- ...config,
419
- plugins: {}
420
- };
421
- })
422
- ];
423
- var plugin_default = plugin;
424
-
425
- //#endregion
426
- export { plugin_default as default };
427
- //# sourceMappingURL=plugin.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"plugin.js","names":["checkAccess","checkAlignment","checkExamples","checkIndentation","checkLineAlignment","checkParamNames","checkPropertyNames","checkSyntax","checkTagNames","checkTemplateNames","checkTypes","checkValues","convertToJsdocComments","emptyTags","implementsOnClasses","importsAsDependencies","informativeDocs","linesBeforeBlock","matchDescription","matchName","multilineBlocks","noBadBlocks","noBlankBlockDescriptions","noBlankBlocks","noDefaults","noMissingSyntax","noMultiAsterisks","noRestrictedSyntax","noTypes","noUndefinedTypes","requireAsteriskPrefix","requireDescription","requireDescriptionCompleteSentence","requireExample","requireFileOverview","requireHyphenBeforeParamDescription","requireJsdoc","requireParam","requireParamDescription","requireParamName","requireParamType","requireProperty","requirePropertyDescription","requirePropertyName","requirePropertyType","requireReturns","requireReturnsCheck","requireReturnsDescription","requireReturnsType","requireTemplate","requireThrows","requireYields","requireYieldsCheck","sortTags","tagLines","textEscaping","validTypes"],"sources":["../src/plugin.js"],"sourcesContent":["import {\n getJsdocProcessorPlugin,\n} from './getJsdocProcessorPlugin.js';\nimport checkAccess from './rules/checkAccess.js';\nimport checkAlignment from './rules/checkAlignment.js';\nimport checkExamples from './rules/checkExamples.js';\nimport checkIndentation from './rules/checkIndentation.js';\nimport checkLineAlignment from './rules/checkLineAlignment.js';\nimport checkParamNames from './rules/checkParamNames.js';\nimport checkPropertyNames from './rules/checkPropertyNames.js';\nimport checkSyntax from './rules/checkSyntax.js';\nimport checkTagNames from './rules/checkTagNames.js';\nimport checkTemplateNames from './rules/checkTemplateNames.js';\nimport checkTypes from './rules/checkTypes.js';\nimport checkValues from './rules/checkValues.js';\nimport convertToJsdocComments from './rules/convertToJsdocComments.js';\nimport emptyTags from './rules/emptyTags.js';\nimport implementsOnClasses from './rules/implementsOnClasses.js';\nimport importsAsDependencies from './rules/importsAsDependencies.js';\nimport informativeDocs from './rules/informativeDocs.js';\nimport linesBeforeBlock from './rules/linesBeforeBlock.js';\nimport matchDescription from './rules/matchDescription.js';\nimport matchName from './rules/matchName.js';\nimport multilineBlocks from './rules/multilineBlocks.js';\nimport noBadBlocks from './rules/noBadBlocks.js';\nimport noBlankBlockDescriptions from './rules/noBlankBlockDescriptions.js';\nimport noBlankBlocks from './rules/noBlankBlocks.js';\nimport noDefaults from './rules/noDefaults.js';\nimport noMissingSyntax from './rules/noMissingSyntax.js';\nimport noMultiAsterisks from './rules/noMultiAsterisks.js';\nimport noRestrictedSyntax from './rules/noRestrictedSyntax.js';\nimport noTypes from './rules/noTypes.js';\nimport noUndefinedTypes from './rules/noUndefinedTypes.js';\nimport requireAsteriskPrefix from './rules/requireAsteriskPrefix.js';\nimport requireDescription from './rules/requireDescription.js';\nimport requireDescriptionCompleteSentence from './rules/requireDescriptionCompleteSentence.js';\nimport requireExample from './rules/requireExample.js';\nimport requireFileOverview from './rules/requireFileOverview.js';\nimport requireHyphenBeforeParamDescription from './rules/requireHyphenBeforeParamDescription.js';\nimport requireJsdoc from './rules/requireJsdoc.js';\nimport requireParam from './rules/requireParam.js';\nimport requireParamDescription from './rules/requireParamDescription.js';\nimport requireParamName from './rules/requireParamName.js';\nimport requireParamType from './rules/requireParamType.js';\nimport requireProperty from './rules/requireProperty.js';\nimport requirePropertyDescription from './rules/requirePropertyDescription.js';\nimport requirePropertyName from './rules/requirePropertyName.js';\nimport requirePropertyType from './rules/requirePropertyType.js';\nimport requireReturns from './rules/requireReturns.js';\nimport requireReturnsCheck from './rules/requireReturnsCheck.js';\nimport requireReturnsDescription from './rules/requireReturnsDescription.js';\nimport requireReturnsType from './rules/requireReturnsType.js';\nimport requireTemplate from './rules/requireTemplate.js';\nimport requireThrows from './rules/requireThrows.js';\nimport requireYields from './rules/requireYields.js';\nimport requireYieldsCheck from './rules/requireYieldsCheck.js';\nimport sortTags from './rules/sortTags.js';\nimport tagLines from './rules/tagLines.js';\nimport textEscaping from './rules/textEscaping.js';\nimport validTypes from './rules/validTypes.js';\n\n/**\n * @typedef {\"recommended\" | \"stylistic\" | \"contents\" | \"logical\" | \"requirements\"} ConfigGroups\n * @typedef {\"\" | \"-typescript\" | \"-typescript-flavor\"} ConfigVariants\n * @typedef {\"\" | \"-error\"} ErrorLevelVariants\n */\n\n/* eslint-disable jsdoc/valid-types -- Bug */\n/**\n * @type {import('eslint').ESLint.Plugin & {\n * configs: Record<`flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}`,\n * import('eslint').Linter.Config>\n * }}\n */\n/* eslint-enable jsdoc/valid-types -- Bug */\nconst plugin = {\n // @ts-expect-error Ok\n configs: {},\n rules: {\n 'check-access': checkAccess,\n 'check-alignment': checkAlignment,\n 'check-examples': checkExamples,\n 'check-indentation': checkIndentation,\n 'check-line-alignment': checkLineAlignment,\n 'check-param-names': checkParamNames,\n 'check-property-names': checkPropertyNames,\n 'check-syntax': checkSyntax,\n 'check-tag-names': checkTagNames,\n 'check-template-names': checkTemplateNames,\n 'check-types': checkTypes,\n 'check-values': checkValues,\n 'convert-to-jsdoc-comments': convertToJsdocComments,\n 'empty-tags': emptyTags,\n 'implements-on-classes': implementsOnClasses,\n 'imports-as-dependencies': importsAsDependencies,\n 'informative-docs': informativeDocs,\n 'lines-before-block': linesBeforeBlock,\n 'match-description': matchDescription,\n 'match-name': matchName,\n 'multiline-blocks': multilineBlocks,\n 'no-bad-blocks': noBadBlocks,\n 'no-blank-block-descriptions': noBlankBlockDescriptions,\n 'no-blank-blocks': noBlankBlocks,\n 'no-defaults': noDefaults,\n 'no-missing-syntax': noMissingSyntax,\n 'no-multi-asterisks': noMultiAsterisks,\n 'no-restricted-syntax': noRestrictedSyntax,\n 'no-types': noTypes,\n 'no-undefined-types': noUndefinedTypes,\n 'require-asterisk-prefix': requireAsteriskPrefix,\n 'require-description': requireDescription,\n 'require-description-complete-sentence': requireDescriptionCompleteSentence,\n 'require-example': requireExample,\n 'require-file-overview': requireFileOverview,\n 'require-hyphen-before-param-description': requireHyphenBeforeParamDescription,\n 'require-jsdoc': requireJsdoc,\n 'require-param': requireParam,\n 'require-param-description': requireParamDescription,\n 'require-param-name': requireParamName,\n 'require-param-type': requireParamType,\n 'require-property': requireProperty,\n 'require-property-description': requirePropertyDescription,\n 'require-property-name': requirePropertyName,\n 'require-property-type': requirePropertyType,\n 'require-returns': requireReturns,\n 'require-returns-check': requireReturnsCheck,\n 'require-returns-description': requireReturnsDescription,\n 'require-returns-type': requireReturnsType,\n 'require-template': requireTemplate,\n 'require-throws': requireThrows,\n 'require-yields': requireYields,\n 'require-yields-check': requireYieldsCheck,\n 'sort-tags': sortTags,\n 'tag-lines': tagLines,\n 'text-escaping': textEscaping,\n 'valid-types': validTypes,\n },\n};\n\n/**\n * @param {\"warn\"|\"error\"} warnOrError\n * @param {string} [flatName]\n * @returns {import('eslint').Linter.FlatConfig}\n */\nconst createRecommendedRuleset = (warnOrError, flatName) => {\n return {\n ...(flatName ? {\n name: 'jsdoc/' + flatName,\n } : {}),\n // @ts-expect-error Ok\n plugins:\n flatName ? {\n jsdoc: plugin,\n } : [\n 'jsdoc',\n ],\n rules: {\n 'jsdoc/check-access': warnOrError,\n 'jsdoc/check-alignment': warnOrError,\n 'jsdoc/check-examples': 'off',\n 'jsdoc/check-indentation': 'off',\n 'jsdoc/check-line-alignment': 'off',\n 'jsdoc/check-param-names': warnOrError,\n 'jsdoc/check-property-names': warnOrError,\n 'jsdoc/check-syntax': 'off',\n 'jsdoc/check-tag-names': warnOrError,\n 'jsdoc/check-template-names': 'off',\n 'jsdoc/check-types': warnOrError,\n 'jsdoc/check-values': warnOrError,\n 'jsdoc/convert-to-jsdoc-comments': 'off',\n 'jsdoc/empty-tags': warnOrError,\n 'jsdoc/implements-on-classes': warnOrError,\n 'jsdoc/imports-as-dependencies': 'off',\n 'jsdoc/informative-docs': 'off',\n 'jsdoc/lines-before-block': 'off',\n 'jsdoc/match-description': 'off',\n 'jsdoc/match-name': 'off',\n 'jsdoc/multiline-blocks': warnOrError,\n 'jsdoc/no-bad-blocks': 'off',\n 'jsdoc/no-blank-block-descriptions': 'off',\n 'jsdoc/no-blank-blocks': 'off',\n 'jsdoc/no-defaults': warnOrError,\n 'jsdoc/no-missing-syntax': 'off',\n 'jsdoc/no-multi-asterisks': warnOrError,\n 'jsdoc/no-restricted-syntax': 'off',\n 'jsdoc/no-types': 'off',\n 'jsdoc/no-undefined-types': warnOrError,\n 'jsdoc/require-asterisk-prefix': 'off',\n 'jsdoc/require-description': 'off',\n 'jsdoc/require-description-complete-sentence': 'off',\n 'jsdoc/require-example': 'off',\n 'jsdoc/require-file-overview': 'off',\n 'jsdoc/require-hyphen-before-param-description': 'off',\n 'jsdoc/require-jsdoc': warnOrError,\n 'jsdoc/require-param': warnOrError,\n 'jsdoc/require-param-description': warnOrError,\n 'jsdoc/require-param-name': warnOrError,\n 'jsdoc/require-param-type': warnOrError,\n 'jsdoc/require-property': warnOrError,\n 'jsdoc/require-property-description': warnOrError,\n 'jsdoc/require-property-name': warnOrError,\n 'jsdoc/require-property-type': warnOrError,\n 'jsdoc/require-returns': warnOrError,\n 'jsdoc/require-returns-check': warnOrError,\n 'jsdoc/require-returns-description': warnOrError,\n 'jsdoc/require-returns-type': warnOrError,\n 'jsdoc/require-template': 'off',\n 'jsdoc/require-throws': 'off',\n 'jsdoc/require-yields': warnOrError,\n 'jsdoc/require-yields-check': warnOrError,\n 'jsdoc/sort-tags': 'off',\n 'jsdoc/tag-lines': warnOrError,\n 'jsdoc/text-escaping': 'off',\n 'jsdoc/valid-types': warnOrError,\n },\n };\n};\n\n/**\n * @param {\"warn\"|\"error\"} warnOrError\n * @param {string} [flatName]\n * @returns {import('eslint').Linter.FlatConfig}\n */\nconst createRecommendedTypeScriptRuleset = (warnOrError, flatName) => {\n const ruleset = createRecommendedRuleset(warnOrError, flatName);\n\n return {\n ...ruleset,\n rules: {\n ...ruleset.rules,\n /* eslint-disable @stylistic/indent -- Extra indent to avoid use by auto-rule-editing */\n 'jsdoc/check-tag-names': [\n warnOrError, {\n typed: true,\n },\n ],\n 'jsdoc/no-types': warnOrError,\n 'jsdoc/no-undefined-types': 'off',\n 'jsdoc/require-param-type': 'off',\n 'jsdoc/require-property-type': 'off',\n 'jsdoc/require-returns-type': 'off',\n /* eslint-enable @stylistic/indent */\n },\n };\n};\n\n/**\n * @param {\"warn\"|\"error\"} warnOrError\n * @param {string} [flatName]\n * @returns {import('eslint').Linter.FlatConfig}\n */\nconst createRecommendedTypeScriptFlavorRuleset = (warnOrError, flatName) => {\n const ruleset = createRecommendedRuleset(warnOrError, flatName);\n\n return {\n ...ruleset,\n rules: {\n ...ruleset.rules,\n /* eslint-disable @stylistic/indent -- Extra indent to avoid use by auto-rule-editing */\n 'jsdoc/no-undefined-types': 'off',\n /* eslint-enable @stylistic/indent */\n },\n };\n};\n\n/**\n * @param {(string | unknown[])[]} ruleNames\n */\nconst createStandaloneRulesetFactory = (ruleNames) => {\n /**\n * @param {\"warn\"|\"error\"} warnOrError\n * @param {string} [flatName]\n * @returns {import('eslint').Linter.FlatConfig}\n */\n return (warnOrError, flatName) => {\n return {\n name: 'jsdoc/' + flatName,\n plugins: {\n jsdoc: plugin,\n },\n rules: Object.fromEntries(\n ruleNames.map(\n (ruleName) => {\n return (typeof ruleName === 'string' ?\n [\n ruleName, warnOrError,\n ] :\n [\n ruleName[0], [\n warnOrError, ...ruleName.slice(1),\n ],\n ]);\n },\n ),\n ),\n };\n };\n};\n\nconst contentsRules = [\n 'jsdoc/informative-docs',\n 'jsdoc/match-description',\n 'jsdoc/no-blank-block-descriptions',\n 'jsdoc/no-blank-blocks',\n [\n 'jsdoc/text-escaping', {\n escapeHTML: true,\n },\n ],\n];\n\nconst createContentsTypescriptRuleset = createStandaloneRulesetFactory(contentsRules);\n\nconst createContentsTypescriptFlavorRuleset = createStandaloneRulesetFactory(contentsRules);\n\nconst logicalRules = [\n 'jsdoc/check-access',\n 'jsdoc/check-param-names',\n 'jsdoc/check-property-names',\n 'jsdoc/check-syntax',\n 'jsdoc/check-tag-names',\n 'jsdoc/check-template-names',\n 'jsdoc/check-types',\n 'jsdoc/check-values',\n 'jsdoc/empty-tags',\n 'jsdoc/implements-on-classes',\n 'jsdoc/require-returns-check',\n 'jsdoc/require-yields-check',\n 'jsdoc/no-bad-blocks',\n 'jsdoc/no-defaults',\n 'jsdoc/no-types',\n 'jsdoc/no-undefined-types',\n 'jsdoc/valid-types',\n];\n\nconst createLogicalTypescriptRuleset = createStandaloneRulesetFactory(logicalRules);\n\nconst createLogicalTypescriptFlavorRuleset = createStandaloneRulesetFactory(logicalRules);\n\nconst requirementsRules = [\n 'jsdoc/require-example',\n 'jsdoc/require-jsdoc',\n 'jsdoc/require-param',\n 'jsdoc/require-param-description',\n 'jsdoc/require-param-name',\n 'jsdoc/require-property',\n 'jsdoc/require-property-description',\n 'jsdoc/require-property-name',\n 'jsdoc/require-returns',\n 'jsdoc/require-returns-description',\n 'jsdoc/require-yields',\n];\n\nconst createRequirementsTypeScriptRuleset = createStandaloneRulesetFactory(requirementsRules);\n\nconst createRequirementsTypeScriptFlavorRuleset = createStandaloneRulesetFactory([\n ...requirementsRules,\n 'jsdoc/require-param-type',\n 'jsdoc/require-property-type',\n 'jsdoc/require-returns-type',\n 'jsdoc/require-template',\n]);\n\nconst stylisticRules = [\n 'jsdoc/check-alignment',\n 'jsdoc/check-line-alignment',\n 'jsdoc/lines-before-block',\n 'jsdoc/multiline-blocks',\n 'jsdoc/no-multi-asterisks',\n 'jsdoc/require-asterisk-prefix',\n [\n 'jsdoc/require-hyphen-before-param-description', 'never',\n ],\n 'jsdoc/tag-lines',\n];\n\nconst createStylisticTypeScriptRuleset = createStandaloneRulesetFactory(stylisticRules);\n\nconst createStylisticTypeScriptFlavorRuleset = createStandaloneRulesetFactory(stylisticRules);\n\n/* c8 ignore next 3 -- TS */\nif (!plugin.configs) {\n throw new Error('TypeScript guard');\n}\n\nplugin.configs.recommended = createRecommendedRuleset('warn');\nplugin.configs['recommended-error'] = createRecommendedRuleset('error');\nplugin.configs['recommended-typescript'] = createRecommendedTypeScriptRuleset('warn');\nplugin.configs['recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error');\nplugin.configs['recommended-typescript-flavor'] = createRecommendedTypeScriptFlavorRuleset('warn');\nplugin.configs['recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error');\n\nplugin.configs['flat/recommended'] = createRecommendedRuleset('warn', 'flat/recommended');\nplugin.configs['flat/recommended-error'] = createRecommendedRuleset('error', 'flat/recommended-error');\nplugin.configs['flat/recommended-typescript'] = createRecommendedTypeScriptRuleset('warn', 'flat/recommended-typescript');\nplugin.configs['flat/recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error', 'flat/recommended-typescript-error');\nplugin.configs['flat/recommended-typescript-flavor'] = createRecommendedTypeScriptFlavorRuleset('warn', 'flat/recommended-typescript-flavor');\nplugin.configs['flat/recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error', 'flat/recommended-typescript-flavor-error');\n\nplugin.configs['flat/contents-typescript'] = createContentsTypescriptRuleset('warn', 'flat/contents-typescript');\nplugin.configs['flat/contents-typescript-error'] = createContentsTypescriptRuleset('error', 'flat/contents-typescript-error');\nplugin.configs['flat/contents-typescript-flavor'] = createContentsTypescriptFlavorRuleset('warn', 'flat/contents-typescript-flavor');\nplugin.configs['flat/contents-typescript-flavor-error'] = createContentsTypescriptFlavorRuleset('error', 'flat/contents-typescript-error-flavor');\nplugin.configs['flat/logical-typescript'] = createLogicalTypescriptRuleset('warn', 'flat/logical-typescript');\nplugin.configs['flat/logical-typescript-error'] = createLogicalTypescriptRuleset('error', 'flat/logical-typescript-error');\nplugin.configs['flat/logical-typescript-flavor'] = createLogicalTypescriptFlavorRuleset('warn', 'flat/logical-typescript-flavor');\nplugin.configs['flat/logical-typescript-flavor-error'] = createLogicalTypescriptFlavorRuleset('error', 'flat/logical-typescript-error-flavor');\nplugin.configs['flat/requirements-typescript'] = createRequirementsTypeScriptRuleset('warn', 'flat/requirements-typescript');\nplugin.configs['flat/requirements-typescript-error'] = createRequirementsTypeScriptRuleset('error', 'flat/requirements-typescript-error');\nplugin.configs['flat/requirements-typescript-flavor'] = createRequirementsTypeScriptFlavorRuleset('warn', 'flat/requirements-typescript-flavor');\nplugin.configs['flat/requirements-typescript-flavor-error'] = createRequirementsTypeScriptFlavorRuleset('error', 'flat/requirements-typescript-error-flavor');\nplugin.configs['flat/stylistic-typescript'] = createStylisticTypeScriptRuleset('warn', 'flat/stylistic-typescript');\nplugin.configs['flat/stylistic-typescript-error'] = createStylisticTypeScriptRuleset('error', 'flat/stylistic-typescript-error');\nplugin.configs['flat/stylistic-typescript-flavor'] = createStylisticTypeScriptFlavorRuleset('warn', 'flat/stylistic-typescript-flavor');\nplugin.configs['flat/stylistic-typescript-flavor-error'] = createStylisticTypeScriptFlavorRuleset('error', 'flat/stylistic-typescript-error-flavor');\n\nplugin.configs.examples = /** @type {import('eslint').Linter.FlatConfig[]} */ ([\n {\n files: [\n '**/*.js',\n ],\n name: 'jsdoc/examples/processor',\n plugins: {\n examples: getJsdocProcessorPlugin(),\n },\n processor: 'examples/examples',\n },\n {\n files: [\n '**/*.md/*.js',\n ],\n name: 'jsdoc/examples/rules',\n rules: {\n // \"always\" newline rule at end unlikely in sample code\n 'eol-last': 0,\n\n // Wouldn't generally expect example paths to resolve relative to JS file\n 'import/no-unresolved': 0,\n\n // Snippets likely too short to always include import/export info\n 'import/unambiguous': 0,\n\n 'jsdoc/require-file-overview': 0,\n\n // The end of a multiline comment would end the comment the example is in.\n 'jsdoc/require-jsdoc': 0,\n\n // Unlikely to have inadvertent debugging within examples\n 'no-console': 0,\n\n // Often wish to start `@example` code after newline; also may use\n // empty lines for spacing\n 'no-multiple-empty-lines': 0,\n\n // Many variables in examples will be `undefined`\n 'no-undef': 0,\n\n // Common to define variables for clarity without always using them\n 'no-unused-vars': 0,\n\n // See import/no-unresolved\n 'node/no-missing-import': 0,\n 'node/no-missing-require': 0,\n\n // Can generally look nicer to pad a little even if code imposes more stringency\n 'padded-blocks': 0,\n },\n },\n]);\n\nplugin.configs['default-expressions'] = /** @type {import('eslint').Linter.FlatConfig[]} */ ([\n {\n files: [\n '**/*.js',\n ],\n name: 'jsdoc/default-expressions/processor',\n plugins: {\n examples: getJsdocProcessorPlugin({\n checkDefaults: true,\n checkParams: true,\n checkProperties: true,\n }),\n },\n processor: 'examples/examples',\n },\n {\n files: [\n '**/*.jsdoc-defaults', '**/*.jsdoc-params', '**/*.jsdoc-properties',\n ],\n name: 'jsdoc/default-expressions/rules',\n rules: {\n ...plugin.configs.examples[1].rules,\n 'chai-friendly/no-unused-expressions': 0,\n 'no-empty-function': 0,\n 'no-new': 0,\n 'no-unused-expressions': 0,\n quotes: [\n 'error', 'double',\n ],\n semi: [\n 'error', 'never',\n ],\n strict: 0,\n },\n },\n]);\n\nplugin.configs['examples-and-default-expressions'] = /** @type {import('eslint').Linter.FlatConfig[]} */ ([\n {\n name: 'jsdoc/examples-and-default-expressions',\n plugins: {\n examples: getJsdocProcessorPlugin({\n checkDefaults: true,\n checkParams: true,\n checkProperties: true,\n }),\n },\n },\n ...plugin.configs.examples.map((config) => {\n return {\n ...config,\n plugins: {},\n };\n }),\n ...plugin.configs['default-expressions'].map((config) => {\n return {\n ...config,\n plugins: {},\n };\n }),\n]);\n\nexport default plugin;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2EA,MAAM,SAAS;CAEb,SAAS,CAAE;CACX,OAAO;EACL,gBAAgBA;EAChB,mBAAmBC;EACnB,kBAAkBC;EAClB,qBAAqBC;EACrB,wBAAwBC;EACxB,qBAAqBC;EACrB,wBAAwBC;EACxB,gBAAgBC;EAChB,mBAAmBC;EACnB,wBAAwBC;EACxB,eAAeC;EACf,gBAAgBC;EAChB,6BAA6BC;EAC7B,cAAcC;EACd,yBAAyBC;EACzB,2BAA2BC;EAC3B,oBAAoBC;EACpB,sBAAsBC;EACtB,qBAAqBC;EACrB,cAAcC;EACd,oBAAoBC;EACpB,iBAAiBC;EACjB,+BAA+BC;EAC/B,mBAAmBC;EACnB,eAAeC;EACf,qBAAqBC;EACrB,sBAAsBC;EACtB,wBAAwBC;EACxB,YAAYC;EACZ,sBAAsBC;EACtB,2BAA2BC;EAC3B,uBAAuBC;EACvB,yCAAyCC;EACzC,mBAAmBC;EACnB,yBAAyBC;EACzB,2CAA2CC;EAC3C,iBAAiBC;EACjB,iBAAiBC;EACjB,6BAA6BC;EAC7B,sBAAsBC;EACtB,sBAAsBC;EACtB,oBAAoBC;EACpB,gCAAgCC;EAChC,yBAAyBC;EACzB,yBAAyBC;EACzB,mBAAmBC;EACnB,yBAAyBC;EACzB,+BAA+BC;EAC/B,wBAAwBC;EACxB,oBAAoBC;EACpB,kBAAkBC;EAClB,kBAAkBC;EAClB,wBAAwBC;EACxB,aAAaC;EACb,aAAaC;EACb,iBAAiBC;EACjB,eAAeC;CAChB;AACF;;;;;;AAOD,MAAM,2BAA2B,CAAC,aAAa,aAAa;AAC1D,QAAO;EACL,GAAI,WAAW,EACb,MAAM,WAAW,SAClB,IAAG,CAAE;EAEN,SACE,WAAW,EACT,OAAO,OACR,IAAG,CACF,OACD;EACH,OAAO;GACL,sBAAsB;GACtB,yBAAyB;GACzB,wBAAwB;GACxB,2BAA2B;GAC3B,8BAA8B;GAC9B,2BAA2B;GAC3B,8BAA8B;GAC9B,sBAAsB;GACtB,yBAAyB;GACzB,8BAA8B;GAC9B,qBAAqB;GACrB,sBAAsB;GACtB,mCAAmC;GACnC,oBAAoB;GACpB,+BAA+B;GAC/B,iCAAiC;GACjC,0BAA0B;GAC1B,4BAA4B;GAC5B,2BAA2B;GAC3B,oBAAoB;GACpB,0BAA0B;GAC1B,uBAAuB;GACvB,qCAAqC;GACrC,yBAAyB;GACzB,qBAAqB;GACrB,2BAA2B;GAC3B,4BAA4B;GAC5B,8BAA8B;GAC9B,kBAAkB;GAClB,4BAA4B;GAC5B,iCAAiC;GACjC,6BAA6B;GAC7B,+CAA+C;GAC/C,yBAAyB;GACzB,+BAA+B;GAC/B,iDAAiD;GACjD,uBAAuB;GACvB,uBAAuB;GACvB,mCAAmC;GACnC,4BAA4B;GAC5B,4BAA4B;GAC5B,0BAA0B;GAC1B,sCAAsC;GACtC,+BAA+B;GAC/B,+BAA+B;GAC/B,yBAAyB;GACzB,+BAA+B;GAC/B,qCAAqC;GACrC,8BAA8B;GAC9B,0BAA0B;GAC1B,wBAAwB;GACxB,wBAAwB;GACxB,8BAA8B;GAC9B,mBAAmB;GACnB,mBAAmB;GACnB,uBAAuB;GACvB,qBAAqB;EACtB;CACF;AACF;;;;;;AAOD,MAAM,qCAAqC,CAAC,aAAa,aAAa;CACpE,MAAM,UAAU,yBAAyB,aAAa,SAAS;AAE/D,QAAO;EACL,GAAG;EACH,OAAO;GACL,GAAG,QAAQ;GAET,yBAAyB,CACvB,aAAa,EACX,OAAO,KACR,CACF;GACD,kBAAkB;GAClB,4BAA4B;GAC5B,4BAA4B;GAC5B,+BAA+B;GAC/B,8BAA8B;EAEjC;CACF;AACF;;;;;;AAOD,MAAM,2CAA2C,CAAC,aAAa,aAAa;CAC1E,MAAM,UAAU,yBAAyB,aAAa,SAAS;AAE/D,QAAO;EACL,GAAG;EACH,OAAO;GACL,GAAG,QAAQ;GAET,4BAA4B;EAE/B;CACF;AACF;;;;AAKD,MAAM,iCAAiC,CAAC,cAAc;;;;;;AAMpD,QAAO,CAAC,aAAa,aAAa;AAChC,SAAO;GACL,MAAM,WAAW;GACjB,SAAS,EACP,OAAO,OACR;GACD,OAAO,OAAO,YACZ,UAAU,IACR,CAAC,aAAa;AACZ,WAAQ,OAAO,aAAa,WAC1B,CACE,UAAU,WACX,IACD,CACE,SAAS,IAAI,CACX,aAAa,GAAG,SAAS,MAAM,EAAE,AAClC,CACF;GACJ,EACF,CACF;EACF;CACF;AACF;AAED,MAAM,gBAAgB;CACpB;CACA;CACA;CACA;CACA,CACE,uBAAuB,EACrB,YAAY,KACb,CACF;AACF;AAED,MAAM,kCAAkC,+BAA+B,cAAc;AAErF,MAAM,wCAAwC,+BAA+B,cAAc;AAE3F,MAAM,eAAe;CACnB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD;AAED,MAAM,iCAAiC,+BAA+B,aAAa;AAEnF,MAAM,uCAAuC,+BAA+B,aAAa;AAEzF,MAAM,oBAAoB;CACxB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD;AAED,MAAM,sCAAsC,+BAA+B,kBAAkB;AAE7F,MAAM,4CAA4C,+BAA+B;CAC/E,GAAG;CACH;CACA;CACA;CACA;AACD,EAAC;AAEF,MAAM,iBAAiB;CACrB;CACA;CACA;CACA;CACA;CACA;CACA,CACE,iDAAiD,OAClD;CACD;AACD;AAED,MAAM,mCAAmC,+BAA+B,eAAe;AAEvF,MAAM,yCAAyC,+BAA+B,eAAe;;AAG7F,IAAI,CAAC,OAAO,QACV,OAAM,IAAI,MAAM;AAGlB,OAAO,QAAQ,cAAc,yBAAyB,OAAO;AAC7D,OAAO,QAAQ,uBAAuB,yBAAyB,QAAQ;AACvE,OAAO,QAAQ,4BAA4B,mCAAmC,OAAO;AACrF,OAAO,QAAQ,kCAAkC,mCAAmC,QAAQ;AAC5F,OAAO,QAAQ,mCAAmC,yCAAyC,OAAO;AAClG,OAAO,QAAQ,yCAAyC,yCAAyC,QAAQ;AAEzG,OAAO,QAAQ,sBAAsB,yBAAyB,QAAQ,mBAAmB;AACzF,OAAO,QAAQ,4BAA4B,yBAAyB,SAAS,yBAAyB;AACtG,OAAO,QAAQ,iCAAiC,mCAAmC,QAAQ,8BAA8B;AACzH,OAAO,QAAQ,uCAAuC,mCAAmC,SAAS,oCAAoC;AACtI,OAAO,QAAQ,wCAAwC,yCAAyC,QAAQ,qCAAqC;AAC7I,OAAO,QAAQ,8CAA8C,yCAAyC,SAAS,2CAA2C;AAE1J,OAAO,QAAQ,8BAA8B,gCAAgC,QAAQ,2BAA2B;AAChH,OAAO,QAAQ,oCAAoC,gCAAgC,SAAS,iCAAiC;AAC7H,OAAO,QAAQ,qCAAqC,sCAAsC,QAAQ,kCAAkC;AACpI,OAAO,QAAQ,2CAA2C,sCAAsC,SAAS,wCAAwC;AACjJ,OAAO,QAAQ,6BAA6B,+BAA+B,QAAQ,0BAA0B;AAC7G,OAAO,QAAQ,mCAAmC,+BAA+B,SAAS,gCAAgC;AAC1H,OAAO,QAAQ,oCAAoC,qCAAqC,QAAQ,iCAAiC;AACjI,OAAO,QAAQ,0CAA0C,qCAAqC,SAAS,uCAAuC;AAC9I,OAAO,QAAQ,kCAAkC,oCAAoC,QAAQ,+BAA+B;AAC5H,OAAO,QAAQ,wCAAwC,oCAAoC,SAAS,qCAAqC;AACzI,OAAO,QAAQ,yCAAyC,0CAA0C,QAAQ,sCAAsC;AAChJ,OAAO,QAAQ,+CAA+C,0CAA0C,SAAS,4CAA4C;AAC7J,OAAO,QAAQ,+BAA+B,iCAAiC,QAAQ,4BAA4B;AACnH,OAAO,QAAQ,qCAAqC,iCAAiC,SAAS,kCAAkC;AAChI,OAAO,QAAQ,sCAAsC,uCAAuC,QAAQ,mCAAmC;AACvI,OAAO,QAAQ,4CAA4C,uCAAuC,SAAS,yCAAyC;AAEpJ,OAAO,QAAQ,WAAgE,CAC7E;CACE,OAAO,CACL,SACD;CACD,MAAM;CACN,SAAS,EACP,UAAU,yBAAyB,CACpC;CACD,WAAW;AACZ,GACD;CACE,OAAO,CACL,cACD;CACD,MAAM;CACN,OAAO;EAEL,YAAY;EAGZ,wBAAwB;EAGxB,sBAAsB;EAEtB,+BAA+B;EAG/B,uBAAuB;EAGvB,cAAc;EAId,2BAA2B;EAG3B,YAAY;EAGZ,kBAAkB;EAGlB,0BAA0B;EAC1B,2BAA2B;EAG3B,iBAAiB;CAClB;AACF,CACF;AAED,OAAO,QAAQ,yBAA8E,CAC3F;CACE,OAAO,CACL,SACD;CACD,MAAM;CACN,SAAS,EACP,UAAU,wBAAwB;EAChC,eAAe;EACf,aAAa;EACb,iBAAiB;CAClB,EAAC,CACH;CACD,WAAW;AACZ,GACD;CACE,OAAO;EACL;EAAuB;EAAqB;CAC7C;CACD,MAAM;CACN,OAAO;EACL,GAAG,OAAO,QAAQ,SAAS,GAAG;EAC9B,uCAAuC;EACvC,qBAAqB;EACrB,UAAU;EACV,yBAAyB;EACzB,QAAQ,CACN,SAAS,QACV;EACD,MAAM,CACJ,SAAS,OACV;EACD,QAAQ;CACT;AACF,CACF;AAED,OAAO,QAAQ,sCAA2F;CACxG;EACE,MAAM;EACN,SAAS,EACP,UAAU,wBAAwB;GAChC,eAAe;GACf,aAAa;GACb,iBAAiB;EAClB,EAAC,CACH;CACF;CACD,GAAG,OAAO,QAAQ,SAAS,IAAI,CAAC,WAAW;AACzC,SAAO;GACL,GAAG;GACH,SAAS,CAAE;EACZ;CACF,EAAC;CACF,GAAG,OAAO,QAAQ,uBAAuB,IAAI,CAAC,WAAW;AACvD,SAAO;GACL,GAAG;GACH,SAAS,CAAE;EACZ;CACF,EAAC;AACH;AAED,qBAAe"}
@@ -1,33 +0,0 @@
1
- import iterateJsdoc from "../iterateJsdoc.js";
2
-
3
- //#region src/rules/checkAccess.js
4
- const accessLevels = [
5
- "package",
6
- "private",
7
- "protected",
8
- "public"
9
- ];
10
- var checkAccess_default = iterateJsdoc(({ report, utils }) => {
11
- utils.forEachPreferredTag("access", (jsdocParameter, targetTagName) => {
12
- const desc = jsdocParameter.name + " " + jsdocParameter.description;
13
- if (!accessLevels.includes(desc.trim())) report(`Missing valid JSDoc @${targetTagName} level.`, null, jsdocParameter);
14
- });
15
- const accessLength = utils.getTags("access").length;
16
- const individualTagLength = utils.getPresentTags(accessLevels).length;
17
- if (accessLength && individualTagLength) report("The @access tag may not be used with specific access-control tags (@package, @private, @protected, or @public).");
18
- if (accessLength > 1 || individualTagLength > 1) report("At most one access-control tag may be present on a jsdoc block.");
19
- }, {
20
- checkPrivate: true,
21
- iterateAllJsdocs: true,
22
- meta: {
23
- docs: {
24
- description: "Checks that `@access` tags have a valid value.",
25
- url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-access.md#repos-sticky-header"
26
- },
27
- type: "suggestion"
28
- }
29
- });
30
-
31
- //#endregion
32
- export { checkAccess_default as default };
33
- //# sourceMappingURL=checkAccess.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"checkAccess.js","names":[],"sources":["../../src/rules/checkAccess.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nconst accessLevels = [\n 'package', 'private', 'protected', 'public',\n];\n\nexport default iterateJsdoc(({\n report,\n utils,\n}) => {\n utils.forEachPreferredTag('access', (jsdocParameter, targetTagName) => {\n const desc = jsdocParameter.name + ' ' + jsdocParameter.description;\n\n if (!accessLevels.includes(desc.trim())) {\n report(\n `Missing valid JSDoc @${targetTagName} level.`,\n null,\n jsdocParameter,\n );\n }\n });\n const accessLength = utils.getTags('access').length;\n const individualTagLength = utils.getPresentTags(accessLevels).length;\n if (accessLength && individualTagLength) {\n report(\n 'The @access tag may not be used with specific access-control tags (@package, @private, @protected, or @public).',\n );\n }\n\n if (accessLength > 1 || individualTagLength > 1) {\n report(\n 'At most one access-control tag may be present on a jsdoc block.',\n );\n }\n}, {\n checkPrivate: true,\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Checks that `@access` tags have a valid value.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-access.md#repos-sticky-header',\n },\n type: 'suggestion',\n },\n});\n"],"mappings":";;;AAEA,MAAM,eAAe;CACnB;CAAW;CAAW;CAAa;AACpC;AAED,0BAAe,aAAa,CAAC,EAC3B,QACA,OACD,KAAK;CACJ,MAAM,oBAAoB,UAAU,CAAC,gBAAgB,kBAAkB;EACrE,MAAM,OAAO,eAAe,OAAO,MAAM,eAAe;AAExD,MAAI,CAAC,aAAa,SAAS,KAAK,MAAM,CAAC,EACrC,OACE,CAAC,qBAAqB,EAAE,cAAc,OAAO,CAAC,EAC9C,MACA,eACD;CAEJ,EAAC;CACF,MAAM,eAAe,MAAM,QAAQ,SAAS,CAAC;CAC7C,MAAM,sBAAsB,MAAM,eAAe,aAAa,CAAC;AAC/D,KAAI,gBAAgB,qBAClB,OACE,kHACD;AAGH,KAAI,eAAe,KAAK,sBAAsB,GAC5C,OACE,kEACD;AAEJ,GAAE;CACD,cAAc;CACd,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,MAAM;CACP;AACF,EAAC"}