eslint-plugin-tsdoc-require-2 1.0.2 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (174) hide show
  1. package/README.md +115 -73
  2. package/dist/internal/require-tag-factory.cjs +309 -0
  3. package/dist/internal/require-tag-factory.d.ts +26 -0
  4. package/dist/internal/require-tag-factory.d.ts.map +1 -0
  5. package/dist/internal/require-tag-factory.js +302 -0
  6. package/dist/internal/require-tag-factory.js.map +1 -0
  7. package/dist/plugin.cjs +33 -11
  8. package/dist/plugin.d.ts +2 -1
  9. package/dist/plugin.d.ts.map +1 -1
  10. package/dist/plugin.js +33 -11
  11. package/dist/plugin.js.map +1 -1
  12. package/dist/rules/require-tag-rules.cjs +88 -0
  13. package/dist/rules/require-tag-rules.d.ts +35 -0
  14. package/dist/rules/require-tag-rules.d.ts.map +1 -0
  15. package/dist/rules/require-tag-rules.js +85 -0
  16. package/dist/rules/require-tag-rules.js.map +1 -0
  17. package/dist/rules/require.cjs +16 -3
  18. package/dist/rules/require.d.ts +1 -0
  19. package/dist/rules/require.d.ts.map +1 -1
  20. package/dist/rules/require.js +16 -3
  21. package/dist/rules/require.js.map +1 -1
  22. package/dist/rules/required-tags/require-alpha.cjs +32 -0
  23. package/dist/rules/required-tags/require-alpha.d.ts +4 -0
  24. package/dist/rules/required-tags/require-alpha.d.ts.map +1 -0
  25. package/dist/rules/required-tags/require-alpha.js +30 -0
  26. package/dist/rules/required-tags/require-alpha.js.map +1 -0
  27. package/dist/rules/required-tags/require-beta.cjs +32 -0
  28. package/dist/rules/required-tags/require-beta.d.ts +4 -0
  29. package/dist/rules/required-tags/require-beta.d.ts.map +1 -0
  30. package/dist/rules/required-tags/require-beta.js +30 -0
  31. package/dist/rules/required-tags/require-beta.js.map +1 -0
  32. package/dist/rules/required-tags/require-decorator.cjs +32 -0
  33. package/dist/rules/required-tags/require-decorator.d.ts +4 -0
  34. package/dist/rules/required-tags/require-decorator.d.ts.map +1 -0
  35. package/dist/rules/required-tags/require-decorator.js +30 -0
  36. package/dist/rules/required-tags/require-decorator.js.map +1 -0
  37. package/dist/rules/required-tags/require-default-value.cjs +32 -0
  38. package/dist/rules/required-tags/require-default-value.d.ts +4 -0
  39. package/dist/rules/required-tags/require-default-value.d.ts.map +1 -0
  40. package/dist/rules/required-tags/require-default-value.js +30 -0
  41. package/dist/rules/required-tags/require-default-value.js.map +1 -0
  42. package/dist/rules/required-tags/require-deprecated.cjs +32 -0
  43. package/dist/rules/required-tags/require-deprecated.d.ts +4 -0
  44. package/dist/rules/required-tags/require-deprecated.d.ts.map +1 -0
  45. package/dist/rules/required-tags/require-deprecated.js +30 -0
  46. package/dist/rules/required-tags/require-deprecated.js.map +1 -0
  47. package/dist/rules/required-tags/require-event-property.cjs +32 -0
  48. package/dist/rules/required-tags/require-event-property.d.ts +4 -0
  49. package/dist/rules/required-tags/require-event-property.d.ts.map +1 -0
  50. package/dist/rules/required-tags/require-event-property.js +30 -0
  51. package/dist/rules/required-tags/require-event-property.js.map +1 -0
  52. package/dist/rules/required-tags/require-example.cjs +32 -0
  53. package/dist/rules/required-tags/require-example.d.ts +4 -0
  54. package/dist/rules/required-tags/require-example.d.ts.map +1 -0
  55. package/dist/rules/required-tags/require-example.js +30 -0
  56. package/dist/rules/required-tags/require-example.js.map +1 -0
  57. package/dist/rules/required-tags/require-experimental.cjs +32 -0
  58. package/dist/rules/required-tags/require-experimental.d.ts +4 -0
  59. package/dist/rules/required-tags/require-experimental.d.ts.map +1 -0
  60. package/dist/rules/required-tags/require-experimental.js +30 -0
  61. package/dist/rules/required-tags/require-experimental.js.map +1 -0
  62. package/dist/rules/required-tags/require-inherit-doc.cjs +32 -0
  63. package/dist/rules/required-tags/require-inherit-doc.d.ts +4 -0
  64. package/dist/rules/required-tags/require-inherit-doc.d.ts.map +1 -0
  65. package/dist/rules/required-tags/require-inherit-doc.js +30 -0
  66. package/dist/rules/required-tags/require-inherit-doc.js.map +1 -0
  67. package/dist/rules/required-tags/require-internal.cjs +32 -0
  68. package/dist/rules/required-tags/require-internal.d.ts +4 -0
  69. package/dist/rules/required-tags/require-internal.d.ts.map +1 -0
  70. package/dist/rules/required-tags/require-internal.js +30 -0
  71. package/dist/rules/required-tags/require-internal.js.map +1 -0
  72. package/dist/rules/required-tags/require-label.cjs +32 -0
  73. package/dist/rules/required-tags/require-label.d.ts +4 -0
  74. package/dist/rules/required-tags/require-label.d.ts.map +1 -0
  75. package/dist/rules/required-tags/require-label.js +30 -0
  76. package/dist/rules/required-tags/require-label.js.map +1 -0
  77. package/dist/rules/required-tags/require-link.cjs +32 -0
  78. package/dist/rules/required-tags/require-link.d.ts +4 -0
  79. package/dist/rules/required-tags/require-link.d.ts.map +1 -0
  80. package/dist/rules/required-tags/require-link.js +30 -0
  81. package/dist/rules/required-tags/require-link.js.map +1 -0
  82. package/dist/rules/required-tags/require-override.cjs +32 -0
  83. package/dist/rules/required-tags/require-override.d.ts +4 -0
  84. package/dist/rules/required-tags/require-override.d.ts.map +1 -0
  85. package/dist/rules/required-tags/require-override.js +30 -0
  86. package/dist/rules/required-tags/require-override.js.map +1 -0
  87. package/dist/rules/required-tags/require-package-documentation.cjs +32 -0
  88. package/dist/rules/required-tags/require-package-documentation.d.ts +4 -0
  89. package/dist/rules/required-tags/require-package-documentation.d.ts.map +1 -0
  90. package/dist/rules/required-tags/require-package-documentation.js +30 -0
  91. package/dist/rules/required-tags/require-package-documentation.js.map +1 -0
  92. package/dist/rules/required-tags/require-param.cjs +32 -0
  93. package/dist/rules/required-tags/require-param.d.ts +4 -0
  94. package/dist/rules/required-tags/require-param.d.ts.map +1 -0
  95. package/dist/rules/required-tags/require-param.js +30 -0
  96. package/dist/rules/required-tags/require-param.js.map +1 -0
  97. package/dist/rules/required-tags/require-private-remarks.cjs +32 -0
  98. package/dist/rules/required-tags/require-private-remarks.d.ts +4 -0
  99. package/dist/rules/required-tags/require-private-remarks.d.ts.map +1 -0
  100. package/dist/rules/required-tags/require-private-remarks.js +30 -0
  101. package/dist/rules/required-tags/require-private-remarks.js.map +1 -0
  102. package/dist/rules/required-tags/require-public.cjs +32 -0
  103. package/dist/rules/required-tags/require-public.d.ts +4 -0
  104. package/dist/rules/required-tags/require-public.d.ts.map +1 -0
  105. package/dist/rules/required-tags/require-public.js +30 -0
  106. package/dist/rules/required-tags/require-public.js.map +1 -0
  107. package/dist/rules/required-tags/require-readonly.cjs +32 -0
  108. package/dist/rules/required-tags/require-readonly.d.ts +4 -0
  109. package/dist/rules/required-tags/require-readonly.d.ts.map +1 -0
  110. package/dist/rules/required-tags/require-readonly.js +30 -0
  111. package/dist/rules/required-tags/require-readonly.js.map +1 -0
  112. package/dist/rules/required-tags/require-remarks.cjs +32 -0
  113. package/dist/rules/required-tags/require-remarks.d.ts +4 -0
  114. package/dist/rules/required-tags/require-remarks.d.ts.map +1 -0
  115. package/dist/rules/required-tags/require-remarks.js +30 -0
  116. package/dist/rules/required-tags/require-remarks.js.map +1 -0
  117. package/dist/rules/required-tags/require-returns.cjs +32 -0
  118. package/dist/rules/required-tags/require-returns.d.ts +4 -0
  119. package/dist/rules/required-tags/require-returns.d.ts.map +1 -0
  120. package/dist/rules/required-tags/require-returns.js +30 -0
  121. package/dist/rules/required-tags/require-returns.js.map +1 -0
  122. package/dist/rules/required-tags/require-sealed.cjs +32 -0
  123. package/dist/rules/required-tags/require-sealed.d.ts +4 -0
  124. package/dist/rules/required-tags/require-sealed.d.ts.map +1 -0
  125. package/dist/rules/required-tags/require-sealed.js +30 -0
  126. package/dist/rules/required-tags/require-sealed.js.map +1 -0
  127. package/dist/rules/required-tags/require-see.cjs +32 -0
  128. package/dist/rules/required-tags/require-see.d.ts +4 -0
  129. package/dist/rules/required-tags/require-see.d.ts.map +1 -0
  130. package/dist/rules/required-tags/require-see.js +30 -0
  131. package/dist/rules/required-tags/require-see.js.map +1 -0
  132. package/dist/rules/required-tags/require-throws.cjs +32 -0
  133. package/dist/rules/required-tags/require-throws.d.ts +4 -0
  134. package/dist/rules/required-tags/require-throws.d.ts.map +1 -0
  135. package/dist/rules/required-tags/require-throws.js +30 -0
  136. package/dist/rules/required-tags/require-throws.js.map +1 -0
  137. package/dist/rules/required-tags/require-type-param.cjs +32 -0
  138. package/dist/rules/required-tags/require-type-param.d.ts +4 -0
  139. package/dist/rules/required-tags/require-type-param.d.ts.map +1 -0
  140. package/dist/rules/required-tags/require-type-param.js +30 -0
  141. package/dist/rules/required-tags/require-type-param.js.map +1 -0
  142. package/dist/rules/required-tags/require-virtual.cjs +32 -0
  143. package/dist/rules/required-tags/require-virtual.d.ts +4 -0
  144. package/dist/rules/required-tags/require-virtual.d.ts.map +1 -0
  145. package/dist/rules/required-tags/require-virtual.js +30 -0
  146. package/dist/rules/required-tags/require-virtual.js.map +1 -0
  147. package/docs/rules/require.md +39 -5
  148. package/docs/rules/required-tags/require-alpha.md +57 -0
  149. package/docs/rules/required-tags/require-beta.md +57 -0
  150. package/docs/rules/required-tags/require-decorator.md +57 -0
  151. package/docs/rules/required-tags/require-default-value.md +57 -0
  152. package/docs/rules/required-tags/require-deprecated.md +57 -0
  153. package/docs/rules/required-tags/require-event-property.md +57 -0
  154. package/docs/rules/required-tags/require-example.md +57 -0
  155. package/docs/rules/required-tags/require-experimental.md +57 -0
  156. package/docs/rules/required-tags/require-inherit-doc.md +57 -0
  157. package/docs/rules/required-tags/require-internal.md +57 -0
  158. package/docs/rules/required-tags/require-label.md +57 -0
  159. package/docs/rules/required-tags/require-link.md +57 -0
  160. package/docs/rules/required-tags/require-override.md +57 -0
  161. package/docs/rules/required-tags/require-package-documentation.md +57 -0
  162. package/docs/rules/required-tags/require-param.md +57 -0
  163. package/docs/rules/required-tags/require-private-remarks.md +57 -0
  164. package/docs/rules/required-tags/require-public.md +57 -0
  165. package/docs/rules/required-tags/require-readonly.md +57 -0
  166. package/docs/rules/required-tags/require-remarks.md +57 -0
  167. package/docs/rules/required-tags/require-returns.md +57 -0
  168. package/docs/rules/required-tags/require-sealed.md +57 -0
  169. package/docs/rules/required-tags/require-see.md +57 -0
  170. package/docs/rules/required-tags/require-throws.md +57 -0
  171. package/docs/rules/required-tags/require-type-param.md +57 -0
  172. package/docs/rules/required-tags/require-virtual.md +57 -0
  173. package/docs/rules/required-tags.md +76 -0
  174. package/package.json +27 -13
@@ -0,0 +1,302 @@
1
+ import { AST_NODE_TYPES, AST_TOKEN_TYPES, ESLintUtils, } from "@typescript-eslint/utils";
2
+ const createTagRule =
3
+ // eslint-disable-next-line total-functions/no-hidden-type-assertions -- RuleCreator generic is required to support plugin-specific docs.recommended metadata field.
4
+ ESLintUtils.RuleCreator((ruleName) => `https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags.md#${ruleName}`);
5
+ const enforceableEntityKinds = [
6
+ "class",
7
+ "enum",
8
+ "function",
9
+ "interface",
10
+ "object",
11
+ "type",
12
+ "variable",
13
+ ];
14
+ const defaultEnforceFor = [...enforceableEntityKinds];
15
+ const defaultRuleOptions = [
16
+ {
17
+ enforceFor: defaultEnforceFor,
18
+ includeNonExported: false,
19
+ },
20
+ ];
21
+ const optionSchema = {
22
+ additionalProperties: false,
23
+ properties: {
24
+ enforceFor: {
25
+ items: {
26
+ enum: [...enforceableEntityKinds],
27
+ type: "string",
28
+ },
29
+ type: "array",
30
+ uniqueItems: true,
31
+ },
32
+ includeNonExported: {
33
+ default: false,
34
+ description: "Also enforce on non-exported declarations (opt-in).",
35
+ type: "boolean",
36
+ },
37
+ },
38
+ type: "object",
39
+ };
40
+ const assertUnreachable = (value) => {
41
+ throw new Error(`Unexpected node type: ${String(value)}`);
42
+ };
43
+ const isWordCharacter = (character) => {
44
+ if (character === undefined) {
45
+ return false;
46
+ }
47
+ return /\w/u.test(character);
48
+ };
49
+ const hasRequiredTag = (commentText, tagName) => {
50
+ let searchStartIndex = 0;
51
+ while (searchStartIndex < commentText.length) {
52
+ const tagIndex = commentText.indexOf(tagName, searchStartIndex);
53
+ if (tagIndex === -1) {
54
+ return false;
55
+ }
56
+ const beforeCharacter = tagIndex > 0 ? commentText[tagIndex - 1] : undefined;
57
+ const afterCharacter = commentText[tagIndex + tagName.length];
58
+ const hasBoundaryBefore = !isWordCharacter(beforeCharacter);
59
+ const hasBoundaryAfter = !isWordCharacter(afterCharacter);
60
+ if (hasBoundaryBefore && hasBoundaryAfter) {
61
+ return true;
62
+ }
63
+ searchStartIndex = tagIndex + tagName.length;
64
+ }
65
+ return false;
66
+ };
67
+ const getEntityDisplayName = (name) => name ?? "<default export>";
68
+ const isSupportedDeclaration = (node) => node.type === AST_NODE_TYPES.ClassDeclaration ||
69
+ node.type === AST_NODE_TYPES.FunctionDeclaration ||
70
+ node.type === AST_NODE_TYPES.TSDeclareFunction ||
71
+ node.type === AST_NODE_TYPES.TSEnumDeclaration ||
72
+ node.type === AST_NODE_TYPES.TSInterfaceDeclaration ||
73
+ node.type === AST_NODE_TYPES.TSTypeAliasDeclaration ||
74
+ node.type === AST_NODE_TYPES.VariableDeclaration;
75
+ const isSupportedDefaultExportExpression = (node) => node.type === AST_NODE_TYPES.ArrowFunctionExpression ||
76
+ node.type === AST_NODE_TYPES.ClassExpression ||
77
+ node.type === AST_NODE_TYPES.FunctionExpression ||
78
+ node.type === AST_NODE_TYPES.ObjectExpression;
79
+ const getExpressionKind = (node) => {
80
+ if (node.type === AST_NODE_TYPES.ArrowFunctionExpression ||
81
+ node.type === AST_NODE_TYPES.FunctionExpression) {
82
+ return "function";
83
+ }
84
+ if (node.type === AST_NODE_TYPES.ClassExpression) {
85
+ return "class";
86
+ }
87
+ if (node.type === AST_NODE_TYPES.ObjectExpression) {
88
+ return "object";
89
+ }
90
+ return assertUnreachable(node);
91
+ };
92
+ const getTSDocCommentNode = (sourceCode, node) => {
93
+ const comments = sourceCode.getCommentsBefore(node);
94
+ const nearestComment = comments.at(-1);
95
+ if (nearestComment === undefined) {
96
+ return null;
97
+ }
98
+ if (nearestComment.type !== AST_TOKEN_TYPES.Block) {
99
+ return null;
100
+ }
101
+ if (!nearestComment.value.startsWith("*")) {
102
+ return null;
103
+ }
104
+ const nearestCommentLoc = nearestComment.loc;
105
+ const nodeLoc = node.loc;
106
+ if (nearestCommentLoc === null || nodeLoc === null) {
107
+ return null;
108
+ }
109
+ const lineGap = nodeLoc.start.line - nearestCommentLoc.end.line;
110
+ if (lineGap < 0 || lineGap > 1) {
111
+ return null;
112
+ }
113
+ return nearestComment;
114
+ };
115
+ const createTargetKey = (target) => {
116
+ const [start, end] = target.reportNode.range;
117
+ return `${start}:${end}:${target.kind}:${target.name ?? ""}`;
118
+ };
119
+ const declarationTargets = (declaration) => {
120
+ if (declaration.type === AST_NODE_TYPES.ClassDeclaration) {
121
+ return [
122
+ {
123
+ commentNode: declaration,
124
+ kind: "class",
125
+ name: declaration.id?.name,
126
+ reportNode: declaration,
127
+ },
128
+ ];
129
+ }
130
+ if (declaration.type === AST_NODE_TYPES.FunctionDeclaration ||
131
+ declaration.type === AST_NODE_TYPES.TSDeclareFunction) {
132
+ return [
133
+ {
134
+ commentNode: declaration,
135
+ kind: "function",
136
+ name: declaration.id?.name,
137
+ reportNode: declaration,
138
+ },
139
+ ];
140
+ }
141
+ if (declaration.type === AST_NODE_TYPES.TSEnumDeclaration) {
142
+ return [
143
+ {
144
+ commentNode: declaration,
145
+ kind: "enum",
146
+ name: declaration.id.name,
147
+ reportNode: declaration,
148
+ },
149
+ ];
150
+ }
151
+ if (declaration.type === AST_NODE_TYPES.TSInterfaceDeclaration) {
152
+ return [
153
+ {
154
+ commentNode: declaration,
155
+ kind: "interface",
156
+ name: declaration.id.name,
157
+ reportNode: declaration,
158
+ },
159
+ ];
160
+ }
161
+ if (declaration.type === AST_NODE_TYPES.TSTypeAliasDeclaration) {
162
+ return [
163
+ {
164
+ commentNode: declaration,
165
+ kind: "type",
166
+ name: declaration.id.name,
167
+ reportNode: declaration,
168
+ },
169
+ ];
170
+ }
171
+ if (declaration.type === AST_NODE_TYPES.VariableDeclaration) {
172
+ return declaration.declarations.flatMap((declarator) => {
173
+ if (declarator.id.type !== AST_NODE_TYPES.Identifier) {
174
+ return [];
175
+ }
176
+ return [
177
+ {
178
+ commentNode: declaration,
179
+ kind: "variable",
180
+ name: declarator.id.name,
181
+ reportNode: declarator,
182
+ },
183
+ ];
184
+ });
185
+ }
186
+ return assertUnreachable(declaration);
187
+ };
188
+ const declarationTargetsWithCommentNode = (declaration, commentNode) => declarationTargets(declaration).map((target) => ({
189
+ ...target,
190
+ commentNode,
191
+ }));
192
+ const createRequireTagRuleListener = (context, requiredTag) => {
193
+ const declarationsByName = new Map();
194
+ const checkedTargets = new Set();
195
+ const sourceCode = context.sourceCode;
196
+ const ruleOption = context.options.at(0);
197
+ const enabledKinds = new Set(ruleOption?.enforceFor ?? defaultEnforceFor);
198
+ const includeNonExported = ruleOption?.includeNonExported ?? false;
199
+ const checkTarget = (target) => {
200
+ if (!enabledKinds.has(target.kind)) {
201
+ return;
202
+ }
203
+ const targetKey = createTargetKey(target);
204
+ if (checkedTargets.has(targetKey)) {
205
+ return;
206
+ }
207
+ checkedTargets.add(targetKey);
208
+ const commentNode = getTSDocCommentNode(sourceCode, target.commentNode);
209
+ if (commentNode === null) {
210
+ return;
211
+ }
212
+ if (hasRequiredTag(commentNode.value, requiredTag)) {
213
+ return;
214
+ }
215
+ context.report({
216
+ data: {
217
+ entityKind: target.kind,
218
+ entityName: getEntityDisplayName(target.name),
219
+ tagName: requiredTag,
220
+ },
221
+ messageId: "missingTag",
222
+ node: target.reportNode,
223
+ });
224
+ };
225
+ const checkDeclarationWithExportComment = (declaration, exportNode) => {
226
+ for (const target of declarationTargetsWithCommentNode(declaration, exportNode)) {
227
+ checkTarget(target);
228
+ }
229
+ };
230
+ const trackDeclarationTargets = (declaration) => {
231
+ for (const target of declarationTargets(declaration)) {
232
+ if (target.name === undefined) {
233
+ continue;
234
+ }
235
+ declarationsByName.set(target.name, target);
236
+ }
237
+ };
238
+ const checkIdentifierExport = (identifier) => {
239
+ const target = declarationsByName.get(identifier.name);
240
+ if (target !== undefined) {
241
+ checkTarget(target);
242
+ }
243
+ };
244
+ return {
245
+ ExportDefaultDeclaration(exportNode) {
246
+ const { declaration } = exportNode;
247
+ if (declaration.type === AST_NODE_TYPES.Identifier) {
248
+ checkIdentifierExport(declaration);
249
+ return;
250
+ }
251
+ if (isSupportedDeclaration(declaration)) {
252
+ checkDeclarationWithExportComment(declaration, exportNode);
253
+ return;
254
+ }
255
+ if (isSupportedDefaultExportExpression(declaration)) {
256
+ checkTarget({
257
+ commentNode: exportNode,
258
+ kind: getExpressionKind(declaration),
259
+ name: undefined,
260
+ reportNode: declaration,
261
+ });
262
+ }
263
+ },
264
+ ExportNamedDeclaration(exportNode) {
265
+ if (exportNode.declaration !== null &&
266
+ isSupportedDeclaration(exportNode.declaration)) {
267
+ checkDeclarationWithExportComment(exportNode.declaration, exportNode);
268
+ }
269
+ if (exportNode.source !== null) {
270
+ return;
271
+ }
272
+ for (const specifier of exportNode.specifiers) {
273
+ if (specifier.type !== AST_NODE_TYPES.ExportSpecifier) {
274
+ continue;
275
+ }
276
+ checkIdentifierExport(specifier.local);
277
+ }
278
+ },
279
+ Program(programNode) {
280
+ declarationsByName.clear();
281
+ checkedTargets.clear();
282
+ for (const statement of programNode.body) {
283
+ if (includeNonExported && isSupportedDeclaration(statement)) {
284
+ for (const target of declarationTargetsWithCommentNode(statement, statement)) {
285
+ checkTarget(target);
286
+ }
287
+ }
288
+ if (isSupportedDeclaration(statement)) {
289
+ trackDeclarationTargets(statement);
290
+ continue;
291
+ }
292
+ if (statement.type === AST_NODE_TYPES.ExportNamedDeclaration &&
293
+ statement.declaration !== null &&
294
+ isSupportedDeclaration(statement.declaration)) {
295
+ trackDeclarationTargets(statement.declaration);
296
+ }
297
+ }
298
+ },
299
+ };
300
+ };
301
+ export { createRequireTagRuleListener, createTagRule, defaultRuleOptions, enforceableEntityKinds, optionSchema, };
302
+ //# sourceMappingURL=require-tag-factory.js.map
@@ -0,0 +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;AAuBlC,MAAM,aAAa;AACf,oKAAoK;AACpK,WAAW,CAAC,WAAW,CACnB,CAAC,QAAQ,EAAE,EAAE,CACT,qGAAqG,QAAQ,EAAE,CACtH,CAAC;AAsCN,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,MAAM,kBAAkB,GAAmB;IACvC;QACI,UAAU,EAAE,iBAAiB;QAC7B,kBAAkB,EAAE,KAAK;KAC5B;CACJ,CAAC;AAEF,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,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"}
package/dist/plugin.cjs CHANGED
@@ -1,29 +1,51 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.rules = void 0;
4
+ const require_tag_rules_js_1 = require("./rules/require-tag-rules.cjs");
4
5
  const require_js_1 = require("./rules/require.cjs");
5
6
  const rules = {
6
7
  require: require_js_1.default,
8
+ ...require_tag_rules_js_1.requiredTagRules,
7
9
  };
8
10
  exports.rules = rules;
9
11
  const pluginRules = rules;
10
- const recommendedConfig = {
11
- plugins: {},
12
- rules: {
13
- "tsdoc-require-2/require": "error",
14
- },
15
- };
16
12
  const plugin = {
17
- configs: {
18
- recommended: recommendedConfig,
19
- },
13
+ configs: {},
20
14
  meta: {
21
15
  name: "eslint-plugin-tsdoc-require-2",
22
- version: "0.1.0",
16
+ version: "1.0.2",
23
17
  },
24
18
  rules: pluginRules,
25
19
  };
26
- recommendedConfig.plugins["tsdoc-require-2"] = plugin;
20
+ const presetRuleNames = {
21
+ all: ["require", ...require_tag_rules_js_1.requiredTagDefinitions.map(({ ruleName }) => ruleName)],
22
+ detailed: ["require", "require-remarks"],
23
+ packages: [
24
+ "require",
25
+ "require-remarks",
26
+ "require-package-documentation",
27
+ ],
28
+ recommended: ["require"],
29
+ };
30
+ const createPresetRules = (ruleNames) => {
31
+ const presetRules = {};
32
+ for (const ruleName of ruleNames) {
33
+ presetRules[`tsdoc-require-2/${ruleName}`] = "error";
34
+ }
35
+ return presetRules;
36
+ };
37
+ const createPresetConfig = (ruleNames) => ({
38
+ plugins: {
39
+ "tsdoc-require-2": plugin,
40
+ },
41
+ rules: createPresetRules(ruleNames),
42
+ });
43
+ plugin.configs = {
44
+ all: createPresetConfig(presetRuleNames.all),
45
+ detailed: createPresetConfig(presetRuleNames.detailed),
46
+ packages: createPresetConfig(presetRuleNames.packages),
47
+ recommended: createPresetConfig(presetRuleNames.recommended),
48
+ };
27
49
  exports.default = plugin;
28
50
  //# sourceMappingURL=plugin.js.map
29
51
 
package/dist/plugin.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  import type { ESLint } from "eslint";
2
+ import { requiredTagRules } from "./rules/require-tag-rules.js";
2
3
  import requireRule from "./rules/require.js";
3
- type RuleModuleMap = {
4
+ type RuleModuleMap = typeof requiredTagRules & {
4
5
  require: typeof requireRule;
5
6
  };
6
7
  declare const rules: RuleModuleMap;
@@ -1 +1 @@
1
- {"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAU,MAAM,QAAQ,CAAC;AAE7C,OAAO,WAAW,MAAM,oBAAoB,CAAC;AAO7C,KAAK,aAAa,GAAG;IACjB,OAAO,EAAE,OAAO,WAAW,CAAC;CAC/B,CAAC;AAEF,QAAA,MAAM,KAAK,EAAE,aAEZ,CAAC;AAWF,QAAA,MAAM,MAAM,EAAE,MAAM,CAAC,MASpB,CAAC;AAIF,OAAO,EAAE,KAAK,EAAE,CAAC;AACjB,eAAe,MAAM,CAAC"}
1
+ {"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAU,MAAM,QAAQ,CAAC;AAE7C,OAAO,EAEH,gBAAgB,EACnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,WAAW,MAAM,oBAAoB,CAAC;AAO7C,KAAK,aAAa,GAAG,OAAO,gBAAgB,GAAG;IAC3C,OAAO,EAAE,OAAO,WAAW,CAAC;CAC/B,CAAC;AAEF,QAAA,MAAM,KAAK,EAAE,aAGZ,CAAC;AAIF,QAAA,MAAM,MAAM,EAAE,MAAM,CAAC,MAOpB,CAAC;AAuCF,OAAO,EAAE,KAAK,EAAE,CAAC;AACjB,eAAe,MAAM,CAAC"}
package/dist/plugin.js CHANGED
@@ -1,25 +1,47 @@
1
+ import { requiredTagDefinitions, requiredTagRules, } from "./rules/require-tag-rules.js";
1
2
  import requireRule from "./rules/require.js";
2
3
  const rules = {
3
4
  require: requireRule,
5
+ ...requiredTagRules,
4
6
  };
5
7
  const pluginRules = rules;
6
- const recommendedConfig = {
7
- plugins: {},
8
- rules: {
9
- "tsdoc-require-2/require": "error",
10
- },
11
- };
12
8
  const plugin = {
13
- configs: {
14
- recommended: recommendedConfig,
15
- },
9
+ configs: {},
16
10
  meta: {
17
11
  name: "eslint-plugin-tsdoc-require-2",
18
- version: "0.1.0",
12
+ version: "1.0.2",
19
13
  },
20
14
  rules: pluginRules,
21
15
  };
22
- recommendedConfig.plugins["tsdoc-require-2"] = plugin;
16
+ const presetRuleNames = {
17
+ all: ["require", ...requiredTagDefinitions.map(({ ruleName }) => ruleName)],
18
+ detailed: ["require", "require-remarks"],
19
+ packages: [
20
+ "require",
21
+ "require-remarks",
22
+ "require-package-documentation",
23
+ ],
24
+ recommended: ["require"],
25
+ };
26
+ const createPresetRules = (ruleNames) => {
27
+ const presetRules = {};
28
+ for (const ruleName of ruleNames) {
29
+ presetRules[`tsdoc-require-2/${ruleName}`] = "error";
30
+ }
31
+ return presetRules;
32
+ };
33
+ const createPresetConfig = (ruleNames) => ({
34
+ plugins: {
35
+ "tsdoc-require-2": plugin,
36
+ },
37
+ rules: createPresetRules(ruleNames),
38
+ });
39
+ plugin.configs = {
40
+ all: createPresetConfig(presetRuleNames.all),
41
+ detailed: createPresetConfig(presetRuleNames.detailed),
42
+ packages: createPresetConfig(presetRuleNames.packages),
43
+ recommended: createPresetConfig(presetRuleNames.recommended),
44
+ };
23
45
  export { rules };
24
46
  export default plugin;
25
47
  //# sourceMappingURL=plugin.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAEA,OAAO,WAAW,MAAM,oBAAoB,CAAC;AAW7C,MAAM,KAAK,GAAkB;IACzB,OAAO,EAAE,WAAW;CACvB,CAAC;AAEF,MAAM,WAAW,GAAG,KAAuD,CAAC;AAE5E,MAAM,iBAAiB,GAAsB;IACzC,OAAO,EAAE,EAAE;IACX,KAAK,EAAE;QACH,yBAAyB,EAAE,OAAO;KACrC;CACJ,CAAC;AAEF,MAAM,MAAM,GAAkB;IAC1B,OAAO,EAAE;QACL,WAAW,EAAE,iBAAiB;KACjC;IACD,IAAI,EAAE;QACF,IAAI,EAAE,+BAA+B;QACrC,OAAO,EAAE,OAAO;KACnB;IACD,KAAK,EAAE,WAAW;CACrB,CAAC;AAEF,iBAAiB,CAAC,OAAO,CAAC,iBAAiB,CAAC,GAAG,MAAM,CAAC;AAEtD,OAAO,EAAE,KAAK,EAAE,CAAC;AACjB,eAAe,MAAM,CAAC"}
1
+ {"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAEA,OAAO,EACH,sBAAsB,EACtB,gBAAgB,GACnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,WAAW,MAAM,oBAAoB,CAAC;AAW7C,MAAM,KAAK,GAAkB;IACzB,OAAO,EAAE,WAAW;IACpB,GAAG,gBAAgB;CACtB,CAAC;AAEF,MAAM,WAAW,GAAG,KAAuD,CAAC;AAE5E,MAAM,MAAM,GAAkB;IAC1B,OAAO,EAAE,EAAE;IACX,IAAI,EAAE;QACF,IAAI,EAAE,+BAA+B;QACrC,OAAO,EAAE,OAAO;KACnB;IACD,KAAK,EAAE,WAAW;CACrB,CAAC;AAEF,MAAM,eAAe,GAAG;IACpB,GAAG,EAAE,CAAC,SAAS,EAAE,GAAG,sBAAsB,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC;IAC3E,QAAQ,EAAE,CAAC,SAAS,EAAE,iBAAiB,CAAC;IACxC,QAAQ,EAAE;QACN,SAAS;QACT,iBAAiB;QACjB,+BAA+B;KAClC;IACD,WAAW,EAAE,CAAC,SAAS,CAAC;CAClB,CAAC;AAEX,MAAM,iBAAiB,GAAG,CACtB,SAA4B,EACI,EAAE;IAClC,MAAM,WAAW,GAAqC,EAAE,CAAC;IAEzD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QAC/B,WAAW,CAAC,mBAAmB,QAAQ,EAAE,CAAC,GAAG,OAAO,CAAC;IACzD,CAAC;IAED,OAAO,WAAW,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,SAA4B,EAAc,EAAE,CAAC,CAAC;IACtE,OAAO,EAAE;QACL,iBAAiB,EAAE,MAAM;KAC5B;IACD,KAAK,EAAE,iBAAiB,CAAC,SAAS,CAAC;CACtC,CAAC,CAAC;AAEH,MAAM,CAAC,OAAO,GAAG;IACb,GAAG,EAAE,kBAAkB,CAAC,eAAe,CAAC,GAAG,CAAC;IAC5C,QAAQ,EAAE,kBAAkB,CAAC,eAAe,CAAC,QAAQ,CAAC;IACtD,QAAQ,EAAE,kBAAkB,CAAC,eAAe,CAAC,QAAQ,CAAC;IACtD,WAAW,EAAE,kBAAkB,CAAC,eAAe,CAAC,WAAW,CAAC;CAC/D,CAAC;AAEF,OAAO,EAAE,KAAK,EAAE,CAAC;AACjB,eAAe,MAAM,CAAC"}
@@ -0,0 +1,88 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.requiredTagRules = exports.requiredTagDefinitions = void 0;
4
+ const require_alpha_js_1 = require("./required-tags/require-alpha.cjs");
5
+ const require_beta_js_1 = require("./required-tags/require-beta.cjs");
6
+ const require_decorator_js_1 = require("./required-tags/require-decorator.cjs");
7
+ const require_default_value_js_1 = require("./required-tags/require-default-value.cjs");
8
+ const require_deprecated_js_1 = require("./required-tags/require-deprecated.cjs");
9
+ const require_event_property_js_1 = require("./required-tags/require-event-property.cjs");
10
+ const require_example_js_1 = require("./required-tags/require-example.cjs");
11
+ const require_experimental_js_1 = require("./required-tags/require-experimental.cjs");
12
+ const require_inherit_doc_js_1 = require("./required-tags/require-inherit-doc.cjs");
13
+ const require_internal_js_1 = require("./required-tags/require-internal.cjs");
14
+ const require_label_js_1 = require("./required-tags/require-label.cjs");
15
+ const require_link_js_1 = require("./required-tags/require-link.cjs");
16
+ const require_override_js_1 = require("./required-tags/require-override.cjs");
17
+ const require_package_documentation_js_1 = require("./required-tags/require-package-documentation.cjs");
18
+ const require_param_js_1 = require("./required-tags/require-param.cjs");
19
+ const require_private_remarks_js_1 = require("./required-tags/require-private-remarks.cjs");
20
+ const require_public_js_1 = require("./required-tags/require-public.cjs");
21
+ const require_readonly_js_1 = require("./required-tags/require-readonly.cjs");
22
+ const require_remarks_js_1 = require("./required-tags/require-remarks.cjs");
23
+ const require_returns_js_1 = require("./required-tags/require-returns.cjs");
24
+ const require_sealed_js_1 = require("./required-tags/require-sealed.cjs");
25
+ const require_see_js_1 = require("./required-tags/require-see.cjs");
26
+ const require_throws_js_1 = require("./required-tags/require-throws.cjs");
27
+ const require_type_param_js_1 = require("./required-tags/require-type-param.cjs");
28
+ const require_virtual_js_1 = require("./required-tags/require-virtual.cjs");
29
+ const requiredTagDefinitions = [
30
+ { ruleName: "require-alpha", tagName: "@alpha" },
31
+ { ruleName: "require-beta", tagName: "@beta" },
32
+ { ruleName: "require-decorator", tagName: "@decorator" },
33
+ { ruleName: "require-default-value", tagName: "@defaultValue" },
34
+ { ruleName: "require-deprecated", tagName: "@deprecated" },
35
+ { ruleName: "require-event-property", tagName: "@eventProperty" },
36
+ { ruleName: "require-example", tagName: "@example" },
37
+ { ruleName: "require-experimental", tagName: "@experimental" },
38
+ { ruleName: "require-inherit-doc", tagName: "@inheritDoc" },
39
+ { ruleName: "require-internal", tagName: "@internal" },
40
+ { ruleName: "require-label", tagName: "@label" },
41
+ { ruleName: "require-link", tagName: "@link" },
42
+ { ruleName: "require-override", tagName: "@override" },
43
+ {
44
+ ruleName: "require-package-documentation",
45
+ tagName: "@packageDocumentation",
46
+ },
47
+ { ruleName: "require-param", tagName: "@param" },
48
+ { ruleName: "require-private-remarks", tagName: "@privateRemarks" },
49
+ { ruleName: "require-public", tagName: "@public" },
50
+ { ruleName: "require-readonly", tagName: "@readonly" },
51
+ { ruleName: "require-remarks", tagName: "@remarks" },
52
+ { ruleName: "require-returns", tagName: "@returns" },
53
+ { ruleName: "require-sealed", tagName: "@sealed" },
54
+ { ruleName: "require-see", tagName: "@see" },
55
+ { ruleName: "require-throws", tagName: "@throws" },
56
+ { ruleName: "require-type-param", tagName: "@typeParam" },
57
+ { ruleName: "require-virtual", tagName: "@virtual" },
58
+ ];
59
+ exports.requiredTagDefinitions = requiredTagDefinitions;
60
+ const requiredTagRules = {
61
+ "require-alpha": require_alpha_js_1.default,
62
+ "require-beta": require_beta_js_1.default,
63
+ "require-decorator": require_decorator_js_1.default,
64
+ "require-default-value": require_default_value_js_1.default,
65
+ "require-deprecated": require_deprecated_js_1.default,
66
+ "require-event-property": require_event_property_js_1.default,
67
+ "require-example": require_example_js_1.default,
68
+ "require-experimental": require_experimental_js_1.default,
69
+ "require-inherit-doc": require_inherit_doc_js_1.default,
70
+ "require-internal": require_internal_js_1.default,
71
+ "require-label": require_label_js_1.default,
72
+ "require-link": require_link_js_1.default,
73
+ "require-override": require_override_js_1.default,
74
+ "require-package-documentation": require_package_documentation_js_1.default,
75
+ "require-param": require_param_js_1.default,
76
+ "require-private-remarks": require_private_remarks_js_1.default,
77
+ "require-public": require_public_js_1.default,
78
+ "require-readonly": require_readonly_js_1.default,
79
+ "require-remarks": require_remarks_js_1.default,
80
+ "require-returns": require_returns_js_1.default,
81
+ "require-sealed": require_sealed_js_1.default,
82
+ "require-see": require_see_js_1.default,
83
+ "require-throws": require_throws_js_1.default,
84
+ "require-type-param": require_type_param_js_1.default,
85
+ "require-virtual": require_virtual_js_1.default,
86
+ };
87
+ exports.requiredTagRules = requiredTagRules;
88
+ //# sourceMappingURL=require-tag-rules.js.map
@@ -0,0 +1,35 @@
1
+ import type { TSESLint } from "@typescript-eslint/utils";
2
+ import type { TagRuleDefinition, TagRuleMessageIds, TagRuleOptions } from "../internal/require-tag-factory.js";
3
+ declare const requiredTagDefinitions: readonly TagRuleDefinition[];
4
+ type RequiredTagRules = {
5
+ "require-alpha": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
6
+ "require-beta": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
7
+ "require-decorator": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
8
+ "require-default-value": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
9
+ "require-deprecated": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
10
+ "require-event-property": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
11
+ "require-example": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
12
+ "require-experimental": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
13
+ "require-inherit-doc": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
14
+ "require-internal": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
15
+ "require-label": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
16
+ "require-link": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
17
+ "require-override": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
18
+ "require-package-documentation": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
19
+ "require-param": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
20
+ "require-private-remarks": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
21
+ "require-public": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
22
+ "require-readonly": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
23
+ "require-remarks": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
24
+ "require-returns": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
25
+ "require-sealed": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
26
+ "require-see": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
27
+ "require-throws": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
28
+ "require-type-param": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
29
+ "require-virtual": TSESLint.RuleModule<TagRuleMessageIds, TagRuleOptions>;
30
+ };
31
+ declare const requiredTagRules: RequiredTagRules;
32
+ export type RequiredTagRuleName = keyof typeof requiredTagRules;
33
+ export { requiredTagDefinitions };
34
+ export { requiredTagRules };
35
+ //# sourceMappingURL=require-tag-rules.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"require-tag-rules.d.ts","sourceRoot":"","sources":["../../src/rules/require-tag-rules.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEzD,OAAO,KAAK,EACR,iBAAiB,EACjB,iBAAiB,EACjB,cAAc,EACjB,MAAM,oCAAoC,CAAC;AA4B5C,QAAA,MAAM,sBAAsB,EAAE,SAAS,iBAAiB,EA6BvD,CAAC;AAEF,KAAK,gBAAgB,GAAG;IACpB,eAAe,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IACxE,cAAc,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IACvE,mBAAmB,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IAC5E,uBAAuB,EAAE,QAAQ,CAAC,UAAU,CACxC,iBAAiB,EACjB,cAAc,CACjB,CAAC;IACF,oBAAoB,EAAE,QAAQ,CAAC,UAAU,CACrC,iBAAiB,EACjB,cAAc,CACjB,CAAC;IACF,wBAAwB,EAAE,QAAQ,CAAC,UAAU,CACzC,iBAAiB,EACjB,cAAc,CACjB,CAAC;IACF,iBAAiB,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IAC1E,sBAAsB,EAAE,QAAQ,CAAC,UAAU,CACvC,iBAAiB,EACjB,cAAc,CACjB,CAAC;IACF,qBAAqB,EAAE,QAAQ,CAAC,UAAU,CACtC,iBAAiB,EACjB,cAAc,CACjB,CAAC;IACF,kBAAkB,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IAC3E,eAAe,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IACxE,cAAc,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IACvE,kBAAkB,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IAC3E,+BAA+B,EAAE,QAAQ,CAAC,UAAU,CAChD,iBAAiB,EACjB,cAAc,CACjB,CAAC;IACF,eAAe,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IACxE,yBAAyB,EAAE,QAAQ,CAAC,UAAU,CAC1C,iBAAiB,EACjB,cAAc,CACjB,CAAC;IACF,gBAAgB,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IACzE,kBAAkB,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IAC3E,iBAAiB,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IAC1E,iBAAiB,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IAC1E,gBAAgB,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IACzE,aAAa,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IACtE,gBAAgB,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IACzE,oBAAoB,EAAE,QAAQ,CAAC,UAAU,CACrC,iBAAiB,EACjB,cAAc,CACjB,CAAC;IACF,iBAAiB,EAAE,QAAQ,CAAC,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;CAC7E,CAAC;AAEF,QAAA,MAAM,gBAAgB,EAAE,gBA0BvB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,MAAM,OAAO,gBAAgB,CAAC;AAEhE,OAAO,EAAE,sBAAsB,EAAE,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,CAAC"}