eslint-plugin-tsdoc-require-2 1.0.7 → 1.0.9

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 (346) hide show
  1. package/README.md +111 -36
  2. package/dist/internal/require-tag-factory.cjs +58 -9
  3. package/dist/internal/require-tag-factory.d.ts +5 -2
  4. package/dist/internal/require-tag-factory.d.ts.map +1 -1
  5. package/dist/internal/require-tag-factory.js +58 -9
  6. package/dist/internal/require-tag-factory.js.map +1 -1
  7. package/dist/plugin.cjs +146 -17
  8. package/dist/plugin.d.ts +2 -0
  9. package/dist/plugin.d.ts.map +1 -1
  10. package/dist/plugin.js +142 -16
  11. package/dist/plugin.js.map +1 -1
  12. package/dist/rules/require-tag-rules.cjs +121 -25
  13. package/dist/rules/require-tag-rules.d.ts +5 -30
  14. package/dist/rules/require-tag-rules.d.ts.map +1 -1
  15. package/dist/rules/require-tag-rules.js +93 -0
  16. package/dist/rules/require-tag-rules.js.map +1 -1
  17. package/dist/rules/require.cjs +59 -16
  18. package/dist/rules/require.d.ts +3 -1
  19. package/dist/rules/require.d.ts.map +1 -1
  20. package/dist/rules/require.js +59 -16
  21. package/dist/rules/require.js.map +1 -1
  22. package/dist/rules/required-tags/require-abstract.cjs +32 -0
  23. package/dist/rules/required-tags/require-abstract.d.ts +5 -0
  24. package/dist/rules/required-tags/require-abstract.d.ts.map +1 -0
  25. package/dist/rules/required-tags/require-abstract.js +30 -0
  26. package/dist/rules/required-tags/require-abstract.js.map +1 -0
  27. package/dist/rules/required-tags/require-alpha.cjs +0 -1
  28. package/dist/rules/required-tags/require-alpha.d.ts.map +1 -1
  29. package/dist/rules/required-tags/require-alpha.js +1 -2
  30. package/dist/rules/required-tags/require-alpha.js.map +1 -1
  31. package/dist/rules/required-tags/require-author.cjs +32 -0
  32. package/dist/rules/required-tags/require-author.d.ts +5 -0
  33. package/dist/rules/required-tags/require-author.d.ts.map +1 -0
  34. package/dist/rules/required-tags/require-author.js +30 -0
  35. package/dist/rules/required-tags/require-author.js.map +1 -0
  36. package/dist/rules/required-tags/require-beta.cjs +0 -1
  37. package/dist/rules/required-tags/require-beta.d.ts.map +1 -1
  38. package/dist/rules/required-tags/require-beta.js +1 -2
  39. package/dist/rules/required-tags/require-beta.js.map +1 -1
  40. package/dist/rules/required-tags/require-category.cjs +32 -0
  41. package/dist/rules/required-tags/require-category.d.ts +5 -0
  42. package/dist/rules/required-tags/require-category.d.ts.map +1 -0
  43. package/dist/rules/required-tags/require-category.js +30 -0
  44. package/dist/rules/required-tags/require-category.js.map +1 -0
  45. package/dist/rules/required-tags/require-class.cjs +32 -0
  46. package/dist/rules/required-tags/require-class.d.ts +5 -0
  47. package/dist/rules/required-tags/require-class.d.ts.map +1 -0
  48. package/dist/rules/required-tags/require-class.js +30 -0
  49. package/dist/rules/required-tags/require-class.js.map +1 -0
  50. package/dist/rules/required-tags/require-decorator.cjs +0 -1
  51. package/dist/rules/required-tags/require-decorator.d.ts.map +1 -1
  52. package/dist/rules/required-tags/require-decorator.js +1 -2
  53. package/dist/rules/required-tags/require-decorator.js.map +1 -1
  54. package/dist/rules/required-tags/require-default-value.cjs +0 -1
  55. package/dist/rules/required-tags/require-default-value.d.ts.map +1 -1
  56. package/dist/rules/required-tags/require-default-value.js +1 -2
  57. package/dist/rules/required-tags/require-default-value.js.map +1 -1
  58. package/dist/rules/required-tags/require-deprecated.cjs +0 -1
  59. package/dist/rules/required-tags/require-deprecated.d.ts.map +1 -1
  60. package/dist/rules/required-tags/require-deprecated.js +1 -2
  61. package/dist/rules/required-tags/require-deprecated.js.map +1 -1
  62. package/dist/rules/required-tags/require-document.cjs +32 -0
  63. package/dist/rules/required-tags/require-document.d.ts +5 -0
  64. package/dist/rules/required-tags/require-document.d.ts.map +1 -0
  65. package/dist/rules/required-tags/require-document.js +30 -0
  66. package/dist/rules/required-tags/require-document.js.map +1 -0
  67. package/dist/rules/required-tags/require-enum.cjs +32 -0
  68. package/dist/rules/required-tags/require-enum.d.ts +5 -0
  69. package/dist/rules/required-tags/require-enum.d.ts.map +1 -0
  70. package/dist/rules/required-tags/require-enum.js +30 -0
  71. package/dist/rules/required-tags/require-enum.js.map +1 -0
  72. package/dist/rules/required-tags/require-event-property.cjs +0 -1
  73. package/dist/rules/required-tags/require-event-property.d.ts.map +1 -1
  74. package/dist/rules/required-tags/require-event-property.js +1 -2
  75. package/dist/rules/required-tags/require-event-property.js.map +1 -1
  76. package/dist/rules/required-tags/require-event.cjs +32 -0
  77. package/dist/rules/required-tags/require-event.d.ts +5 -0
  78. package/dist/rules/required-tags/require-event.d.ts.map +1 -0
  79. package/dist/rules/required-tags/require-event.js +30 -0
  80. package/dist/rules/required-tags/require-event.js.map +1 -0
  81. package/dist/rules/required-tags/require-example.cjs +0 -1
  82. package/dist/rules/required-tags/require-example.d.ts.map +1 -1
  83. package/dist/rules/required-tags/require-example.js +1 -2
  84. package/dist/rules/required-tags/require-example.js.map +1 -1
  85. package/dist/rules/required-tags/require-expand.cjs +32 -0
  86. package/dist/rules/required-tags/require-expand.d.ts +5 -0
  87. package/dist/rules/required-tags/require-expand.d.ts.map +1 -0
  88. package/dist/rules/required-tags/require-expand.js +30 -0
  89. package/dist/rules/required-tags/require-expand.js.map +1 -0
  90. package/dist/rules/required-tags/require-experimental.cjs +0 -1
  91. package/dist/rules/required-tags/require-experimental.d.ts.map +1 -1
  92. package/dist/rules/required-tags/require-experimental.js +1 -2
  93. package/dist/rules/required-tags/require-experimental.js.map +1 -1
  94. package/dist/rules/required-tags/require-function.cjs +32 -0
  95. package/dist/rules/required-tags/require-function.d.ts +5 -0
  96. package/dist/rules/required-tags/require-function.d.ts.map +1 -0
  97. package/dist/rules/required-tags/require-function.js +30 -0
  98. package/dist/rules/required-tags/require-function.js.map +1 -0
  99. package/dist/rules/required-tags/require-group.cjs +32 -0
  100. package/dist/rules/required-tags/require-group.d.ts +5 -0
  101. package/dist/rules/required-tags/require-group.d.ts.map +1 -0
  102. package/dist/rules/required-tags/require-group.js +30 -0
  103. package/dist/rules/required-tags/require-group.js.map +1 -0
  104. package/dist/rules/required-tags/require-hidden.cjs +32 -0
  105. package/dist/rules/required-tags/require-hidden.d.ts +5 -0
  106. package/dist/rules/required-tags/require-hidden.d.ts.map +1 -0
  107. package/dist/rules/required-tags/require-hidden.js +30 -0
  108. package/dist/rules/required-tags/require-hidden.js.map +1 -0
  109. package/dist/rules/required-tags/require-hideconstructor.cjs +32 -0
  110. package/dist/rules/required-tags/require-hideconstructor.d.ts +5 -0
  111. package/dist/rules/required-tags/require-hideconstructor.d.ts.map +1 -0
  112. package/dist/rules/required-tags/require-hideconstructor.js +30 -0
  113. package/dist/rules/required-tags/require-hideconstructor.js.map +1 -0
  114. package/dist/rules/required-tags/require-ignore.cjs +32 -0
  115. package/dist/rules/required-tags/require-ignore.d.ts +5 -0
  116. package/dist/rules/required-tags/require-ignore.d.ts.map +1 -0
  117. package/dist/rules/required-tags/require-ignore.js +30 -0
  118. package/dist/rules/required-tags/require-ignore.js.map +1 -0
  119. package/dist/rules/required-tags/require-import.cjs +32 -0
  120. package/dist/rules/required-tags/require-import.d.ts +5 -0
  121. package/dist/rules/required-tags/require-import.d.ts.map +1 -0
  122. package/dist/rules/required-tags/require-import.js +30 -0
  123. package/dist/rules/required-tags/require-import.js.map +1 -0
  124. package/dist/rules/required-tags/require-include.cjs +32 -0
  125. package/dist/rules/required-tags/require-include.d.ts +5 -0
  126. package/dist/rules/required-tags/require-include.d.ts.map +1 -0
  127. package/dist/rules/required-tags/require-include.js +30 -0
  128. package/dist/rules/required-tags/require-include.js.map +1 -0
  129. package/dist/rules/required-tags/require-inherit-doc.cjs +0 -1
  130. package/dist/rules/required-tags/require-inherit-doc.d.ts.map +1 -1
  131. package/dist/rules/required-tags/require-inherit-doc.js +1 -2
  132. package/dist/rules/required-tags/require-inherit-doc.js.map +1 -1
  133. package/dist/rules/required-tags/require-inline.cjs +32 -0
  134. package/dist/rules/required-tags/require-inline.d.ts +5 -0
  135. package/dist/rules/required-tags/require-inline.d.ts.map +1 -0
  136. package/dist/rules/required-tags/require-inline.js +30 -0
  137. package/dist/rules/required-tags/require-inline.js.map +1 -0
  138. package/dist/rules/required-tags/require-interface.cjs +32 -0
  139. package/dist/rules/required-tags/require-interface.d.ts +5 -0
  140. package/dist/rules/required-tags/require-interface.d.ts.map +1 -0
  141. package/dist/rules/required-tags/require-interface.js +30 -0
  142. package/dist/rules/required-tags/require-interface.js.map +1 -0
  143. package/dist/rules/required-tags/require-internal.cjs +0 -1
  144. package/dist/rules/required-tags/require-internal.d.ts.map +1 -1
  145. package/dist/rules/required-tags/require-internal.js +1 -2
  146. package/dist/rules/required-tags/require-internal.js.map +1 -1
  147. package/dist/rules/required-tags/require-label.cjs +0 -1
  148. package/dist/rules/required-tags/require-label.d.ts.map +1 -1
  149. package/dist/rules/required-tags/require-label.js +1 -2
  150. package/dist/rules/required-tags/require-label.js.map +1 -1
  151. package/dist/rules/required-tags/require-license.cjs +32 -0
  152. package/dist/rules/required-tags/require-license.d.ts +5 -0
  153. package/dist/rules/required-tags/require-license.d.ts.map +1 -0
  154. package/dist/rules/required-tags/require-license.js +30 -0
  155. package/dist/rules/required-tags/require-license.js.map +1 -0
  156. package/dist/rules/required-tags/require-link.cjs +0 -1
  157. package/dist/rules/required-tags/require-link.d.ts.map +1 -1
  158. package/dist/rules/required-tags/require-link.js +1 -2
  159. package/dist/rules/required-tags/require-link.js.map +1 -1
  160. package/dist/rules/required-tags/require-merge-module-with.cjs +32 -0
  161. package/dist/rules/required-tags/require-merge-module-with.d.ts +5 -0
  162. package/dist/rules/required-tags/require-merge-module-with.d.ts.map +1 -0
  163. package/dist/rules/required-tags/require-merge-module-with.js +30 -0
  164. package/dist/rules/required-tags/require-merge-module-with.js.map +1 -0
  165. package/dist/rules/required-tags/require-module.cjs +32 -0
  166. package/dist/rules/required-tags/require-module.d.ts +5 -0
  167. package/dist/rules/required-tags/require-module.d.ts.map +1 -0
  168. package/dist/rules/required-tags/require-module.js +30 -0
  169. package/dist/rules/required-tags/require-module.js.map +1 -0
  170. package/dist/rules/required-tags/require-namespace.cjs +32 -0
  171. package/dist/rules/required-tags/require-namespace.d.ts +5 -0
  172. package/dist/rules/required-tags/require-namespace.d.ts.map +1 -0
  173. package/dist/rules/required-tags/require-namespace.js +30 -0
  174. package/dist/rules/required-tags/require-namespace.js.map +1 -0
  175. package/dist/rules/required-tags/require-overload.cjs +32 -0
  176. package/dist/rules/required-tags/require-overload.d.ts +5 -0
  177. package/dist/rules/required-tags/require-overload.d.ts.map +1 -0
  178. package/dist/rules/required-tags/require-overload.js +30 -0
  179. package/dist/rules/required-tags/require-overload.js.map +1 -0
  180. package/dist/rules/required-tags/require-override.cjs +0 -1
  181. package/dist/rules/required-tags/require-override.d.ts.map +1 -1
  182. package/dist/rules/required-tags/require-override.js +1 -2
  183. package/dist/rules/required-tags/require-override.js.map +1 -1
  184. package/dist/rules/required-tags/require-package-documentation.cjs +0 -1
  185. package/dist/rules/required-tags/require-package-documentation.d.ts.map +1 -1
  186. package/dist/rules/required-tags/require-package-documentation.js +1 -2
  187. package/dist/rules/required-tags/require-package-documentation.js.map +1 -1
  188. package/dist/rules/required-tags/require-param.cjs +0 -1
  189. package/dist/rules/required-tags/require-param.d.ts.map +1 -1
  190. package/dist/rules/required-tags/require-param.js +1 -2
  191. package/dist/rules/required-tags/require-param.js.map +1 -1
  192. package/dist/rules/required-tags/require-primary-export.cjs +32 -0
  193. package/dist/rules/required-tags/require-primary-export.d.ts +5 -0
  194. package/dist/rules/required-tags/require-primary-export.d.ts.map +1 -0
  195. package/dist/rules/required-tags/require-primary-export.js +30 -0
  196. package/dist/rules/required-tags/require-primary-export.js.map +1 -0
  197. package/dist/rules/required-tags/require-private-remarks.cjs +0 -1
  198. package/dist/rules/required-tags/require-private-remarks.d.ts.map +1 -1
  199. package/dist/rules/required-tags/require-private-remarks.js +1 -2
  200. package/dist/rules/required-tags/require-private-remarks.js.map +1 -1
  201. package/dist/rules/required-tags/require-private.cjs +32 -0
  202. package/dist/rules/required-tags/require-private.d.ts +5 -0
  203. package/dist/rules/required-tags/require-private.d.ts.map +1 -0
  204. package/dist/rules/required-tags/require-private.js +30 -0
  205. package/dist/rules/required-tags/require-private.js.map +1 -0
  206. package/dist/rules/required-tags/require-property.cjs +32 -0
  207. package/dist/rules/required-tags/require-property.d.ts +5 -0
  208. package/dist/rules/required-tags/require-property.d.ts.map +1 -0
  209. package/dist/rules/required-tags/require-property.js +30 -0
  210. package/dist/rules/required-tags/require-property.js.map +1 -0
  211. package/dist/rules/required-tags/require-protected.cjs +32 -0
  212. package/dist/rules/required-tags/require-protected.d.ts +5 -0
  213. package/dist/rules/required-tags/require-protected.d.ts.map +1 -0
  214. package/dist/rules/required-tags/require-protected.js +30 -0
  215. package/dist/rules/required-tags/require-protected.js.map +1 -0
  216. package/dist/rules/required-tags/require-public.cjs +0 -1
  217. package/dist/rules/required-tags/require-public.d.ts.map +1 -1
  218. package/dist/rules/required-tags/require-public.js +1 -2
  219. package/dist/rules/required-tags/require-public.js.map +1 -1
  220. package/dist/rules/required-tags/require-readonly.cjs +0 -1
  221. package/dist/rules/required-tags/require-readonly.d.ts.map +1 -1
  222. package/dist/rules/required-tags/require-readonly.js +1 -2
  223. package/dist/rules/required-tags/require-readonly.js.map +1 -1
  224. package/dist/rules/required-tags/require-remarks.cjs +0 -1
  225. package/dist/rules/required-tags/require-remarks.d.ts.map +1 -1
  226. package/dist/rules/required-tags/require-remarks.js +1 -2
  227. package/dist/rules/required-tags/require-remarks.js.map +1 -1
  228. package/dist/rules/required-tags/require-returns.cjs +0 -1
  229. package/dist/rules/required-tags/require-returns.d.ts.map +1 -1
  230. package/dist/rules/required-tags/require-returns.js +1 -2
  231. package/dist/rules/required-tags/require-returns.js.map +1 -1
  232. package/dist/rules/required-tags/require-sealed.cjs +0 -1
  233. package/dist/rules/required-tags/require-sealed.d.ts.map +1 -1
  234. package/dist/rules/required-tags/require-sealed.js +1 -2
  235. package/dist/rules/required-tags/require-sealed.js.map +1 -1
  236. package/dist/rules/required-tags/require-see.cjs +0 -1
  237. package/dist/rules/required-tags/require-see.d.ts.map +1 -1
  238. package/dist/rules/required-tags/require-see.js +1 -2
  239. package/dist/rules/required-tags/require-see.js.map +1 -1
  240. package/dist/rules/required-tags/require-since.cjs +32 -0
  241. package/dist/rules/required-tags/require-since.d.ts +5 -0
  242. package/dist/rules/required-tags/require-since.d.ts.map +1 -0
  243. package/dist/rules/required-tags/require-since.js +30 -0
  244. package/dist/rules/required-tags/require-since.js.map +1 -0
  245. package/dist/rules/required-tags/require-sort-strategy.cjs +32 -0
  246. package/dist/rules/required-tags/require-sort-strategy.d.ts +5 -0
  247. package/dist/rules/required-tags/require-sort-strategy.d.ts.map +1 -0
  248. package/dist/rules/required-tags/require-sort-strategy.js +30 -0
  249. package/dist/rules/required-tags/require-sort-strategy.js.map +1 -0
  250. package/dist/rules/required-tags/require-summary.cjs +32 -0
  251. package/dist/rules/required-tags/require-summary.d.ts +5 -0
  252. package/dist/rules/required-tags/require-summary.d.ts.map +1 -0
  253. package/dist/rules/required-tags/require-summary.js +30 -0
  254. package/dist/rules/required-tags/require-summary.js.map +1 -0
  255. package/dist/rules/required-tags/require-template.cjs +32 -0
  256. package/dist/rules/required-tags/require-template.d.ts +5 -0
  257. package/dist/rules/required-tags/require-template.d.ts.map +1 -0
  258. package/dist/rules/required-tags/require-template.js +30 -0
  259. package/dist/rules/required-tags/require-template.js.map +1 -0
  260. package/dist/rules/required-tags/require-throws.cjs +0 -1
  261. package/dist/rules/required-tags/require-throws.d.ts.map +1 -1
  262. package/dist/rules/required-tags/require-throws.js +1 -2
  263. package/dist/rules/required-tags/require-throws.js.map +1 -1
  264. package/dist/rules/required-tags/require-type-param.cjs +0 -1
  265. package/dist/rules/required-tags/require-type-param.d.ts.map +1 -1
  266. package/dist/rules/required-tags/require-type-param.js +1 -2
  267. package/dist/rules/required-tags/require-type-param.js.map +1 -1
  268. package/dist/rules/required-tags/require-use-declared-type.cjs +32 -0
  269. package/dist/rules/required-tags/require-use-declared-type.d.ts +5 -0
  270. package/dist/rules/required-tags/require-use-declared-type.d.ts.map +1 -0
  271. package/dist/rules/required-tags/require-use-declared-type.js +30 -0
  272. package/dist/rules/required-tags/require-use-declared-type.js.map +1 -0
  273. package/dist/rules/required-tags/require-virtual.cjs +0 -1
  274. package/dist/rules/required-tags/require-virtual.d.ts.map +1 -1
  275. package/dist/rules/required-tags/require-virtual.js +1 -2
  276. package/dist/rules/required-tags/require-virtual.js.map +1 -1
  277. package/dist/rules/restrict-tags.cjs +416 -0
  278. package/dist/rules/restrict-tags.d.ts +17 -0
  279. package/dist/rules/restrict-tags.d.ts.map +1 -0
  280. package/dist/rules/restrict-tags.js +414 -0
  281. package/dist/rules/restrict-tags.js.map +1 -0
  282. package/docs/rules/getting-started.md +97 -0
  283. package/docs/rules/index.md +61 -0
  284. package/docs/rules/presets/all.md +100 -0
  285. package/docs/rules/presets/detailed.md +41 -0
  286. package/docs/rules/presets/index.md +156 -0
  287. package/docs/rules/presets/jsdoc.md +43 -0
  288. package/docs/rules/presets/packages.md +41 -0
  289. package/docs/rules/presets/recommended.md +37 -0
  290. package/docs/rules/presets/tsdoc.md +45 -0
  291. package/docs/rules/presets/typedoc-strict.md +50 -0
  292. package/docs/rules/presets/typedoc.md +44 -0
  293. package/docs/rules/require.md +92 -56
  294. package/docs/rules/required-tags/require-abstract.md +87 -0
  295. package/docs/rules/required-tags/require-alpha.md +1 -1
  296. package/docs/rules/required-tags/require-author.md +87 -0
  297. package/docs/rules/required-tags/require-beta.md +1 -1
  298. package/docs/rules/required-tags/require-category.md +87 -0
  299. package/docs/rules/required-tags/require-class.md +71 -0
  300. package/docs/rules/required-tags/require-decorator.md +1 -1
  301. package/docs/rules/required-tags/require-default-value.md +1 -1
  302. package/docs/rules/required-tags/require-deprecated.md +1 -1
  303. package/docs/rules/required-tags/require-document.md +87 -0
  304. package/docs/rules/required-tags/require-enum.md +73 -0
  305. package/docs/rules/required-tags/require-event-property.md +1 -1
  306. package/docs/rules/required-tags/require-event.md +87 -0
  307. package/docs/rules/required-tags/require-example.md +1 -1
  308. package/docs/rules/required-tags/require-expand.md +87 -0
  309. package/docs/rules/required-tags/require-experimental.md +1 -1
  310. package/docs/rules/required-tags/require-function.md +74 -0
  311. package/docs/rules/required-tags/require-group.md +87 -0
  312. package/docs/rules/required-tags/require-hidden.md +87 -0
  313. package/docs/rules/required-tags/require-hideconstructor.md +87 -0
  314. package/docs/rules/required-tags/require-ignore.md +87 -0
  315. package/docs/rules/required-tags/require-import.md +87 -0
  316. package/docs/rules/required-tags/require-include.md +87 -0
  317. package/docs/rules/required-tags/require-inherit-doc.md +1 -1
  318. package/docs/rules/required-tags/require-inline.md +87 -0
  319. package/docs/rules/required-tags/require-interface.md +74 -0
  320. package/docs/rules/required-tags/require-internal.md +1 -1
  321. package/docs/rules/required-tags/require-label.md +1 -1
  322. package/docs/rules/required-tags/require-license.md +87 -0
  323. package/docs/rules/required-tags/require-link.md +1 -1
  324. package/docs/rules/required-tags/require-merge-module-with.md +87 -0
  325. package/docs/rules/required-tags/require-module.md +78 -0
  326. package/docs/rules/required-tags/require-namespace.md +87 -0
  327. package/docs/rules/required-tags/require-overload.md +87 -0
  328. package/docs/rules/required-tags/require-override.md +1 -1
  329. package/docs/rules/required-tags/require-package-documentation.md +44 -24
  330. package/docs/rules/required-tags/require-param.md +45 -25
  331. package/docs/rules/required-tags/require-primary-export.md +87 -0
  332. package/docs/rules/required-tags/require-private.md +87 -0
  333. package/docs/rules/required-tags/require-property.md +87 -0
  334. package/docs/rules/required-tags/require-protected.md +87 -0
  335. package/docs/rules/required-tags/require-remarks.md +40 -25
  336. package/docs/rules/required-tags/require-returns.md +45 -25
  337. package/docs/rules/required-tags/require-since.md +87 -0
  338. package/docs/rules/required-tags/require-sort-strategy.md +87 -0
  339. package/docs/rules/required-tags/require-summary.md +87 -0
  340. package/docs/rules/required-tags/require-template.md +87 -0
  341. package/docs/rules/required-tags/require-throws.md +53 -25
  342. package/docs/rules/required-tags/require-type-param.md +45 -25
  343. package/docs/rules/required-tags/require-use-declared-type.md +87 -0
  344. package/docs/rules/required-tags.md +171 -39
  345. package/docs/rules/restrict-tags.md +203 -0
  346. package/package.json +394 -45
@@ -0,0 +1 @@
1
+ {"version":3,"file":"require-document.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-document.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,0DAA0D;AAC1D,MAAM,mBAAmB,GAAkB,aAAa,CAGtD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC9D,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,kGAAkG;YACtG,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,oHAAoH;SAC5H;QACD,QAAQ,EAAE;YACN,UAAU,EACN,iEAAiE;SACxE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,kBAAkB;CAC3B,CAAC,CAAC;AAEH,eAAe,mBAAmB,CAAC"}
@@ -0,0 +1,32 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const require_tag_factory_js_1 = require("../../internal/require-tag-factory.cjs");
4
+ /** Rule module for `tsdoc-require-2/require-enum`. */
5
+ const RequireEnumRule = (0, require_tag_factory_js_1.createTagRule)({
6
+ create(context) {
7
+ return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@enum");
8
+ },
9
+ meta: {
10
+ defaultOptions: [
11
+ {
12
+ enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
13
+ includeNonExported: false,
14
+ },
15
+ ],
16
+ deprecated: false,
17
+ docs: {
18
+ description: "require @enum tag in TSDoc blocks for supported TypeScript declarations and default exports.",
19
+ frozen: false,
20
+ recommended: false,
21
+ url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-enum.md",
22
+ },
23
+ messages: {
24
+ missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @enum.",
25
+ },
26
+ schema: [require_tag_factory_js_1.optionSchema],
27
+ type: "problem",
28
+ },
29
+ name: "require-enum",
30
+ });
31
+ exports.default = RequireEnumRule;
32
+ //# sourceMappingURL=require-enum.js.map
@@ -0,0 +1,5 @@
1
+ import { type TagRuleModule } from "../../internal/require-tag-factory.js";
2
+ /** Rule module for `tsdoc-require-2/require-enum`. */
3
+ declare const RequireEnumRule: TagRuleModule;
4
+ export default RequireEnumRule;
5
+ //# sourceMappingURL=require-enum.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"require-enum.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-enum.ts"],"names":[],"mappings":"AAAA,OAAO,EAOH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,sDAAsD;AACtD,QAAA,MAAM,eAAe,EAAE,aA8BrB,CAAC;AAEH,eAAe,eAAe,CAAC"}
@@ -0,0 +1,30 @@
1
+ import { createRequireTagRuleListener, createTagRule, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
2
+ /** Rule module for `tsdoc-require-2/require-enum`. */
3
+ const RequireEnumRule = createTagRule({
4
+ create(context) {
5
+ return createRequireTagRuleListener(context, "@enum");
6
+ },
7
+ meta: {
8
+ defaultOptions: [
9
+ {
10
+ enforceFor: [...enforceableEntityKinds],
11
+ includeNonExported: false,
12
+ },
13
+ ],
14
+ deprecated: false,
15
+ docs: {
16
+ description: "require @enum tag in TSDoc blocks for supported TypeScript declarations and default exports.",
17
+ frozen: false,
18
+ recommended: false,
19
+ url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-enum.md",
20
+ },
21
+ messages: {
22
+ missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @enum.",
23
+ },
24
+ schema: [optionSchema],
25
+ type: "problem",
26
+ },
27
+ name: "require-enum",
28
+ });
29
+ export default RequireEnumRule;
30
+ //# sourceMappingURL=require-enum.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"require-enum.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-enum.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,sDAAsD;AACtD,MAAM,eAAe,GAAkB,aAAa,CAGlD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,8FAA8F;YAClG,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,gHAAgH;SACxH;QACD,QAAQ,EAAE;YACN,UAAU,EACN,6DAA6D;SACpE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,cAAc;CACvB,CAAC,CAAC;AAEH,eAAe,eAAe,CAAC"}
@@ -6,7 +6,6 @@ const RequireEventPropertyRule = (0, require_tag_factory_js_1.createTagRule)({
6
6
  create(context) {
7
7
  return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@eventProperty");
8
8
  },
9
- defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
10
9
  meta: {
11
10
  defaultOptions: [
12
11
  {
@@ -1 +1 @@
1
- {"version":3,"file":"require-event-property.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-event-property.ts"],"names":[],"mappings":"AAAA,OAAO,EAQH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,gEAAgE;AAChE,QAAA,MAAM,wBAAwB,EAAE,aA+B9B,CAAC;AAEH,eAAe,wBAAwB,CAAC"}
1
+ {"version":3,"file":"require-event-property.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-event-property.ts"],"names":[],"mappings":"AAAA,OAAO,EAOH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,gEAAgE;AAChE,QAAA,MAAM,wBAAwB,EAAE,aA8B9B,CAAC;AAEH,eAAe,wBAAwB,CAAC"}
@@ -1,10 +1,9 @@
1
- import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
1
+ import { createRequireTagRuleListener, createTagRule, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
2
2
  /** Rule module for `tsdoc-require-2/require-event-property`. */
3
3
  const RequireEventPropertyRule = createTagRule({
4
4
  create(context) {
5
5
  return createRequireTagRuleListener(context, "@eventProperty");
6
6
  },
7
- defaultOptions: defaultRuleOptions,
8
7
  meta: {
9
8
  defaultOptions: [
10
9
  {
@@ -1 +1 @@
1
- {"version":3,"file":"require-event-property.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-event-property.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,gEAAgE;AAChE,MAAM,wBAAwB,GAAkB,aAAa,CAG3D;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;IACnE,CAAC;IACD,cAAc,EAAE,kBAAkB;IAClC,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,6FAA6F;YACjG,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,0HAA0H;SAClI;QACD,QAAQ,EAAE;YACN,UAAU,EACN,sEAAsE;SAC7E;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,wBAAwB;CACjC,CAAC,CAAC;AAEH,eAAe,wBAAwB,CAAC"}
1
+ {"version":3,"file":"require-event-property.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-event-property.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,gEAAgE;AAChE,MAAM,wBAAwB,GAAkB,aAAa,CAG3D;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;IACnE,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,6FAA6F;YACjG,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,0HAA0H;SAClI;QACD,QAAQ,EAAE;YACN,UAAU,EACN,sEAAsE;SAC7E;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,wBAAwB;CACjC,CAAC,CAAC;AAEH,eAAe,wBAAwB,CAAC"}
@@ -0,0 +1,32 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const require_tag_factory_js_1 = require("../../internal/require-tag-factory.cjs");
4
+ /** Rule module for `tsdoc-require-2/require-event`. */
5
+ const RequireEventRule = (0, require_tag_factory_js_1.createTagRule)({
6
+ create(context) {
7
+ return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@event");
8
+ },
9
+ meta: {
10
+ defaultOptions: [
11
+ {
12
+ enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
13
+ includeNonExported: false,
14
+ },
15
+ ],
16
+ deprecated: false,
17
+ docs: {
18
+ description: "require @event tag in TSDoc blocks for supported TypeScript declarations and default exports.",
19
+ frozen: false,
20
+ recommended: false,
21
+ url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-event.md",
22
+ },
23
+ messages: {
24
+ missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @event.",
25
+ },
26
+ schema: [require_tag_factory_js_1.optionSchema],
27
+ type: "problem",
28
+ },
29
+ name: "require-event",
30
+ });
31
+ exports.default = RequireEventRule;
32
+ //# sourceMappingURL=require-event.js.map
@@ -0,0 +1,5 @@
1
+ import { type TagRuleModule } from "../../internal/require-tag-factory.js";
2
+ /** Rule module for `tsdoc-require-2/require-event`. */
3
+ declare const RequireEventRule: TagRuleModule;
4
+ export default RequireEventRule;
5
+ //# sourceMappingURL=require-event.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"require-event.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAOH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,uDAAuD;AACvD,QAAA,MAAM,gBAAgB,EAAE,aA8BtB,CAAC;AAEH,eAAe,gBAAgB,CAAC"}
@@ -0,0 +1,30 @@
1
+ import { createRequireTagRuleListener, createTagRule, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
2
+ /** Rule module for `tsdoc-require-2/require-event`. */
3
+ const RequireEventRule = createTagRule({
4
+ create(context) {
5
+ return createRequireTagRuleListener(context, "@event");
6
+ },
7
+ meta: {
8
+ defaultOptions: [
9
+ {
10
+ enforceFor: [...enforceableEntityKinds],
11
+ includeNonExported: false,
12
+ },
13
+ ],
14
+ deprecated: false,
15
+ docs: {
16
+ description: "require @event tag in TSDoc blocks for supported TypeScript declarations and default exports.",
17
+ frozen: false,
18
+ recommended: false,
19
+ url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-event.md",
20
+ },
21
+ messages: {
22
+ missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @event.",
23
+ },
24
+ schema: [optionSchema],
25
+ type: "problem",
26
+ },
27
+ name: "require-event",
28
+ });
29
+ export default RequireEventRule;
30
+ //# sourceMappingURL=require-event.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"require-event.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-event.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,uDAAuD;AACvD,MAAM,gBAAgB,GAAkB,aAAa,CAGnD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC3D,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,+FAA+F;YACnG,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,iHAAiH;SACzH;QACD,QAAQ,EAAE;YACN,UAAU,EACN,8DAA8D;SACrE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,eAAe;CACxB,CAAC,CAAC;AAEH,eAAe,gBAAgB,CAAC"}
@@ -6,7 +6,6 @@ const RequireExampleRule = (0, require_tag_factory_js_1.createTagRule)({
6
6
  create(context) {
7
7
  return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@example");
8
8
  },
9
- defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
10
9
  meta: {
11
10
  defaultOptions: [
12
11
  {
@@ -1 +1 @@
1
- {"version":3,"file":"require-example.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-example.ts"],"names":[],"mappings":"AAAA,OAAO,EAQH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,yDAAyD;AACzD,QAAA,MAAM,kBAAkB,EAAE,aA+BxB,CAAC;AAEH,eAAe,kBAAkB,CAAC"}
1
+ {"version":3,"file":"require-example.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-example.ts"],"names":[],"mappings":"AAAA,OAAO,EAOH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,yDAAyD;AACzD,QAAA,MAAM,kBAAkB,EAAE,aA8BxB,CAAC;AAEH,eAAe,kBAAkB,CAAC"}
@@ -1,10 +1,9 @@
1
- import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
1
+ import { createRequireTagRuleListener, createTagRule, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
2
2
  /** Rule module for `tsdoc-require-2/require-example`. */
3
3
  const RequireExampleRule = createTagRule({
4
4
  create(context) {
5
5
  return createRequireTagRuleListener(context, "@example");
6
6
  },
7
- defaultOptions: defaultRuleOptions,
8
7
  meta: {
9
8
  defaultOptions: [
10
9
  {
@@ -1 +1 @@
1
- {"version":3,"file":"require-example.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-example.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,yDAAyD;AACzD,MAAM,kBAAkB,GAAkB,aAAa,CAGrD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC7D,CAAC;IACD,cAAc,EAAE,kBAAkB;IAClC,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,uFAAuF;YAC3F,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,mHAAmH;SAC3H;QACD,QAAQ,EAAE;YACN,UAAU,EACN,gEAAgE;SACvE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,iBAAiB;CAC1B,CAAC,CAAC;AAEH,eAAe,kBAAkB,CAAC"}
1
+ {"version":3,"file":"require-example.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-example.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,yDAAyD;AACzD,MAAM,kBAAkB,GAAkB,aAAa,CAGrD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC7D,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,uFAAuF;YAC3F,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,mHAAmH;SAC3H;QACD,QAAQ,EAAE;YACN,UAAU,EACN,gEAAgE;SACvE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,iBAAiB;CAC1B,CAAC,CAAC;AAEH,eAAe,kBAAkB,CAAC"}
@@ -0,0 +1,32 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const require_tag_factory_js_1 = require("../../internal/require-tag-factory.cjs");
4
+ /** Rule module for `tsdoc-require-2/require-expand`. */
5
+ const RequireExpandRule = (0, require_tag_factory_js_1.createTagRule)({
6
+ create(context) {
7
+ return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@expand");
8
+ },
9
+ meta: {
10
+ defaultOptions: [
11
+ {
12
+ enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
13
+ includeNonExported: false,
14
+ },
15
+ ],
16
+ deprecated: false,
17
+ docs: {
18
+ description: "require @expand tag in TSDoc blocks for supported TypeScript declarations and default exports.",
19
+ frozen: false,
20
+ recommended: false,
21
+ url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-expand.md",
22
+ },
23
+ messages: {
24
+ missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @expand.",
25
+ },
26
+ schema: [require_tag_factory_js_1.optionSchema],
27
+ type: "problem",
28
+ },
29
+ name: "require-expand",
30
+ });
31
+ exports.default = RequireExpandRule;
32
+ //# sourceMappingURL=require-expand.js.map
@@ -0,0 +1,5 @@
1
+ import { type TagRuleModule } from "../../internal/require-tag-factory.js";
2
+ /** Rule module for `tsdoc-require-2/require-expand`. */
3
+ declare const RequireExpandRule: TagRuleModule;
4
+ export default RequireExpandRule;
5
+ //# sourceMappingURL=require-expand.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"require-expand.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-expand.ts"],"names":[],"mappings":"AAAA,OAAO,EAOH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,wDAAwD;AACxD,QAAA,MAAM,iBAAiB,EAAE,aA8BvB,CAAC;AAEH,eAAe,iBAAiB,CAAC"}
@@ -0,0 +1,30 @@
1
+ import { createRequireTagRuleListener, createTagRule, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
2
+ /** Rule module for `tsdoc-require-2/require-expand`. */
3
+ const RequireExpandRule = createTagRule({
4
+ create(context) {
5
+ return createRequireTagRuleListener(context, "@expand");
6
+ },
7
+ meta: {
8
+ defaultOptions: [
9
+ {
10
+ enforceFor: [...enforceableEntityKinds],
11
+ includeNonExported: false,
12
+ },
13
+ ],
14
+ deprecated: false,
15
+ docs: {
16
+ description: "require @expand tag in TSDoc blocks for supported TypeScript declarations and default exports.",
17
+ frozen: false,
18
+ recommended: false,
19
+ url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-expand.md",
20
+ },
21
+ messages: {
22
+ missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @expand.",
23
+ },
24
+ schema: [optionSchema],
25
+ type: "problem",
26
+ },
27
+ name: "require-expand",
28
+ });
29
+ export default RequireExpandRule;
30
+ //# sourceMappingURL=require-expand.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"require-expand.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-expand.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,wDAAwD;AACxD,MAAM,iBAAiB,GAAkB,aAAa,CAGpD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAC5D,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,gGAAgG;YACpG,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,kHAAkH;SAC1H;QACD,QAAQ,EAAE;YACN,UAAU,EACN,+DAA+D;SACtE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,gBAAgB;CACzB,CAAC,CAAC;AAEH,eAAe,iBAAiB,CAAC"}
@@ -6,7 +6,6 @@ const RequireExperimentalRule = (0, require_tag_factory_js_1.createTagRule)({
6
6
  create(context) {
7
7
  return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@experimental");
8
8
  },
9
- defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
10
9
  meta: {
11
10
  defaultOptions: [
12
11
  {
@@ -1 +1 @@
1
- {"version":3,"file":"require-experimental.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-experimental.ts"],"names":[],"mappings":"AAAA,OAAO,EAQH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,8DAA8D;AAC9D,QAAA,MAAM,uBAAuB,EAAE,aA+B7B,CAAC;AAEH,eAAe,uBAAuB,CAAC"}
1
+ {"version":3,"file":"require-experimental.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-experimental.ts"],"names":[],"mappings":"AAAA,OAAO,EAOH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,8DAA8D;AAC9D,QAAA,MAAM,uBAAuB,EAAE,aA8B7B,CAAC;AAEH,eAAe,uBAAuB,CAAC"}
@@ -1,10 +1,9 @@
1
- import { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
1
+ import { createRequireTagRuleListener, createTagRule, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
2
2
  /** Rule module for `tsdoc-require-2/require-experimental`. */
3
3
  const RequireExperimentalRule = createTagRule({
4
4
  create(context) {
5
5
  return createRequireTagRuleListener(context, "@experimental");
6
6
  },
7
- defaultOptions: defaultRuleOptions,
8
7
  meta: {
9
8
  defaultOptions: [
10
9
  {
@@ -1 +1 @@
1
- {"version":3,"file":"require-experimental.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-experimental.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,8DAA8D;AAC9D,MAAM,uBAAuB,GAAkB,aAAa,CAG1D;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IAClE,CAAC;IACD,cAAc,EAAE,kBAAkB;IAClC,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,4FAA4F;YAChG,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,wHAAwH;SAChI;QACD,QAAQ,EAAE;YACN,UAAU,EACN,qEAAqE;SAC5E;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,sBAAsB;CAC/B,CAAC,CAAC;AAEH,eAAe,uBAAuB,CAAC"}
1
+ {"version":3,"file":"require-experimental.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-experimental.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,8DAA8D;AAC9D,MAAM,uBAAuB,GAAkB,aAAa,CAG1D;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IAClE,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,4FAA4F;YAChG,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,wHAAwH;SAChI;QACD,QAAQ,EAAE;YACN,UAAU,EACN,qEAAqE;SAC5E;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,sBAAsB;CAC/B,CAAC,CAAC;AAEH,eAAe,uBAAuB,CAAC"}
@@ -0,0 +1,32 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const require_tag_factory_js_1 = require("../../internal/require-tag-factory.cjs");
4
+ /** Rule module for `tsdoc-require-2/require-function`. */
5
+ const RequireFunctionRule = (0, require_tag_factory_js_1.createTagRule)({
6
+ create(context) {
7
+ return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@function");
8
+ },
9
+ meta: {
10
+ defaultOptions: [
11
+ {
12
+ enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
13
+ includeNonExported: false,
14
+ },
15
+ ],
16
+ deprecated: false,
17
+ docs: {
18
+ description: "require @function tag in TSDoc blocks for supported TypeScript declarations and default exports.",
19
+ frozen: false,
20
+ recommended: false,
21
+ url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-function.md",
22
+ },
23
+ messages: {
24
+ missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @function.",
25
+ },
26
+ schema: [require_tag_factory_js_1.optionSchema],
27
+ type: "problem",
28
+ },
29
+ name: "require-function",
30
+ });
31
+ exports.default = RequireFunctionRule;
32
+ //# sourceMappingURL=require-function.js.map
@@ -0,0 +1,5 @@
1
+ import { type TagRuleModule } from "../../internal/require-tag-factory.js";
2
+ /** Rule module for `tsdoc-require-2/require-function`. */
3
+ declare const RequireFunctionRule: TagRuleModule;
4
+ export default RequireFunctionRule;
5
+ //# sourceMappingURL=require-function.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"require-function.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-function.ts"],"names":[],"mappings":"AAAA,OAAO,EAOH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,0DAA0D;AAC1D,QAAA,MAAM,mBAAmB,EAAE,aA8BzB,CAAC;AAEH,eAAe,mBAAmB,CAAC"}
@@ -0,0 +1,30 @@
1
+ import { createRequireTagRuleListener, createTagRule, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
2
+ /** Rule module for `tsdoc-require-2/require-function`. */
3
+ const RequireFunctionRule = createTagRule({
4
+ create(context) {
5
+ return createRequireTagRuleListener(context, "@function");
6
+ },
7
+ meta: {
8
+ defaultOptions: [
9
+ {
10
+ enforceFor: [...enforceableEntityKinds],
11
+ includeNonExported: false,
12
+ },
13
+ ],
14
+ deprecated: false,
15
+ docs: {
16
+ description: "require @function tag in TSDoc blocks for supported TypeScript declarations and default exports.",
17
+ frozen: false,
18
+ recommended: false,
19
+ url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-function.md",
20
+ },
21
+ messages: {
22
+ missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @function.",
23
+ },
24
+ schema: [optionSchema],
25
+ type: "problem",
26
+ },
27
+ name: "require-function",
28
+ });
29
+ export default RequireFunctionRule;
30
+ //# sourceMappingURL=require-function.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"require-function.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-function.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,0DAA0D;AAC1D,MAAM,mBAAmB,GAAkB,aAAa,CAGtD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC9D,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,kGAAkG;YACtG,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,oHAAoH;SAC5H;QACD,QAAQ,EAAE;YACN,UAAU,EACN,iEAAiE;SACxE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,kBAAkB;CAC3B,CAAC,CAAC;AAEH,eAAe,mBAAmB,CAAC"}
@@ -0,0 +1,32 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const require_tag_factory_js_1 = require("../../internal/require-tag-factory.cjs");
4
+ /** Rule module for `tsdoc-require-2/require-group`. */
5
+ const RequireGroupRule = (0, require_tag_factory_js_1.createTagRule)({
6
+ create(context) {
7
+ return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@group");
8
+ },
9
+ meta: {
10
+ defaultOptions: [
11
+ {
12
+ enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
13
+ includeNonExported: false,
14
+ },
15
+ ],
16
+ deprecated: false,
17
+ docs: {
18
+ description: "require @group tag in TSDoc blocks for supported TypeScript declarations and default exports.",
19
+ frozen: false,
20
+ recommended: false,
21
+ url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-group.md",
22
+ },
23
+ messages: {
24
+ missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @group.",
25
+ },
26
+ schema: [require_tag_factory_js_1.optionSchema],
27
+ type: "problem",
28
+ },
29
+ name: "require-group",
30
+ });
31
+ exports.default = RequireGroupRule;
32
+ //# sourceMappingURL=require-group.js.map
@@ -0,0 +1,5 @@
1
+ import { type TagRuleModule } from "../../internal/require-tag-factory.js";
2
+ /** Rule module for `tsdoc-require-2/require-group`. */
3
+ declare const RequireGroupRule: TagRuleModule;
4
+ export default RequireGroupRule;
5
+ //# sourceMappingURL=require-group.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"require-group.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-group.ts"],"names":[],"mappings":"AAAA,OAAO,EAOH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,uDAAuD;AACvD,QAAA,MAAM,gBAAgB,EAAE,aA8BtB,CAAC;AAEH,eAAe,gBAAgB,CAAC"}
@@ -0,0 +1,30 @@
1
+ import { createRequireTagRuleListener, createTagRule, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
2
+ /** Rule module for `tsdoc-require-2/require-group`. */
3
+ const RequireGroupRule = createTagRule({
4
+ create(context) {
5
+ return createRequireTagRuleListener(context, "@group");
6
+ },
7
+ meta: {
8
+ defaultOptions: [
9
+ {
10
+ enforceFor: [...enforceableEntityKinds],
11
+ includeNonExported: false,
12
+ },
13
+ ],
14
+ deprecated: false,
15
+ docs: {
16
+ description: "require @group tag in TSDoc blocks for supported TypeScript declarations and default exports.",
17
+ frozen: false,
18
+ recommended: false,
19
+ url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-group.md",
20
+ },
21
+ messages: {
22
+ missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @group.",
23
+ },
24
+ schema: [optionSchema],
25
+ type: "problem",
26
+ },
27
+ name: "require-group",
28
+ });
29
+ export default RequireGroupRule;
30
+ //# sourceMappingURL=require-group.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"require-group.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-group.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,uDAAuD;AACvD,MAAM,gBAAgB,GAAkB,aAAa,CAGnD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC3D,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,+FAA+F;YACnG,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,iHAAiH;SACzH;QACD,QAAQ,EAAE;YACN,UAAU,EACN,8DAA8D;SACrE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,eAAe;CACxB,CAAC,CAAC;AAEH,eAAe,gBAAgB,CAAC"}
@@ -0,0 +1,32 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const require_tag_factory_js_1 = require("../../internal/require-tag-factory.cjs");
4
+ /** Rule module for `tsdoc-require-2/require-hidden`. */
5
+ const RequireHiddenRule = (0, require_tag_factory_js_1.createTagRule)({
6
+ create(context) {
7
+ return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@hidden");
8
+ },
9
+ meta: {
10
+ defaultOptions: [
11
+ {
12
+ enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
13
+ includeNonExported: false,
14
+ },
15
+ ],
16
+ deprecated: false,
17
+ docs: {
18
+ description: "require @hidden tag in TSDoc blocks for supported TypeScript declarations and default exports.",
19
+ frozen: false,
20
+ recommended: false,
21
+ url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-hidden.md",
22
+ },
23
+ messages: {
24
+ missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @hidden.",
25
+ },
26
+ schema: [require_tag_factory_js_1.optionSchema],
27
+ type: "problem",
28
+ },
29
+ name: "require-hidden",
30
+ });
31
+ exports.default = RequireHiddenRule;
32
+ //# sourceMappingURL=require-hidden.js.map
@@ -0,0 +1,5 @@
1
+ import { type TagRuleModule } from "../../internal/require-tag-factory.js";
2
+ /** Rule module for `tsdoc-require-2/require-hidden`. */
3
+ declare const RequireHiddenRule: TagRuleModule;
4
+ export default RequireHiddenRule;
5
+ //# sourceMappingURL=require-hidden.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"require-hidden.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-hidden.ts"],"names":[],"mappings":"AAAA,OAAO,EAOH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,wDAAwD;AACxD,QAAA,MAAM,iBAAiB,EAAE,aA8BvB,CAAC;AAEH,eAAe,iBAAiB,CAAC"}
@@ -0,0 +1,30 @@
1
+ import { createRequireTagRuleListener, createTagRule, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
2
+ /** Rule module for `tsdoc-require-2/require-hidden`. */
3
+ const RequireHiddenRule = createTagRule({
4
+ create(context) {
5
+ return createRequireTagRuleListener(context, "@hidden");
6
+ },
7
+ meta: {
8
+ defaultOptions: [
9
+ {
10
+ enforceFor: [...enforceableEntityKinds],
11
+ includeNonExported: false,
12
+ },
13
+ ],
14
+ deprecated: false,
15
+ docs: {
16
+ description: "require @hidden tag in TSDoc blocks for supported TypeScript declarations and default exports.",
17
+ frozen: false,
18
+ recommended: false,
19
+ url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-hidden.md",
20
+ },
21
+ messages: {
22
+ missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @hidden.",
23
+ },
24
+ schema: [optionSchema],
25
+ type: "problem",
26
+ },
27
+ name: "require-hidden",
28
+ });
29
+ export default RequireHiddenRule;
30
+ //# sourceMappingURL=require-hidden.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"require-hidden.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-hidden.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,wDAAwD;AACxD,MAAM,iBAAiB,GAAkB,aAAa,CAGpD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAC5D,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,gGAAgG;YACpG,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,kHAAkH;SAC1H;QACD,QAAQ,EAAE;YACN,UAAU,EACN,+DAA+D;SACtE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,gBAAgB;CACzB,CAAC,CAAC;AAEH,eAAe,iBAAiB,CAAC"}
@@ -0,0 +1,32 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const require_tag_factory_js_1 = require("../../internal/require-tag-factory.cjs");
4
+ /** Rule module for `tsdoc-require-2/require-hideconstructor`. */
5
+ const RequireHideconstructorRule = (0, require_tag_factory_js_1.createTagRule)({
6
+ create(context) {
7
+ return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@hideconstructor");
8
+ },
9
+ meta: {
10
+ defaultOptions: [
11
+ {
12
+ enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
13
+ includeNonExported: false,
14
+ },
15
+ ],
16
+ deprecated: false,
17
+ docs: {
18
+ description: "require @hideconstructor tag in TSDoc blocks for supported TypeScript declarations and default exports.",
19
+ frozen: false,
20
+ recommended: false,
21
+ url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-hideconstructor.md",
22
+ },
23
+ messages: {
24
+ missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @hideconstructor.",
25
+ },
26
+ schema: [require_tag_factory_js_1.optionSchema],
27
+ type: "problem",
28
+ },
29
+ name: "require-hideconstructor",
30
+ });
31
+ exports.default = RequireHideconstructorRule;
32
+ //# sourceMappingURL=require-hideconstructor.js.map