eslint-plugin-jsdoc 52.0.3 → 52.0.4

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 +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 +383 -398
  18. package/dist/index.cjs.map +1 -1
  19. package/dist/index.d.ts +6 -11
  20. package/dist/index.d.ts.map +1 -1
  21. package/dist/iterateJsdoc.cjs +1988 -1528
  22. package/dist/iterateJsdoc.cjs.map +1 -1
  23. package/dist/iterateJsdoc.d.ts +349 -358
  24. package/dist/iterateJsdoc.d.ts.map +1 -1
  25. package/dist/jsdocUtils.cjs +1376 -1009
  26. package/dist/jsdocUtils.cjs.map +1 -1
  27. package/dist/rules/checkAccess.cjs +36 -29
  28. package/dist/rules/checkAccess.cjs.map +1 -1
  29. package/dist/rules/checkAlignment.cjs +54 -41
  30. package/dist/rules/checkAlignment.cjs.map +1 -1
  31. package/dist/rules/checkExamples.cjs +484 -327
  32. package/dist/rules/checkExamples.cjs.map +1 -1
  33. package/dist/rules/checkIndentation.cjs +65 -50
  34. package/dist/rules/checkIndentation.cjs.map +1 -1
  35. package/dist/rules/checkLineAlignment.cjs +311 -220
  36. package/dist/rules/checkLineAlignment.cjs.map +1 -1
  37. package/dist/rules/checkParamNames.cjs +335 -227
  38. package/dist/rules/checkParamNames.cjs.map +1 -1
  39. package/dist/rules/checkPropertyNames.cjs +106 -78
  40. package/dist/rules/checkPropertyNames.cjs.map +1 -1
  41. package/dist/rules/checkSyntax.cjs +34 -21
  42. package/dist/rules/checkSyntax.cjs.map +1 -1
  43. package/dist/rules/checkTagNames.cjs +210 -188
  44. package/dist/rules/checkTagNames.cjs.map +1 -1
  45. package/dist/rules/checkTemplateNames.cjs +178 -121
  46. package/dist/rules/checkTemplateNames.cjs.map +1 -1
  47. package/dist/rules/checkTypes.cjs +385 -291
  48. package/dist/rules/checkTypes.cjs.map +1 -1
  49. package/dist/rules/checkValues.cjs +146 -100
  50. package/dist/rules/checkValues.cjs.map +1 -1
  51. package/dist/rules/convertToJsdocComments.cjs +306 -228
  52. package/dist/rules/convertToJsdocComments.cjs.map +1 -1
  53. package/dist/rules/emptyTags.cjs +72 -62
  54. package/dist/rules/emptyTags.cjs.map +1 -1
  55. package/dist/rules/implementsOnClasses.cjs +56 -36
  56. package/dist/rules/implementsOnClasses.cjs.map +1 -1
  57. package/dist/rules/importsAsDependencies.cjs +99 -62
  58. package/dist/rules/importsAsDependencies.cjs.map +1 -1
  59. package/dist/rules/informativeDocs.cjs +142 -105
  60. package/dist/rules/informativeDocs.cjs.map +1 -1
  61. package/dist/rules/linesBeforeBlock.cjs +105 -70
  62. package/dist/rules/linesBeforeBlock.cjs.map +1 -1
  63. package/dist/rules/matchDescription.cjs +222 -160
  64. package/dist/rules/matchDescription.cjs.map +1 -1
  65. package/dist/rules/matchName.cjs +128 -73
  66. package/dist/rules/matchName.cjs.map +1 -1
  67. package/dist/rules/multilineBlocks.cjs +352 -235
  68. package/dist/rules/multilineBlocks.cjs.map +1 -1
  69. package/dist/rules/noBadBlocks.cjs +86 -63
  70. package/dist/rules/noBadBlocks.cjs.map +1 -1
  71. package/dist/rules/noBlankBlockDescriptions.cjs +57 -35
  72. package/dist/rules/noBlankBlockDescriptions.cjs.map +1 -1
  73. package/dist/rules/noBlankBlocks.cjs +48 -26
  74. package/dist/rules/noBlankBlocks.cjs.map +1 -1
  75. package/dist/rules/noDefaults.cjs +79 -52
  76. package/dist/rules/noDefaults.cjs.map +1 -1
  77. package/dist/rules/noMissingSyntax.cjs +165 -115
  78. package/dist/rules/noMissingSyntax.cjs.map +1 -1
  79. package/dist/rules/noMultiAsterisks.cjs +89 -48
  80. package/dist/rules/noMultiAsterisks.cjs.map +1 -1
  81. package/dist/rules/noRestrictedSyntax.cjs +79 -45
  82. package/dist/rules/noRestrictedSyntax.cjs.map +1 -1
  83. package/dist/rules/noTypes.cjs +80 -59
  84. package/dist/rules/noTypes.cjs.map +1 -1
  85. package/dist/rules/noUndefinedTypes.cjs +388 -297
  86. package/dist/rules/noUndefinedTypes.cjs.map +1 -1
  87. package/dist/rules/requireAsteriskPrefix.cjs +159 -108
  88. package/dist/rules/requireAsteriskPrefix.cjs.map +1 -1
  89. package/dist/rules/requireDescription.cjs +129 -89
  90. package/dist/rules/requireDescription.cjs.map +1 -1
  91. package/dist/rules/requireDescriptionCompleteSentence.cjs +262 -201
  92. package/dist/rules/requireDescriptionCompleteSentence.cjs.map +1 -1
  93. package/dist/rules/requireExample.cjs +104 -73
  94. package/dist/rules/requireExample.cjs.map +1 -1
  95. package/dist/rules/requireFileOverview.cjs +129 -75
  96. package/dist/rules/requireFileOverview.cjs.map +1 -1
  97. package/dist/rules/requireHyphenBeforeParamDescription.cjs +133 -85
  98. package/dist/rules/requireHyphenBeforeParamDescription.cjs.map +1 -1
  99. package/dist/rules/requireJsdoc.cjs +557 -384
  100. package/dist/rules/requireJsdoc.cjs.map +1 -1
  101. package/dist/rules/requireParam.cjs +526 -336
  102. package/dist/rules/requireParam.cjs.map +1 -1
  103. package/dist/rules/requireParamDescription.cjs +80 -55
  104. package/dist/rules/requireParamDescription.cjs.map +1 -1
  105. package/dist/rules/requireParamName.cjs +50 -32
  106. package/dist/rules/requireParamName.cjs.map +1 -1
  107. package/dist/rules/requireParamType.cjs +80 -55
  108. package/dist/rules/requireParamType.cjs.map +1 -1
  109. package/dist/rules/requireProperty.cjs +42 -31
  110. package/dist/rules/requireProperty.cjs.map +1 -1
  111. package/dist/rules/requirePropertyDescription.cjs +25 -17
  112. package/dist/rules/requirePropertyDescription.cjs.map +1 -1
  113. package/dist/rules/requirePropertyName.cjs +25 -17
  114. package/dist/rules/requirePropertyName.cjs.map +1 -1
  115. package/dist/rules/requirePropertyType.cjs +25 -17
  116. package/dist/rules/requirePropertyType.cjs.map +1 -1
  117. package/dist/rules/requireReturns.cjs +203 -125
  118. package/dist/rules/requireReturns.cjs.map +1 -1
  119. package/dist/rules/requireReturnsCheck.cjs +103 -60
  120. package/dist/rules/requireReturnsCheck.cjs.map +1 -1
  121. package/dist/rules/requireReturnsDescription.cjs +54 -39
  122. package/dist/rules/requireReturnsDescription.cjs.map +1 -1
  123. package/dist/rules/requireReturnsType.cjs +50 -32
  124. package/dist/rules/requireReturnsType.cjs.map +1 -1
  125. package/dist/rules/requireTemplate.cjs +178 -119
  126. package/dist/rules/requireTemplate.cjs.map +1 -1
  127. package/dist/rules/requireThrows.cjs +95 -61
  128. package/dist/rules/requireThrows.cjs.map +1 -1
  129. package/dist/rules/requireYields.cjs +166 -106
  130. package/dist/rules/requireYields.cjs.map +1 -1
  131. package/dist/rules/requireYieldsCheck.cjs +152 -96
  132. package/dist/rules/requireYieldsCheck.cjs.map +1 -1
  133. package/dist/rules/sortTags.cjs +444 -258
  134. package/dist/rules/sortTags.cjs.map +1 -1
  135. package/dist/rules/tagLines.cjs +266 -179
  136. package/dist/rules/tagLines.cjs.map +1 -1
  137. package/dist/rules/textEscaping.cjs +127 -92
  138. package/dist/rules/textEscaping.cjs.map +1 -1
  139. package/dist/rules/validTypes.cjs +265 -252
  140. package/dist/rules/validTypes.cjs.map +1 -1
  141. package/dist/tagNames.cjs +170 -134
  142. package/dist/tagNames.cjs.map +1 -1
  143. package/dist/utils/hasReturnValue.cjs +474 -246
  144. package/dist/utils/hasReturnValue.cjs.map +1 -1
  145. package/package.json +24 -40
  146. package/src/WarnSettings.js +34 -0
  147. package/src/alignTransform.js +358 -0
  148. package/src/defaultTagOrder.js +169 -0
  149. package/src/exportParser.js +978 -0
  150. package/src/getDefaultTagStructureForMode.js +969 -0
  151. package/src/getJsdocProcessorPlugin.js +672 -0
  152. package/src/index.js +530 -0
  153. package/src/iterateJsdoc.js +2518 -0
  154. package/src/jsdocUtils.js +1896 -0
  155. package/src/rules/checkAccess.js +45 -0
  156. package/src/rules/checkAlignment.js +63 -0
  157. package/src/rules/checkExamples.js +589 -0
  158. package/src/rules/checkIndentation.js +75 -0
  159. package/src/rules/checkLineAlignment.js +372 -0
  160. package/src/rules/checkParamNames.js +474 -0
  161. package/src/rules/checkPropertyNames.js +152 -0
  162. package/src/rules/checkSyntax.js +30 -0
  163. package/src/rules/checkTagNames.js +314 -0
  164. package/src/rules/checkTemplateNames.js +204 -0
  165. package/src/rules/checkTypes.js +535 -0
  166. package/src/rules/checkValues.js +248 -0
  167. package/src/rules/convertToJsdocComments.js +398 -0
  168. package/src/rules/emptyTags.js +98 -0
  169. package/src/rules/implementsOnClasses.js +64 -0
  170. package/src/rules/importsAsDependencies.js +133 -0
  171. package/src/rules/informativeDocs.js +189 -0
  172. package/src/rules/linesBeforeBlock.js +134 -0
  173. package/src/rules/matchDescription.js +286 -0
  174. package/src/rules/matchName.js +151 -0
  175. package/src/rules/multilineBlocks.js +493 -0
  176. package/src/rules/noBadBlocks.js +119 -0
  177. package/src/rules/noBlankBlockDescriptions.js +69 -0
  178. package/src/rules/noBlankBlocks.js +53 -0
  179. package/src/rules/noDefaults.js +85 -0
  180. package/src/rules/noMissingSyntax.js +195 -0
  181. package/src/rules/noMultiAsterisks.js +134 -0
  182. package/src/rules/noRestrictedSyntax.js +91 -0
  183. package/src/rules/noTypes.js +93 -0
  184. package/src/rules/noUndefinedTypes.js +543 -0
  185. package/src/rules/requireAsteriskPrefix.js +190 -0
  186. package/src/rules/requireDescription.js +161 -0
  187. package/src/rules/requireDescriptionCompleteSentence.js +335 -0
  188. package/src/rules/requireExample.js +118 -0
  189. package/src/rules/requireFileOverview.js +154 -0
  190. package/src/rules/requireHyphenBeforeParamDescription.js +176 -0
  191. package/src/rules/requireJsdoc.js +743 -0
  192. package/src/rules/requireParam.js +602 -0
  193. package/src/rules/requireParamDescription.js +89 -0
  194. package/src/rules/requireParamName.js +55 -0
  195. package/src/rules/requireParamType.js +89 -0
  196. package/src/rules/requireProperty.js +48 -0
  197. package/src/rules/requirePropertyDescription.js +25 -0
  198. package/src/rules/requirePropertyName.js +25 -0
  199. package/src/rules/requirePropertyType.js +25 -0
  200. package/src/rules/requireReturns.js +238 -0
  201. package/src/rules/requireReturnsCheck.js +145 -0
  202. package/src/rules/requireReturnsDescription.js +59 -0
  203. package/src/rules/requireReturnsType.js +51 -0
  204. package/src/rules/requireTemplate.js +201 -0
  205. package/src/rules/requireThrows.js +111 -0
  206. package/src/rules/requireYields.js +216 -0
  207. package/src/rules/requireYieldsCheck.js +208 -0
  208. package/src/rules/sortTags.js +558 -0
  209. package/src/rules/tagLines.js +359 -0
  210. package/src/rules/textEscaping.js +154 -0
  211. package/src/rules/validTypes.js +401 -0
  212. package/src/tagNames.js +238 -0
  213. package/src/utils/hasReturnValue.js +572 -0
  214. package/dist/WarnSettings.js +0 -20
  215. package/dist/WarnSettings.js.map +0 -1
  216. package/dist/_virtual/rolldown_runtime.cjs +0 -32
  217. package/dist/_virtual/rolldown_runtime.js +0 -11
  218. package/dist/alignTransform.js +0 -241
  219. package/dist/alignTransform.js.map +0 -1
  220. package/dist/defaultTagOrder.js +0 -134
  221. package/dist/defaultTagOrder.js.map +0 -1
  222. package/dist/exportParser.js +0 -518
  223. package/dist/exportParser.js.map +0 -1
  224. package/dist/getDefaultTagStructureForMode.js +0 -188
  225. package/dist/getDefaultTagStructureForMode.js.map +0 -1
  226. package/dist/getJsdocProcessorPlugin.d.cts +0 -70
  227. package/dist/getJsdocProcessorPlugin.d.cts.map +0 -1
  228. package/dist/getJsdocProcessorPlugin.js +0 -383
  229. package/dist/getJsdocProcessorPlugin.js.map +0 -1
  230. package/dist/index.d.cts +0 -22
  231. package/dist/index.d.cts.map +0 -1
  232. package/dist/index.js +0 -425
  233. package/dist/index.js.map +0 -1
  234. package/dist/iterateJsdoc.d.cts +0 -471
  235. package/dist/iterateJsdoc.d.cts.map +0 -1
  236. package/dist/iterateJsdoc.js +0 -1617
  237. package/dist/iterateJsdoc.js.map +0 -1
  238. package/dist/jsdocUtils.js +0 -1123
  239. package/dist/jsdocUtils.js.map +0 -1
  240. package/dist/rules/checkAccess.js +0 -33
  241. package/dist/rules/checkAccess.js.map +0 -1
  242. package/dist/rules/checkAlignment.js +0 -47
  243. package/dist/rules/checkAlignment.js.map +0 -1
  244. package/dist/rules/checkExamples.js +0 -348
  245. package/dist/rules/checkExamples.js.map +0 -1
  246. package/dist/rules/checkIndentation.js +0 -59
  247. package/dist/rules/checkIndentation.js.map +0 -1
  248. package/dist/rules/checkLineAlignment.js +0 -229
  249. package/dist/rules/checkLineAlignment.js.map +0 -1
  250. package/dist/rules/checkParamNames.js +0 -237
  251. package/dist/rules/checkParamNames.js.map +0 -1
  252. package/dist/rules/checkPropertyNames.js +0 -88
  253. package/dist/rules/checkPropertyNames.js.map +0 -1
  254. package/dist/rules/checkSyntax.js +0 -25
  255. package/dist/rules/checkSyntax.js.map +0 -1
  256. package/dist/rules/checkTagNames.js +0 -191
  257. package/dist/rules/checkTagNames.js.map +0 -1
  258. package/dist/rules/checkTemplateNames.js +0 -124
  259. package/dist/rules/checkTemplateNames.js.map +0 -1
  260. package/dist/rules/checkTypes.js +0 -299
  261. package/dist/rules/checkTypes.js.map +0 -1
  262. package/dist/rules/checkValues.js +0 -103
  263. package/dist/rules/checkValues.js.map +0 -1
  264. package/dist/rules/convertToJsdocComments.js +0 -231
  265. package/dist/rules/convertToJsdocComments.js.map +0 -1
  266. package/dist/rules/emptyTags.js +0 -67
  267. package/dist/rules/emptyTags.js.map +0 -1
  268. package/dist/rules/implementsOnClasses.js +0 -40
  269. package/dist/rules/implementsOnClasses.js.map +0 -1
  270. package/dist/rules/importsAsDependencies.js +0 -68
  271. package/dist/rules/importsAsDependencies.js.map +0 -1
  272. package/dist/rules/informativeDocs.js +0 -110
  273. package/dist/rules/informativeDocs.js.map +0 -1
  274. package/dist/rules/linesBeforeBlock.js +0 -75
  275. package/dist/rules/linesBeforeBlock.js.map +0 -1
  276. package/dist/rules/matchDescription.js +0 -167
  277. package/dist/rules/matchDescription.js.map +0 -1
  278. package/dist/rules/matchName.js +0 -77
  279. package/dist/rules/matchName.js.map +0 -1
  280. package/dist/rules/multilineBlocks.js +0 -245
  281. package/dist/rules/multilineBlocks.js.map +0 -1
  282. package/dist/rules/noBadBlocks.js +0 -68
  283. package/dist/rules/noBadBlocks.js.map +0 -1
  284. package/dist/rules/noBlankBlockDescriptions.js +0 -41
  285. package/dist/rules/noBlankBlockDescriptions.js.map +0 -1
  286. package/dist/rules/noBlankBlocks.js +0 -30
  287. package/dist/rules/noBlankBlocks.js.map +0 -1
  288. package/dist/rules/noDefaults.js +0 -56
  289. package/dist/rules/noDefaults.js.map +0 -1
  290. package/dist/rules/noMissingSyntax.js +0 -126
  291. package/dist/rules/noMissingSyntax.js.map +0 -1
  292. package/dist/rules/noMultiAsterisks.js +0 -58
  293. package/dist/rules/noMultiAsterisks.js.map +0 -1
  294. package/dist/rules/noRestrictedSyntax.js +0 -49
  295. package/dist/rules/noRestrictedSyntax.js.map +0 -1
  296. package/dist/rules/noTypes.js +0 -65
  297. package/dist/rules/noTypes.js.map +0 -1
  298. package/dist/rules/noUndefinedTypes.js +0 -303
  299. package/dist/rules/noUndefinedTypes.js.map +0 -1
  300. package/dist/rules/requireAsteriskPrefix.js +0 -112
  301. package/dist/rules/requireAsteriskPrefix.js.map +0 -1
  302. package/dist/rules/requireDescription.js +0 -95
  303. package/dist/rules/requireDescription.js.map +0 -1
  304. package/dist/rules/requireDescriptionCompleteSentence.js +0 -220
  305. package/dist/rules/requireDescriptionCompleteSentence.js.map +0 -1
  306. package/dist/rules/requireExample.js +0 -77
  307. package/dist/rules/requireExample.js.map +0 -1
  308. package/dist/rules/requireFileOverview.js +0 -81
  309. package/dist/rules/requireFileOverview.js.map +0 -1
  310. package/dist/rules/requireHyphenBeforeParamDescription.js +0 -89
  311. package/dist/rules/requireHyphenBeforeParamDescription.js.map +0 -1
  312. package/dist/rules/requireJsdoc.js +0 -404
  313. package/dist/rules/requireJsdoc.js.map +0 -1
  314. package/dist/rules/requireParam.js +0 -344
  315. package/dist/rules/requireParam.js.map +0 -1
  316. package/dist/rules/requireParamDescription.js +0 -59
  317. package/dist/rules/requireParamDescription.js.map +0 -1
  318. package/dist/rules/requireParamName.js +0 -36
  319. package/dist/rules/requireParamName.js.map +0 -1
  320. package/dist/rules/requireParamType.js +0 -59
  321. package/dist/rules/requireParamType.js.map +0 -1
  322. package/dist/rules/requireProperty.js +0 -35
  323. package/dist/rules/requireProperty.js.map +0 -1
  324. package/dist/rules/requirePropertyDescription.js +0 -21
  325. package/dist/rules/requirePropertyDescription.js.map +0 -1
  326. package/dist/rules/requirePropertyName.js +0 -21
  327. package/dist/rules/requirePropertyName.js.map +0 -1
  328. package/dist/rules/requirePropertyType.js +0 -21
  329. package/dist/rules/requirePropertyType.js.map +0 -1
  330. package/dist/rules/requireReturns.js +0 -131
  331. package/dist/rules/requireReturns.js.map +0 -1
  332. package/dist/rules/requireReturnsCheck.js +0 -66
  333. package/dist/rules/requireReturnsCheck.js.map +0 -1
  334. package/dist/rules/requireReturnsDescription.js +0 -43
  335. package/dist/rules/requireReturnsDescription.js.map +0 -1
  336. package/dist/rules/requireReturnsType.js +0 -36
  337. package/dist/rules/requireReturnsType.js.map +0 -1
  338. package/dist/rules/requireTemplate.js +0 -122
  339. package/dist/rules/requireTemplate.js.map +0 -1
  340. package/dist/rules/requireThrows.js +0 -67
  341. package/dist/rules/requireThrows.js.map +0 -1
  342. package/dist/rules/requireYields.js +0 -115
  343. package/dist/rules/requireYields.js.map +0 -1
  344. package/dist/rules/requireYieldsCheck.js +0 -105
  345. package/dist/rules/requireYieldsCheck.js.map +0 -1
  346. package/dist/rules/sortTags.js +0 -262
  347. package/dist/rules/sortTags.js.map +0 -1
  348. package/dist/rules/tagLines.js +0 -183
  349. package/dist/rules/tagLines.js.map +0 -1
  350. package/dist/rules/textEscaping.js +0 -102
  351. package/dist/rules/textEscaping.js.map +0 -1
  352. package/dist/rules/validTypes.js +0 -259
  353. package/dist/rules/validTypes.js.map +0 -1
  354. package/dist/tagNames.js +0 -144
  355. package/dist/tagNames.js.map +0 -1
  356. package/dist/utils/hasReturnValue.js +0 -265
  357. package/dist/utils/hasReturnValue.js.map +0 -1
@@ -1,35 +1,46 @@
1
- const require_iterateJsdoc = require('../iterateJsdoc.cjs');
1
+ "use strict";
2
2
 
3
- //#region src/rules/requireProperty.js
4
- var requireProperty_default = require_iterateJsdoc.default(({ utils }) => {
5
- const propertyAssociatedTags = utils.filterTags(({ tag }) => {
6
- return ["namespace", "typedef"].includes(tag);
7
- });
8
- if (!propertyAssociatedTags.length) return;
9
- const targetTagName = utils.getPreferredTagName({ tagName: "property" });
10
- if (utils.hasATag([targetTagName])) return;
11
- for (const propertyAssociatedTag of propertyAssociatedTags) {
12
- if (![
13
- "object",
14
- "Object",
15
- "PlainObject"
16
- ].includes(propertyAssociatedTag.type)) continue;
17
- utils.reportJSDoc(`Missing JSDoc @${targetTagName}.`, null, () => {
18
- utils.addTag(targetTagName);
19
- });
20
- }
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.default = void 0;
7
+ var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
8
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
9
+ var _default = exports.default = (0, _iterateJsdoc.default)(({
10
+ utils
11
+ }) => {
12
+ const propertyAssociatedTags = utils.filterTags(({
13
+ tag
14
+ }) => {
15
+ return ['namespace', 'typedef'].includes(tag);
16
+ });
17
+ if (!propertyAssociatedTags.length) {
18
+ return;
19
+ }
20
+ const targetTagName = /** @type {string} */utils.getPreferredTagName({
21
+ tagName: 'property'
22
+ });
23
+ if (utils.hasATag([targetTagName])) {
24
+ return;
25
+ }
26
+ for (const propertyAssociatedTag of propertyAssociatedTags) {
27
+ if (!['object', 'Object', 'PlainObject'].includes(propertyAssociatedTag.type)) {
28
+ continue;
29
+ }
30
+ utils.reportJSDoc(`Missing JSDoc @${targetTagName}.`, null, () => {
31
+ utils.addTag(targetTagName);
32
+ });
33
+ }
21
34
  }, {
22
- iterateAllJsdocs: true,
23
- meta: {
24
- docs: {
25
- description: "Requires that all `@typedef` and `@namespace` tags have `@property` when their type is a plain `object`, `Object`, or `PlainObject`.",
26
- url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property.md#repos-sticky-header"
27
- },
28
- fixable: "code",
29
- type: "suggestion"
30
- }
35
+ iterateAllJsdocs: true,
36
+ meta: {
37
+ docs: {
38
+ description: 'Requires that all `@typedef` and `@namespace` tags have `@property` when their type is a plain `object`, `Object`, or `PlainObject`.',
39
+ url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property.md#repos-sticky-header'
40
+ },
41
+ fixable: 'code',
42
+ type: 'suggestion'
43
+ }
31
44
  });
32
-
33
- //#endregion
34
- exports.default = requireProperty_default;
45
+ module.exports = exports.default;
35
46
  //# sourceMappingURL=requireProperty.cjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"requireProperty.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/requireProperty.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n utils,\n}) => {\n const propertyAssociatedTags = utils.filterTags(({\n tag,\n }) => {\n return [\n 'namespace', 'typedef',\n ].includes(tag);\n });\n if (!propertyAssociatedTags.length) {\n return;\n }\n\n const targetTagName = /** @type {string} */ (utils.getPreferredTagName({\n tagName: 'property',\n }));\n\n if (utils.hasATag([\n targetTagName,\n ])) {\n return;\n }\n\n for (const propertyAssociatedTag of propertyAssociatedTags) {\n if (![\n 'object', 'Object', 'PlainObject',\n ].includes(propertyAssociatedTag.type)) {\n continue;\n }\n\n utils.reportJSDoc(`Missing JSDoc @${targetTagName}.`, null, () => {\n utils.addTag(targetTagName);\n });\n }\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Requires that all `@typedef` and `@namespace` tags have `@property` when their type is a plain `object`, `Object`, or `PlainObject`.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property.md#repos-sticky-header',\n },\n fixable: 'code',\n type: 'suggestion',\n },\n});\n"],"mappings":";;;AAEA,8BAAeA,6BAAa,CAAC,EAC3B,OACD,KAAK;CACJ,MAAM,yBAAyB,MAAM,WAAW,CAAC,EAC/C,KACD,KAAK;AACJ,SAAO,CACL,aAAa,SACd,EAAC,SAAS,IAAI;CAChB,EAAC;AACF,KAAI,CAAC,uBAAuB,OAC1B;CAGF,MAAM,gBAAuC,MAAM,oBAAoB,EACrE,SAAS,WACV,EAAC;AAEF,KAAI,MAAM,QAAQ,CAChB,aACD,EAAC,CACA;AAGF,MAAK,MAAM,yBAAyB,wBAAwB;AAC1D,MAAI,CAAC;GACH;GAAU;GAAU;EACrB,EAAC,SAAS,sBAAsB,KAAK,CACpC;EAGF,MAAM,YAAY,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC,EAAE,MAAM,MAAM;GAChE,MAAM,OAAO,cAAc;EAC5B,EAAC;CACH;AACF,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,MAAM;CACP;AACF,EAAC"}
1
+ {"version":3,"file":"requireProperty.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","_default","exports","iterateJsdoc","utils","propertyAssociatedTags","filterTags","tag","includes","length","targetTagName","getPreferredTagName","tagName","hasATag","propertyAssociatedTag","type","reportJSDoc","addTag","iterateAllJsdocs","meta","docs","description","url","fixable","module"],"sources":["../../src/rules/requireProperty.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n utils,\n}) => {\n const propertyAssociatedTags = utils.filterTags(({\n tag,\n }) => {\n return [\n 'namespace', 'typedef',\n ].includes(tag);\n });\n if (!propertyAssociatedTags.length) {\n return;\n }\n\n const targetTagName = /** @type {string} */ (utils.getPreferredTagName({\n tagName: 'property',\n }));\n\n if (utils.hasATag([\n targetTagName,\n ])) {\n return;\n }\n\n for (const propertyAssociatedTag of propertyAssociatedTags) {\n if (![\n 'object', 'Object', 'PlainObject',\n ].includes(propertyAssociatedTag.type)) {\n continue;\n }\n\n utils.reportJSDoc(`Missing JSDoc @${targetTagName}.`, null, () => {\n utils.addTag(targetTagName);\n });\n }\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Requires that all `@typedef` and `@namespace` tags have `@property` when their type is a plain `object`, `Object`, or `PlainObject`.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property.md#repos-sticky-header',\n },\n fixable: 'code',\n type: 'suggestion',\n },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,IAAAG,QAAA,GAAAC,OAAA,CAAAF,OAAA,GAE/B,IAAAG,qBAAY,EAAC,CAAC;EAC3BC;AACF,CAAC,KAAK;EACJ,MAAMC,sBAAsB,GAAGD,KAAK,CAACE,UAAU,CAAC,CAAC;IAC/CC;EACF,CAAC,KAAK;IACJ,OAAO,CACL,WAAW,EAAE,SAAS,CACvB,CAACC,QAAQ,CAACD,GAAG,CAAC;EACjB,CAAC,CAAC;EACF,IAAI,CAACF,sBAAsB,CAACI,MAAM,EAAE;IAClC;EACF;EAEA,MAAMC,aAAa,GAAG,qBAAuBN,KAAK,CAACO,mBAAmB,CAAC;IACrEC,OAAO,EAAE;EACX,CAAC,CAAE;EAEH,IAAIR,KAAK,CAACS,OAAO,CAAC,CAChBH,aAAa,CACd,CAAC,EAAE;IACF;EACF;EAEA,KAAK,MAAMI,qBAAqB,IAAIT,sBAAsB,EAAE;IAC1D,IAAI,CAAC,CACH,QAAQ,EAAE,QAAQ,EAAE,aAAa,CAClC,CAACG,QAAQ,CAACM,qBAAqB,CAACC,IAAI,CAAC,EAAE;MACtC;IACF;IAEAX,KAAK,CAACY,WAAW,CAAC,kBAAkBN,aAAa,GAAG,EAAE,IAAI,EAAE,MAAM;MAChEN,KAAK,CAACa,MAAM,CAACP,aAAa,CAAC;IAC7B,CAAC,CAAC;EACJ;AACF,CAAC,EAAE;EACDQ,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,sIAAsI;MACnJC,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfR,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAS,MAAA,CAAAtB,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}
@@ -1,21 +1,29 @@
1
- const require_iterateJsdoc = require('../iterateJsdoc.cjs');
1
+ "use strict";
2
2
 
3
- //#region src/rules/requirePropertyDescription.js
4
- var requirePropertyDescription_default = require_iterateJsdoc.default(({ report, utils }) => {
5
- utils.forEachPreferredTag("property", (jsdoc, targetTagName) => {
6
- if (!jsdoc.description.trim()) report(`Missing JSDoc @${targetTagName} "${jsdoc.name}" description.`, null, jsdoc);
7
- });
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.default = void 0;
7
+ var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
8
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
9
+ var _default = exports.default = (0, _iterateJsdoc.default)(({
10
+ report,
11
+ utils
12
+ }) => {
13
+ utils.forEachPreferredTag('property', (jsdoc, targetTagName) => {
14
+ if (!jsdoc.description.trim()) {
15
+ report(`Missing JSDoc @${targetTagName} "${jsdoc.name}" description.`, null, jsdoc);
16
+ }
17
+ });
8
18
  }, {
9
- iterateAllJsdocs: true,
10
- meta: {
11
- docs: {
12
- description: "Requires that each `@property` tag has a `description` value.",
13
- url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-description.md#repos-sticky-header"
14
- },
15
- type: "suggestion"
16
- }
19
+ iterateAllJsdocs: true,
20
+ meta: {
21
+ docs: {
22
+ description: 'Requires that each `@property` tag has a `description` value.',
23
+ url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-description.md#repos-sticky-header'
24
+ },
25
+ type: 'suggestion'
26
+ }
17
27
  });
18
-
19
- //#endregion
20
- exports.default = requirePropertyDescription_default;
28
+ module.exports = exports.default;
21
29
  //# sourceMappingURL=requirePropertyDescription.cjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"requirePropertyDescription.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/requirePropertyDescription.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n report,\n utils,\n}) => {\n utils.forEachPreferredTag('property', (jsdoc, targetTagName) => {\n if (!jsdoc.description.trim()) {\n report(\n `Missing JSDoc @${targetTagName} \"${jsdoc.name}\" description.`,\n null,\n jsdoc,\n );\n }\n });\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Requires that each `@property` tag has a `description` value.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-description.md#repos-sticky-header',\n },\n type: 'suggestion',\n },\n});\n"],"mappings":";;;AAEA,yCAAeA,6BAAa,CAAC,EAC3B,QACA,OACD,KAAK;CACJ,MAAM,oBAAoB,YAAY,CAAC,OAAO,kBAAkB;AAC9D,MAAI,CAAC,MAAM,YAAY,MAAM,EAC3B,OACE,CAAC,eAAe,EAAE,cAAc,EAAE,EAAE,MAAM,KAAK,cAAc,CAAC,EAC9D,MACA,MACD;CAEJ,EAAC;AACH,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,MAAM;CACP;AACF,EAAC"}
1
+ {"version":3,"file":"requirePropertyDescription.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","_default","exports","iterateJsdoc","report","utils","forEachPreferredTag","jsdoc","targetTagName","description","trim","name","iterateAllJsdocs","meta","docs","url","type","module"],"sources":["../../src/rules/requirePropertyDescription.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n report,\n utils,\n}) => {\n utils.forEachPreferredTag('property', (jsdoc, targetTagName) => {\n if (!jsdoc.description.trim()) {\n report(\n `Missing JSDoc @${targetTagName} \"${jsdoc.name}\" description.`,\n null,\n jsdoc,\n );\n }\n });\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Requires that each `@property` tag has a `description` value.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-description.md#repos-sticky-header',\n },\n type: 'suggestion',\n },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,IAAAG,QAAA,GAAAC,OAAA,CAAAF,OAAA,GAE/B,IAAAG,qBAAY,EAAC,CAAC;EAC3BC,MAAM;EACNC;AACF,CAAC,KAAK;EACJA,KAAK,CAACC,mBAAmB,CAAC,UAAU,EAAE,CAACC,KAAK,EAAEC,aAAa,KAAK;IAC9D,IAAI,CAACD,KAAK,CAACE,WAAW,CAACC,IAAI,CAAC,CAAC,EAAE;MAC7BN,MAAM,CACJ,kBAAkBI,aAAa,KAAKD,KAAK,CAACI,IAAI,gBAAgB,EAC9D,IAAI,EACJJ,KACF,CAAC;IACH;EACF,CAAC,CAAC;AACJ,CAAC,EAAE;EACDK,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJL,WAAW,EAAE,+DAA+D;MAC5EM,GAAG,EAAE;IACP,CAAC;IACDC,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAC,MAAA,CAAAf,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}
@@ -1,21 +1,29 @@
1
- const require_iterateJsdoc = require('../iterateJsdoc.cjs');
1
+ "use strict";
2
2
 
3
- //#region src/rules/requirePropertyName.js
4
- var requirePropertyName_default = require_iterateJsdoc.default(({ report, utils }) => {
5
- utils.forEachPreferredTag("property", (jsdoc, targetTagName) => {
6
- if (jsdoc.tag && jsdoc.name === "") report(`There must be an identifier after @${targetTagName} ${jsdoc.type === "" ? "type" : "tag"}.`, null, jsdoc);
7
- });
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.default = void 0;
7
+ var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
8
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
9
+ var _default = exports.default = (0, _iterateJsdoc.default)(({
10
+ report,
11
+ utils
12
+ }) => {
13
+ utils.forEachPreferredTag('property', (jsdoc, targetTagName) => {
14
+ if (jsdoc.tag && jsdoc.name === '') {
15
+ report(`There must be an identifier after @${targetTagName} ${jsdoc.type === '' ? 'type' : 'tag'}.`, null, jsdoc);
16
+ }
17
+ });
8
18
  }, {
9
- iterateAllJsdocs: true,
10
- meta: {
11
- docs: {
12
- description: "Requires that all function `@property` tags have names.",
13
- url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-name.md#repos-sticky-header"
14
- },
15
- type: "suggestion"
16
- }
19
+ iterateAllJsdocs: true,
20
+ meta: {
21
+ docs: {
22
+ description: 'Requires that all function `@property` tags have names.',
23
+ url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-name.md#repos-sticky-header'
24
+ },
25
+ type: 'suggestion'
26
+ }
17
27
  });
18
-
19
- //#endregion
20
- exports.default = requirePropertyName_default;
28
+ module.exports = exports.default;
21
29
  //# sourceMappingURL=requirePropertyName.cjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"requirePropertyName.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/requirePropertyName.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n report,\n utils,\n}) => {\n utils.forEachPreferredTag('property', (jsdoc, targetTagName) => {\n if (jsdoc.tag && jsdoc.name === '') {\n report(\n `There must be an identifier after @${targetTagName} ${jsdoc.type === '' ? 'type' : 'tag'}.`,\n null,\n jsdoc,\n );\n }\n });\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Requires that all function `@property` tags have names.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-name.md#repos-sticky-header',\n },\n type: 'suggestion',\n },\n});\n"],"mappings":";;;AAEA,kCAAeA,6BAAa,CAAC,EAC3B,QACA,OACD,KAAK;CACJ,MAAM,oBAAoB,YAAY,CAAC,OAAO,kBAAkB;AAC9D,MAAI,MAAM,OAAO,MAAM,SAAS,IAC9B,OACE,CAAC,mCAAmC,EAAE,cAAc,CAAC,EAAE,MAAM,SAAS,KAAK,SAAS,MAAM,CAAC,CAAC,EAC5F,MACA,MACD;CAEJ,EAAC;AACH,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,MAAM;CACP;AACF,EAAC"}
1
+ {"version":3,"file":"requirePropertyName.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","_default","exports","iterateJsdoc","report","utils","forEachPreferredTag","jsdoc","targetTagName","tag","name","type","iterateAllJsdocs","meta","docs","description","url","module"],"sources":["../../src/rules/requirePropertyName.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n report,\n utils,\n}) => {\n utils.forEachPreferredTag('property', (jsdoc, targetTagName) => {\n if (jsdoc.tag && jsdoc.name === '') {\n report(\n `There must be an identifier after @${targetTagName} ${jsdoc.type === '' ? 'type' : 'tag'}.`,\n null,\n jsdoc,\n );\n }\n });\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Requires that all function `@property` tags have names.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-name.md#repos-sticky-header',\n },\n type: 'suggestion',\n },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,IAAAG,QAAA,GAAAC,OAAA,CAAAF,OAAA,GAE/B,IAAAG,qBAAY,EAAC,CAAC;EAC3BC,MAAM;EACNC;AACF,CAAC,KAAK;EACJA,KAAK,CAACC,mBAAmB,CAAC,UAAU,EAAE,CAACC,KAAK,EAAEC,aAAa,KAAK;IAC9D,IAAID,KAAK,CAACE,GAAG,IAAIF,KAAK,CAACG,IAAI,KAAK,EAAE,EAAE;MAClCN,MAAM,CACJ,sCAAsCI,aAAa,IAAID,KAAK,CAACI,IAAI,KAAK,EAAE,GAAG,MAAM,GAAG,KAAK,GAAG,EAC5F,IAAI,EACJJ,KACF,CAAC;IACH;EACF,CAAC,CAAC;AACJ,CAAC,EAAE;EACDK,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,yDAAyD;MACtEC,GAAG,EAAE;IACP,CAAC;IACDL,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAM,MAAA,CAAAf,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}
@@ -1,21 +1,29 @@
1
- const require_iterateJsdoc = require('../iterateJsdoc.cjs');
1
+ "use strict";
2
2
 
3
- //#region src/rules/requirePropertyType.js
4
- var requirePropertyType_default = require_iterateJsdoc.default(({ report, utils }) => {
5
- utils.forEachPreferredTag("property", (jsdoc, targetTagName) => {
6
- if (!jsdoc.type) report(`Missing JSDoc @${targetTagName} "${jsdoc.name}" type.`, null, jsdoc);
7
- });
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.default = void 0;
7
+ var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
8
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
9
+ var _default = exports.default = (0, _iterateJsdoc.default)(({
10
+ report,
11
+ utils
12
+ }) => {
13
+ utils.forEachPreferredTag('property', (jsdoc, targetTagName) => {
14
+ if (!jsdoc.type) {
15
+ report(`Missing JSDoc @${targetTagName} "${jsdoc.name}" type.`, null, jsdoc);
16
+ }
17
+ });
8
18
  }, {
9
- iterateAllJsdocs: true,
10
- meta: {
11
- docs: {
12
- description: "Requires that each `@property` tag has a `type` value.",
13
- url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-type.md#repos-sticky-header"
14
- },
15
- type: "suggestion"
16
- }
19
+ iterateAllJsdocs: true,
20
+ meta: {
21
+ docs: {
22
+ description: 'Requires that each `@property` tag has a `type` value.',
23
+ url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-type.md#repos-sticky-header'
24
+ },
25
+ type: 'suggestion'
26
+ }
17
27
  });
18
-
19
- //#endregion
20
- exports.default = requirePropertyType_default;
28
+ module.exports = exports.default;
21
29
  //# sourceMappingURL=requirePropertyType.cjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"requirePropertyType.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/requirePropertyType.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n report,\n utils,\n}) => {\n utils.forEachPreferredTag('property', (jsdoc, targetTagName) => {\n if (!jsdoc.type) {\n report(\n `Missing JSDoc @${targetTagName} \"${jsdoc.name}\" type.`,\n null,\n jsdoc,\n );\n }\n });\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Requires that each `@property` tag has a `type` value.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-type.md#repos-sticky-header',\n },\n type: 'suggestion',\n },\n});\n"],"mappings":";;;AAEA,kCAAeA,6BAAa,CAAC,EAC3B,QACA,OACD,KAAK;CACJ,MAAM,oBAAoB,YAAY,CAAC,OAAO,kBAAkB;AAC9D,MAAI,CAAC,MAAM,MACT,OACE,CAAC,eAAe,EAAE,cAAc,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,EACvD,MACA,MACD;CAEJ,EAAC;AACH,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,MAAM;CACP;AACF,EAAC"}
1
+ {"version":3,"file":"requirePropertyType.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","_default","exports","iterateJsdoc","report","utils","forEachPreferredTag","jsdoc","targetTagName","type","name","iterateAllJsdocs","meta","docs","description","url","module"],"sources":["../../src/rules/requirePropertyType.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n report,\n utils,\n}) => {\n utils.forEachPreferredTag('property', (jsdoc, targetTagName) => {\n if (!jsdoc.type) {\n report(\n `Missing JSDoc @${targetTagName} \"${jsdoc.name}\" type.`,\n null,\n jsdoc,\n );\n }\n });\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Requires that each `@property` tag has a `type` value.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-type.md#repos-sticky-header',\n },\n type: 'suggestion',\n },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,IAAAG,QAAA,GAAAC,OAAA,CAAAF,OAAA,GAE/B,IAAAG,qBAAY,EAAC,CAAC;EAC3BC,MAAM;EACNC;AACF,CAAC,KAAK;EACJA,KAAK,CAACC,mBAAmB,CAAC,UAAU,EAAE,CAACC,KAAK,EAAEC,aAAa,KAAK;IAC9D,IAAI,CAACD,KAAK,CAACE,IAAI,EAAE;MACfL,MAAM,CACJ,kBAAkBI,aAAa,KAAKD,KAAK,CAACG,IAAI,SAAS,EACvD,IAAI,EACJH,KACF,CAAC;IACH;EACF,CAAC,CAAC;AACJ,CAAC,EAAE;EACDI,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,wDAAwD;MACrEC,GAAG,EAAE;IACP,CAAC;IACDN,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAO,MAAA,CAAAd,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}
@@ -1,131 +1,209 @@
1
- const require_iterateJsdoc = require('../iterateJsdoc.cjs');
2
- const require_exportParser = require('../exportParser.cjs');
1
+ "use strict";
3
2
 
4
- //#region src/rules/requireReturns.js
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.default = void 0;
7
+ var _exportParser = _interopRequireDefault(require("../exportParser.cjs"));
8
+ var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
9
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
5
10
  /**
6
- * We can skip checking for a return value, in case the documentation is inherited
7
- * or the method is either a constructor or an abstract method.
8
- *
9
- * In either of these cases the return value is optional or not defined.
10
- * @param {import('../iterateJsdoc.js').Utils} utils
11
- * a reference to the utils which are used to probe if a tag is present or not.
12
- * @returns {boolean}
13
- * true in case deep checking can be skipped; otherwise false.
14
- */
15
- const canSkip = (utils) => {
16
- return utils.hasATag([
17
- "abstract",
18
- "virtual",
19
- "class",
20
- "constructor",
21
- "type",
22
- "interface"
23
- ]) || utils.avoidDocs();
11
+ * We can skip checking for a return value, in case the documentation is inherited
12
+ * or the method is either a constructor or an abstract method.
13
+ *
14
+ * In either of these cases the return value is optional or not defined.
15
+ * @param {import('../iterateJsdoc.js').Utils} utils
16
+ * a reference to the utils which are used to probe if a tag is present or not.
17
+ * @returns {boolean}
18
+ * true in case deep checking can be skipped; otherwise false.
19
+ */
20
+ const canSkip = utils => {
21
+ return utils.hasATag([
22
+ // inheritdoc implies that all documentation is inherited
23
+ // see https://jsdoc.app/tags-inheritdoc.html
24
+ //
25
+ // Abstract methods are by definition incomplete,
26
+ // so it is not an error if it declares a return value but does not implement it.
27
+ 'abstract', 'virtual',
28
+ // Constructors do not have a return value by definition (https://jsdoc.app/tags-class.html)
29
+ // So we can bail out here, too.
30
+ 'class', 'constructor',
31
+ // Return type is specified by type in @type
32
+ 'type',
33
+ // This seems to imply a class as well
34
+ 'interface']) || utils.avoidDocs();
24
35
  };
25
- var requireReturns_default = require_iterateJsdoc.default(({ context, info: { comment }, node, report, settings, utils }) => {
26
- const { contexts, enableFixer = false, forceRequireReturn = false, forceReturnsWithAsync = false, publicOnly = false } = context.options[0] || {};
27
- if (canSkip(utils)) return;
28
- /** @type {boolean|undefined} */
29
- let forceRequireReturnContext;
30
- if (contexts) {
31
- const { foundContext } = utils.findContext(contexts, comment);
32
- if (typeof foundContext === "object") forceRequireReturnContext = foundContext.forceRequireReturn;
33
- }
34
- const tagName = utils.getPreferredTagName({ tagName: "returns" });
35
- if (!tagName) return;
36
- const tags = utils.getTags(tagName);
37
- if (tags.length > 1) report(`Found more than one @${tagName} declaration.`);
38
- const iteratingFunction = utils.isIteratingFunction();
39
- const [tag] = tags;
40
- const missingReturnTag = typeof tag === "undefined" || tag === null;
41
- const shouldReport = () => {
42
- if (!missingReturnTag) return false;
43
- if (publicOnly) {
44
- /** @type {import('./requireJsdoc.js').RequireJsdocOpts} */
45
- const opt = {
46
- ancestorsOnly: Boolean(publicOnly?.ancestorsOnly ?? false),
47
- esm: Boolean(publicOnly?.esm ?? true),
48
- initModuleExports: Boolean(publicOnly?.cjs ?? true),
49
- initWindow: Boolean(publicOnly?.window ?? false)
50
- };
51
- /* c8 ignore next -- Fallback to deprecated method */
52
- const { sourceCode = context.getSourceCode() } = context;
53
- const exported = require_exportParser.default.isUncommentedExport(node, sourceCode, opt, settings);
54
- if (!exported) return false;
55
- }
56
- if ((forceRequireReturn || forceRequireReturnContext) && (iteratingFunction || utils.isVirtualFunction())) return true;
57
- const isAsync = !iteratingFunction && utils.hasTag("async") || iteratingFunction && utils.isAsync();
58
- if (forceReturnsWithAsync && isAsync) return true;
59
- return iteratingFunction && utils.hasValueOrExecutorHasNonEmptyResolveValue(forceReturnsWithAsync);
60
- };
61
- if (shouldReport()) utils.reportJSDoc(`Missing JSDoc @${tagName} declaration.`, null, enableFixer ? () => {
62
- utils.addTag(tagName);
63
- } : null);
36
+ var _default = exports.default = (0, _iterateJsdoc.default)(({
37
+ context,
38
+ info: {
39
+ comment
40
+ },
41
+ node,
42
+ report,
43
+ settings,
44
+ utils
45
+ }) => {
46
+ const {
47
+ contexts,
48
+ enableFixer = false,
49
+ forceRequireReturn = false,
50
+ forceReturnsWithAsync = false,
51
+ publicOnly = false
52
+ } = context.options[0] || {};
53
+
54
+ // A preflight check. We do not need to run a deep check
55
+ // in case the @returns comment is optional or undefined.
56
+ if (canSkip(utils)) {
57
+ return;
58
+ }
59
+
60
+ /** @type {boolean|undefined} */
61
+ let forceRequireReturnContext;
62
+ if (contexts) {
63
+ const {
64
+ foundContext
65
+ } = utils.findContext(contexts, comment);
66
+ if (typeof foundContext === 'object') {
67
+ forceRequireReturnContext = foundContext.forceRequireReturn;
68
+ }
69
+ }
70
+ const tagName = /** @type {string} */utils.getPreferredTagName({
71
+ tagName: 'returns'
72
+ });
73
+ if (!tagName) {
74
+ return;
75
+ }
76
+ const tags = utils.getTags(tagName);
77
+ if (tags.length > 1) {
78
+ report(`Found more than one @${tagName} declaration.`);
79
+ }
80
+ const iteratingFunction = utils.isIteratingFunction();
81
+
82
+ // In case the code returns something, we expect a return value in JSDoc.
83
+ const [tag] = tags;
84
+ const missingReturnTag = typeof tag === 'undefined' || tag === null;
85
+ const shouldReport = () => {
86
+ if (!missingReturnTag) {
87
+ return false;
88
+ }
89
+ if (publicOnly) {
90
+ /** @type {import('./requireJsdoc.js').RequireJsdocOpts} */
91
+ const opt = {
92
+ ancestorsOnly: Boolean(publicOnly?.ancestorsOnly ?? false),
93
+ esm: Boolean(publicOnly?.esm ?? true),
94
+ initModuleExports: Boolean(publicOnly?.cjs ?? true),
95
+ initWindow: Boolean(publicOnly?.window ?? false)
96
+ };
97
+ /* c8 ignore next -- Fallback to deprecated method */
98
+ const {
99
+ sourceCode = context.getSourceCode()
100
+ } = context;
101
+ const exported = _exportParser.default.isUncommentedExport(/** @type {import('eslint').Rule.Node} */node, sourceCode, opt, settings);
102
+ if (!exported) {
103
+ return false;
104
+ }
105
+ }
106
+ if ((forceRequireReturn || forceRequireReturnContext) && (iteratingFunction || utils.isVirtualFunction())) {
107
+ return true;
108
+ }
109
+ const isAsync = !iteratingFunction && utils.hasTag('async') || iteratingFunction && utils.isAsync();
110
+ if (forceReturnsWithAsync && isAsync) {
111
+ return true;
112
+ }
113
+ return iteratingFunction && utils.hasValueOrExecutorHasNonEmptyResolveValue(forceReturnsWithAsync);
114
+ };
115
+ if (shouldReport()) {
116
+ utils.reportJSDoc(`Missing JSDoc @${tagName} declaration.`, null, enableFixer ? () => {
117
+ utils.addTag(tagName);
118
+ } : null);
119
+ }
64
120
  }, {
65
- contextDefaults: true,
66
- meta: {
67
- docs: {
68
- description: "Requires that returns are documented.",
69
- url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns.md#repos-sticky-header"
70
- },
71
- fixable: "code",
72
- schema: [{
73
- additionalProperties: false,
74
- properties: {
75
- checkConstructors: {
76
- default: false,
77
- type: "boolean"
78
- },
79
- checkGetters: {
80
- default: true,
81
- type: "boolean"
82
- },
83
- contexts: {
84
- items: { anyOf: [{ type: "string" }, {
85
- additionalProperties: false,
86
- properties: {
87
- comment: { type: "string" },
88
- context: { type: "string" },
89
- forceRequireReturn: { type: "boolean" }
90
- },
91
- type: "object"
92
- }] },
93
- type: "array"
94
- },
95
- enableFixer: { type: "boolean" },
96
- exemptedBy: {
97
- items: { type: "string" },
98
- type: "array"
99
- },
100
- forceRequireReturn: {
101
- default: false,
102
- type: "boolean"
103
- },
104
- forceReturnsWithAsync: {
105
- default: false,
106
- type: "boolean"
107
- },
108
- publicOnly: { oneOf: [{
109
- default: false,
110
- type: "boolean"
111
- }, {
112
- additionalProperties: false,
113
- default: {},
114
- properties: {
115
- ancestorsOnly: { type: "boolean" },
116
- cjs: { type: "boolean" },
117
- esm: { type: "boolean" },
118
- window: { type: "boolean" }
119
- },
120
- type: "object"
121
- }] }
122
- },
123
- type: "object"
124
- }],
125
- type: "suggestion"
126
- }
121
+ contextDefaults: true,
122
+ meta: {
123
+ docs: {
124
+ description: 'Requires that returns are documented.',
125
+ url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns.md#repos-sticky-header'
126
+ },
127
+ fixable: 'code',
128
+ schema: [{
129
+ additionalProperties: false,
130
+ properties: {
131
+ checkConstructors: {
132
+ default: false,
133
+ type: 'boolean'
134
+ },
135
+ checkGetters: {
136
+ default: true,
137
+ type: 'boolean'
138
+ },
139
+ contexts: {
140
+ items: {
141
+ anyOf: [{
142
+ type: 'string'
143
+ }, {
144
+ additionalProperties: false,
145
+ properties: {
146
+ comment: {
147
+ type: 'string'
148
+ },
149
+ context: {
150
+ type: 'string'
151
+ },
152
+ forceRequireReturn: {
153
+ type: 'boolean'
154
+ }
155
+ },
156
+ type: 'object'
157
+ }]
158
+ },
159
+ type: 'array'
160
+ },
161
+ enableFixer: {
162
+ type: 'boolean'
163
+ },
164
+ exemptedBy: {
165
+ items: {
166
+ type: 'string'
167
+ },
168
+ type: 'array'
169
+ },
170
+ forceRequireReturn: {
171
+ default: false,
172
+ type: 'boolean'
173
+ },
174
+ forceReturnsWithAsync: {
175
+ default: false,
176
+ type: 'boolean'
177
+ },
178
+ publicOnly: {
179
+ oneOf: [{
180
+ default: false,
181
+ type: 'boolean'
182
+ }, {
183
+ additionalProperties: false,
184
+ default: {},
185
+ properties: {
186
+ ancestorsOnly: {
187
+ type: 'boolean'
188
+ },
189
+ cjs: {
190
+ type: 'boolean'
191
+ },
192
+ esm: {
193
+ type: 'boolean'
194
+ },
195
+ window: {
196
+ type: 'boolean'
197
+ }
198
+ },
199
+ type: 'object'
200
+ }]
201
+ }
202
+ },
203
+ type: 'object'
204
+ }],
205
+ type: 'suggestion'
206
+ }
127
207
  });
128
-
129
- //#endregion
130
- exports.default = requireReturns_default;
208
+ module.exports = exports.default;
131
209
  //# sourceMappingURL=requireReturns.cjs.map