eslint-plugin-jsdoc 52.0.2 → 52.0.3

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 (357) hide show
  1. package/dist/WarnSettings.cjs +18 -35
  2. package/dist/WarnSettings.cjs.map +1 -1
  3. package/dist/WarnSettings.js +20 -0
  4. package/dist/WarnSettings.js.map +1 -0
  5. package/dist/_virtual/rolldown_runtime.cjs +32 -0
  6. package/dist/_virtual/rolldown_runtime.js +11 -0
  7. package/dist/alignTransform.cjs +224 -305
  8. package/dist/alignTransform.cjs.map +1 -1
  9. package/dist/alignTransform.js +241 -0
  10. package/dist/alignTransform.js.map +1 -0
  11. package/dist/defaultTagOrder.cjs +132 -43
  12. package/dist/defaultTagOrder.cjs.map +1 -1
  13. package/dist/defaultTagOrder.js +134 -0
  14. package/dist/defaultTagOrder.js.map +1 -0
  15. package/dist/exportParser.cjs +478 -696
  16. package/dist/exportParser.cjs.map +1 -1
  17. package/dist/exportParser.js +518 -0
  18. package/dist/exportParser.js.map +1 -0
  19. package/dist/getDefaultTagStructureForMode.cjs +184 -288
  20. package/dist/getDefaultTagStructureForMode.cjs.map +1 -1
  21. package/dist/getDefaultTagStructureForMode.js +188 -0
  22. package/dist/getDefaultTagStructureForMode.js.map +1 -0
  23. package/dist/getJsdocProcessorPlugin.cjs +364 -550
  24. package/dist/getJsdocProcessorPlugin.cjs.map +1 -1
  25. package/dist/getJsdocProcessorPlugin.d.cts +70 -0
  26. package/dist/getJsdocProcessorPlugin.d.cts.map +1 -0
  27. package/dist/getJsdocProcessorPlugin.d.ts +68 -65
  28. package/dist/getJsdocProcessorPlugin.d.ts.map +1 -1
  29. package/dist/getJsdocProcessorPlugin.js +383 -0
  30. package/dist/getJsdocProcessorPlugin.js.map +1 -0
  31. package/dist/index.cjs +398 -383
  32. package/dist/index.cjs.map +1 -1
  33. package/dist/index.d.cts +22 -0
  34. package/dist/index.d.cts.map +1 -0
  35. package/dist/index.d.ts +11 -6
  36. package/dist/index.d.ts.map +1 -1
  37. package/dist/index.js +425 -0
  38. package/dist/index.js.map +1 -0
  39. package/dist/iterateJsdoc.cjs +1528 -1988
  40. package/dist/iterateJsdoc.cjs.map +1 -1
  41. package/dist/iterateJsdoc.d.cts +471 -0
  42. package/dist/iterateJsdoc.d.cts.map +1 -0
  43. package/dist/iterateJsdoc.d.ts +358 -349
  44. package/dist/iterateJsdoc.d.ts.map +1 -1
  45. package/dist/iterateJsdoc.js +1617 -0
  46. package/dist/iterateJsdoc.js.map +1 -0
  47. package/dist/jsdocUtils.cjs +1009 -1376
  48. package/dist/jsdocUtils.cjs.map +1 -1
  49. package/dist/jsdocUtils.js +1123 -0
  50. package/dist/jsdocUtils.js.map +1 -0
  51. package/dist/rules/checkAccess.cjs +29 -36
  52. package/dist/rules/checkAccess.cjs.map +1 -1
  53. package/dist/rules/checkAccess.js +33 -0
  54. package/dist/rules/checkAccess.js.map +1 -0
  55. package/dist/rules/checkAlignment.cjs +41 -54
  56. package/dist/rules/checkAlignment.cjs.map +1 -1
  57. package/dist/rules/checkAlignment.js +47 -0
  58. package/dist/rules/checkAlignment.js.map +1 -0
  59. package/dist/rules/checkExamples.cjs +327 -484
  60. package/dist/rules/checkExamples.cjs.map +1 -1
  61. package/dist/rules/checkExamples.js +348 -0
  62. package/dist/rules/checkExamples.js.map +1 -0
  63. package/dist/rules/checkIndentation.cjs +50 -65
  64. package/dist/rules/checkIndentation.cjs.map +1 -1
  65. package/dist/rules/checkIndentation.js +59 -0
  66. package/dist/rules/checkIndentation.js.map +1 -0
  67. package/dist/rules/checkLineAlignment.cjs +220 -311
  68. package/dist/rules/checkLineAlignment.cjs.map +1 -1
  69. package/dist/rules/checkLineAlignment.js +229 -0
  70. package/dist/rules/checkLineAlignment.js.map +1 -0
  71. package/dist/rules/checkParamNames.cjs +227 -335
  72. package/dist/rules/checkParamNames.cjs.map +1 -1
  73. package/dist/rules/checkParamNames.js +237 -0
  74. package/dist/rules/checkParamNames.js.map +1 -0
  75. package/dist/rules/checkPropertyNames.cjs +78 -106
  76. package/dist/rules/checkPropertyNames.cjs.map +1 -1
  77. package/dist/rules/checkPropertyNames.js +88 -0
  78. package/dist/rules/checkPropertyNames.js.map +1 -0
  79. package/dist/rules/checkSyntax.cjs +21 -34
  80. package/dist/rules/checkSyntax.cjs.map +1 -1
  81. package/dist/rules/checkSyntax.js +25 -0
  82. package/dist/rules/checkSyntax.js.map +1 -0
  83. package/dist/rules/checkTagNames.cjs +188 -210
  84. package/dist/rules/checkTagNames.cjs.map +1 -1
  85. package/dist/rules/checkTagNames.js +191 -0
  86. package/dist/rules/checkTagNames.js.map +1 -0
  87. package/dist/rules/checkTemplateNames.cjs +121 -178
  88. package/dist/rules/checkTemplateNames.cjs.map +1 -1
  89. package/dist/rules/checkTemplateNames.js +124 -0
  90. package/dist/rules/checkTemplateNames.js.map +1 -0
  91. package/dist/rules/checkTypes.cjs +291 -385
  92. package/dist/rules/checkTypes.cjs.map +1 -1
  93. package/dist/rules/checkTypes.js +299 -0
  94. package/dist/rules/checkTypes.js.map +1 -0
  95. package/dist/rules/checkValues.cjs +100 -146
  96. package/dist/rules/checkValues.cjs.map +1 -1
  97. package/dist/rules/checkValues.js +103 -0
  98. package/dist/rules/checkValues.js.map +1 -0
  99. package/dist/rules/convertToJsdocComments.cjs +228 -306
  100. package/dist/rules/convertToJsdocComments.cjs.map +1 -1
  101. package/dist/rules/convertToJsdocComments.js +231 -0
  102. package/dist/rules/convertToJsdocComments.js.map +1 -0
  103. package/dist/rules/emptyTags.cjs +62 -72
  104. package/dist/rules/emptyTags.cjs.map +1 -1
  105. package/dist/rules/emptyTags.js +67 -0
  106. package/dist/rules/emptyTags.js.map +1 -0
  107. package/dist/rules/implementsOnClasses.cjs +36 -56
  108. package/dist/rules/implementsOnClasses.cjs.map +1 -1
  109. package/dist/rules/implementsOnClasses.js +40 -0
  110. package/dist/rules/implementsOnClasses.js.map +1 -0
  111. package/dist/rules/importsAsDependencies.cjs +62 -99
  112. package/dist/rules/importsAsDependencies.cjs.map +1 -1
  113. package/dist/rules/importsAsDependencies.js +68 -0
  114. package/dist/rules/importsAsDependencies.js.map +1 -0
  115. package/dist/rules/informativeDocs.cjs +105 -142
  116. package/dist/rules/informativeDocs.cjs.map +1 -1
  117. package/dist/rules/informativeDocs.js +110 -0
  118. package/dist/rules/informativeDocs.js.map +1 -0
  119. package/dist/rules/linesBeforeBlock.cjs +70 -105
  120. package/dist/rules/linesBeforeBlock.cjs.map +1 -1
  121. package/dist/rules/linesBeforeBlock.js +75 -0
  122. package/dist/rules/linesBeforeBlock.js.map +1 -0
  123. package/dist/rules/matchDescription.cjs +160 -222
  124. package/dist/rules/matchDescription.cjs.map +1 -1
  125. package/dist/rules/matchDescription.js +167 -0
  126. package/dist/rules/matchDescription.js.map +1 -0
  127. package/dist/rules/matchName.cjs +73 -128
  128. package/dist/rules/matchName.cjs.map +1 -1
  129. package/dist/rules/matchName.js +77 -0
  130. package/dist/rules/matchName.js.map +1 -0
  131. package/dist/rules/multilineBlocks.cjs +235 -352
  132. package/dist/rules/multilineBlocks.cjs.map +1 -1
  133. package/dist/rules/multilineBlocks.js +245 -0
  134. package/dist/rules/multilineBlocks.js.map +1 -0
  135. package/dist/rules/noBadBlocks.cjs +63 -86
  136. package/dist/rules/noBadBlocks.cjs.map +1 -1
  137. package/dist/rules/noBadBlocks.js +68 -0
  138. package/dist/rules/noBadBlocks.js.map +1 -0
  139. package/dist/rules/noBlankBlockDescriptions.cjs +35 -57
  140. package/dist/rules/noBlankBlockDescriptions.cjs.map +1 -1
  141. package/dist/rules/noBlankBlockDescriptions.js +41 -0
  142. package/dist/rules/noBlankBlockDescriptions.js.map +1 -0
  143. package/dist/rules/noBlankBlocks.cjs +26 -48
  144. package/dist/rules/noBlankBlocks.cjs.map +1 -1
  145. package/dist/rules/noBlankBlocks.js +30 -0
  146. package/dist/rules/noBlankBlocks.js.map +1 -0
  147. package/dist/rules/noDefaults.cjs +52 -79
  148. package/dist/rules/noDefaults.cjs.map +1 -1
  149. package/dist/rules/noDefaults.js +56 -0
  150. package/dist/rules/noDefaults.js.map +1 -0
  151. package/dist/rules/noMissingSyntax.cjs +115 -165
  152. package/dist/rules/noMissingSyntax.cjs.map +1 -1
  153. package/dist/rules/noMissingSyntax.js +126 -0
  154. package/dist/rules/noMissingSyntax.js.map +1 -0
  155. package/dist/rules/noMultiAsterisks.cjs +48 -89
  156. package/dist/rules/noMultiAsterisks.cjs.map +1 -1
  157. package/dist/rules/noMultiAsterisks.js +58 -0
  158. package/dist/rules/noMultiAsterisks.js.map +1 -0
  159. package/dist/rules/noRestrictedSyntax.cjs +45 -79
  160. package/dist/rules/noRestrictedSyntax.cjs.map +1 -1
  161. package/dist/rules/noRestrictedSyntax.js +49 -0
  162. package/dist/rules/noRestrictedSyntax.js.map +1 -0
  163. package/dist/rules/noTypes.cjs +59 -80
  164. package/dist/rules/noTypes.cjs.map +1 -1
  165. package/dist/rules/noTypes.js +65 -0
  166. package/dist/rules/noTypes.js.map +1 -0
  167. package/dist/rules/noUndefinedTypes.cjs +297 -388
  168. package/dist/rules/noUndefinedTypes.cjs.map +1 -1
  169. package/dist/rules/noUndefinedTypes.js +303 -0
  170. package/dist/rules/noUndefinedTypes.js.map +1 -0
  171. package/dist/rules/requireAsteriskPrefix.cjs +108 -159
  172. package/dist/rules/requireAsteriskPrefix.cjs.map +1 -1
  173. package/dist/rules/requireAsteriskPrefix.js +112 -0
  174. package/dist/rules/requireAsteriskPrefix.js.map +1 -0
  175. package/dist/rules/requireDescription.cjs +89 -129
  176. package/dist/rules/requireDescription.cjs.map +1 -1
  177. package/dist/rules/requireDescription.js +95 -0
  178. package/dist/rules/requireDescription.js.map +1 -0
  179. package/dist/rules/requireDescriptionCompleteSentence.cjs +201 -262
  180. package/dist/rules/requireDescriptionCompleteSentence.cjs.map +1 -1
  181. package/dist/rules/requireDescriptionCompleteSentence.js +220 -0
  182. package/dist/rules/requireDescriptionCompleteSentence.js.map +1 -0
  183. package/dist/rules/requireExample.cjs +73 -104
  184. package/dist/rules/requireExample.cjs.map +1 -1
  185. package/dist/rules/requireExample.js +77 -0
  186. package/dist/rules/requireExample.js.map +1 -0
  187. package/dist/rules/requireFileOverview.cjs +75 -129
  188. package/dist/rules/requireFileOverview.cjs.map +1 -1
  189. package/dist/rules/requireFileOverview.js +81 -0
  190. package/dist/rules/requireFileOverview.js.map +1 -0
  191. package/dist/rules/requireHyphenBeforeParamDescription.cjs +85 -133
  192. package/dist/rules/requireHyphenBeforeParamDescription.cjs.map +1 -1
  193. package/dist/rules/requireHyphenBeforeParamDescription.js +89 -0
  194. package/dist/rules/requireHyphenBeforeParamDescription.js.map +1 -0
  195. package/dist/rules/requireJsdoc.cjs +384 -557
  196. package/dist/rules/requireJsdoc.cjs.map +1 -1
  197. package/dist/rules/requireJsdoc.js +404 -0
  198. package/dist/rules/requireJsdoc.js.map +1 -0
  199. package/dist/rules/requireParam.cjs +336 -526
  200. package/dist/rules/requireParam.cjs.map +1 -1
  201. package/dist/rules/requireParam.js +344 -0
  202. package/dist/rules/requireParam.js.map +1 -0
  203. package/dist/rules/requireParamDescription.cjs +55 -80
  204. package/dist/rules/requireParamDescription.cjs.map +1 -1
  205. package/dist/rules/requireParamDescription.js +59 -0
  206. package/dist/rules/requireParamDescription.js.map +1 -0
  207. package/dist/rules/requireParamName.cjs +32 -50
  208. package/dist/rules/requireParamName.cjs.map +1 -1
  209. package/dist/rules/requireParamName.js +36 -0
  210. package/dist/rules/requireParamName.js.map +1 -0
  211. package/dist/rules/requireParamType.cjs +55 -80
  212. package/dist/rules/requireParamType.cjs.map +1 -1
  213. package/dist/rules/requireParamType.js +59 -0
  214. package/dist/rules/requireParamType.js.map +1 -0
  215. package/dist/rules/requireProperty.cjs +31 -42
  216. package/dist/rules/requireProperty.cjs.map +1 -1
  217. package/dist/rules/requireProperty.js +35 -0
  218. package/dist/rules/requireProperty.js.map +1 -0
  219. package/dist/rules/requirePropertyDescription.cjs +17 -25
  220. package/dist/rules/requirePropertyDescription.cjs.map +1 -1
  221. package/dist/rules/requirePropertyDescription.js +21 -0
  222. package/dist/rules/requirePropertyDescription.js.map +1 -0
  223. package/dist/rules/requirePropertyName.cjs +17 -25
  224. package/dist/rules/requirePropertyName.cjs.map +1 -1
  225. package/dist/rules/requirePropertyName.js +21 -0
  226. package/dist/rules/requirePropertyName.js.map +1 -0
  227. package/dist/rules/requirePropertyType.cjs +17 -25
  228. package/dist/rules/requirePropertyType.cjs.map +1 -1
  229. package/dist/rules/requirePropertyType.js +21 -0
  230. package/dist/rules/requirePropertyType.js.map +1 -0
  231. package/dist/rules/requireReturns.cjs +125 -203
  232. package/dist/rules/requireReturns.cjs.map +1 -1
  233. package/dist/rules/requireReturns.js +131 -0
  234. package/dist/rules/requireReturns.js.map +1 -0
  235. package/dist/rules/requireReturnsCheck.cjs +60 -103
  236. package/dist/rules/requireReturnsCheck.cjs.map +1 -1
  237. package/dist/rules/requireReturnsCheck.js +66 -0
  238. package/dist/rules/requireReturnsCheck.js.map +1 -0
  239. package/dist/rules/requireReturnsDescription.cjs +39 -54
  240. package/dist/rules/requireReturnsDescription.cjs.map +1 -1
  241. package/dist/rules/requireReturnsDescription.js +43 -0
  242. package/dist/rules/requireReturnsDescription.js.map +1 -0
  243. package/dist/rules/requireReturnsType.cjs +32 -50
  244. package/dist/rules/requireReturnsType.cjs.map +1 -1
  245. package/dist/rules/requireReturnsType.js +36 -0
  246. package/dist/rules/requireReturnsType.js.map +1 -0
  247. package/dist/rules/requireTemplate.cjs +119 -178
  248. package/dist/rules/requireTemplate.cjs.map +1 -1
  249. package/dist/rules/requireTemplate.js +122 -0
  250. package/dist/rules/requireTemplate.js.map +1 -0
  251. package/dist/rules/requireThrows.cjs +61 -95
  252. package/dist/rules/requireThrows.cjs.map +1 -1
  253. package/dist/rules/requireThrows.js +67 -0
  254. package/dist/rules/requireThrows.js.map +1 -0
  255. package/dist/rules/requireYields.cjs +106 -166
  256. package/dist/rules/requireYields.cjs.map +1 -1
  257. package/dist/rules/requireYields.js +115 -0
  258. package/dist/rules/requireYields.js.map +1 -0
  259. package/dist/rules/requireYieldsCheck.cjs +96 -152
  260. package/dist/rules/requireYieldsCheck.cjs.map +1 -1
  261. package/dist/rules/requireYieldsCheck.js +105 -0
  262. package/dist/rules/requireYieldsCheck.js.map +1 -0
  263. package/dist/rules/sortTags.cjs +258 -444
  264. package/dist/rules/sortTags.cjs.map +1 -1
  265. package/dist/rules/sortTags.js +262 -0
  266. package/dist/rules/sortTags.js.map +1 -0
  267. package/dist/rules/tagLines.cjs +179 -266
  268. package/dist/rules/tagLines.cjs.map +1 -1
  269. package/dist/rules/tagLines.js +183 -0
  270. package/dist/rules/tagLines.js.map +1 -0
  271. package/dist/rules/textEscaping.cjs +92 -127
  272. package/dist/rules/textEscaping.cjs.map +1 -1
  273. package/dist/rules/textEscaping.js +102 -0
  274. package/dist/rules/textEscaping.js.map +1 -0
  275. package/dist/rules/validTypes.cjs +252 -265
  276. package/dist/rules/validTypes.cjs.map +1 -1
  277. package/dist/rules/validTypes.js +259 -0
  278. package/dist/rules/validTypes.js.map +1 -0
  279. package/dist/tagNames.cjs +134 -170
  280. package/dist/tagNames.cjs.map +1 -1
  281. package/dist/tagNames.js +144 -0
  282. package/dist/tagNames.js.map +1 -0
  283. package/dist/utils/hasReturnValue.cjs +246 -474
  284. package/dist/utils/hasReturnValue.cjs.map +1 -1
  285. package/dist/utils/hasReturnValue.js +265 -0
  286. package/dist/utils/hasReturnValue.js.map +1 -0
  287. package/package.json +40 -24
  288. package/dist/generateRule.cjs +0 -242
  289. package/dist/generateRule.cjs.map +0 -1
  290. package/src/WarnSettings.js +0 -34
  291. package/src/alignTransform.js +0 -358
  292. package/src/defaultTagOrder.js +0 -169
  293. package/src/exportParser.js +0 -978
  294. package/src/getDefaultTagStructureForMode.js +0 -969
  295. package/src/getJsdocProcessorPlugin.js +0 -672
  296. package/src/index.js +0 -530
  297. package/src/iterateJsdoc.js +0 -2518
  298. package/src/jsdocUtils.js +0 -1896
  299. package/src/rules/checkAccess.js +0 -45
  300. package/src/rules/checkAlignment.js +0 -63
  301. package/src/rules/checkExamples.js +0 -589
  302. package/src/rules/checkIndentation.js +0 -75
  303. package/src/rules/checkLineAlignment.js +0 -372
  304. package/src/rules/checkParamNames.js +0 -474
  305. package/src/rules/checkPropertyNames.js +0 -152
  306. package/src/rules/checkSyntax.js +0 -30
  307. package/src/rules/checkTagNames.js +0 -314
  308. package/src/rules/checkTemplateNames.js +0 -204
  309. package/src/rules/checkTypes.js +0 -535
  310. package/src/rules/checkValues.js +0 -248
  311. package/src/rules/convertToJsdocComments.js +0 -398
  312. package/src/rules/emptyTags.js +0 -98
  313. package/src/rules/implementsOnClasses.js +0 -64
  314. package/src/rules/importsAsDependencies.js +0 -133
  315. package/src/rules/informativeDocs.js +0 -189
  316. package/src/rules/linesBeforeBlock.js +0 -134
  317. package/src/rules/matchDescription.js +0 -286
  318. package/src/rules/matchName.js +0 -151
  319. package/src/rules/multilineBlocks.js +0 -493
  320. package/src/rules/noBadBlocks.js +0 -119
  321. package/src/rules/noBlankBlockDescriptions.js +0 -69
  322. package/src/rules/noBlankBlocks.js +0 -53
  323. package/src/rules/noDefaults.js +0 -85
  324. package/src/rules/noMissingSyntax.js +0 -195
  325. package/src/rules/noMultiAsterisks.js +0 -134
  326. package/src/rules/noRestrictedSyntax.js +0 -91
  327. package/src/rules/noTypes.js +0 -93
  328. package/src/rules/noUndefinedTypes.js +0 -543
  329. package/src/rules/requireAsteriskPrefix.js +0 -190
  330. package/src/rules/requireDescription.js +0 -161
  331. package/src/rules/requireDescriptionCompleteSentence.js +0 -335
  332. package/src/rules/requireExample.js +0 -118
  333. package/src/rules/requireFileOverview.js +0 -154
  334. package/src/rules/requireHyphenBeforeParamDescription.js +0 -176
  335. package/src/rules/requireJsdoc.js +0 -743
  336. package/src/rules/requireParam.js +0 -602
  337. package/src/rules/requireParamDescription.js +0 -89
  338. package/src/rules/requireParamName.js +0 -55
  339. package/src/rules/requireParamType.js +0 -89
  340. package/src/rules/requireProperty.js +0 -48
  341. package/src/rules/requirePropertyDescription.js +0 -25
  342. package/src/rules/requirePropertyName.js +0 -25
  343. package/src/rules/requirePropertyType.js +0 -25
  344. package/src/rules/requireReturns.js +0 -238
  345. package/src/rules/requireReturnsCheck.js +0 -145
  346. package/src/rules/requireReturnsDescription.js +0 -59
  347. package/src/rules/requireReturnsType.js +0 -51
  348. package/src/rules/requireTemplate.js +0 -201
  349. package/src/rules/requireThrows.js +0 -111
  350. package/src/rules/requireYields.js +0 -216
  351. package/src/rules/requireYieldsCheck.js +0 -208
  352. package/src/rules/sortTags.js +0 -558
  353. package/src/rules/tagLines.js +0 -359
  354. package/src/rules/textEscaping.js +0 -154
  355. package/src/rules/validTypes.js +0 -401
  356. package/src/tagNames.js +0 -238
  357. package/src/utils/hasReturnValue.js +0 -572
package/dist/index.cjs CHANGED
@@ -1,411 +1,426 @@
1
- "use strict";
1
+ Object.defineProperty(exports, '__esModule', { value: true });
2
+ const require_getJsdocProcessorPlugin = require('./getJsdocProcessorPlugin.cjs');
3
+ const require_checkAccess = require('./rules/checkAccess.cjs');
4
+ const require_checkAlignment = require('./rules/checkAlignment.cjs');
5
+ const require_checkExamples = require('./rules/checkExamples.cjs');
6
+ const require_checkIndentation = require('./rules/checkIndentation.cjs');
7
+ const require_checkLineAlignment = require('./rules/checkLineAlignment.cjs');
8
+ const require_checkParamNames = require('./rules/checkParamNames.cjs');
9
+ const require_checkPropertyNames = require('./rules/checkPropertyNames.cjs');
10
+ const require_checkSyntax = require('./rules/checkSyntax.cjs');
11
+ const require_checkTagNames = require('./rules/checkTagNames.cjs');
12
+ const require_checkTemplateNames = require('./rules/checkTemplateNames.cjs');
13
+ const require_checkTypes = require('./rules/checkTypes.cjs');
14
+ const require_checkValues = require('./rules/checkValues.cjs');
15
+ const require_convertToJsdocComments = require('./rules/convertToJsdocComments.cjs');
16
+ const require_emptyTags = require('./rules/emptyTags.cjs');
17
+ const require_implementsOnClasses = require('./rules/implementsOnClasses.cjs');
18
+ const require_importsAsDependencies = require('./rules/importsAsDependencies.cjs');
19
+ const require_informativeDocs = require('./rules/informativeDocs.cjs');
20
+ const require_linesBeforeBlock = require('./rules/linesBeforeBlock.cjs');
21
+ const require_matchDescription = require('./rules/matchDescription.cjs');
22
+ const require_matchName = require('./rules/matchName.cjs');
23
+ const require_multilineBlocks = require('./rules/multilineBlocks.cjs');
24
+ const require_noBadBlocks = require('./rules/noBadBlocks.cjs');
25
+ const require_noBlankBlockDescriptions = require('./rules/noBlankBlockDescriptions.cjs');
26
+ const require_noBlankBlocks = require('./rules/noBlankBlocks.cjs');
27
+ const require_noDefaults = require('./rules/noDefaults.cjs');
28
+ const require_noMissingSyntax = require('./rules/noMissingSyntax.cjs');
29
+ const require_noMultiAsterisks = require('./rules/noMultiAsterisks.cjs');
30
+ const require_noRestrictedSyntax = require('./rules/noRestrictedSyntax.cjs');
31
+ const require_noTypes = require('./rules/noTypes.cjs');
32
+ const require_noUndefinedTypes = require('./rules/noUndefinedTypes.cjs');
33
+ const require_requireAsteriskPrefix = require('./rules/requireAsteriskPrefix.cjs');
34
+ const require_requireDescription = require('./rules/requireDescription.cjs');
35
+ const require_requireDescriptionCompleteSentence = require('./rules/requireDescriptionCompleteSentence.cjs');
36
+ const require_requireExample = require('./rules/requireExample.cjs');
37
+ const require_requireFileOverview = require('./rules/requireFileOverview.cjs');
38
+ const require_requireHyphenBeforeParamDescription = require('./rules/requireHyphenBeforeParamDescription.cjs');
39
+ const require_requireJsdoc = require('./rules/requireJsdoc.cjs');
40
+ const require_requireParam = require('./rules/requireParam.cjs');
41
+ const require_requireParamDescription = require('./rules/requireParamDescription.cjs');
42
+ const require_requireParamName = require('./rules/requireParamName.cjs');
43
+ const require_requireParamType = require('./rules/requireParamType.cjs');
44
+ const require_requireProperty = require('./rules/requireProperty.cjs');
45
+ const require_requirePropertyDescription = require('./rules/requirePropertyDescription.cjs');
46
+ const require_requirePropertyName = require('./rules/requirePropertyName.cjs');
47
+ const require_requirePropertyType = require('./rules/requirePropertyType.cjs');
48
+ const require_requireReturns = require('./rules/requireReturns.cjs');
49
+ const require_requireReturnsCheck = require('./rules/requireReturnsCheck.cjs');
50
+ const require_requireReturnsDescription = require('./rules/requireReturnsDescription.cjs');
51
+ const require_requireReturnsType = require('./rules/requireReturnsType.cjs');
52
+ const require_requireTemplate = require('./rules/requireTemplate.cjs');
53
+ const require_requireThrows = require('./rules/requireThrows.cjs');
54
+ const require_requireYields = require('./rules/requireYields.cjs');
55
+ const require_requireYieldsCheck = require('./rules/requireYieldsCheck.cjs');
56
+ const require_sortTags = require('./rules/sortTags.cjs');
57
+ const require_tagLines = require('./rules/tagLines.cjs');
58
+ const require_textEscaping = require('./rules/textEscaping.cjs');
59
+ const require_validTypes = require('./rules/validTypes.cjs');
2
60
 
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.default = void 0;
7
- var _getJsdocProcessorPlugin = require("./getJsdocProcessorPlugin.cjs");
8
- var _checkAccess = _interopRequireDefault(require("./rules/checkAccess.cjs"));
9
- var _checkAlignment = _interopRequireDefault(require("./rules/checkAlignment.cjs"));
10
- var _checkExamples = _interopRequireDefault(require("./rules/checkExamples.cjs"));
11
- var _checkIndentation = _interopRequireDefault(require("./rules/checkIndentation.cjs"));
12
- var _checkLineAlignment = _interopRequireDefault(require("./rules/checkLineAlignment.cjs"));
13
- var _checkParamNames = _interopRequireDefault(require("./rules/checkParamNames.cjs"));
14
- var _checkPropertyNames = _interopRequireDefault(require("./rules/checkPropertyNames.cjs"));
15
- var _checkSyntax = _interopRequireDefault(require("./rules/checkSyntax.cjs"));
16
- var _checkTagNames = _interopRequireDefault(require("./rules/checkTagNames.cjs"));
17
- var _checkTemplateNames = _interopRequireDefault(require("./rules/checkTemplateNames.cjs"));
18
- var _checkTypes = _interopRequireDefault(require("./rules/checkTypes.cjs"));
19
- var _checkValues = _interopRequireDefault(require("./rules/checkValues.cjs"));
20
- var _convertToJsdocComments = _interopRequireDefault(require("./rules/convertToJsdocComments.cjs"));
21
- var _emptyTags = _interopRequireDefault(require("./rules/emptyTags.cjs"));
22
- var _implementsOnClasses = _interopRequireDefault(require("./rules/implementsOnClasses.cjs"));
23
- var _importsAsDependencies = _interopRequireDefault(require("./rules/importsAsDependencies.cjs"));
24
- var _informativeDocs = _interopRequireDefault(require("./rules/informativeDocs.cjs"));
25
- var _linesBeforeBlock = _interopRequireDefault(require("./rules/linesBeforeBlock.cjs"));
26
- var _matchDescription = _interopRequireDefault(require("./rules/matchDescription.cjs"));
27
- var _matchName = _interopRequireDefault(require("./rules/matchName.cjs"));
28
- var _multilineBlocks = _interopRequireDefault(require("./rules/multilineBlocks.cjs"));
29
- var _noBadBlocks = _interopRequireDefault(require("./rules/noBadBlocks.cjs"));
30
- var _noBlankBlockDescriptions = _interopRequireDefault(require("./rules/noBlankBlockDescriptions.cjs"));
31
- var _noBlankBlocks = _interopRequireDefault(require("./rules/noBlankBlocks.cjs"));
32
- var _noDefaults = _interopRequireDefault(require("./rules/noDefaults.cjs"));
33
- var _noMissingSyntax = _interopRequireDefault(require("./rules/noMissingSyntax.cjs"));
34
- var _noMultiAsterisks = _interopRequireDefault(require("./rules/noMultiAsterisks.cjs"));
35
- var _noRestrictedSyntax = _interopRequireDefault(require("./rules/noRestrictedSyntax.cjs"));
36
- var _noTypes = _interopRequireDefault(require("./rules/noTypes.cjs"));
37
- var _noUndefinedTypes = _interopRequireDefault(require("./rules/noUndefinedTypes.cjs"));
38
- var _requireAsteriskPrefix = _interopRequireDefault(require("./rules/requireAsteriskPrefix.cjs"));
39
- var _requireDescription = _interopRequireDefault(require("./rules/requireDescription.cjs"));
40
- var _requireDescriptionCompleteSentence = _interopRequireDefault(require("./rules/requireDescriptionCompleteSentence.cjs"));
41
- var _requireExample = _interopRequireDefault(require("./rules/requireExample.cjs"));
42
- var _requireFileOverview = _interopRequireDefault(require("./rules/requireFileOverview.cjs"));
43
- var _requireHyphenBeforeParamDescription = _interopRequireDefault(require("./rules/requireHyphenBeforeParamDescription.cjs"));
44
- var _requireJsdoc = _interopRequireDefault(require("./rules/requireJsdoc.cjs"));
45
- var _requireParam = _interopRequireDefault(require("./rules/requireParam.cjs"));
46
- var _requireParamDescription = _interopRequireDefault(require("./rules/requireParamDescription.cjs"));
47
- var _requireParamName = _interopRequireDefault(require("./rules/requireParamName.cjs"));
48
- var _requireParamType = _interopRequireDefault(require("./rules/requireParamType.cjs"));
49
- var _requireProperty = _interopRequireDefault(require("./rules/requireProperty.cjs"));
50
- var _requirePropertyDescription = _interopRequireDefault(require("./rules/requirePropertyDescription.cjs"));
51
- var _requirePropertyName = _interopRequireDefault(require("./rules/requirePropertyName.cjs"));
52
- var _requirePropertyType = _interopRequireDefault(require("./rules/requirePropertyType.cjs"));
53
- var _requireReturns = _interopRequireDefault(require("./rules/requireReturns.cjs"));
54
- var _requireReturnsCheck = _interopRequireDefault(require("./rules/requireReturnsCheck.cjs"));
55
- var _requireReturnsDescription = _interopRequireDefault(require("./rules/requireReturnsDescription.cjs"));
56
- var _requireReturnsType = _interopRequireDefault(require("./rules/requireReturnsType.cjs"));
57
- var _requireTemplate = _interopRequireDefault(require("./rules/requireTemplate.cjs"));
58
- var _requireThrows = _interopRequireDefault(require("./rules/requireThrows.cjs"));
59
- var _requireYields = _interopRequireDefault(require("./rules/requireYields.cjs"));
60
- var _requireYieldsCheck = _interopRequireDefault(require("./rules/requireYieldsCheck.cjs"));
61
- var _sortTags = _interopRequireDefault(require("./rules/sortTags.cjs"));
62
- var _tagLines = _interopRequireDefault(require("./rules/tagLines.cjs"));
63
- var _textEscaping = _interopRequireDefault(require("./rules/textEscaping.cjs"));
64
- var _validTypes = _interopRequireDefault(require("./rules/validTypes.cjs"));
65
- function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
66
- /* eslint-disable jsdoc/valid-types -- Bug */
61
+ //#region src/index.js
67
62
  /**
68
- * @typedef {"recommended" | "stylistic" | "contents" | "logical" | "requirements"} ConfigGroups
69
- * @typedef {"" | "-typescript" | "-typescript-flavor"} ConfigVariants
70
- * @typedef {"" | "-error"} ErrorLevelVariants
71
- * @type {import('eslint').ESLint.Plugin & {
72
- * configs: Record<`flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}`,
73
- * import('eslint').Linter.Config>
74
- * }}
75
- */
63
+ * @typedef {"recommended" | "stylistic" | "contents" | "logical" | "requirements"} ConfigGroups
64
+ * @typedef {"" | "-typescript" | "-typescript-flavor"} ConfigVariants
65
+ * @typedef {"" | "-error"} ErrorLevelVariants
66
+ * @type {import('eslint').ESLint.Plugin & {
67
+ * configs: Record<`flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}`,
68
+ * import('eslint').Linter.Config>
69
+ * }}
70
+ */
76
71
  const index = {
77
- /* eslint-enable jsdoc/valid-types -- Bug */
78
- // @ts-expect-error Ok
79
- configs: {},
80
- rules: {
81
- 'check-access': _checkAccess.default,
82
- 'check-alignment': _checkAlignment.default,
83
- 'check-examples': _checkExamples.default,
84
- 'check-indentation': _checkIndentation.default,
85
- 'check-line-alignment': _checkLineAlignment.default,
86
- 'check-param-names': _checkParamNames.default,
87
- 'check-property-names': _checkPropertyNames.default,
88
- 'check-syntax': _checkSyntax.default,
89
- 'check-tag-names': _checkTagNames.default,
90
- 'check-template-names': _checkTemplateNames.default,
91
- 'check-types': _checkTypes.default,
92
- 'check-values': _checkValues.default,
93
- 'convert-to-jsdoc-comments': _convertToJsdocComments.default,
94
- 'empty-tags': _emptyTags.default,
95
- 'implements-on-classes': _implementsOnClasses.default,
96
- 'imports-as-dependencies': _importsAsDependencies.default,
97
- 'informative-docs': _informativeDocs.default,
98
- 'lines-before-block': _linesBeforeBlock.default,
99
- 'match-description': _matchDescription.default,
100
- 'match-name': _matchName.default,
101
- 'multiline-blocks': _multilineBlocks.default,
102
- 'no-bad-blocks': _noBadBlocks.default,
103
- 'no-blank-block-descriptions': _noBlankBlockDescriptions.default,
104
- 'no-blank-blocks': _noBlankBlocks.default,
105
- 'no-defaults': _noDefaults.default,
106
- 'no-missing-syntax': _noMissingSyntax.default,
107
- 'no-multi-asterisks': _noMultiAsterisks.default,
108
- 'no-restricted-syntax': _noRestrictedSyntax.default,
109
- 'no-types': _noTypes.default,
110
- 'no-undefined-types': _noUndefinedTypes.default,
111
- 'require-asterisk-prefix': _requireAsteriskPrefix.default,
112
- 'require-description': _requireDescription.default,
113
- 'require-description-complete-sentence': _requireDescriptionCompleteSentence.default,
114
- 'require-example': _requireExample.default,
115
- 'require-file-overview': _requireFileOverview.default,
116
- 'require-hyphen-before-param-description': _requireHyphenBeforeParamDescription.default,
117
- 'require-jsdoc': _requireJsdoc.default,
118
- 'require-param': _requireParam.default,
119
- 'require-param-description': _requireParamDescription.default,
120
- 'require-param-name': _requireParamName.default,
121
- 'require-param-type': _requireParamType.default,
122
- 'require-property': _requireProperty.default,
123
- 'require-property-description': _requirePropertyDescription.default,
124
- 'require-property-name': _requirePropertyName.default,
125
- 'require-property-type': _requirePropertyType.default,
126
- 'require-returns': _requireReturns.default,
127
- 'require-returns-check': _requireReturnsCheck.default,
128
- 'require-returns-description': _requireReturnsDescription.default,
129
- 'require-returns-type': _requireReturnsType.default,
130
- 'require-template': _requireTemplate.default,
131
- 'require-throws': _requireThrows.default,
132
- 'require-yields': _requireYields.default,
133
- 'require-yields-check': _requireYieldsCheck.default,
134
- 'sort-tags': _sortTags.default,
135
- 'tag-lines': _tagLines.default,
136
- 'text-escaping': _textEscaping.default,
137
- 'valid-types': _validTypes.default
138
- }
72
+ configs: {},
73
+ rules: {
74
+ "check-access": require_checkAccess.default,
75
+ "check-alignment": require_checkAlignment.default,
76
+ "check-examples": require_checkExamples.default,
77
+ "check-indentation": require_checkIndentation.default,
78
+ "check-line-alignment": require_checkLineAlignment.default,
79
+ "check-param-names": require_checkParamNames.default,
80
+ "check-property-names": require_checkPropertyNames.default,
81
+ "check-syntax": require_checkSyntax.default,
82
+ "check-tag-names": require_checkTagNames.default,
83
+ "check-template-names": require_checkTemplateNames.default,
84
+ "check-types": require_checkTypes.default,
85
+ "check-values": require_checkValues.default,
86
+ "convert-to-jsdoc-comments": require_convertToJsdocComments.default,
87
+ "empty-tags": require_emptyTags.default,
88
+ "implements-on-classes": require_implementsOnClasses.default,
89
+ "imports-as-dependencies": require_importsAsDependencies.default,
90
+ "informative-docs": require_informativeDocs.default,
91
+ "lines-before-block": require_linesBeforeBlock.default,
92
+ "match-description": require_matchDescription.default,
93
+ "match-name": require_matchName.default,
94
+ "multiline-blocks": require_multilineBlocks.default,
95
+ "no-bad-blocks": require_noBadBlocks.default,
96
+ "no-blank-block-descriptions": require_noBlankBlockDescriptions.default,
97
+ "no-blank-blocks": require_noBlankBlocks.default,
98
+ "no-defaults": require_noDefaults.default,
99
+ "no-missing-syntax": require_noMissingSyntax.default,
100
+ "no-multi-asterisks": require_noMultiAsterisks.default,
101
+ "no-restricted-syntax": require_noRestrictedSyntax.default,
102
+ "no-types": require_noTypes.default,
103
+ "no-undefined-types": require_noUndefinedTypes.default,
104
+ "require-asterisk-prefix": require_requireAsteriskPrefix.default,
105
+ "require-description": require_requireDescription.default,
106
+ "require-description-complete-sentence": require_requireDescriptionCompleteSentence.default,
107
+ "require-example": require_requireExample.default,
108
+ "require-file-overview": require_requireFileOverview.default,
109
+ "require-hyphen-before-param-description": require_requireHyphenBeforeParamDescription.default,
110
+ "require-jsdoc": require_requireJsdoc.default,
111
+ "require-param": require_requireParam.default,
112
+ "require-param-description": require_requireParamDescription.default,
113
+ "require-param-name": require_requireParamName.default,
114
+ "require-param-type": require_requireParamType.default,
115
+ "require-property": require_requireProperty.default,
116
+ "require-property-description": require_requirePropertyDescription.default,
117
+ "require-property-name": require_requirePropertyName.default,
118
+ "require-property-type": require_requirePropertyType.default,
119
+ "require-returns": require_requireReturns.default,
120
+ "require-returns-check": require_requireReturnsCheck.default,
121
+ "require-returns-description": require_requireReturnsDescription.default,
122
+ "require-returns-type": require_requireReturnsType.default,
123
+ "require-template": require_requireTemplate.default,
124
+ "require-throws": require_requireThrows.default,
125
+ "require-yields": require_requireYields.default,
126
+ "require-yields-check": require_requireYieldsCheck.default,
127
+ "sort-tags": require_sortTags.default,
128
+ "tag-lines": require_tagLines.default,
129
+ "text-escaping": require_textEscaping.default,
130
+ "valid-types": require_validTypes.default
131
+ }
139
132
  };
140
-
141
133
  /**
142
- * @param {"warn"|"error"} warnOrError
143
- * @param {string} [flatName]
144
- * @returns {import('eslint').Linter.FlatConfig}
145
- */
134
+ * @param {"warn"|"error"} warnOrError
135
+ * @param {string} [flatName]
136
+ * @returns {import('eslint').Linter.FlatConfig}
137
+ */
146
138
  const createRecommendedRuleset = (warnOrError, flatName) => {
147
- return {
148
- ...(flatName ? {
149
- name: 'jsdoc/' + flatName
150
- } : {}),
151
- // @ts-expect-error Ok
152
- plugins: flatName ? {
153
- jsdoc: index
154
- } : ['jsdoc'],
155
- rules: {
156
- 'jsdoc/check-access': warnOrError,
157
- 'jsdoc/check-alignment': warnOrError,
158
- 'jsdoc/check-examples': 'off',
159
- 'jsdoc/check-indentation': 'off',
160
- 'jsdoc/check-line-alignment': 'off',
161
- 'jsdoc/check-param-names': warnOrError,
162
- 'jsdoc/check-property-names': warnOrError,
163
- 'jsdoc/check-syntax': 'off',
164
- 'jsdoc/check-tag-names': warnOrError,
165
- 'jsdoc/check-template-names': 'off',
166
- 'jsdoc/check-types': warnOrError,
167
- 'jsdoc/check-values': warnOrError,
168
- 'jsdoc/convert-to-jsdoc-comments': 'off',
169
- 'jsdoc/empty-tags': warnOrError,
170
- 'jsdoc/implements-on-classes': warnOrError,
171
- 'jsdoc/imports-as-dependencies': 'off',
172
- 'jsdoc/informative-docs': 'off',
173
- 'jsdoc/lines-before-block': 'off',
174
- 'jsdoc/match-description': 'off',
175
- 'jsdoc/match-name': 'off',
176
- 'jsdoc/multiline-blocks': warnOrError,
177
- 'jsdoc/no-bad-blocks': 'off',
178
- 'jsdoc/no-blank-block-descriptions': 'off',
179
- 'jsdoc/no-blank-blocks': 'off',
180
- 'jsdoc/no-defaults': warnOrError,
181
- 'jsdoc/no-missing-syntax': 'off',
182
- 'jsdoc/no-multi-asterisks': warnOrError,
183
- 'jsdoc/no-restricted-syntax': 'off',
184
- 'jsdoc/no-types': 'off',
185
- 'jsdoc/no-undefined-types': warnOrError,
186
- 'jsdoc/require-asterisk-prefix': 'off',
187
- 'jsdoc/require-description': 'off',
188
- 'jsdoc/require-description-complete-sentence': 'off',
189
- 'jsdoc/require-example': 'off',
190
- 'jsdoc/require-file-overview': 'off',
191
- 'jsdoc/require-hyphen-before-param-description': 'off',
192
- 'jsdoc/require-jsdoc': warnOrError,
193
- 'jsdoc/require-param': warnOrError,
194
- 'jsdoc/require-param-description': warnOrError,
195
- 'jsdoc/require-param-name': warnOrError,
196
- 'jsdoc/require-param-type': warnOrError,
197
- 'jsdoc/require-property': warnOrError,
198
- 'jsdoc/require-property-description': warnOrError,
199
- 'jsdoc/require-property-name': warnOrError,
200
- 'jsdoc/require-property-type': warnOrError,
201
- 'jsdoc/require-returns': warnOrError,
202
- 'jsdoc/require-returns-check': warnOrError,
203
- 'jsdoc/require-returns-description': warnOrError,
204
- 'jsdoc/require-returns-type': warnOrError,
205
- 'jsdoc/require-template': 'off',
206
- 'jsdoc/require-throws': 'off',
207
- 'jsdoc/require-yields': warnOrError,
208
- 'jsdoc/require-yields-check': warnOrError,
209
- 'jsdoc/sort-tags': 'off',
210
- 'jsdoc/tag-lines': warnOrError,
211
- 'jsdoc/text-escaping': 'off',
212
- 'jsdoc/valid-types': warnOrError
213
- }
214
- };
139
+ return {
140
+ ...flatName ? { name: "jsdoc/" + flatName } : {},
141
+ plugins: flatName ? { jsdoc: index } : ["jsdoc"],
142
+ rules: {
143
+ "jsdoc/check-access": warnOrError,
144
+ "jsdoc/check-alignment": warnOrError,
145
+ "jsdoc/check-examples": "off",
146
+ "jsdoc/check-indentation": "off",
147
+ "jsdoc/check-line-alignment": "off",
148
+ "jsdoc/check-param-names": warnOrError,
149
+ "jsdoc/check-property-names": warnOrError,
150
+ "jsdoc/check-syntax": "off",
151
+ "jsdoc/check-tag-names": warnOrError,
152
+ "jsdoc/check-template-names": "off",
153
+ "jsdoc/check-types": warnOrError,
154
+ "jsdoc/check-values": warnOrError,
155
+ "jsdoc/convert-to-jsdoc-comments": "off",
156
+ "jsdoc/empty-tags": warnOrError,
157
+ "jsdoc/implements-on-classes": warnOrError,
158
+ "jsdoc/imports-as-dependencies": "off",
159
+ "jsdoc/informative-docs": "off",
160
+ "jsdoc/lines-before-block": "off",
161
+ "jsdoc/match-description": "off",
162
+ "jsdoc/match-name": "off",
163
+ "jsdoc/multiline-blocks": warnOrError,
164
+ "jsdoc/no-bad-blocks": "off",
165
+ "jsdoc/no-blank-block-descriptions": "off",
166
+ "jsdoc/no-blank-blocks": "off",
167
+ "jsdoc/no-defaults": warnOrError,
168
+ "jsdoc/no-missing-syntax": "off",
169
+ "jsdoc/no-multi-asterisks": warnOrError,
170
+ "jsdoc/no-restricted-syntax": "off",
171
+ "jsdoc/no-types": "off",
172
+ "jsdoc/no-undefined-types": warnOrError,
173
+ "jsdoc/require-asterisk-prefix": "off",
174
+ "jsdoc/require-description": "off",
175
+ "jsdoc/require-description-complete-sentence": "off",
176
+ "jsdoc/require-example": "off",
177
+ "jsdoc/require-file-overview": "off",
178
+ "jsdoc/require-hyphen-before-param-description": "off",
179
+ "jsdoc/require-jsdoc": warnOrError,
180
+ "jsdoc/require-param": warnOrError,
181
+ "jsdoc/require-param-description": warnOrError,
182
+ "jsdoc/require-param-name": warnOrError,
183
+ "jsdoc/require-param-type": warnOrError,
184
+ "jsdoc/require-property": warnOrError,
185
+ "jsdoc/require-property-description": warnOrError,
186
+ "jsdoc/require-property-name": warnOrError,
187
+ "jsdoc/require-property-type": warnOrError,
188
+ "jsdoc/require-returns": warnOrError,
189
+ "jsdoc/require-returns-check": warnOrError,
190
+ "jsdoc/require-returns-description": warnOrError,
191
+ "jsdoc/require-returns-type": warnOrError,
192
+ "jsdoc/require-template": "off",
193
+ "jsdoc/require-throws": "off",
194
+ "jsdoc/require-yields": warnOrError,
195
+ "jsdoc/require-yields-check": warnOrError,
196
+ "jsdoc/sort-tags": "off",
197
+ "jsdoc/tag-lines": warnOrError,
198
+ "jsdoc/text-escaping": "off",
199
+ "jsdoc/valid-types": warnOrError
200
+ }
201
+ };
215
202
  };
216
-
217
203
  /**
218
- * @param {"warn"|"error"} warnOrError
219
- * @param {string} [flatName]
220
- * @returns {import('eslint').Linter.FlatConfig}
221
- */
204
+ * @param {"warn"|"error"} warnOrError
205
+ * @param {string} [flatName]
206
+ * @returns {import('eslint').Linter.FlatConfig}
207
+ */
222
208
  const createRecommendedTypeScriptRuleset = (warnOrError, flatName) => {
223
- const ruleset = createRecommendedRuleset(warnOrError, flatName);
224
- return {
225
- ...ruleset,
226
- rules: {
227
- ...ruleset.rules,
228
- /* eslint-disable @stylistic/indent -- Extra indent to avoid use by auto-rule-editing */
229
- 'jsdoc/check-tag-names': [warnOrError, {
230
- typed: true
231
- }],
232
- 'jsdoc/no-types': warnOrError,
233
- 'jsdoc/no-undefined-types': 'off',
234
- 'jsdoc/require-param-type': 'off',
235
- 'jsdoc/require-property-type': 'off',
236
- 'jsdoc/require-returns-type': 'off'
237
- /* eslint-enable @stylistic/indent */
238
- }
239
- };
209
+ const ruleset = createRecommendedRuleset(warnOrError, flatName);
210
+ return {
211
+ ...ruleset,
212
+ rules: {
213
+ ...ruleset.rules,
214
+ "jsdoc/check-tag-names": [warnOrError, { typed: true }],
215
+ "jsdoc/no-types": warnOrError,
216
+ "jsdoc/no-undefined-types": "off",
217
+ "jsdoc/require-param-type": "off",
218
+ "jsdoc/require-property-type": "off",
219
+ "jsdoc/require-returns-type": "off"
220
+ }
221
+ };
240
222
  };
241
-
242
223
  /**
243
- * @param {"warn"|"error"} warnOrError
244
- * @param {string} [flatName]
245
- * @returns {import('eslint').Linter.FlatConfig}
246
- */
224
+ * @param {"warn"|"error"} warnOrError
225
+ * @param {string} [flatName]
226
+ * @returns {import('eslint').Linter.FlatConfig}
227
+ */
247
228
  const createRecommendedTypeScriptFlavorRuleset = (warnOrError, flatName) => {
248
- const ruleset = createRecommendedRuleset(warnOrError, flatName);
249
- return {
250
- ...ruleset,
251
- rules: {
252
- ...ruleset.rules,
253
- /* eslint-disable @stylistic/indent -- Extra indent to avoid use by auto-rule-editing */
254
- 'jsdoc/no-undefined-types': 'off'
255
- /* eslint-enable @stylistic/indent */
256
- }
257
- };
229
+ const ruleset = createRecommendedRuleset(warnOrError, flatName);
230
+ return {
231
+ ...ruleset,
232
+ rules: {
233
+ ...ruleset.rules,
234
+ "jsdoc/no-undefined-types": "off"
235
+ }
236
+ };
258
237
  };
259
-
260
238
  /**
261
- * @param {(string | unknown[])[]} ruleNames
262
- */
263
- const createStandaloneRulesetFactory = ruleNames => {
264
- /**
265
- * @param {"warn"|"error"} warnOrError
266
- * @param {string} [flatName]
267
- * @returns {import('eslint').Linter.FlatConfig}
268
- */
269
- return (warnOrError, flatName) => {
270
- return {
271
- name: 'jsdoc/' + flatName,
272
- plugins: {
273
- jsdoc: index
274
- },
275
- rules: Object.fromEntries(ruleNames.map(ruleName => {
276
- return typeof ruleName === 'string' ? [ruleName, warnOrError] : [ruleName[0], [warnOrError, ...ruleName.slice(1)]];
277
- }))
278
- };
279
- };
239
+ * @param {(string | unknown[])[]} ruleNames
240
+ */
241
+ const createStandaloneRulesetFactory = (ruleNames) => {
242
+ /**
243
+ * @param {"warn"|"error"} warnOrError
244
+ * @param {string} [flatName]
245
+ * @returns {import('eslint').Linter.FlatConfig}
246
+ */
247
+ return (warnOrError, flatName) => {
248
+ return {
249
+ name: "jsdoc/" + flatName,
250
+ plugins: { jsdoc: index },
251
+ rules: Object.fromEntries(ruleNames.map((ruleName) => {
252
+ return typeof ruleName === "string" ? [ruleName, warnOrError] : [ruleName[0], [warnOrError, ...ruleName.slice(1)]];
253
+ }))
254
+ };
255
+ };
280
256
  };
281
- const contentsRules = ['jsdoc/informative-docs', 'jsdoc/match-description', 'jsdoc/no-blank-block-descriptions', 'jsdoc/no-blank-blocks', ['jsdoc/text-escaping', {
282
- escapeHTML: true
283
- }]];
257
+ const contentsRules = [
258
+ "jsdoc/informative-docs",
259
+ "jsdoc/match-description",
260
+ "jsdoc/no-blank-block-descriptions",
261
+ "jsdoc/no-blank-blocks",
262
+ ["jsdoc/text-escaping", { escapeHTML: true }]
263
+ ];
284
264
  const createContentsTypescriptRuleset = createStandaloneRulesetFactory(contentsRules);
285
265
  const createContentsTypescriptFlavorRuleset = createStandaloneRulesetFactory(contentsRules);
286
- const logicalRules = ['jsdoc/check-access', 'jsdoc/check-param-names', 'jsdoc/check-property-names', 'jsdoc/check-syntax', 'jsdoc/check-tag-names', 'jsdoc/check-template-names', 'jsdoc/check-types', 'jsdoc/check-values', 'jsdoc/empty-tags', 'jsdoc/implements-on-classes', 'jsdoc/require-returns-check', 'jsdoc/require-yields-check', 'jsdoc/no-bad-blocks', 'jsdoc/no-defaults', 'jsdoc/no-types', 'jsdoc/no-undefined-types', 'jsdoc/valid-types'];
266
+ const logicalRules = [
267
+ "jsdoc/check-access",
268
+ "jsdoc/check-param-names",
269
+ "jsdoc/check-property-names",
270
+ "jsdoc/check-syntax",
271
+ "jsdoc/check-tag-names",
272
+ "jsdoc/check-template-names",
273
+ "jsdoc/check-types",
274
+ "jsdoc/check-values",
275
+ "jsdoc/empty-tags",
276
+ "jsdoc/implements-on-classes",
277
+ "jsdoc/require-returns-check",
278
+ "jsdoc/require-yields-check",
279
+ "jsdoc/no-bad-blocks",
280
+ "jsdoc/no-defaults",
281
+ "jsdoc/no-types",
282
+ "jsdoc/no-undefined-types",
283
+ "jsdoc/valid-types"
284
+ ];
287
285
  const createLogicalTypescriptRuleset = createStandaloneRulesetFactory(logicalRules);
288
286
  const createLogicalTypescriptFlavorRuleset = createStandaloneRulesetFactory(logicalRules);
289
- const requirementsRules = ['jsdoc/require-example', 'jsdoc/require-jsdoc', 'jsdoc/require-param', 'jsdoc/require-param-description', 'jsdoc/require-param-name', 'jsdoc/require-property', 'jsdoc/require-property-description', 'jsdoc/require-property-name', 'jsdoc/require-returns', 'jsdoc/require-returns-description', 'jsdoc/require-yields'];
287
+ const requirementsRules = [
288
+ "jsdoc/require-example",
289
+ "jsdoc/require-jsdoc",
290
+ "jsdoc/require-param",
291
+ "jsdoc/require-param-description",
292
+ "jsdoc/require-param-name",
293
+ "jsdoc/require-property",
294
+ "jsdoc/require-property-description",
295
+ "jsdoc/require-property-name",
296
+ "jsdoc/require-returns",
297
+ "jsdoc/require-returns-description",
298
+ "jsdoc/require-yields"
299
+ ];
290
300
  const createRequirementsTypeScriptRuleset = createStandaloneRulesetFactory(requirementsRules);
291
- const createRequirementsTypeScriptFlavorRuleset = createStandaloneRulesetFactory([...requirementsRules, 'jsdoc/require-param-type', 'jsdoc/require-property-type', 'jsdoc/require-returns-type', 'jsdoc/require-template']);
292
- const stylisticRules = ['jsdoc/check-alignment', 'jsdoc/check-line-alignment', 'jsdoc/lines-before-block', 'jsdoc/multiline-blocks', 'jsdoc/no-multi-asterisks', 'jsdoc/require-asterisk-prefix', ['jsdoc/require-hyphen-before-param-description', 'never'], 'jsdoc/tag-lines'];
301
+ const createRequirementsTypeScriptFlavorRuleset = createStandaloneRulesetFactory([
302
+ ...requirementsRules,
303
+ "jsdoc/require-param-type",
304
+ "jsdoc/require-property-type",
305
+ "jsdoc/require-returns-type",
306
+ "jsdoc/require-template"
307
+ ]);
308
+ const stylisticRules = [
309
+ "jsdoc/check-alignment",
310
+ "jsdoc/check-line-alignment",
311
+ "jsdoc/lines-before-block",
312
+ "jsdoc/multiline-blocks",
313
+ "jsdoc/no-multi-asterisks",
314
+ "jsdoc/require-asterisk-prefix",
315
+ ["jsdoc/require-hyphen-before-param-description", "never"],
316
+ "jsdoc/tag-lines"
317
+ ];
293
318
  const createStylisticTypeScriptRuleset = createStandaloneRulesetFactory(stylisticRules);
294
319
  const createStylisticTypeScriptFlavorRuleset = createStandaloneRulesetFactory(stylisticRules);
295
-
296
320
  /* c8 ignore next 3 -- TS */
297
- if (!index.configs) {
298
- throw new Error('TypeScript guard');
299
- }
300
- index.configs.recommended = createRecommendedRuleset('warn');
301
- index.configs['recommended-error'] = createRecommendedRuleset('error');
302
- index.configs['recommended-typescript'] = createRecommendedTypeScriptRuleset('warn');
303
- index.configs['recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error');
304
- index.configs['recommended-typescript-flavor'] = createRecommendedTypeScriptFlavorRuleset('warn');
305
- index.configs['recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error');
306
- index.configs['flat/recommended'] = createRecommendedRuleset('warn', 'flat/recommended');
307
- index.configs['flat/recommended-error'] = createRecommendedRuleset('error', 'flat/recommended-error');
308
- index.configs['flat/recommended-typescript'] = createRecommendedTypeScriptRuleset('warn', 'flat/recommended-typescript');
309
- index.configs['flat/recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error', 'flat/recommended-typescript-error');
310
- index.configs['flat/recommended-typescript-flavor'] = createRecommendedTypeScriptFlavorRuleset('warn', 'flat/recommended-typescript-flavor');
311
- index.configs['flat/recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error', 'flat/recommended-typescript-flavor-error');
312
- index.configs['flat/contents-typescript'] = createContentsTypescriptRuleset('warn', 'flat/contents-typescript');
313
- index.configs['flat/contents-typescript-error'] = createContentsTypescriptRuleset('error', 'flat/contents-typescript-error');
314
- index.configs['flat/contents-typescript-flavor'] = createContentsTypescriptFlavorRuleset('warn', 'flat/contents-typescript-flavor');
315
- index.configs['flat/contents-typescript-flavor-error'] = createContentsTypescriptFlavorRuleset('error', 'flat/contents-typescript-error-flavor');
316
- index.configs['flat/logical-typescript'] = createLogicalTypescriptRuleset('warn', 'flat/logical-typescript');
317
- index.configs['flat/logical-typescript-error'] = createLogicalTypescriptRuleset('error', 'flat/logical-typescript-error');
318
- index.configs['flat/logical-typescript-flavor'] = createLogicalTypescriptFlavorRuleset('warn', 'flat/logical-typescript-flavor');
319
- index.configs['flat/logical-typescript-flavor-error'] = createLogicalTypescriptFlavorRuleset('error', 'flat/logical-typescript-error-flavor');
320
- index.configs['flat/requirements-typescript'] = createRequirementsTypeScriptRuleset('warn', 'flat/requirements-typescript');
321
- index.configs['flat/requirements-typescript-error'] = createRequirementsTypeScriptRuleset('error', 'flat/requirements-typescript-error');
322
- index.configs['flat/requirements-typescript-flavor'] = createRequirementsTypeScriptFlavorRuleset('warn', 'flat/requirements-typescript-flavor');
323
- index.configs['flat/requirements-typescript-flavor-error'] = createRequirementsTypeScriptFlavorRuleset('error', 'flat/requirements-typescript-error-flavor');
324
- index.configs['flat/stylistic-typescript'] = createStylisticTypeScriptRuleset('warn', 'flat/stylistic-typescript');
325
- index.configs['flat/stylistic-typescript-error'] = createStylisticTypeScriptRuleset('error', 'flat/stylistic-typescript-error');
326
- index.configs['flat/stylistic-typescript-flavor'] = createStylisticTypeScriptFlavorRuleset('warn', 'flat/stylistic-typescript-flavor');
327
- index.configs['flat/stylistic-typescript-flavor-error'] = createStylisticTypeScriptFlavorRuleset('error', 'flat/stylistic-typescript-error-flavor');
328
- index.configs.examples = /** @type {import('eslint').Linter.FlatConfig[]} */[{
329
- files: ['**/*.js'],
330
- name: 'jsdoc/examples/processor',
331
- plugins: {
332
- examples: (0, _getJsdocProcessorPlugin.getJsdocProcessorPlugin)()
333
- },
334
- processor: 'examples/examples'
321
+ if (!index.configs) throw new Error("TypeScript guard");
322
+ index.configs.recommended = createRecommendedRuleset("warn");
323
+ index.configs["recommended-error"] = createRecommendedRuleset("error");
324
+ index.configs["recommended-typescript"] = createRecommendedTypeScriptRuleset("warn");
325
+ index.configs["recommended-typescript-error"] = createRecommendedTypeScriptRuleset("error");
326
+ index.configs["recommended-typescript-flavor"] = createRecommendedTypeScriptFlavorRuleset("warn");
327
+ index.configs["recommended-typescript-flavor-error"] = createRecommendedTypeScriptFlavorRuleset("error");
328
+ index.configs["flat/recommended"] = createRecommendedRuleset("warn", "flat/recommended");
329
+ index.configs["flat/recommended-error"] = createRecommendedRuleset("error", "flat/recommended-error");
330
+ index.configs["flat/recommended-typescript"] = createRecommendedTypeScriptRuleset("warn", "flat/recommended-typescript");
331
+ index.configs["flat/recommended-typescript-error"] = createRecommendedTypeScriptRuleset("error", "flat/recommended-typescript-error");
332
+ index.configs["flat/recommended-typescript-flavor"] = createRecommendedTypeScriptFlavorRuleset("warn", "flat/recommended-typescript-flavor");
333
+ index.configs["flat/recommended-typescript-flavor-error"] = createRecommendedTypeScriptFlavorRuleset("error", "flat/recommended-typescript-flavor-error");
334
+ index.configs["flat/contents-typescript"] = createContentsTypescriptRuleset("warn", "flat/contents-typescript");
335
+ index.configs["flat/contents-typescript-error"] = createContentsTypescriptRuleset("error", "flat/contents-typescript-error");
336
+ index.configs["flat/contents-typescript-flavor"] = createContentsTypescriptFlavorRuleset("warn", "flat/contents-typescript-flavor");
337
+ index.configs["flat/contents-typescript-flavor-error"] = createContentsTypescriptFlavorRuleset("error", "flat/contents-typescript-error-flavor");
338
+ index.configs["flat/logical-typescript"] = createLogicalTypescriptRuleset("warn", "flat/logical-typescript");
339
+ index.configs["flat/logical-typescript-error"] = createLogicalTypescriptRuleset("error", "flat/logical-typescript-error");
340
+ index.configs["flat/logical-typescript-flavor"] = createLogicalTypescriptFlavorRuleset("warn", "flat/logical-typescript-flavor");
341
+ index.configs["flat/logical-typescript-flavor-error"] = createLogicalTypescriptFlavorRuleset("error", "flat/logical-typescript-error-flavor");
342
+ index.configs["flat/requirements-typescript"] = createRequirementsTypeScriptRuleset("warn", "flat/requirements-typescript");
343
+ index.configs["flat/requirements-typescript-error"] = createRequirementsTypeScriptRuleset("error", "flat/requirements-typescript-error");
344
+ index.configs["flat/requirements-typescript-flavor"] = createRequirementsTypeScriptFlavorRuleset("warn", "flat/requirements-typescript-flavor");
345
+ index.configs["flat/requirements-typescript-flavor-error"] = createRequirementsTypeScriptFlavorRuleset("error", "flat/requirements-typescript-error-flavor");
346
+ index.configs["flat/stylistic-typescript"] = createStylisticTypeScriptRuleset("warn", "flat/stylistic-typescript");
347
+ index.configs["flat/stylistic-typescript-error"] = createStylisticTypeScriptRuleset("error", "flat/stylistic-typescript-error");
348
+ index.configs["flat/stylistic-typescript-flavor"] = createStylisticTypeScriptFlavorRuleset("warn", "flat/stylistic-typescript-flavor");
349
+ index.configs["flat/stylistic-typescript-flavor-error"] = createStylisticTypeScriptFlavorRuleset("error", "flat/stylistic-typescript-error-flavor");
350
+ index.configs.examples = [{
351
+ files: ["**/*.js"],
352
+ name: "jsdoc/examples/processor",
353
+ plugins: { examples: require_getJsdocProcessorPlugin.getJsdocProcessorPlugin() },
354
+ processor: "examples/examples"
335
355
  }, {
336
- files: ['**/*.md/*.js'],
337
- name: 'jsdoc/examples/rules',
338
- rules: {
339
- // "always" newline rule at end unlikely in sample code
340
- 'eol-last': 0,
341
- // Wouldn't generally expect example paths to resolve relative to JS file
342
- 'import/no-unresolved': 0,
343
- // Snippets likely too short to always include import/export info
344
- 'import/unambiguous': 0,
345
- 'jsdoc/require-file-overview': 0,
346
- // The end of a multiline comment would end the comment the example is in.
347
- 'jsdoc/require-jsdoc': 0,
348
- // Unlikely to have inadvertent debugging within examples
349
- 'no-console': 0,
350
- // Often wish to start `@example` code after newline; also may use
351
- // empty lines for spacing
352
- 'no-multiple-empty-lines': 0,
353
- // Many variables in examples will be `undefined`
354
- 'no-undef': 0,
355
- // Common to define variables for clarity without always using them
356
- 'no-unused-vars': 0,
357
- // See import/no-unresolved
358
- 'node/no-missing-import': 0,
359
- 'node/no-missing-require': 0,
360
- // Can generally look nicer to pad a little even if code imposes more stringency
361
- 'padded-blocks': 0
362
- }
356
+ files: ["**/*.md/*.js"],
357
+ name: "jsdoc/examples/rules",
358
+ rules: {
359
+ "eol-last": 0,
360
+ "import/no-unresolved": 0,
361
+ "import/unambiguous": 0,
362
+ "jsdoc/require-file-overview": 0,
363
+ "jsdoc/require-jsdoc": 0,
364
+ "no-console": 0,
365
+ "no-multiple-empty-lines": 0,
366
+ "no-undef": 0,
367
+ "no-unused-vars": 0,
368
+ "node/no-missing-import": 0,
369
+ "node/no-missing-require": 0,
370
+ "padded-blocks": 0
371
+ }
363
372
  }];
364
- index.configs['default-expressions'] = /** @type {import('eslint').Linter.FlatConfig[]} */[{
365
- files: ['**/*.js'],
366
- name: 'jsdoc/default-expressions/processor',
367
- plugins: {
368
- examples: (0, _getJsdocProcessorPlugin.getJsdocProcessorPlugin)({
369
- checkDefaults: true,
370
- checkParams: true,
371
- checkProperties: true
372
- })
373
- },
374
- processor: 'examples/examples'
373
+ index.configs["default-expressions"] = [{
374
+ files: ["**/*.js"],
375
+ name: "jsdoc/default-expressions/processor",
376
+ plugins: { examples: require_getJsdocProcessorPlugin.getJsdocProcessorPlugin({
377
+ checkDefaults: true,
378
+ checkParams: true,
379
+ checkProperties: true
380
+ }) },
381
+ processor: "examples/examples"
375
382
  }, {
376
- files: ['**/*.jsdoc-defaults', '**/*.jsdoc-params', '**/*.jsdoc-properties'],
377
- name: 'jsdoc/default-expressions/rules',
378
- rules: {
379
- ...index.configs.examples[1].rules,
380
- 'chai-friendly/no-unused-expressions': 0,
381
- 'no-empty-function': 0,
382
- 'no-new': 0,
383
- 'no-unused-expressions': 0,
384
- quotes: ['error', 'double'],
385
- semi: ['error', 'never'],
386
- strict: 0
387
- }
383
+ files: [
384
+ "**/*.jsdoc-defaults",
385
+ "**/*.jsdoc-params",
386
+ "**/*.jsdoc-properties"
387
+ ],
388
+ name: "jsdoc/default-expressions/rules",
389
+ rules: {
390
+ ...index.configs.examples[1].rules,
391
+ "chai-friendly/no-unused-expressions": 0,
392
+ "no-empty-function": 0,
393
+ "no-new": 0,
394
+ "no-unused-expressions": 0,
395
+ quotes: ["error", "double"],
396
+ semi: ["error", "never"],
397
+ strict: 0
398
+ }
388
399
  }];
389
- index.configs['examples-and-default-expressions'] = /** @type {import('eslint').Linter.FlatConfig[]} */[{
390
- name: 'jsdoc/examples-and-default-expressions',
391
- plugins: {
392
- examples: (0, _getJsdocProcessorPlugin.getJsdocProcessorPlugin)({
393
- checkDefaults: true,
394
- checkParams: true,
395
- checkProperties: true
396
- })
397
- }
398
- }, ...index.configs.examples.map(config => {
399
- return {
400
- ...config,
401
- plugins: {}
402
- };
403
- }), ...index.configs['default-expressions'].map(config => {
404
- return {
405
- ...config,
406
- plugins: {}
407
- };
408
- })];
409
- var _default = exports.default = index;
410
- module.exports = exports.default;
400
+ index.configs["examples-and-default-expressions"] = [
401
+ {
402
+ name: "jsdoc/examples-and-default-expressions",
403
+ plugins: { examples: require_getJsdocProcessorPlugin.getJsdocProcessorPlugin({
404
+ checkDefaults: true,
405
+ checkParams: true,
406
+ checkProperties: true
407
+ }) }
408
+ },
409
+ ...index.configs.examples.map((config) => {
410
+ return {
411
+ ...config,
412
+ plugins: {}
413
+ };
414
+ }),
415
+ ...index.configs["default-expressions"].map((config) => {
416
+ return {
417
+ ...config,
418
+ plugins: {}
419
+ };
420
+ })
421
+ ];
422
+ var src_default = index;
423
+
424
+ //#endregion
425
+ exports.default = src_default;
411
426
  //# sourceMappingURL=index.cjs.map