eslint-plugin-tsdoc-require-2 1.2.1 → 1.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (316) hide show
  1. package/README.md +103 -101
  2. package/dist/internal/require-tag-factory.cjs +40 -48
  3. package/dist/internal/require-tag-factory.d.ts +7 -8
  4. package/dist/internal/require-tag-factory.d.ts.map +1 -1
  5. package/dist/internal/require-tag-factory.js +41 -49
  6. package/dist/internal/require-tag-factory.js.map +1 -1
  7. package/dist/plugin.cjs +9 -2
  8. package/dist/plugin.d.ts.map +1 -1
  9. package/dist/plugin.js +9 -2
  10. package/dist/plugin.js.map +1 -1
  11. package/dist/rules/require-tag-rules.js +112 -112
  12. package/dist/rules/require.cjs +39 -47
  13. package/dist/rules/require.d.ts +3 -3
  14. package/dist/rules/require.d.ts.map +1 -1
  15. package/dist/rules/require.js +40 -48
  16. package/dist/rules/require.js.map +1 -1
  17. package/dist/rules/required-tags/require-abstract.cjs +1 -3
  18. package/dist/rules/required-tags/require-abstract.d.ts.map +1 -1
  19. package/dist/rules/required-tags/require-abstract.js +1 -3
  20. package/dist/rules/required-tags/require-abstract.js.map +1 -1
  21. package/dist/rules/required-tags/require-alpha.cjs +1 -3
  22. package/dist/rules/required-tags/require-alpha.d.ts.map +1 -1
  23. package/dist/rules/required-tags/require-alpha.js +1 -3
  24. package/dist/rules/required-tags/require-alpha.js.map +1 -1
  25. package/dist/rules/required-tags/require-author.cjs +1 -3
  26. package/dist/rules/required-tags/require-author.d.ts.map +1 -1
  27. package/dist/rules/required-tags/require-author.js +1 -3
  28. package/dist/rules/required-tags/require-author.js.map +1 -1
  29. package/dist/rules/required-tags/require-beta.cjs +1 -3
  30. package/dist/rules/required-tags/require-beta.d.ts.map +1 -1
  31. package/dist/rules/required-tags/require-beta.js +1 -3
  32. package/dist/rules/required-tags/require-beta.js.map +1 -1
  33. package/dist/rules/required-tags/require-category.cjs +1 -3
  34. package/dist/rules/required-tags/require-category.d.ts.map +1 -1
  35. package/dist/rules/required-tags/require-category.js +1 -3
  36. package/dist/rules/required-tags/require-category.js.map +1 -1
  37. package/dist/rules/required-tags/require-class.cjs +1 -3
  38. package/dist/rules/required-tags/require-class.d.ts.map +1 -1
  39. package/dist/rules/required-tags/require-class.js +1 -3
  40. package/dist/rules/required-tags/require-class.js.map +1 -1
  41. package/dist/rules/required-tags/require-decorator.cjs +1 -3
  42. package/dist/rules/required-tags/require-decorator.d.ts.map +1 -1
  43. package/dist/rules/required-tags/require-decorator.js +1 -3
  44. package/dist/rules/required-tags/require-decorator.js.map +1 -1
  45. package/dist/rules/required-tags/require-default-value.cjs +1 -3
  46. package/dist/rules/required-tags/require-default-value.d.ts.map +1 -1
  47. package/dist/rules/required-tags/require-default-value.js +1 -3
  48. package/dist/rules/required-tags/require-default-value.js.map +1 -1
  49. package/dist/rules/required-tags/require-deprecated.cjs +1 -3
  50. package/dist/rules/required-tags/require-deprecated.d.ts.map +1 -1
  51. package/dist/rules/required-tags/require-deprecated.js +1 -3
  52. package/dist/rules/required-tags/require-deprecated.js.map +1 -1
  53. package/dist/rules/required-tags/require-document.cjs +1 -3
  54. package/dist/rules/required-tags/require-document.d.ts.map +1 -1
  55. package/dist/rules/required-tags/require-document.js +1 -3
  56. package/dist/rules/required-tags/require-document.js.map +1 -1
  57. package/dist/rules/required-tags/require-enum.cjs +1 -3
  58. package/dist/rules/required-tags/require-enum.d.ts.map +1 -1
  59. package/dist/rules/required-tags/require-enum.js +1 -3
  60. package/dist/rules/required-tags/require-enum.js.map +1 -1
  61. package/dist/rules/required-tags/require-event-property.cjs +1 -3
  62. package/dist/rules/required-tags/require-event-property.d.ts.map +1 -1
  63. package/dist/rules/required-tags/require-event-property.js +1 -3
  64. package/dist/rules/required-tags/require-event-property.js.map +1 -1
  65. package/dist/rules/required-tags/require-event.cjs +1 -3
  66. package/dist/rules/required-tags/require-event.d.ts.map +1 -1
  67. package/dist/rules/required-tags/require-event.js +1 -3
  68. package/dist/rules/required-tags/require-event.js.map +1 -1
  69. package/dist/rules/required-tags/require-example.cjs +1 -3
  70. package/dist/rules/required-tags/require-example.d.ts.map +1 -1
  71. package/dist/rules/required-tags/require-example.js +1 -3
  72. package/dist/rules/required-tags/require-example.js.map +1 -1
  73. package/dist/rules/required-tags/require-expand.cjs +1 -3
  74. package/dist/rules/required-tags/require-expand.d.ts.map +1 -1
  75. package/dist/rules/required-tags/require-expand.js +1 -3
  76. package/dist/rules/required-tags/require-expand.js.map +1 -1
  77. package/dist/rules/required-tags/require-experimental.cjs +1 -3
  78. package/dist/rules/required-tags/require-experimental.d.ts.map +1 -1
  79. package/dist/rules/required-tags/require-experimental.js +1 -3
  80. package/dist/rules/required-tags/require-experimental.js.map +1 -1
  81. package/dist/rules/required-tags/require-function.cjs +1 -3
  82. package/dist/rules/required-tags/require-function.d.ts.map +1 -1
  83. package/dist/rules/required-tags/require-function.js +1 -3
  84. package/dist/rules/required-tags/require-function.js.map +1 -1
  85. package/dist/rules/required-tags/require-group.cjs +1 -3
  86. package/dist/rules/required-tags/require-group.d.ts.map +1 -1
  87. package/dist/rules/required-tags/require-group.js +1 -3
  88. package/dist/rules/required-tags/require-group.js.map +1 -1
  89. package/dist/rules/required-tags/require-hidden.cjs +1 -3
  90. package/dist/rules/required-tags/require-hidden.d.ts.map +1 -1
  91. package/dist/rules/required-tags/require-hidden.js +1 -3
  92. package/dist/rules/required-tags/require-hidden.js.map +1 -1
  93. package/dist/rules/required-tags/require-hideconstructor.cjs +1 -3
  94. package/dist/rules/required-tags/require-hideconstructor.d.ts.map +1 -1
  95. package/dist/rules/required-tags/require-hideconstructor.js +1 -3
  96. package/dist/rules/required-tags/require-hideconstructor.js.map +1 -1
  97. package/dist/rules/required-tags/require-ignore.cjs +1 -3
  98. package/dist/rules/required-tags/require-ignore.d.ts.map +1 -1
  99. package/dist/rules/required-tags/require-ignore.js +1 -3
  100. package/dist/rules/required-tags/require-ignore.js.map +1 -1
  101. package/dist/rules/required-tags/require-import.cjs +1 -3
  102. package/dist/rules/required-tags/require-import.d.ts.map +1 -1
  103. package/dist/rules/required-tags/require-import.js +1 -3
  104. package/dist/rules/required-tags/require-import.js.map +1 -1
  105. package/dist/rules/required-tags/require-include.cjs +1 -3
  106. package/dist/rules/required-tags/require-include.d.ts.map +1 -1
  107. package/dist/rules/required-tags/require-include.js +1 -3
  108. package/dist/rules/required-tags/require-include.js.map +1 -1
  109. package/dist/rules/required-tags/require-inherit-doc.cjs +1 -3
  110. package/dist/rules/required-tags/require-inherit-doc.d.ts.map +1 -1
  111. package/dist/rules/required-tags/require-inherit-doc.js +1 -3
  112. package/dist/rules/required-tags/require-inherit-doc.js.map +1 -1
  113. package/dist/rules/required-tags/require-inline.cjs +1 -3
  114. package/dist/rules/required-tags/require-inline.d.ts.map +1 -1
  115. package/dist/rules/required-tags/require-inline.js +1 -3
  116. package/dist/rules/required-tags/require-inline.js.map +1 -1
  117. package/dist/rules/required-tags/require-interface.cjs +1 -3
  118. package/dist/rules/required-tags/require-interface.d.ts.map +1 -1
  119. package/dist/rules/required-tags/require-interface.js +1 -3
  120. package/dist/rules/required-tags/require-interface.js.map +1 -1
  121. package/dist/rules/required-tags/require-internal.cjs +1 -3
  122. package/dist/rules/required-tags/require-internal.d.ts.map +1 -1
  123. package/dist/rules/required-tags/require-internal.js +1 -3
  124. package/dist/rules/required-tags/require-internal.js.map +1 -1
  125. package/dist/rules/required-tags/require-label.cjs +1 -3
  126. package/dist/rules/required-tags/require-label.d.ts.map +1 -1
  127. package/dist/rules/required-tags/require-label.js +1 -3
  128. package/dist/rules/required-tags/require-label.js.map +1 -1
  129. package/dist/rules/required-tags/require-license.cjs +1 -3
  130. package/dist/rules/required-tags/require-license.d.ts.map +1 -1
  131. package/dist/rules/required-tags/require-license.js +1 -3
  132. package/dist/rules/required-tags/require-license.js.map +1 -1
  133. package/dist/rules/required-tags/require-link.cjs +1 -3
  134. package/dist/rules/required-tags/require-link.d.ts.map +1 -1
  135. package/dist/rules/required-tags/require-link.js +1 -3
  136. package/dist/rules/required-tags/require-link.js.map +1 -1
  137. package/dist/rules/required-tags/require-merge-module-with.cjs +1 -3
  138. package/dist/rules/required-tags/require-merge-module-with.d.ts.map +1 -1
  139. package/dist/rules/required-tags/require-merge-module-with.js +1 -3
  140. package/dist/rules/required-tags/require-merge-module-with.js.map +1 -1
  141. package/dist/rules/required-tags/require-module.cjs +1 -3
  142. package/dist/rules/required-tags/require-module.d.ts.map +1 -1
  143. package/dist/rules/required-tags/require-module.js +1 -3
  144. package/dist/rules/required-tags/require-module.js.map +1 -1
  145. package/dist/rules/required-tags/require-namespace.cjs +1 -3
  146. package/dist/rules/required-tags/require-namespace.d.ts.map +1 -1
  147. package/dist/rules/required-tags/require-namespace.js +1 -3
  148. package/dist/rules/required-tags/require-namespace.js.map +1 -1
  149. package/dist/rules/required-tags/require-overload.cjs +1 -3
  150. package/dist/rules/required-tags/require-overload.d.ts.map +1 -1
  151. package/dist/rules/required-tags/require-overload.js +1 -3
  152. package/dist/rules/required-tags/require-overload.js.map +1 -1
  153. package/dist/rules/required-tags/require-override.cjs +1 -3
  154. package/dist/rules/required-tags/require-override.d.ts.map +1 -1
  155. package/dist/rules/required-tags/require-override.js +1 -3
  156. package/dist/rules/required-tags/require-override.js.map +1 -1
  157. package/dist/rules/required-tags/require-package-documentation.cjs +1 -3
  158. package/dist/rules/required-tags/require-package-documentation.d.ts.map +1 -1
  159. package/dist/rules/required-tags/require-package-documentation.js +1 -3
  160. package/dist/rules/required-tags/require-package-documentation.js.map +1 -1
  161. package/dist/rules/required-tags/require-param.cjs +1 -3
  162. package/dist/rules/required-tags/require-param.d.ts.map +1 -1
  163. package/dist/rules/required-tags/require-param.js +1 -3
  164. package/dist/rules/required-tags/require-param.js.map +1 -1
  165. package/dist/rules/required-tags/require-primary-export.cjs +1 -3
  166. package/dist/rules/required-tags/require-primary-export.d.ts.map +1 -1
  167. package/dist/rules/required-tags/require-primary-export.js +1 -3
  168. package/dist/rules/required-tags/require-primary-export.js.map +1 -1
  169. package/dist/rules/required-tags/require-private-remarks.cjs +1 -3
  170. package/dist/rules/required-tags/require-private-remarks.d.ts.map +1 -1
  171. package/dist/rules/required-tags/require-private-remarks.js +1 -3
  172. package/dist/rules/required-tags/require-private-remarks.js.map +1 -1
  173. package/dist/rules/required-tags/require-private.cjs +1 -3
  174. package/dist/rules/required-tags/require-private.d.ts.map +1 -1
  175. package/dist/rules/required-tags/require-private.js +1 -3
  176. package/dist/rules/required-tags/require-private.js.map +1 -1
  177. package/dist/rules/required-tags/require-property.cjs +1 -3
  178. package/dist/rules/required-tags/require-property.d.ts.map +1 -1
  179. package/dist/rules/required-tags/require-property.js +1 -3
  180. package/dist/rules/required-tags/require-property.js.map +1 -1
  181. package/dist/rules/required-tags/require-protected.cjs +1 -3
  182. package/dist/rules/required-tags/require-protected.d.ts.map +1 -1
  183. package/dist/rules/required-tags/require-protected.js +1 -3
  184. package/dist/rules/required-tags/require-protected.js.map +1 -1
  185. package/dist/rules/required-tags/require-public.cjs +1 -3
  186. package/dist/rules/required-tags/require-public.d.ts.map +1 -1
  187. package/dist/rules/required-tags/require-public.js +1 -3
  188. package/dist/rules/required-tags/require-public.js.map +1 -1
  189. package/dist/rules/required-tags/require-readonly.cjs +1 -3
  190. package/dist/rules/required-tags/require-readonly.d.ts.map +1 -1
  191. package/dist/rules/required-tags/require-readonly.js +1 -3
  192. package/dist/rules/required-tags/require-readonly.js.map +1 -1
  193. package/dist/rules/required-tags/require-remarks.cjs +1 -3
  194. package/dist/rules/required-tags/require-remarks.d.ts.map +1 -1
  195. package/dist/rules/required-tags/require-remarks.js +1 -3
  196. package/dist/rules/required-tags/require-remarks.js.map +1 -1
  197. package/dist/rules/required-tags/require-returns.cjs +1 -3
  198. package/dist/rules/required-tags/require-returns.d.ts.map +1 -1
  199. package/dist/rules/required-tags/require-returns.js +1 -3
  200. package/dist/rules/required-tags/require-returns.js.map +1 -1
  201. package/dist/rules/required-tags/require-sealed.cjs +1 -3
  202. package/dist/rules/required-tags/require-sealed.d.ts.map +1 -1
  203. package/dist/rules/required-tags/require-sealed.js +1 -3
  204. package/dist/rules/required-tags/require-sealed.js.map +1 -1
  205. package/dist/rules/required-tags/require-see.cjs +1 -3
  206. package/dist/rules/required-tags/require-see.d.ts.map +1 -1
  207. package/dist/rules/required-tags/require-see.js +1 -3
  208. package/dist/rules/required-tags/require-see.js.map +1 -1
  209. package/dist/rules/required-tags/require-since.cjs +1 -3
  210. package/dist/rules/required-tags/require-since.d.ts.map +1 -1
  211. package/dist/rules/required-tags/require-since.js +1 -3
  212. package/dist/rules/required-tags/require-since.js.map +1 -1
  213. package/dist/rules/required-tags/require-sort-strategy.cjs +1 -3
  214. package/dist/rules/required-tags/require-sort-strategy.d.ts.map +1 -1
  215. package/dist/rules/required-tags/require-sort-strategy.js +1 -3
  216. package/dist/rules/required-tags/require-sort-strategy.js.map +1 -1
  217. package/dist/rules/required-tags/require-summary.cjs +1 -3
  218. package/dist/rules/required-tags/require-summary.d.ts.map +1 -1
  219. package/dist/rules/required-tags/require-summary.js +1 -3
  220. package/dist/rules/required-tags/require-summary.js.map +1 -1
  221. package/dist/rules/required-tags/require-template.cjs +1 -3
  222. package/dist/rules/required-tags/require-template.d.ts.map +1 -1
  223. package/dist/rules/required-tags/require-template.js +1 -3
  224. package/dist/rules/required-tags/require-template.js.map +1 -1
  225. package/dist/rules/required-tags/require-throws.cjs +1 -3
  226. package/dist/rules/required-tags/require-throws.d.ts.map +1 -1
  227. package/dist/rules/required-tags/require-throws.js +1 -3
  228. package/dist/rules/required-tags/require-throws.js.map +1 -1
  229. package/dist/rules/required-tags/require-type-param.cjs +1 -3
  230. package/dist/rules/required-tags/require-type-param.d.ts.map +1 -1
  231. package/dist/rules/required-tags/require-type-param.js +1 -3
  232. package/dist/rules/required-tags/require-type-param.js.map +1 -1
  233. package/dist/rules/required-tags/require-use-declared-type.cjs +1 -3
  234. package/dist/rules/required-tags/require-use-declared-type.d.ts.map +1 -1
  235. package/dist/rules/required-tags/require-use-declared-type.js +1 -3
  236. package/dist/rules/required-tags/require-use-declared-type.js.map +1 -1
  237. package/dist/rules/required-tags/require-virtual.cjs +1 -3
  238. package/dist/rules/required-tags/require-virtual.d.ts.map +1 -1
  239. package/dist/rules/required-tags/require-virtual.js +1 -3
  240. package/dist/rules/required-tags/require-virtual.js.map +1 -1
  241. package/dist/rules/restrict-tags.cjs +40 -48
  242. package/dist/rules/restrict-tags.d.ts +3 -3
  243. package/dist/rules/restrict-tags.d.ts.map +1 -1
  244. package/dist/rules/restrict-tags.js +41 -49
  245. package/dist/rules/restrict-tags.js.map +1 -1
  246. package/docs/rules/getting-started.md +27 -27
  247. package/docs/rules/index.md +22 -22
  248. package/docs/rules/presets/all.md +1 -3
  249. package/docs/rules/presets/detailed.md +1 -3
  250. package/docs/rules/presets/index.md +75 -75
  251. package/docs/rules/presets/jsdoc.md +1 -3
  252. package/docs/rules/presets/packages.md +1 -3
  253. package/docs/rules/presets/recommended.md +1 -3
  254. package/docs/rules/presets/tsdoc.md +1 -3
  255. package/docs/rules/presets/typedoc-strict.md +1 -3
  256. package/docs/rules/presets/typedoc.md +1 -3
  257. package/docs/rules/require.md +53 -44
  258. package/docs/rules/required-tags/require-abstract.md +31 -30
  259. package/docs/rules/required-tags/require-alpha.md +18 -9
  260. package/docs/rules/required-tags/require-author.md +31 -30
  261. package/docs/rules/required-tags/require-beta.md +18 -9
  262. package/docs/rules/required-tags/require-category.md +30 -31
  263. package/docs/rules/required-tags/require-class.md +11 -10
  264. package/docs/rules/required-tags/require-decorator.md +18 -9
  265. package/docs/rules/required-tags/require-default-value.md +18 -9
  266. package/docs/rules/required-tags/require-deprecated.md +18 -9
  267. package/docs/rules/required-tags/require-document.md +31 -30
  268. package/docs/rules/required-tags/require-enum.md +13 -12
  269. package/docs/rules/required-tags/require-event-property.md +18 -9
  270. package/docs/rules/required-tags/require-event.md +31 -30
  271. package/docs/rules/required-tags/require-example.md +17 -10
  272. package/docs/rules/required-tags/require-expand.md +31 -30
  273. package/docs/rules/required-tags/require-experimental.md +18 -9
  274. package/docs/rules/required-tags/require-function.md +11 -13
  275. package/docs/rules/required-tags/require-group.md +31 -30
  276. package/docs/rules/required-tags/require-hidden.md +32 -31
  277. package/docs/rules/required-tags/require-hideconstructor.md +31 -30
  278. package/docs/rules/required-tags/require-ignore.md +31 -30
  279. package/docs/rules/required-tags/require-import.md +30 -31
  280. package/docs/rules/required-tags/require-include.md +31 -32
  281. package/docs/rules/required-tags/require-inherit-doc.md +18 -9
  282. package/docs/rules/required-tags/require-inline.md +31 -30
  283. package/docs/rules/required-tags/require-interface.md +14 -13
  284. package/docs/rules/required-tags/require-internal.md +18 -9
  285. package/docs/rules/required-tags/require-label.md +18 -9
  286. package/docs/rules/required-tags/require-license.md +31 -30
  287. package/docs/rules/required-tags/require-link.md +18 -9
  288. package/docs/rules/required-tags/require-merge-module-with.md +31 -30
  289. package/docs/rules/required-tags/require-module.md +14 -13
  290. package/docs/rules/required-tags/require-namespace.md +31 -30
  291. package/docs/rules/required-tags/require-overload.md +31 -30
  292. package/docs/rules/required-tags/require-override.md +18 -9
  293. package/docs/rules/required-tags/require-package-documentation.md +14 -13
  294. package/docs/rules/required-tags/require-param.md +14 -13
  295. package/docs/rules/required-tags/require-primary-export.md +31 -30
  296. package/docs/rules/required-tags/require-private-remarks.md +18 -11
  297. package/docs/rules/required-tags/require-private.md +31 -30
  298. package/docs/rules/required-tags/require-property.md +31 -30
  299. package/docs/rules/required-tags/require-protected.md +31 -30
  300. package/docs/rules/required-tags/require-public.md +19 -10
  301. package/docs/rules/required-tags/require-readonly.md +19 -10
  302. package/docs/rules/required-tags/require-remarks.md +12 -10
  303. package/docs/rules/required-tags/require-returns.md +14 -13
  304. package/docs/rules/required-tags/require-sealed.md +19 -10
  305. package/docs/rules/required-tags/require-see.md +19 -10
  306. package/docs/rules/required-tags/require-since.md +30 -31
  307. package/docs/rules/required-tags/require-sort-strategy.md +31 -30
  308. package/docs/rules/required-tags/require-summary.md +31 -30
  309. package/docs/rules/required-tags/require-template.md +31 -30
  310. package/docs/rules/required-tags/require-throws.md +20 -19
  311. package/docs/rules/required-tags/require-type-param.md +14 -13
  312. package/docs/rules/required-tags/require-use-declared-type.md +31 -30
  313. package/docs/rules/required-tags/require-virtual.md +20 -11
  314. package/docs/rules/required-tags.md +40 -38
  315. package/docs/rules/restrict-tags.md +68 -60
  316. package/package.json +67 -80
package/README.md CHANGED
@@ -10,14 +10,14 @@ non-exported top-level declarations.
10
10
 
11
11
  1. [Installation](#installation)
12
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-)
13
+ 3. [Opt into non-exported declarations](#opt-into-non-exported-declarations)
14
+ 4. [Presets](#presets)
15
+ 5. [Preset matrix](#preset-matrix)
16
+ 6. [Preset usage examples](#preset-usage-examples)
17
+ 7. [Rules](#rules)
18
+ 8. [Rule docs](#rule-docs)
19
+ 9. [License](#license)
20
+ 10. [Contributors ✨](#contributors-)
21
21
 
22
22
  ## Installation
23
23
 
@@ -36,16 +36,16 @@ Use `tsdocRequire.configs.tsdoc` for stricter TSDoc conventions, or
36
36
  import tsdocRequire from "eslint-plugin-tsdoc-require-2";
37
37
 
38
38
  export default [
39
- tsdocRequire.configs.recommended,
40
- {
41
- plugins: {
42
- "tsdoc-require-2": tsdocRequire,
43
- },
44
- rules: {
45
- "tsdoc-require-2/require": "error",
46
- "tsdoc-require-2/require-remarks": "error",
47
- },
39
+ tsdocRequire.configs.recommended,
40
+ {
41
+ plugins: {
42
+ "tsdoc-require-2": tsdocRequire,
43
+ },
44
+ rules: {
45
+ "tsdoc-require-2/require": "error",
46
+ "tsdoc-require-2/require-remarks": "error",
48
47
  },
48
+ },
49
49
  ];
50
50
  ```
51
51
 
@@ -59,25 +59,25 @@ you want.
59
59
  import tsdocRequire from "eslint-plugin-tsdoc-require-2";
60
60
 
61
61
  export default [
62
- {
63
- plugins: {
64
- "tsdoc-require-2": tsdocRequire,
62
+ {
63
+ plugins: {
64
+ "tsdoc-require-2": tsdocRequire,
65
+ },
66
+ rules: {
67
+ "tsdoc-require-2/require": [
68
+ "error",
69
+ {
70
+ includeNonExported: true,
65
71
  },
66
- rules: {
67
- "tsdoc-require-2/require": [
68
- "error",
69
- {
70
- includeNonExported: true,
71
- },
72
- ],
73
- "tsdoc-require-2/require-remarks": [
74
- "error",
75
- {
76
- includeNonExported: true,
77
- },
78
- ],
72
+ ],
73
+ "tsdoc-require-2/require-remarks": [
74
+ "error",
75
+ {
76
+ includeNonExported: true,
79
77
  },
78
+ ],
80
79
  },
80
+ },
81
81
  ];
82
82
  ```
83
83
 
@@ -103,66 +103,66 @@ The matrix below is generated by `scripts/sync-presets-rules-matrix.mjs`.
103
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
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
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) |
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) |
166
166
 
167
167
  <!-- END_PRESETS_MATRIX -->
168
168
 
@@ -172,14 +172,14 @@ The matrix below is generated by `scripts/sync-presets-rules-matrix.mjs`.
172
172
  import tsdocRequire from "eslint-plugin-tsdoc-require-2";
173
173
 
174
174
  export default [
175
- tsdocRequire.configs.detailed,
176
- // or:
177
- // tsdocRequire.configs.packages,
178
- // tsdocRequire.configs.tsdoc,
179
- // tsdocRequire.configs.jsdoc,
180
- // tsdocRequire.configs.typedoc,
181
- // tsdocRequire.configs["typedoc-strict"],
182
- // tsdocRequire.configs.all,
175
+ tsdocRequire.configs.detailed,
176
+ // or:
177
+ // tsdocRequire.configs.packages,
178
+ // tsdocRequire.configs.tsdoc,
179
+ // tsdocRequire.configs.jsdoc,
180
+ // tsdocRequire.configs.typedoc,
181
+ // tsdocRequire.configs["typedoc-strict"],
182
+ // tsdocRequire.configs.all,
183
183
  ];
184
184
  ```
185
185
 
@@ -213,7 +213,9 @@ MIT © Nick2bad4u
213
213
  ## Contributors ✨
214
214
 
215
215
  <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
216
+
216
217
  [![All Contributors.](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)
218
+
217
219
  <!-- ALL-CONTRIBUTORS-BADGE:END -->
218
220
 
219
221
  Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
@@ -3,9 +3,28 @@ 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
  const ts_extras_1 = require("ts-extras");
6
+ const ruleCreator = utils_1.ESLintUtils.RuleCreator;
6
7
  /** RuleCreator instance for all required-tag rules in this plugin. */
7
- const createTagRule = utils_1.ESLintUtils.RuleCreator((ruleName) => `https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags.md#${ruleName}`);
8
+ const createTagRule = ruleCreator((ruleName) => `https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags.md#${ruleName}`);
8
9
  exports.createTagRule = createTagRule;
10
+ const exportedDeclarationModes = ["all", "exported"];
11
+ const nonExportedDeclarationModes = ["all", "non-exported"];
12
+ const supportedDeclarationNodeTypes = [
13
+ utils_1.AST_NODE_TYPES.ClassDeclaration,
14
+ utils_1.AST_NODE_TYPES.FunctionDeclaration,
15
+ utils_1.AST_NODE_TYPES.TSDeclareFunction,
16
+ utils_1.AST_NODE_TYPES.TSEnumDeclaration,
17
+ utils_1.AST_NODE_TYPES.TSInterfaceDeclaration,
18
+ utils_1.AST_NODE_TYPES.TSModuleDeclaration,
19
+ utils_1.AST_NODE_TYPES.TSTypeAliasDeclaration,
20
+ utils_1.AST_NODE_TYPES.VariableDeclaration,
21
+ ];
22
+ const supportedDefaultExportExpressionNodeTypes = [
23
+ utils_1.AST_NODE_TYPES.ArrowFunctionExpression,
24
+ utils_1.AST_NODE_TYPES.ClassExpression,
25
+ utils_1.AST_NODE_TYPES.FunctionExpression,
26
+ utils_1.AST_NODE_TYPES.ObjectExpression,
27
+ ];
9
28
  /** Entity kinds that can be checked by this rule family. */
10
29
  const enforceableEntityKinds = [
11
30
  "class",
@@ -63,16 +82,13 @@ const resolveExportMode = (ruleOption) => {
63
82
  }
64
83
  return ruleOption?.exportMode ?? "exported";
65
84
  };
66
- const shouldCheckExportedDeclarations = (exportMode) => exportMode === "all" || exportMode === "exported";
67
- const shouldCheckNonExportedDeclarations = (exportMode) => exportMode === "all" || exportMode === "non-exported";
68
- const assertUnreachable = (value) => {
69
- throw new Error(`Unexpected node type: ${String(value)}`);
70
- };
85
+ const shouldCheckExportedDeclarations = (exportMode) => (0, ts_extras_1.arrayIncludes)(exportedDeclarationModes, exportMode);
86
+ const shouldCheckNonExportedDeclarations = (exportMode) => (0, ts_extras_1.arrayIncludes)(nonExportedDeclarationModes, exportMode);
71
87
  const isWordCharacter = (character) => {
72
88
  if (!(0, ts_extras_1.isDefined)(character)) {
73
89
  return false;
74
90
  }
75
- return /\w/u.test(character);
91
+ return /\w/v.test(character);
76
92
  };
77
93
  const hasRequiredTag = (commentText, tagName) => {
78
94
  let searchStartIndex = 0;
@@ -104,18 +120,8 @@ const getModuleDeclarationName = (declaration) => {
104
120
  }
105
121
  return undefined;
106
122
  };
107
- const isSupportedDeclaration = (node) => node.type === utils_1.AST_NODE_TYPES.ClassDeclaration ||
108
- node.type === utils_1.AST_NODE_TYPES.FunctionDeclaration ||
109
- node.type === utils_1.AST_NODE_TYPES.TSDeclareFunction ||
110
- node.type === utils_1.AST_NODE_TYPES.TSEnumDeclaration ||
111
- node.type === utils_1.AST_NODE_TYPES.TSInterfaceDeclaration ||
112
- node.type === utils_1.AST_NODE_TYPES.TSModuleDeclaration ||
113
- node.type === utils_1.AST_NODE_TYPES.TSTypeAliasDeclaration ||
114
- node.type === utils_1.AST_NODE_TYPES.VariableDeclaration;
115
- const isSupportedDefaultExportExpression = (node) => node.type === utils_1.AST_NODE_TYPES.ArrowFunctionExpression ||
116
- node.type === utils_1.AST_NODE_TYPES.ClassExpression ||
117
- node.type === utils_1.AST_NODE_TYPES.FunctionExpression ||
118
- node.type === utils_1.AST_NODE_TYPES.ObjectExpression;
123
+ const isSupportedDeclaration = (node) => (0, ts_extras_1.arrayIncludes)(supportedDeclarationNodeTypes, node.type);
124
+ const isSupportedDefaultExportExpression = (node) => (0, ts_extras_1.arrayIncludes)(supportedDefaultExportExpressionNodeTypes, node.type);
119
125
  const getExpressionKind = (node) => {
120
126
  if (node.type === utils_1.AST_NODE_TYPES.ArrowFunctionExpression ||
121
127
  node.type === utils_1.AST_NODE_TYPES.FunctionExpression) {
@@ -124,10 +130,7 @@ const getExpressionKind = (node) => {
124
130
  if (node.type === utils_1.AST_NODE_TYPES.ClassExpression) {
125
131
  return "class";
126
132
  }
127
- if (node.type === utils_1.AST_NODE_TYPES.ObjectExpression) {
128
- return "object";
129
- }
130
- return assertUnreachable(node);
133
+ return "object";
131
134
  };
132
135
  const getTSDocCommentNode = (sourceCode, node) => {
133
136
  const comments = sourceCode.getCommentsBefore(node);
@@ -141,12 +144,7 @@ const getTSDocCommentNode = (sourceCode, node) => {
141
144
  if (!nearestComment.value.startsWith("*")) {
142
145
  return null;
143
146
  }
144
- const nearestCommentLoc = nearestComment.loc;
145
- const nodeLoc = node.loc;
146
- if (nearestCommentLoc === null || nodeLoc === null) {
147
- return null;
148
- }
149
- const lineGap = nodeLoc.start.line - nearestCommentLoc.end.line;
147
+ const lineGap = node.loc.start.line - nearestComment.loc.end.line;
150
148
  if (lineGap < 0 || lineGap > 1) {
151
149
  return null;
152
150
  }
@@ -218,22 +216,19 @@ const declarationTargets = (declaration) => {
218
216
  },
219
217
  ];
220
218
  }
221
- if (declaration.type === utils_1.AST_NODE_TYPES.VariableDeclaration) {
222
- return declaration.declarations.flatMap((declarator) => {
223
- if (declarator.id.type !== utils_1.AST_NODE_TYPES.Identifier) {
224
- return [];
225
- }
226
- return [
227
- {
228
- commentNode: declaration,
229
- kind: "variable",
230
- name: declarator.id.name,
231
- reportNode: declarator,
232
- },
233
- ];
234
- });
235
- }
236
- return assertUnreachable(declaration);
219
+ return declaration.declarations.flatMap((declarator) => {
220
+ if (declarator.id.type !== utils_1.AST_NODE_TYPES.Identifier) {
221
+ return [];
222
+ }
223
+ return [
224
+ {
225
+ commentNode: declaration,
226
+ kind: "variable",
227
+ name: declarator.id.name,
228
+ reportNode: declarator,
229
+ },
230
+ ];
231
+ });
237
232
  };
238
233
  const declarationTargetsWithCommentNode = (declaration, commentNode) => declarationTargets(declaration).map((target) => ({
239
234
  ...target,
@@ -336,9 +331,6 @@ const createRequireTagRuleListener = (context, requiredTag) => {
336
331
  return;
337
332
  }
338
333
  for (const specifier of exportNode.specifiers) {
339
- if (specifier.type !== utils_1.AST_NODE_TYPES.ExportSpecifier) {
340
- continue;
341
- }
342
334
  checkIdentifierExport(specifier.local);
343
335
  }
344
336
  },
@@ -1,13 +1,12 @@
1
- import type { JSONSchema, TSESLint } from "@typescript-eslint/utils";
2
- import { ESLintUtils } from "@typescript-eslint/utils";
1
+ import { ESLintUtils, type JSONSchema, type TSESLint } from "@typescript-eslint/utils";
3
2
  /** Supported declaration kinds enforced by require/required-tag rules. */
4
3
  type EntityKind = "class" | "enum" | "function" | "interface" | "namespace" | "object" | "type" | "variable";
5
4
  /** Export targeting modes supported by shared require-tag rules. */
6
5
  type ExportMode = "all" | "exported" | "non-exported";
7
6
  /** Extra docs metadata shape used by this plugin's RuleCreator. */
8
- type RuleDocs = {
7
+ interface RuleDocs {
9
8
  recommended: boolean;
10
- };
9
+ }
11
10
  /** Rule context type alias shared by generated required-tag rules. */
12
11
  type TagRuleContext = Readonly<TSESLint.RuleContext<TagRuleMessageIds, TagRuleOptions>>;
13
12
  /** Rule module type alias shared by generated required-tag rules. */
@@ -15,16 +14,16 @@ type TagRuleModule = ESLintUtils.RuleModule<TagRuleMessageIds, TagRuleOptions, R
15
14
  /** RuleCreator instance for all required-tag rules in this plugin. */
16
15
  declare const createTagRule: ReturnType<typeof ESLintUtils.RuleCreator<RuleDocs>>;
17
16
  /** Shared options supported by required-tag rules. */
18
- type RuleOption = {
17
+ interface RuleOption {
19
18
  enforceFor?: readonly EntityKind[];
20
19
  exportMode?: ExportMode;
21
20
  includeNonExported?: boolean;
22
- };
21
+ }
23
22
  /** Metadata describing an individual required-tag rule. */
24
- type TagRuleDefinition = {
23
+ interface TagRuleDefinition {
25
24
  readonly ruleName: string;
26
25
  readonly tagName: `@${string}`;
27
- };
26
+ }
28
27
  /** Message id union used by generated required-tag rules. */
29
28
  type TagRuleMessageIds = "missingTag";
30
29
  /** RuleTester-compatible options tuple for required-tag rules. */
@@ -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;AAGlC,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
+ {"version":3,"file":"require-tag-factory.d.ts","sourceRoot":"","sources":["../../src/internal/require-tag-factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAGH,WAAW,EACX,KAAK,UAAU,EACf,KAAK,QAAQ,EAEhB,MAAM,0BAA0B,CAAC;AAGlC,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,UAAU,QAAQ;IACd,WAAW,EAAE,OAAO,CAAC;CACxB;AAED,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;AAIF,sEAAsE;AACtE,QAAA,MAAM,aAAa,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,CAInE,CAAC;AAEN,sDAAsD;AACtD,UAAU,UAAU;IAChB,UAAU,CAAC,EAAE,SAAS,UAAU,EAAE,CAAC;IACnC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC;AAqCD,2DAA2D;AAC3D,UAAU,iBAAiB;IACvB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,IAAI,MAAM,EAAE,CAAC;CAClC;AAED,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;AAwOF;;;;;;;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,YA6KX,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"}