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

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
package/README.md CHANGED
@@ -1,8 +1,23 @@
1
1
  # eslint-plugin-tsdoc-require-2
2
2
 
3
- [![CI](https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/actions/workflows/ci.yml)[![Release](https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/actions/workflows/release.yml/badge.svg)](https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/actions/workflows/release.yml)[![Codecov](https://codecov.io/gh/Nick2bad4u/eslint-plugin-tsdoc-require-2/graph/badge.svg)](https://codecov.io/gh/Nick2bad4u/eslint-plugin-tsdoc-require-2)[![npm version](https://img.shields.io/npm/v/eslint-plugin-tsdoc-require-2)](https://www.npmjs.com/package/eslint-plugin-tsdoc-require-2)[![npm downloads](https://img.shields.io/npm/dm/eslint-plugin-tsdoc-require-2)](https://www.npmjs.com/package/eslint-plugin-tsdoc-require-2)[![Node.js](https://img.shields.io/badge/node-%3E%3D20.19.0-339933?logo=node.js&logoColor=white)](https://nodejs.org/)
3
+ [![npm license.](https://flat.badgen.net/npm/license/eslint-plugin-tsdoc-require-2?color=purple)](https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/LICENSE) [![npm total downloads.](https://flat.badgen.net/npm/dt/eslint-plugin-tsdoc-require-2?color=pink)](https://www.npmjs.com/package/eslint-plugin-tsdoc-require-2) [![latest GitHub release.](https://flat.badgen.net/github/release/Nick2bad4u/eslint-plugin-tsdoc-require-2?color=cyan)](https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/releases) [![GitHub stars.](https://flat.badgen.net/github/stars/Nick2bad4u/eslint-plugin-tsdoc-require-2?color=yellow)](https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/stargazers) [![GitHub forks.](https://flat.badgen.net/github/forks/Nick2bad4u/eslint-plugin-tsdoc-require-2?color=green)](https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/forks) [![GitHub open issues.](https://flat.badgen.net/github/open-issues/Nick2bad4u/eslint-plugin-tsdoc-require-2?color=red)](https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/issues) [![codecov.](https://flat.badgen.net/codecov/github/Nick2bad4u/eslint-plugin-tsdoc-require-2?color=blue)](https://codecov.io/gh/Nick2bad4u/eslint-plugin-tsdoc-require-2)
4
4
 
5
- Require TSDoc comments and specific TSDoc tags on exported TypeScript declarations and default exports, with optional enforcement for non-exported top-level declarations.
5
+ Require TSDoc and JSDoc-style comments and documentation tags on exported
6
+ TypeScript declarations and default exports, with optional enforcement for
7
+ non-exported top-level declarations.
8
+
9
+ ## Table of contents
10
+
11
+ 1. [Installation](#installation)
12
+ 2. [Usage (Flat Config)](#usage-flat-config)
13
+ 1. [Opt into non-exported declarations](#opt-into-non-exported-declarations)
14
+ 3. [Presets](#presets)
15
+ 1. [Preset matrix](#preset-matrix)
16
+ 2. [Preset usage examples](#preset-usage-examples)
17
+ 4. [Rules](#rules)
18
+ 5. [Rule docs](#rule-docs)
19
+ 6. [License](#license)
20
+ 7. [Contributors ✨](#contributors-)
6
21
 
7
22
  ## Installation
8
23
 
@@ -12,6 +27,11 @@ npm i -D eslint-plugin-tsdoc-require-2
12
27
 
13
28
  ## Usage (Flat Config)
14
29
 
30
+ This plugin supports both TSDoc-first and JSDoc-style documentation workflows.
31
+ Use `tsdocRequire.configs.tsdoc` for stricter TSDoc conventions, or
32
+ `tsdocRequire.configs.jsdoc` for JSDoc-style function tag requirements such as
33
+ `@param`, `@returns`, and `@throws`.
34
+
15
35
  ```js
16
36
  import tsdocRequire from "eslint-plugin-tsdoc-require-2";
17
37
 
@@ -67,12 +87,82 @@ The matrix below is generated by `scripts/sync-presets-rules-matrix.mjs`.
67
87
 
68
88
  <!-- BEGIN_PRESETS_MATRIX -->
69
89
 
70
- | Preset | Rule count | Included rules | Typical use case |
71
- | --- | ---: | --- | --- |
72
- | `recommended` | 1 | `tsdoc-require-2/require` | Minimal baseline TSDoc enforcement. |
73
- | `detailed` | 2 | `tsdoc-require-2/require`, `tsdoc-require-2/require-remarks` | General code docs baseline with remarks included. |
74
- | `packages` | 3 | `tsdoc-require-2/require`, `tsdoc-require-2/require-remarks`, `tsdoc-require-2/require-package-documentation` | Library/package-focused baseline for package entry docs. |
75
- | `all` | 26 | **All plugin rules** | Enable every rule shipped by this plugin. (NOT RECOMMENDED) |
90
+ ### Preset matrix
91
+
92
+ - `Fix` legend:
93
+ - `🔧` = autofixable
94
+ - `💡` = suggestions available
95
+ - `—` = report only
96
+ - `Preset key` legend:
97
+ - [🟢](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/recommended) — [`tsdocRequire.configs.recommended`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/recommended) — Minimal baseline TSDoc enforcement.
98
+ - [🟡](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/detailed) — [`tsdocRequire.configs.detailed`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/detailed) — Require comments plus @remarks.
99
+ - [🟠](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/packages) — [`tsdocRequire.configs.packages`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/packages) — Package docs baseline with @packageDocumentation.
100
+ - [🔵](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc) — [`tsdocRequire.configs.typedoc`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc) — Conservative TypeDoc declaration-kind tags.
101
+ - [🔴](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc-strict) — [`tsdocRequire.configs["typedoc-strict"]`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc-strict) — Strict TypeDoc with module/remarks and tag restrictions.
102
+ - [🟣](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/tsdoc) — [`tsdocRequire.configs.tsdoc`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/tsdoc) — TSDoc-focused baseline with function/type tags plus tag restrictions.
103
+ - [🟦](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/jsdoc) — [`tsdocRequire.configs.jsdoc`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/jsdoc) — JSDoc-style function-tag baseline.
104
+ - [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) — [`tsdocRequire.configs.all`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) — All plugin rules. Use for audits and deliberate strictness.
105
+
106
+ | Rule | Fix | Preset key |
107
+ | --- | :---: | --- |
108
+ | [`tsdoc-require-2/require`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/require) | — | [🟢](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/recommended) [🟡](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/detailed) [🟠](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/packages) [🔵](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc) [🔴](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc-strict) [🟣](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/tsdoc) [🟦](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/jsdoc) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
109
+ | [`tsdoc-require-2/require-abstract`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-abstract) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
110
+ | [`tsdoc-require-2/require-alpha`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-alpha) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
111
+ | [`tsdoc-require-2/require-author`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-author) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
112
+ | [`tsdoc-require-2/require-beta`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-beta) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
113
+ | [`tsdoc-require-2/require-category`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-category) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
114
+ | [`tsdoc-require-2/require-class`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-class) | — | [🔵](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc) [🔴](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc-strict) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
115
+ | [`tsdoc-require-2/require-decorator`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-decorator) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
116
+ | [`tsdoc-require-2/require-default-value`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-default-value) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
117
+ | [`tsdoc-require-2/require-deprecated`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-deprecated) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
118
+ | [`tsdoc-require-2/require-document`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-document) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
119
+ | [`tsdoc-require-2/require-enum`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-enum) | — | [🔵](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc) [🔴](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc-strict) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
120
+ | [`tsdoc-require-2/require-event`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-event) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
121
+ | [`tsdoc-require-2/require-event-property`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-event-property) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
122
+ | [`tsdoc-require-2/require-example`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-example) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
123
+ | [`tsdoc-require-2/require-expand`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-expand) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
124
+ | [`tsdoc-require-2/require-experimental`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-experimental) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
125
+ | [`tsdoc-require-2/require-function`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-function) | — | [🔵](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc) [🔴](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc-strict) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
126
+ | [`tsdoc-require-2/require-group`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-group) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
127
+ | [`tsdoc-require-2/require-hidden`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-hidden) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
128
+ | [`tsdoc-require-2/require-hideconstructor`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-hideconstructor) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
129
+ | [`tsdoc-require-2/require-ignore`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-ignore) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
130
+ | [`tsdoc-require-2/require-import`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-import) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
131
+ | [`tsdoc-require-2/require-include`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-include) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
132
+ | [`tsdoc-require-2/require-inherit-doc`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-inherit-doc) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
133
+ | [`tsdoc-require-2/require-inline`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-inline) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
134
+ | [`tsdoc-require-2/require-interface`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-interface) | — | [🔵](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc) [🔴](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc-strict) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
135
+ | [`tsdoc-require-2/require-internal`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-internal) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
136
+ | [`tsdoc-require-2/require-label`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-label) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
137
+ | [`tsdoc-require-2/require-license`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-license) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
138
+ | [`tsdoc-require-2/require-link`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-link) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
139
+ | [`tsdoc-require-2/require-merge-module-with`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-merge-module-with) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
140
+ | [`tsdoc-require-2/require-module`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-module) | — | [🔴](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc-strict) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
141
+ | [`tsdoc-require-2/require-namespace`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-namespace) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
142
+ | [`tsdoc-require-2/require-overload`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-overload) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
143
+ | [`tsdoc-require-2/require-override`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-override) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
144
+ | [`tsdoc-require-2/require-package-documentation`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-package-documentation) | — | [🟠](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/packages) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
145
+ | [`tsdoc-require-2/require-param`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-param) | — | [🟣](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/tsdoc) [🟦](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/jsdoc) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
146
+ | [`tsdoc-require-2/require-primary-export`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-primary-export) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
147
+ | [`tsdoc-require-2/require-private`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-private) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
148
+ | [`tsdoc-require-2/require-private-remarks`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-private-remarks) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
149
+ | [`tsdoc-require-2/require-property`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-property) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
150
+ | [`tsdoc-require-2/require-protected`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-protected) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
151
+ | [`tsdoc-require-2/require-public`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-public) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
152
+ | [`tsdoc-require-2/require-readonly`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-readonly) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
153
+ | [`tsdoc-require-2/require-remarks`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-remarks) | — | [🟡](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/detailed) [🟠](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/packages) [🔴](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc-strict) [🟣](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/tsdoc) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
154
+ | [`tsdoc-require-2/require-returns`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-returns) | — | [🟣](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/tsdoc) [🟦](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/jsdoc) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
155
+ | [`tsdoc-require-2/require-sealed`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-sealed) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
156
+ | [`tsdoc-require-2/require-see`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-see) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
157
+ | [`tsdoc-require-2/require-since`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-since) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
158
+ | [`tsdoc-require-2/require-sort-strategy`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-sort-strategy) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
159
+ | [`tsdoc-require-2/require-summary`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-summary) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
160
+ | [`tsdoc-require-2/require-template`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-template) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
161
+ | [`tsdoc-require-2/require-throws`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-throws) | — | [🟣](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/tsdoc) [🟦](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/jsdoc) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
162
+ | [`tsdoc-require-2/require-type-param`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-type-param) | — | [🟣](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/tsdoc) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
163
+ | [`tsdoc-require-2/require-use-declared-type`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-use-declared-type) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
164
+ | [`tsdoc-require-2/require-virtual`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/required-tags/require-virtual) | — | [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
165
+ | [`tsdoc-require-2/restrict-tags`](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/restrict-tags) | — | [🔴](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/typedoc-strict) [🟣](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/tsdoc) [⚫](https://nick2bad4u.github.io/eslint-plugin-tsdoc-require-2/docs/rules/presets/all) |
76
166
 
77
167
  <!-- END_PRESETS_MATRIX -->
78
168
 
@@ -85,44 +175,29 @@ export default [
85
175
  tsdocRequire.configs.detailed,
86
176
  // or:
87
177
  // tsdocRequire.configs.packages,
178
+ // tsdocRequire.configs.tsdoc,
179
+ // tsdocRequire.configs.jsdoc,
180
+ // tsdocRequire.configs.typedoc,
181
+ // tsdocRequire.configs["typedoc-strict"],
88
182
  // tsdocRequire.configs.all,
89
183
  ];
90
184
  ```
91
185
 
186
+ `configs.typedoc` is intentionally conservative. It only enables TypeDoc-oriented
187
+ tag rules whose applicability can be inferred safely from declaration kind:
188
+ classes, enums, functions, and interfaces.
189
+
190
+ `configs["typedoc-strict"]` adds stricter constraints, including
191
+ `tsdoc-require-2/restrict-tags` to disallow TypeDoc compatibility-only block tags.
192
+
92
193
  ## Rules
93
194
 
94
195
  The table below is generated by `scripts/sync-readme-rules-table.mjs`.
95
196
 
96
197
  <!-- BEGIN_RULES_TABLE -->
97
198
 
98
- | Rule | Description | Recommended | Detailed | Packages | All |
99
- | --- | --- | :---: | :---: | :---: | :---: |
100
- | [`tsdoc-require-2/require`](./docs/rules/require.md) | require TSDoc comments for exported TypeScript declarations and default exports, with opt-in non-exported support. | ✅ | ✅ | ✅ | ✅ |
101
- | [`tsdoc-require-2/require-alpha`](./docs/rules/required-tags/require-alpha.md) | require @alpha tag in TSDoc blocks | — | — | — | ✅ |
102
- | [`tsdoc-require-2/require-beta`](./docs/rules/required-tags/require-beta.md) | require @beta tag in TSDoc blocks | — | — | — | ✅ |
103
- | [`tsdoc-require-2/require-decorator`](./docs/rules/required-tags/require-decorator.md) | require @decorator tag in TSDoc blocks | — | — | — | ✅ |
104
- | [`tsdoc-require-2/require-default-value`](./docs/rules/required-tags/require-default-value.md) | require @defaultValue tag in TSDoc blocks | — | — | — | ✅ |
105
- | [`tsdoc-require-2/require-deprecated`](./docs/rules/required-tags/require-deprecated.md) | require @deprecated tag in TSDoc blocks | — | — | — | ✅ |
106
- | [`tsdoc-require-2/require-event-property`](./docs/rules/required-tags/require-event-property.md) | require @eventProperty tag in TSDoc blocks | — | — | — | ✅ |
107
- | [`tsdoc-require-2/require-example`](./docs/rules/required-tags/require-example.md) | require @example tag in TSDoc blocks | — | — | — | ✅ |
108
- | [`tsdoc-require-2/require-experimental`](./docs/rules/required-tags/require-experimental.md) | require @experimental tag in TSDoc blocks | — | — | — | ✅ |
109
- | [`tsdoc-require-2/require-inherit-doc`](./docs/rules/required-tags/require-inherit-doc.md) | require @inheritDoc tag in TSDoc blocks | — | — | — | ✅ |
110
- | [`tsdoc-require-2/require-internal`](./docs/rules/required-tags/require-internal.md) | require @internal tag in TSDoc blocks | — | — | — | ✅ |
111
- | [`tsdoc-require-2/require-label`](./docs/rules/required-tags/require-label.md) | require @label tag in TSDoc blocks | — | — | — | ✅ |
112
- | [`tsdoc-require-2/require-link`](./docs/rules/required-tags/require-link.md) | require @link tag in TSDoc blocks | — | — | — | ✅ |
113
- | [`tsdoc-require-2/require-override`](./docs/rules/required-tags/require-override.md) | require @override tag in TSDoc blocks | — | — | — | ✅ |
114
- | [`tsdoc-require-2/require-package-documentation`](./docs/rules/required-tags/require-package-documentation.md) | require @packageDocumentation tag in TSDoc blocks | — | — | ✅ | ✅ |
115
- | [`tsdoc-require-2/require-param`](./docs/rules/required-tags/require-param.md) | require @param tag in TSDoc blocks | — | — | — | ✅ |
116
- | [`tsdoc-require-2/require-private-remarks`](./docs/rules/required-tags/require-private-remarks.md) | require @privateRemarks tag in TSDoc blocks | — | — | — | ✅ |
117
- | [`tsdoc-require-2/require-public`](./docs/rules/required-tags/require-public.md) | require @public tag in TSDoc blocks | — | — | — | ✅ |
118
- | [`tsdoc-require-2/require-readonly`](./docs/rules/required-tags/require-readonly.md) | require @readonly tag in TSDoc blocks | — | — | — | ✅ |
119
- | [`tsdoc-require-2/require-remarks`](./docs/rules/required-tags/require-remarks.md) | require @remarks tag in TSDoc blocks | — | ✅ | ✅ | ✅ |
120
- | [`tsdoc-require-2/require-returns`](./docs/rules/required-tags/require-returns.md) | require @returns tag in TSDoc blocks | — | — | — | ✅ |
121
- | [`tsdoc-require-2/require-sealed`](./docs/rules/required-tags/require-sealed.md) | require @sealed tag in TSDoc blocks | — | — | — | ✅ |
122
- | [`tsdoc-require-2/require-see`](./docs/rules/required-tags/require-see.md) | require @see tag in TSDoc blocks | — | — | — | ✅ |
123
- | [`tsdoc-require-2/require-throws`](./docs/rules/required-tags/require-throws.md) | require @throws tag in TSDoc blocks | — | — | — | ✅ |
124
- | [`tsdoc-require-2/require-type-param`](./docs/rules/required-tags/require-type-param.md) | require @typeParam tag in TSDoc blocks | — | — | — | ✅ |
125
- | [`tsdoc-require-2/require-virtual`](./docs/rules/required-tags/require-virtual.md) | require @virtual tag in TSDoc blocks | — | — | — | ✅ |
199
+ - Rule coverage by preset is documented in the [Preset matrix](#preset-matrix) above.
200
+ - For full rule documentation links, see [Rule docs](#rule-docs).
126
201
 
127
202
  <!-- END_RULES_TABLE -->
128
203
 
@@ -3,9 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.optionSchema = exports.enforceableEntityKinds = exports.defaultRuleOptions = exports.createTagRule = exports.createRequireTagRuleListener = void 0;
4
4
  const utils_1 = require("@typescript-eslint/utils");
5
5
  /** RuleCreator instance for all required-tag rules in this plugin. */
6
- const createTagRule =
7
- // eslint-disable-next-line total-functions/no-hidden-type-assertions -- RuleCreator generic is required to support plugin-specific docs.recommended metadata field.
8
- utils_1.ESLintUtils.RuleCreator((ruleName) => `https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags.md#${ruleName}`);
6
+ const createTagRule = utils_1.ESLintUtils.RuleCreator((ruleName) => `https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags.md#${ruleName}`);
9
7
  exports.createTagRule = createTagRule;
10
8
  /** Entity kinds that can be checked by this rule family. */
11
9
  const enforceableEntityKinds = [
@@ -13,6 +11,7 @@ const enforceableEntityKinds = [
13
11
  "enum",
14
12
  "function",
15
13
  "interface",
14
+ "namespace",
16
15
  "object",
17
16
  "type",
18
17
  "variable",
@@ -23,7 +22,7 @@ const defaultEnforceFor = [...enforceableEntityKinds];
23
22
  const defaultRuleOptions = [
24
23
  {
25
24
  enforceFor: defaultEnforceFor,
26
- includeNonExported: false,
25
+ exportMode: "exported",
27
26
  },
28
27
  ];
29
28
  exports.defaultRuleOptions = defaultRuleOptions;
@@ -39,15 +38,32 @@ const optionSchema = {
39
38
  type: "array",
40
39
  uniqueItems: true,
41
40
  },
41
+ exportMode: {
42
+ description: "Choose whether to check exported declarations, non-exported top-level declarations, or both.",
43
+ enum: [
44
+ "all",
45
+ "exported",
46
+ "non-exported",
47
+ ],
48
+ type: "string",
49
+ },
42
50
  includeNonExported: {
43
51
  default: false,
44
- description: "Also enforce on non-exported declarations (opt-in).",
52
+ description: 'Legacy alias for exportMode: "all". Also enforce on non-exported declarations when true.',
45
53
  type: "boolean",
46
54
  },
47
55
  },
48
56
  type: "object",
49
57
  };
50
58
  exports.optionSchema = optionSchema;
59
+ const resolveExportMode = (ruleOption) => {
60
+ if (ruleOption?.includeNonExported === true) {
61
+ return "all";
62
+ }
63
+ return ruleOption?.exportMode ?? "exported";
64
+ };
65
+ const shouldCheckExportedDeclarations = (exportMode) => exportMode === "all" || exportMode === "exported";
66
+ const shouldCheckNonExportedDeclarations = (exportMode) => exportMode === "all" || exportMode === "non-exported";
51
67
  const assertUnreachable = (value) => {
52
68
  throw new Error(`Unexpected node type: ${String(value)}`);
53
69
  };
@@ -76,11 +92,23 @@ const hasRequiredTag = (commentText, tagName) => {
76
92
  return false;
77
93
  };
78
94
  const getEntityDisplayName = (name) => name ?? "<default export>";
95
+ const isTopLevelNode = (node) => node.parent?.type === utils_1.AST_NODE_TYPES.Program;
96
+ const getModuleDeclarationName = (declaration) => {
97
+ if (declaration.id.type === utils_1.AST_NODE_TYPES.Identifier) {
98
+ return declaration.id.name;
99
+ }
100
+ if (declaration.id.type === utils_1.AST_NODE_TYPES.Literal &&
101
+ typeof declaration.id.value === "string") {
102
+ return declaration.id.value;
103
+ }
104
+ return undefined;
105
+ };
79
106
  const isSupportedDeclaration = (node) => node.type === utils_1.AST_NODE_TYPES.ClassDeclaration ||
80
107
  node.type === utils_1.AST_NODE_TYPES.FunctionDeclaration ||
81
108
  node.type === utils_1.AST_NODE_TYPES.TSDeclareFunction ||
82
109
  node.type === utils_1.AST_NODE_TYPES.TSEnumDeclaration ||
83
110
  node.type === utils_1.AST_NODE_TYPES.TSInterfaceDeclaration ||
111
+ node.type === utils_1.AST_NODE_TYPES.TSModuleDeclaration ||
84
112
  node.type === utils_1.AST_NODE_TYPES.TSTypeAliasDeclaration ||
85
113
  node.type === utils_1.AST_NODE_TYPES.VariableDeclaration;
86
114
  const isSupportedDefaultExportExpression = (node) => node.type === utils_1.AST_NODE_TYPES.ArrowFunctionExpression ||
@@ -169,6 +197,16 @@ const declarationTargets = (declaration) => {
169
197
  },
170
198
  ];
171
199
  }
200
+ if (declaration.type === utils_1.AST_NODE_TYPES.TSModuleDeclaration) {
201
+ return [
202
+ {
203
+ commentNode: declaration,
204
+ kind: "namespace",
205
+ name: getModuleDeclarationName(declaration),
206
+ reportNode: declaration,
207
+ },
208
+ ];
209
+ }
172
210
  if (declaration.type === utils_1.AST_NODE_TYPES.TSTypeAliasDeclaration) {
173
211
  return [
174
212
  {
@@ -214,7 +252,7 @@ const createRequireTagRuleListener = (context, requiredTag) => {
214
252
  const sourceCode = context.sourceCode;
215
253
  const ruleOption = context.options.at(0);
216
254
  const enabledKinds = new Set(ruleOption?.enforceFor ?? defaultEnforceFor);
217
- const includeNonExported = ruleOption?.includeNonExported ?? false;
255
+ const exportMode = resolveExportMode(ruleOption);
218
256
  const checkTarget = (target) => {
219
257
  if (!enabledKinds.has(target.kind)) {
220
258
  return;
@@ -262,6 +300,10 @@ const createRequireTagRuleListener = (context, requiredTag) => {
262
300
  };
263
301
  return {
264
302
  ExportDefaultDeclaration(exportNode) {
303
+ if (!shouldCheckExportedDeclarations(exportMode) ||
304
+ !isTopLevelNode(exportNode)) {
305
+ return;
306
+ }
265
307
  const { declaration } = exportNode;
266
308
  if (declaration.type === utils_1.AST_NODE_TYPES.Identifier) {
267
309
  checkIdentifierExport(declaration);
@@ -281,6 +323,10 @@ const createRequireTagRuleListener = (context, requiredTag) => {
281
323
  }
282
324
  },
283
325
  ExportNamedDeclaration(exportNode) {
326
+ if (!shouldCheckExportedDeclarations(exportMode) ||
327
+ !isTopLevelNode(exportNode)) {
328
+ return;
329
+ }
284
330
  if (exportNode.declaration !== null &&
285
331
  isSupportedDeclaration(exportNode.declaration)) {
286
332
  checkDeclarationWithExportComment(exportNode.declaration, exportNode);
@@ -299,16 +345,19 @@ const createRequireTagRuleListener = (context, requiredTag) => {
299
345
  declarationsByName.clear();
300
346
  checkedTargets.clear();
301
347
  for (const statement of programNode.body) {
302
- if (includeNonExported && isSupportedDeclaration(statement)) {
348
+ if (shouldCheckNonExportedDeclarations(exportMode) &&
349
+ isSupportedDeclaration(statement)) {
303
350
  for (const target of declarationTargetsWithCommentNode(statement, statement)) {
304
351
  checkTarget(target);
305
352
  }
306
353
  }
307
- if (isSupportedDeclaration(statement)) {
354
+ if (shouldCheckExportedDeclarations(exportMode) &&
355
+ isSupportedDeclaration(statement)) {
308
356
  trackDeclarationTargets(statement);
309
357
  continue;
310
358
  }
311
- if (statement.type === utils_1.AST_NODE_TYPES.ExportNamedDeclaration &&
359
+ if (shouldCheckExportedDeclarations(exportMode) &&
360
+ statement.type === utils_1.AST_NODE_TYPES.ExportNamedDeclaration &&
312
361
  statement.declaration !== null &&
313
362
  isSupportedDeclaration(statement.declaration)) {
314
363
  trackDeclarationTargets(statement.declaration);
@@ -1,7 +1,9 @@
1
1
  import type { JSONSchema, TSESLint } from "@typescript-eslint/utils";
2
2
  import { ESLintUtils } from "@typescript-eslint/utils";
3
3
  /** Supported declaration kinds enforced by require/required-tag rules. */
4
- type EntityKind = "class" | "enum" | "function" | "interface" | "object" | "type" | "variable";
4
+ type EntityKind = "class" | "enum" | "function" | "interface" | "namespace" | "object" | "type" | "variable";
5
+ /** Export targeting modes supported by shared require-tag rules. */
6
+ type ExportMode = "all" | "exported" | "non-exported";
5
7
  /** Extra docs metadata shape used by this plugin's RuleCreator. */
6
8
  type RuleDocs = {
7
9
  recommended: boolean;
@@ -15,6 +17,7 @@ declare const createTagRule: ReturnType<typeof ESLintUtils.RuleCreator<RuleDocs>
15
17
  /** Shared options supported by required-tag rules. */
16
18
  type RuleOption = {
17
19
  enforceFor?: readonly EntityKind[];
20
+ exportMode?: ExportMode;
18
21
  includeNonExported?: boolean;
19
22
  };
20
23
  /** Metadata describing an individual required-tag rule. */
@@ -41,6 +44,6 @@ declare const optionSchema: JSONSchema.JSONSchema4;
41
44
  * @returns Rule listener object for ESLint traversal.
42
45
  */
43
46
  declare const createRequireTagRuleListener: (context: Readonly<TSESLint.RuleContext<TagRuleMessageIds, TagRuleOptions>>, requiredTag: `@${string}`) => TSESLint.RuleListener;
44
- export type { EntityKind, RuleDocs, RuleOption, TagRuleContext, TagRuleDefinition, TagRuleMessageIds, TagRuleModule, TagRuleOptions, };
47
+ export type { EntityKind, ExportMode, RuleDocs, RuleOption, TagRuleContext, TagRuleDefinition, TagRuleMessageIds, TagRuleModule, TagRuleOptions, };
45
48
  export { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, };
46
49
  //# sourceMappingURL=require-tag-factory.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"require-tag-factory.d.ts","sourceRoot":"","sources":["../../src/internal/require-tag-factory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAY,MAAM,0BAA0B,CAAC;AAE/E,OAAO,EAGH,WAAW,EACd,MAAM,0BAA0B,CAAC;AAElC,0EAA0E;AAC1E,KAAK,UAAU,GACT,OAAO,GACP,MAAM,GACN,UAAU,GACV,WAAW,GACX,QAAQ,GACR,MAAM,GACN,UAAU,CAAC;AAEjB,mEAAmE;AACnE,KAAK,QAAQ,GAAG;IACZ,WAAW,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF,sEAAsE;AACtE,KAAK,cAAc,GAAG,QAAQ,CAC1B,QAAQ,CAAC,WAAW,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAC1D,CAAC;AAEF,qEAAqE;AACrE,KAAK,aAAa,GAAG,WAAW,CAAC,UAAU,CACvC,iBAAiB,EACjB,cAAc,EACd,QAAQ,CACX,CAAC;AAEF,sEAAsE;AACtE,QAAA,MAAM,aAAa,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,CAKnE,CAAC;AAEN,sDAAsD;AACtD,KAAK,UAAU,GAAG;IACd,UAAU,CAAC,EAAE,SAAS,UAAU,EAAE,CAAC;IACnC,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC,CAAC;AAiBF,2DAA2D;AAC3D,KAAK,iBAAiB,GAAG;IACrB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,IAAI,MAAM,EAAE,CAAC;CAClC,CAAC;AAEF,6DAA6D;AAC7D,KAAK,iBAAiB,GAAG,YAAY,CAAC;AAEtC,kEAAkE;AAClE,KAAK,cAAc,GAAG,CAAC,UAAU,CAAC,CAAC;AASnC,4DAA4D;AAC5D,QAAA,MAAM,sBAAsB,EAAE,SAAS,UAAU,EAQhD,CAAC;AAIF,mDAAmD;AACnD,QAAA,MAAM,kBAAkB,EAAE,cAKzB,CAAC;AAEF,+DAA+D;AAC/D,QAAA,MAAM,YAAY,EAAE,UAAU,CAAC,WAkB9B,CAAC;AAoNF;;;;;;;GAOG;AACH,QAAA,MAAM,4BAA4B,GAC9B,SAAS,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC,EAC1E,aAAa,IAAI,MAAM,EAAE,KAC1B,QAAQ,CAAC,YA2JX,CAAC;AAEF,YAAY,EACR,UAAU,EACV,QAAQ,EACR,UAAU,EACV,cAAc,EACd,iBAAiB,EACjB,iBAAiB,EACjB,aAAa,EACb,cAAc,GACjB,CAAC;AACF,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GACf,CAAC"}
1
+ {"version":3,"file":"require-tag-factory.d.ts","sourceRoot":"","sources":["../../src/internal/require-tag-factory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAY,MAAM,0BAA0B,CAAC;AAE/E,OAAO,EAGH,WAAW,EACd,MAAM,0BAA0B,CAAC;AAElC,0EAA0E;AAC1E,KAAK,UAAU,GACT,OAAO,GACP,MAAM,GACN,UAAU,GACV,WAAW,GACX,WAAW,GACX,QAAQ,GACR,MAAM,GACN,UAAU,CAAC;AAEjB,oEAAoE;AACpE,KAAK,UAAU,GAAG,KAAK,GAAG,UAAU,GAAG,cAAc,CAAC;AAEtD,mEAAmE;AACnE,KAAK,QAAQ,GAAG;IACZ,WAAW,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF,sEAAsE;AACtE,KAAK,cAAc,GAAG,QAAQ,CAC1B,QAAQ,CAAC,WAAW,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAC1D,CAAC;AAEF,qEAAqE;AACrE,KAAK,aAAa,GAAG,WAAW,CAAC,UAAU,CACvC,iBAAiB,EACjB,cAAc,EACd,QAAQ,CACX,CAAC;AAEF,sEAAsE;AACtE,QAAA,MAAM,aAAa,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,CAInE,CAAC;AAEN,sDAAsD;AACtD,KAAK,UAAU,GAAG;IACd,UAAU,CAAC,EAAE,SAAS,UAAU,EAAE,CAAC;IACnC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC,CAAC;AAkBF,2DAA2D;AAC3D,KAAK,iBAAiB,GAAG;IACrB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,IAAI,MAAM,EAAE,CAAC;CAClC,CAAC;AAEF,6DAA6D;AAC7D,KAAK,iBAAiB,GAAG,YAAY,CAAC;AAEtC,kEAAkE;AAClE,KAAK,cAAc,GAAG,CAAC,UAAU,CAAC,CAAC;AASnC,4DAA4D;AAC5D,QAAA,MAAM,sBAAsB,EAAE,SAAS,UAAU,EAShD,CAAC;AAIF,mDAAmD;AACnD,QAAA,MAAM,kBAAkB,EAAE,cAKzB,CAAC;AAEF,+DAA+D;AAC/D,QAAA,MAAM,YAAY,EAAE,UAAU,CAAC,WA6B9B,CAAC;AAoQF;;;;;;;GAOG;AACH,QAAA,MAAM,4BAA4B,GAC9B,SAAS,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC,EAC1E,aAAa,IAAI,MAAM,EAAE,KAC1B,QAAQ,CAAC,YAiLX,CAAC;AAEF,YAAY,EACR,UAAU,EACV,UAAU,EACV,QAAQ,EACR,UAAU,EACV,cAAc,EACd,iBAAiB,EACjB,iBAAiB,EACjB,aAAa,EACb,cAAc,GACjB,CAAC;AACF,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GACf,CAAC"}
@@ -1,14 +1,13 @@
1
1
  import { AST_NODE_TYPES, AST_TOKEN_TYPES, ESLintUtils, } from "@typescript-eslint/utils";
2
2
  /** RuleCreator instance for all required-tag rules in this plugin. */
3
- const createTagRule =
4
- // eslint-disable-next-line total-functions/no-hidden-type-assertions -- RuleCreator generic is required to support plugin-specific docs.recommended metadata field.
5
- ESLintUtils.RuleCreator((ruleName) => `https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags.md#${ruleName}`);
3
+ const createTagRule = ESLintUtils.RuleCreator((ruleName) => `https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags.md#${ruleName}`);
6
4
  /** Entity kinds that can be checked by this rule family. */
7
5
  const enforceableEntityKinds = [
8
6
  "class",
9
7
  "enum",
10
8
  "function",
11
9
  "interface",
10
+ "namespace",
12
11
  "object",
13
12
  "type",
14
13
  "variable",
@@ -18,7 +17,7 @@ const defaultEnforceFor = [...enforceableEntityKinds];
18
17
  const defaultRuleOptions = [
19
18
  {
20
19
  enforceFor: defaultEnforceFor,
21
- includeNonExported: false,
20
+ exportMode: "exported",
22
21
  },
23
22
  ];
24
23
  /** JSON schema describing shared required-tag rule options. */
@@ -33,14 +32,31 @@ const optionSchema = {
33
32
  type: "array",
34
33
  uniqueItems: true,
35
34
  },
35
+ exportMode: {
36
+ description: "Choose whether to check exported declarations, non-exported top-level declarations, or both.",
37
+ enum: [
38
+ "all",
39
+ "exported",
40
+ "non-exported",
41
+ ],
42
+ type: "string",
43
+ },
36
44
  includeNonExported: {
37
45
  default: false,
38
- description: "Also enforce on non-exported declarations (opt-in).",
46
+ description: 'Legacy alias for exportMode: "all". Also enforce on non-exported declarations when true.',
39
47
  type: "boolean",
40
48
  },
41
49
  },
42
50
  type: "object",
43
51
  };
52
+ const resolveExportMode = (ruleOption) => {
53
+ if (ruleOption?.includeNonExported === true) {
54
+ return "all";
55
+ }
56
+ return ruleOption?.exportMode ?? "exported";
57
+ };
58
+ const shouldCheckExportedDeclarations = (exportMode) => exportMode === "all" || exportMode === "exported";
59
+ const shouldCheckNonExportedDeclarations = (exportMode) => exportMode === "all" || exportMode === "non-exported";
44
60
  const assertUnreachable = (value) => {
45
61
  throw new Error(`Unexpected node type: ${String(value)}`);
46
62
  };
@@ -69,11 +85,23 @@ const hasRequiredTag = (commentText, tagName) => {
69
85
  return false;
70
86
  };
71
87
  const getEntityDisplayName = (name) => name ?? "<default export>";
88
+ const isTopLevelNode = (node) => node.parent?.type === AST_NODE_TYPES.Program;
89
+ const getModuleDeclarationName = (declaration) => {
90
+ if (declaration.id.type === AST_NODE_TYPES.Identifier) {
91
+ return declaration.id.name;
92
+ }
93
+ if (declaration.id.type === AST_NODE_TYPES.Literal &&
94
+ typeof declaration.id.value === "string") {
95
+ return declaration.id.value;
96
+ }
97
+ return undefined;
98
+ };
72
99
  const isSupportedDeclaration = (node) => node.type === AST_NODE_TYPES.ClassDeclaration ||
73
100
  node.type === AST_NODE_TYPES.FunctionDeclaration ||
74
101
  node.type === AST_NODE_TYPES.TSDeclareFunction ||
75
102
  node.type === AST_NODE_TYPES.TSEnumDeclaration ||
76
103
  node.type === AST_NODE_TYPES.TSInterfaceDeclaration ||
104
+ node.type === AST_NODE_TYPES.TSModuleDeclaration ||
77
105
  node.type === AST_NODE_TYPES.TSTypeAliasDeclaration ||
78
106
  node.type === AST_NODE_TYPES.VariableDeclaration;
79
107
  const isSupportedDefaultExportExpression = (node) => node.type === AST_NODE_TYPES.ArrowFunctionExpression ||
@@ -162,6 +190,16 @@ const declarationTargets = (declaration) => {
162
190
  },
163
191
  ];
164
192
  }
193
+ if (declaration.type === AST_NODE_TYPES.TSModuleDeclaration) {
194
+ return [
195
+ {
196
+ commentNode: declaration,
197
+ kind: "namespace",
198
+ name: getModuleDeclarationName(declaration),
199
+ reportNode: declaration,
200
+ },
201
+ ];
202
+ }
165
203
  if (declaration.type === AST_NODE_TYPES.TSTypeAliasDeclaration) {
166
204
  return [
167
205
  {
@@ -207,7 +245,7 @@ const createRequireTagRuleListener = (context, requiredTag) => {
207
245
  const sourceCode = context.sourceCode;
208
246
  const ruleOption = context.options.at(0);
209
247
  const enabledKinds = new Set(ruleOption?.enforceFor ?? defaultEnforceFor);
210
- const includeNonExported = ruleOption?.includeNonExported ?? false;
248
+ const exportMode = resolveExportMode(ruleOption);
211
249
  const checkTarget = (target) => {
212
250
  if (!enabledKinds.has(target.kind)) {
213
251
  return;
@@ -255,6 +293,10 @@ const createRequireTagRuleListener = (context, requiredTag) => {
255
293
  };
256
294
  return {
257
295
  ExportDefaultDeclaration(exportNode) {
296
+ if (!shouldCheckExportedDeclarations(exportMode) ||
297
+ !isTopLevelNode(exportNode)) {
298
+ return;
299
+ }
258
300
  const { declaration } = exportNode;
259
301
  if (declaration.type === AST_NODE_TYPES.Identifier) {
260
302
  checkIdentifierExport(declaration);
@@ -274,6 +316,10 @@ const createRequireTagRuleListener = (context, requiredTag) => {
274
316
  }
275
317
  },
276
318
  ExportNamedDeclaration(exportNode) {
319
+ if (!shouldCheckExportedDeclarations(exportMode) ||
320
+ !isTopLevelNode(exportNode)) {
321
+ return;
322
+ }
277
323
  if (exportNode.declaration !== null &&
278
324
  isSupportedDeclaration(exportNode.declaration)) {
279
325
  checkDeclarationWithExportComment(exportNode.declaration, exportNode);
@@ -292,16 +338,19 @@ const createRequireTagRuleListener = (context, requiredTag) => {
292
338
  declarationsByName.clear();
293
339
  checkedTargets.clear();
294
340
  for (const statement of programNode.body) {
295
- if (includeNonExported && isSupportedDeclaration(statement)) {
341
+ if (shouldCheckNonExportedDeclarations(exportMode) &&
342
+ isSupportedDeclaration(statement)) {
296
343
  for (const target of declarationTargetsWithCommentNode(statement, statement)) {
297
344
  checkTarget(target);
298
345
  }
299
346
  }
300
- if (isSupportedDeclaration(statement)) {
347
+ if (shouldCheckExportedDeclarations(exportMode) &&
348
+ isSupportedDeclaration(statement)) {
301
349
  trackDeclarationTargets(statement);
302
350
  continue;
303
351
  }
304
- if (statement.type === AST_NODE_TYPES.ExportNamedDeclaration &&
352
+ if (shouldCheckExportedDeclarations(exportMode) &&
353
+ statement.type === AST_NODE_TYPES.ExportNamedDeclaration &&
305
354
  statement.declaration !== null &&
306
355
  isSupportedDeclaration(statement.declaration)) {
307
356
  trackDeclarationTargets(statement.declaration);
@@ -1 +1 @@
1
- {"version":3,"file":"require-tag-factory.js","sourceRoot":"","sources":["../../src/internal/require-tag-factory.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,cAAc,EACd,eAAe,EACf,WAAW,GACd,MAAM,0BAA0B,CAAC;AA6BlC,sEAAsE;AACtE,MAAM,aAAa;AACf,oKAAoK;AACpK,WAAW,CAAC,WAAW,CACnB,CAAC,QAAQ,EAAE,EAAE,CACT,qGAAqG,QAAQ,EAAE,CACtH,CAAC;AA0CN,4DAA4D;AAC5D,MAAM,sBAAsB,GAA0B;IAClD,OAAO;IACP,MAAM;IACN,UAAU;IACV,WAAW;IACX,QAAQ;IACR,MAAM;IACN,UAAU;CACb,CAAC;AAEF,MAAM,iBAAiB,GAA0B,CAAC,GAAG,sBAAsB,CAAC,CAAC;AAE7E,mDAAmD;AACnD,MAAM,kBAAkB,GAAmB;IACvC;QACI,UAAU,EAAE,iBAAiB;QAC7B,kBAAkB,EAAE,KAAK;KAC5B;CACJ,CAAC;AAEF,+DAA+D;AAC/D,MAAM,YAAY,GAA2B;IACzC,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACR,UAAU,EAAE;YACR,KAAK,EAAE;gBACH,IAAI,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACjC,IAAI,EAAE,QAAQ;aACjB;YACD,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,IAAI;SACpB;QACD,kBAAkB,EAAE;YAChB,OAAO,EAAE,KAAK;YACd,WAAW,EAAE,qDAAqD;YAClE,IAAI,EAAE,SAAS;SAClB;KACJ;IACD,IAAI,EAAE,QAAQ;CACjB,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,KAAY,EAAS,EAAE;IAC9C,MAAM,IAAI,KAAK,CAAC,yBAAyB,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AAC9D,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,SAA6B,EAAW,EAAE;IAC/D,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACjC,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CACnB,WAAmB,EACnB,OAAqB,EACd,EAAE;IACT,IAAI,gBAAgB,GAAG,CAAC,CAAC;IACzB,OAAO,gBAAgB,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC;QAC3C,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;QAChE,IAAI,QAAQ,KAAK,CAAC,CAAC,EAAE,CAAC;YAClB,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,MAAM,eAAe,GACjB,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACzD,MAAM,cAAc,GAAG,WAAW,CAAC,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAC9D,MAAM,iBAAiB,GAAG,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;QAC5D,MAAM,gBAAgB,GAAG,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;QAE1D,IAAI,iBAAiB,IAAI,gBAAgB,EAAE,CAAC;YACxC,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,gBAAgB,GAAG,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC;IACjD,CAAC;IAED,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,IAAwB,EAAU,EAAE,CAC9D,IAAI,IAAI,kBAAkB,CAAC;AAE/B,MAAM,sBAAsB,GAAG,CAC3B,IAA6B,EACD,EAAE,CAC9B,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB;IAC7C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,mBAAmB;IAChD,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,iBAAiB;IAC9C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,iBAAiB;IAC9C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,sBAAsB;IACnD,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,sBAAsB;IACnD,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,mBAAmB,CAAC;AAErD,MAAM,kCAAkC,GAAG,CACvC,IAA6B,EACW,EAAE,CAC1C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,uBAAuB;IACpD,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,eAAe;IAC5C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,kBAAkB;IAC/C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,CAAC;AAElD,MAAM,iBAAiB,GAAG,CACtB,IAAgD,EACtC,EAAE;IACZ,IACI,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,uBAAuB;QACpD,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,kBAAkB,EACjD,CAAC;QACC,OAAO,UAAU,CAAC;IACtB,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,eAAe,EAAE,CAAC;QAC/C,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;QAChD,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CACxB,UAAyC,EACzC,IAA6B,EACN,EAAE;IACzB,MAAM,QAAQ,GAAG,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACpD,MAAM,cAAc,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAEvC,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,IAAI,cAAc,CAAC,IAAI,KAAK,eAAe,CAAC,KAAK,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACxC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,iBAAiB,GAAG,cAAc,CAAC,GAAG,CAAC;IAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC;IACzB,IAAI,iBAAiB,KAAK,IAAI,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACjD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC;IAChE,IAAI,OAAO,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO,cAAc,CAAC;AAC1B,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,MAAwB,EAAU,EAAE;IACzD,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC;IAC7C,OAAO,GAAG,KAAK,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC;AACjE,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CACvB,WAA2C,EACnC,EAAE;IACV,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;QACvD,OAAO;YACH;gBACI,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,WAAW,CAAC,EAAE,EAAE,IAAI;gBAC1B,UAAU,EAAE,WAAW;aAC1B;SACJ,CAAC;IACN,CAAC;IAED,IACI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,mBAAmB;QACvD,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,iBAAiB,EACvD,CAAC;QACC,OAAO;YACH;gBACI,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,WAAW,CAAC,EAAE,EAAE,IAAI;gBAC1B,UAAU,EAAE,WAAW;aAC1B;SACJ,CAAC;IACN,CAAC;IAED,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,iBAAiB,EAAE,CAAC;QACxD,OAAO;YACH;gBACI,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC,IAAI;gBACzB,UAAU,EAAE,WAAW;aAC1B;SACJ,CAAC;IACN,CAAC;IAED,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,sBAAsB,EAAE,CAAC;QAC7D,OAAO;YACH;gBACI,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC,IAAI;gBACzB,UAAU,EAAE,WAAW;aAC1B;SACJ,CAAC;IACN,CAAC;IAED,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,sBAAsB,EAAE,CAAC;QAC7D,OAAO;YACH;gBACI,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC,IAAI;gBACzB,UAAU,EAAE,WAAW;aAC1B;SACJ,CAAC;IACN,CAAC;IAED,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,mBAAmB,EAAE,CAAC;QAC1D,OAAO,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YACnD,IAAI,UAAU,CAAC,EAAE,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU,EAAE,CAAC;gBACnD,OAAO,EAAE,CAAC;YACd,CAAC;YAED,OAAO;gBACH;oBACI,WAAW,EAAE,WAAW;oBACxB,IAAI,EAAE,UAAmB;oBACzB,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC,IAAI;oBACxB,UAAU,EAAE,UAAU;iBACzB;aACJ,CAAC;QACN,CAAC,CAAC,CAAC;IACP,CAAC;IAED,OAAO,iBAAiB,CAAC,WAAW,CAAC,CAAC;AAC1C,CAAC,CAAC;AAEF,MAAM,iCAAiC,GAAG,CACtC,WAA2C,EAC3C,WAAoC,EAC5B,EAAE,CACV,kBAAkB,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC7C,GAAG,MAAM;IACT,WAAW;CACd,CAAC,CAAC,CAAC;AAER;;;;;;;GAOG;AACH,MAAM,4BAA4B,GAAG,CACjC,OAA0E,EAC1E,WAAyB,EACJ,EAAE;IACvB,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAkB,CAAC;IACrD,MAAM,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC;IACzC,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IACtC,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACzC,MAAM,YAAY,GAAG,IAAI,GAAG,CACxB,UAAU,EAAE,UAAU,IAAI,iBAAiB,CAC9C,CAAC;IACF,MAAM,kBAAkB,GAAG,UAAU,EAAE,kBAAkB,IAAI,KAAK,CAAC;IAEnE,MAAM,WAAW,GAAG,CAAC,MAAwB,EAAQ,EAAE;QACnD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YACjC,OAAO;QACX,CAAC;QAED,MAAM,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;YAChC,OAAO;QACX,CAAC;QAED,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAE9B,MAAM,WAAW,GAAG,mBAAmB,CAAC,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;QACxE,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;YACvB,OAAO;QACX,CAAC;QAED,IAAI,cAAc,CAAC,WAAW,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE,CAAC;YACjD,OAAO;QACX,CAAC;QAED,OAAO,CAAC,MAAM,CAAC;YACX,IAAI,EAAE;gBACF,UAAU,EAAE,MAAM,CAAC,IAAI;gBACvB,UAAU,EAAE,oBAAoB,CAAC,MAAM,CAAC,IAAI,CAAC;gBAC7C,OAAO,EAAE,WAAW;aACvB;YACD,SAAS,EAAE,YAAY;YACvB,IAAI,EAAE,MAAM,CAAC,UAAU;SAC1B,CAAC,CAAC;IACP,CAAC,CAAC;IAEF,MAAM,iCAAiC,GAAG,CACtC,WAA2C,EAC3C,UAE+C,EAC3C,EAAE;QACN,KAAK,MAAM,MAAM,IAAI,iCAAiC,CAClD,WAAW,EACX,UAAU,CACb,EAAE,CAAC;YACA,WAAW,CAAC,MAAM,CAAC,CAAC;QACxB,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,uBAAuB,GAAG,CAC5B,WAA2C,EACvC,EAAE;QACN,KAAK,MAAM,MAAM,IAAI,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC;YACnD,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC5B,SAAS;YACb,CAAC;YAED,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAChD,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,qBAAqB,GAAG,CAC1B,UAAyC,EACrC,EAAE;QACN,MAAM,MAAM,GAAG,kBAAkB,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACvD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACvB,WAAW,CAAC,MAAM,CAAC,CAAC;QACxB,CAAC;IACL,CAAC,CAAC;IAEF,OAAO;QACH,wBAAwB,CACpB,UAAuD;YAEvD,MAAM,EAAE,WAAW,EAAE,GAAG,UAAU,CAAC;YAEnC,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU,EAAE,CAAC;gBACjD,qBAAqB,CAAC,WAAW,CAAC,CAAC;gBACnC,OAAO;YACX,CAAC;YAED,IAAI,sBAAsB,CAAC,WAAW,CAAC,EAAE,CAAC;gBACtC,iCAAiC,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;gBAC3D,OAAO;YACX,CAAC;YAED,IAAI,kCAAkC,CAAC,WAAW,CAAC,EAAE,CAAC;gBAClD,WAAW,CAAC;oBACR,WAAW,EAAE,UAAU;oBACvB,IAAI,EAAE,iBAAiB,CAAC,WAAW,CAAC;oBACpC,IAAI,EAAE,SAAS;oBACf,UAAU,EAAE,WAAW;iBAC1B,CAAC,CAAC;YACP,CAAC;QACL,CAAC;QACD,sBAAsB,CAClB,UAAqD;YAErD,IACI,UAAU,CAAC,WAAW,KAAK,IAAI;gBAC/B,sBAAsB,CAAC,UAAU,CAAC,WAAW,CAAC,EAChD,CAAC;gBACC,iCAAiC,CAC7B,UAAU,CAAC,WAAW,EACtB,UAAU,CACb,CAAC;YACN,CAAC;YAED,IAAI,UAAU,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;gBAC7B,OAAO;YACX,CAAC;YAED,KAAK,MAAM,SAAS,IAAI,UAAU,CAAC,UAAU,EAAE,CAAC;gBAC5C,IAAI,SAAS,CAAC,IAAI,KAAK,cAAc,CAAC,eAAe,EAAE,CAAC;oBACpD,SAAS;gBACb,CAAC;gBAED,qBAAqB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAC3C,CAAC;QACL,CAAC;QACD,OAAO,CAAC,WAAuC;YAC3C,kBAAkB,CAAC,KAAK,EAAE,CAAC;YAC3B,cAAc,CAAC,KAAK,EAAE,CAAC;YAEvB,KAAK,MAAM,SAAS,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC;gBACvC,IAAI,kBAAkB,IAAI,sBAAsB,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC1D,KAAK,MAAM,MAAM,IAAI,iCAAiC,CAClD,SAAS,EACT,SAAS,CACZ,EAAE,CAAC;wBACA,WAAW,CAAC,MAAM,CAAC,CAAC;oBACxB,CAAC;gBACL,CAAC;gBACD,IAAI,sBAAsB,CAAC,SAAS,CAAC,EAAE,CAAC;oBACpC,uBAAuB,CAAC,SAAS,CAAC,CAAC;oBACnC,SAAS;gBACb,CAAC;gBAED,IACI,SAAS,CAAC,IAAI,KAAK,cAAc,CAAC,sBAAsB;oBACxD,SAAS,CAAC,WAAW,KAAK,IAAI;oBAC9B,sBAAsB,CAAC,SAAS,CAAC,WAAW,CAAC,EAC/C,CAAC;oBACC,uBAAuB,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;gBACnD,CAAC;YACL,CAAC;QACL,CAAC;KACJ,CAAC;AACN,CAAC,CAAC;AAYF,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GACf,CAAC"}
1
+ {"version":3,"file":"require-tag-factory.js","sourceRoot":"","sources":["../../src/internal/require-tag-factory.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,cAAc,EACd,eAAe,EACf,WAAW,GACd,MAAM,0BAA0B,CAAC;AAiClC,sEAAsE;AACtE,MAAM,aAAa,GACf,WAAW,CAAC,WAAW,CACnB,CAAC,QAAQ,EAAE,EAAE,CACT,qGAAqG,QAAQ,EAAE,CACtH,CAAC;AA4CN,4DAA4D;AAC5D,MAAM,sBAAsB,GAA0B;IAClD,OAAO;IACP,MAAM;IACN,UAAU;IACV,WAAW;IACX,WAAW;IACX,QAAQ;IACR,MAAM;IACN,UAAU;CACb,CAAC;AAEF,MAAM,iBAAiB,GAA0B,CAAC,GAAG,sBAAsB,CAAC,CAAC;AAE7E,mDAAmD;AACnD,MAAM,kBAAkB,GAAmB;IACvC;QACI,UAAU,EAAE,iBAAiB;QAC7B,UAAU,EAAE,UAAU;KACzB;CACJ,CAAC;AAEF,+DAA+D;AAC/D,MAAM,YAAY,GAA2B;IACzC,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACR,UAAU,EAAE;YACR,KAAK,EAAE;gBACH,IAAI,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACjC,IAAI,EAAE,QAAQ;aACjB;YACD,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,IAAI;SACpB;QACD,UAAU,EAAE;YACR,WAAW,EACP,8FAA8F;YAClG,IAAI,EAAE;gBACF,KAAK;gBACL,UAAU;gBACV,cAAc;aACjB;YACD,IAAI,EAAE,QAAQ;SACjB;QACD,kBAAkB,EAAE;YAChB,OAAO,EAAE,KAAK;YACd,WAAW,EACP,0FAA0F;YAC9F,IAAI,EAAE,SAAS;SAClB;KACJ;IACD,IAAI,EAAE,QAAQ;CACjB,CAAC;AAEF,MAAM,iBAAiB,GAAG,CACtB,UAA4C,EAClC,EAAE;IACZ,IAAI,UAAU,EAAE,kBAAkB,KAAK,IAAI,EAAE,CAAC;QAC1C,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,UAAU,EAAE,UAAU,IAAI,UAAU,CAAC;AAChD,CAAC,CAAC;AAEF,MAAM,+BAA+B,GAAG,CAAC,UAAsB,EAAW,EAAE,CACxE,UAAU,KAAK,KAAK,IAAI,UAAU,KAAK,UAAU,CAAC;AAEtD,MAAM,kCAAkC,GAAG,CAAC,UAAsB,EAAW,EAAE,CAC3E,UAAU,KAAK,KAAK,IAAI,UAAU,KAAK,cAAc,CAAC;AAE1D,MAAM,iBAAiB,GAAG,CAAC,KAAY,EAAS,EAAE;IAC9C,MAAM,IAAI,KAAK,CAAC,yBAAyB,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AAC9D,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,SAA6B,EAAW,EAAE;IAC/D,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AACjC,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CACnB,WAAmB,EACnB,OAAqB,EACd,EAAE;IACT,IAAI,gBAAgB,GAAG,CAAC,CAAC;IACzB,OAAO,gBAAgB,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC;QAC3C,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;QAChE,IAAI,QAAQ,KAAK,CAAC,CAAC,EAAE,CAAC;YAClB,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,MAAM,eAAe,GACjB,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACzD,MAAM,cAAc,GAAG,WAAW,CAAC,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAC9D,MAAM,iBAAiB,GAAG,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;QAC5D,MAAM,gBAAgB,GAAG,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;QAE1D,IAAI,iBAAiB,IAAI,gBAAgB,EAAE,CAAC;YACxC,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,gBAAgB,GAAG,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC;IACjD,CAAC;IAED,OAAO,KAAK,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,IAAwB,EAAU,EAAE,CAC9D,IAAI,IAAI,kBAAkB,CAAC;AAE/B,MAAM,cAAc,GAAG,CAAC,IAA6B,EAAW,EAAE,CAC9D,IAAI,CAAC,MAAM,EAAE,IAAI,KAAK,cAAc,CAAC,OAAO,CAAC;AAEjD,MAAM,wBAAwB,GAAG,CAC7B,WAAmD,EACjC,EAAE;IACpB,IAAI,WAAW,CAAC,EAAE,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU,EAAE,CAAC;QACpD,OAAO,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC;IAC/B,CAAC;IAED,IACI,WAAW,CAAC,EAAE,CAAC,IAAI,KAAK,cAAc,CAAC,OAAO;QAC9C,OAAO,WAAW,CAAC,EAAE,CAAC,KAAK,KAAK,QAAQ,EAC1C,CAAC;QACC,OAAO,WAAW,CAAC,EAAE,CAAC,KAAK,CAAC;IAChC,CAAC;IAED,OAAO,SAAS,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAC3B,IAA6B,EACD,EAAE,CAC9B,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB;IAC7C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,mBAAmB;IAChD,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,iBAAiB;IAC9C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,iBAAiB;IAC9C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,sBAAsB;IACnD,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,mBAAmB;IAChD,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,sBAAsB;IACnD,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,mBAAmB,CAAC;AAErD,MAAM,kCAAkC,GAAG,CACvC,IAA6B,EACW,EAAE,CAC1C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,uBAAuB;IACpD,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,eAAe;IAC5C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,kBAAkB;IAC/C,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,CAAC;AAElD,MAAM,iBAAiB,GAAG,CACtB,IAAgD,EACtC,EAAE;IACZ,IACI,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,uBAAuB;QACpD,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,kBAAkB,EACjD,CAAC;QACC,OAAO,UAAU,CAAC;IACtB,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,eAAe,EAAE,CAAC;QAC/C,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;QAChD,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CACxB,UAAyC,EACzC,IAA6B,EACN,EAAE;IACzB,MAAM,QAAQ,GAAG,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACpD,MAAM,cAAc,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAEvC,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,IAAI,cAAc,CAAC,IAAI,KAAK,eAAe,CAAC,KAAK,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACxC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,iBAAiB,GAAG,cAAc,CAAC,GAAG,CAAC;IAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC;IACzB,IAAI,iBAAiB,KAAK,IAAI,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACjD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,GAAG,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC;IAChE,IAAI,OAAO,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO,cAAc,CAAC;AAC1B,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,MAAwB,EAAU,EAAE;IACzD,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC;IAC7C,OAAO,GAAG,KAAK,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC;AACjE,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CACvB,WAA2C,EACnC,EAAE;IACV,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,gBAAgB,EAAE,CAAC;QACvD,OAAO;YACH;gBACI,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,WAAW,CAAC,EAAE,EAAE,IAAI;gBAC1B,UAAU,EAAE,WAAW;aAC1B;SACJ,CAAC;IACN,CAAC;IAED,IACI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,mBAAmB;QACvD,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,iBAAiB,EACvD,CAAC;QACC,OAAO;YACH;gBACI,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,WAAW,CAAC,EAAE,EAAE,IAAI;gBAC1B,UAAU,EAAE,WAAW;aAC1B;SACJ,CAAC;IACN,CAAC;IAED,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,iBAAiB,EAAE,CAAC;QACxD,OAAO;YACH;gBACI,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC,IAAI;gBACzB,UAAU,EAAE,WAAW;aAC1B;SACJ,CAAC;IACN,CAAC;IAED,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,sBAAsB,EAAE,CAAC;QAC7D,OAAO;YACH;gBACI,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC,IAAI;gBACzB,UAAU,EAAE,WAAW;aAC1B;SACJ,CAAC;IACN,CAAC;IAED,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,mBAAmB,EAAE,CAAC;QAC1D,OAAO;YACH;gBACI,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,wBAAwB,CAAC,WAAW,CAAC;gBAC3C,UAAU,EAAE,WAAW;aAC1B;SACJ,CAAC;IACN,CAAC;IAED,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,sBAAsB,EAAE,CAAC;QAC7D,OAAO;YACH;gBACI,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC,IAAI;gBACzB,UAAU,EAAE,WAAW;aAC1B;SACJ,CAAC;IACN,CAAC;IAED,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,mBAAmB,EAAE,CAAC;QAC1D,OAAO,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YACnD,IAAI,UAAU,CAAC,EAAE,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU,EAAE,CAAC;gBACnD,OAAO,EAAE,CAAC;YACd,CAAC;YAED,OAAO;gBACH;oBACI,WAAW,EAAE,WAAW;oBACxB,IAAI,EAAE,UAAmB;oBACzB,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC,IAAI;oBACxB,UAAU,EAAE,UAAU;iBACzB;aACJ,CAAC;QACN,CAAC,CAAC,CAAC;IACP,CAAC;IAED,OAAO,iBAAiB,CAAC,WAAW,CAAC,CAAC;AAC1C,CAAC,CAAC;AAEF,MAAM,iCAAiC,GAAG,CACtC,WAA2C,EAC3C,WAAoC,EAC5B,EAAE,CACV,kBAAkB,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC7C,GAAG,MAAM;IACT,WAAW;CACd,CAAC,CAAC,CAAC;AAER;;;;;;;GAOG;AACH,MAAM,4BAA4B,GAAG,CACjC,OAA0E,EAC1E,WAAyB,EACJ,EAAE;IACvB,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAkB,CAAC;IACrD,MAAM,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC;IACzC,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IACtC,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACzC,MAAM,YAAY,GAAG,IAAI,GAAG,CACxB,UAAU,EAAE,UAAU,IAAI,iBAAiB,CAC9C,CAAC;IACF,MAAM,UAAU,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAEjD,MAAM,WAAW,GAAG,CAAC,MAAwB,EAAQ,EAAE;QACnD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YACjC,OAAO;QACX,CAAC;QAED,MAAM,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;YAChC,OAAO;QACX,CAAC;QAED,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAE9B,MAAM,WAAW,GAAG,mBAAmB,CAAC,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;QACxE,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;YACvB,OAAO;QACX,CAAC;QAED,IAAI,cAAc,CAAC,WAAW,CAAC,KAAK,EAAE,WAAW,CAAC,EAAE,CAAC;YACjD,OAAO;QACX,CAAC;QAED,OAAO,CAAC,MAAM,CAAC;YACX,IAAI,EAAE;gBACF,UAAU,EAAE,MAAM,CAAC,IAAI;gBACvB,UAAU,EAAE,oBAAoB,CAAC,MAAM,CAAC,IAAI,CAAC;gBAC7C,OAAO,EAAE,WAAW;aACvB;YACD,SAAS,EAAE,YAAY;YACvB,IAAI,EAAE,MAAM,CAAC,UAAU;SAC1B,CAAC,CAAC;IACP,CAAC,CAAC;IAEF,MAAM,iCAAiC,GAAG,CACtC,WAA2C,EAC3C,UAE+C,EAC3C,EAAE;QACN,KAAK,MAAM,MAAM,IAAI,iCAAiC,CAClD,WAAW,EACX,UAAU,CACb,EAAE,CAAC;YACA,WAAW,CAAC,MAAM,CAAC,CAAC;QACxB,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,uBAAuB,GAAG,CAC5B,WAA2C,EACvC,EAAE;QACN,KAAK,MAAM,MAAM,IAAI,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC;YACnD,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC5B,SAAS;YACb,CAAC;YAED,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAChD,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,qBAAqB,GAAG,CAC1B,UAAyC,EACrC,EAAE;QACN,MAAM,MAAM,GAAG,kBAAkB,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACvD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACvB,WAAW,CAAC,MAAM,CAAC,CAAC;QACxB,CAAC;IACL,CAAC,CAAC;IAEF,OAAO;QACH,wBAAwB,CACpB,UAAuD;YAEvD,IACI,CAAC,+BAA+B,CAAC,UAAU,CAAC;gBAC5C,CAAC,cAAc,CAAC,UAAU,CAAC,EAC7B,CAAC;gBACC,OAAO;YACX,CAAC;YAED,MAAM,EAAE,WAAW,EAAE,GAAG,UAAU,CAAC;YAEnC,IAAI,WAAW,CAAC,IAAI,KAAK,cAAc,CAAC,UAAU,EAAE,CAAC;gBACjD,qBAAqB,CAAC,WAAW,CAAC,CAAC;gBACnC,OAAO;YACX,CAAC;YAED,IAAI,sBAAsB,CAAC,WAAW,CAAC,EAAE,CAAC;gBACtC,iCAAiC,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;gBAC3D,OAAO;YACX,CAAC;YAED,IAAI,kCAAkC,CAAC,WAAW,CAAC,EAAE,CAAC;gBAClD,WAAW,CAAC;oBACR,WAAW,EAAE,UAAU;oBACvB,IAAI,EAAE,iBAAiB,CAAC,WAAW,CAAC;oBACpC,IAAI,EAAE,SAAS;oBACf,UAAU,EAAE,WAAW;iBAC1B,CAAC,CAAC;YACP,CAAC;QACL,CAAC;QACD,sBAAsB,CAClB,UAAqD;YAErD,IACI,CAAC,+BAA+B,CAAC,UAAU,CAAC;gBAC5C,CAAC,cAAc,CAAC,UAAU,CAAC,EAC7B,CAAC;gBACC,OAAO;YACX,CAAC;YAED,IACI,UAAU,CAAC,WAAW,KAAK,IAAI;gBAC/B,sBAAsB,CAAC,UAAU,CAAC,WAAW,CAAC,EAChD,CAAC;gBACC,iCAAiC,CAC7B,UAAU,CAAC,WAAW,EACtB,UAAU,CACb,CAAC;YACN,CAAC;YAED,IAAI,UAAU,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;gBAC7B,OAAO;YACX,CAAC;YAED,KAAK,MAAM,SAAS,IAAI,UAAU,CAAC,UAAU,EAAE,CAAC;gBAC5C,IAAI,SAAS,CAAC,IAAI,KAAK,cAAc,CAAC,eAAe,EAAE,CAAC;oBACpD,SAAS;gBACb,CAAC;gBAED,qBAAqB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAC3C,CAAC;QACL,CAAC;QACD,OAAO,CAAC,WAAuC;YAC3C,kBAAkB,CAAC,KAAK,EAAE,CAAC;YAC3B,cAAc,CAAC,KAAK,EAAE,CAAC;YAEvB,KAAK,MAAM,SAAS,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC;gBACvC,IACI,kCAAkC,CAAC,UAAU,CAAC;oBAC9C,sBAAsB,CAAC,SAAS,CAAC,EACnC,CAAC;oBACC,KAAK,MAAM,MAAM,IAAI,iCAAiC,CAClD,SAAS,EACT,SAAS,CACZ,EAAE,CAAC;wBACA,WAAW,CAAC,MAAM,CAAC,CAAC;oBACxB,CAAC;gBACL,CAAC;gBAED,IACI,+BAA+B,CAAC,UAAU,CAAC;oBAC3C,sBAAsB,CAAC,SAAS,CAAC,EACnC,CAAC;oBACC,uBAAuB,CAAC,SAAS,CAAC,CAAC;oBACnC,SAAS;gBACb,CAAC;gBAED,IACI,+BAA+B,CAAC,UAAU,CAAC;oBAC3C,SAAS,CAAC,IAAI,KAAK,cAAc,CAAC,sBAAsB;oBACxD,SAAS,CAAC,WAAW,KAAK,IAAI;oBAC9B,sBAAsB,CAAC,SAAS,CAAC,WAAW,CAAC,EAC/C,CAAC;oBACC,uBAAuB,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;gBACnD,CAAC;YACL,CAAC;QACL,CAAC;KACJ,CAAC;AACN,CAAC,CAAC;AAaF,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,GACf,CAAC"}