eslint-plugin-jsdoc 52.0.3 → 53.0.0
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.
- package/dist/index.cjs +2 -425
- package/dist/index.d.cts +2 -22
- package/dist/index.d.ts +2 -22
- package/dist/index.js +2 -424
- package/dist/iterateJsdoc.d.cts +15 -15
- package/dist/iterateJsdoc.d.ts +15 -15
- package/dist/plugin.cjs +427 -0
- package/dist/plugin.cjs.map +1 -0
- package/dist/plugin.js +427 -0
- package/dist/plugin.js.map +1 -0
- package/package.json +2 -2
- package/dist/index.cjs.map +0 -1
- package/dist/index.d.cts.map +0 -1
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js.map +0 -1
package/dist/index.js
CHANGED
|
@@ -1,425 +1,3 @@
|
|
|
1
|
-
import
|
|
2
|
-
import checkAccess_default from "./rules/checkAccess.js";
|
|
3
|
-
import checkAlignment_default from "./rules/checkAlignment.js";
|
|
4
|
-
import checkExamples_default from "./rules/checkExamples.js";
|
|
5
|
-
import checkIndentation_default from "./rules/checkIndentation.js";
|
|
6
|
-
import checkLineAlignment_default from "./rules/checkLineAlignment.js";
|
|
7
|
-
import checkParamNames_default from "./rules/checkParamNames.js";
|
|
8
|
-
import checkPropertyNames_default from "./rules/checkPropertyNames.js";
|
|
9
|
-
import checkSyntax_default from "./rules/checkSyntax.js";
|
|
10
|
-
import checkTagNames_default from "./rules/checkTagNames.js";
|
|
11
|
-
import checkTemplateNames_default from "./rules/checkTemplateNames.js";
|
|
12
|
-
import checkTypes_default from "./rules/checkTypes.js";
|
|
13
|
-
import checkValues_default from "./rules/checkValues.js";
|
|
14
|
-
import convertToJsdocComments_default from "./rules/convertToJsdocComments.js";
|
|
15
|
-
import emptyTags_default from "./rules/emptyTags.js";
|
|
16
|
-
import implementsOnClasses_default from "./rules/implementsOnClasses.js";
|
|
17
|
-
import importsAsDependencies_default from "./rules/importsAsDependencies.js";
|
|
18
|
-
import informativeDocs_default from "./rules/informativeDocs.js";
|
|
19
|
-
import linesBeforeBlock_default from "./rules/linesBeforeBlock.js";
|
|
20
|
-
import matchDescription_default from "./rules/matchDescription.js";
|
|
21
|
-
import matchName_default from "./rules/matchName.js";
|
|
22
|
-
import multilineBlocks_default from "./rules/multilineBlocks.js";
|
|
23
|
-
import noBadBlocks_default from "./rules/noBadBlocks.js";
|
|
24
|
-
import noBlankBlockDescriptions_default from "./rules/noBlankBlockDescriptions.js";
|
|
25
|
-
import noBlankBlocks_default from "./rules/noBlankBlocks.js";
|
|
26
|
-
import noDefaults_default from "./rules/noDefaults.js";
|
|
27
|
-
import noMissingSyntax_default from "./rules/noMissingSyntax.js";
|
|
28
|
-
import noMultiAsterisks_default from "./rules/noMultiAsterisks.js";
|
|
29
|
-
import noRestrictedSyntax_default from "./rules/noRestrictedSyntax.js";
|
|
30
|
-
import noTypes_default from "./rules/noTypes.js";
|
|
31
|
-
import noUndefinedTypes_default from "./rules/noUndefinedTypes.js";
|
|
32
|
-
import requireAsteriskPrefix_default from "./rules/requireAsteriskPrefix.js";
|
|
33
|
-
import requireDescription_default from "./rules/requireDescription.js";
|
|
34
|
-
import requireDescriptionCompleteSentence_default from "./rules/requireDescriptionCompleteSentence.js";
|
|
35
|
-
import requireExample_default from "./rules/requireExample.js";
|
|
36
|
-
import requireFileOverview_default from "./rules/requireFileOverview.js";
|
|
37
|
-
import requireHyphenBeforeParamDescription_default from "./rules/requireHyphenBeforeParamDescription.js";
|
|
38
|
-
import requireJsdoc_default from "./rules/requireJsdoc.js";
|
|
39
|
-
import requireParam_default from "./rules/requireParam.js";
|
|
40
|
-
import requireParamDescription_default from "./rules/requireParamDescription.js";
|
|
41
|
-
import requireParamName_default from "./rules/requireParamName.js";
|
|
42
|
-
import requireParamType_default from "./rules/requireParamType.js";
|
|
43
|
-
import requireProperty_default from "./rules/requireProperty.js";
|
|
44
|
-
import requirePropertyDescription_default from "./rules/requirePropertyDescription.js";
|
|
45
|
-
import requirePropertyName_default from "./rules/requirePropertyName.js";
|
|
46
|
-
import requirePropertyType_default from "./rules/requirePropertyType.js";
|
|
47
|
-
import requireReturns_default from "./rules/requireReturns.js";
|
|
48
|
-
import requireReturnsCheck_default from "./rules/requireReturnsCheck.js";
|
|
49
|
-
import requireReturnsDescription_default from "./rules/requireReturnsDescription.js";
|
|
50
|
-
import requireReturnsType_default from "./rules/requireReturnsType.js";
|
|
51
|
-
import requireTemplate_default from "./rules/requireTemplate.js";
|
|
52
|
-
import requireThrows_default from "./rules/requireThrows.js";
|
|
53
|
-
import requireYields_default from "./rules/requireYields.js";
|
|
54
|
-
import requireYieldsCheck_default from "./rules/requireYieldsCheck.js";
|
|
55
|
-
import sortTags_default from "./rules/sortTags.js";
|
|
56
|
-
import tagLines_default from "./rules/tagLines.js";
|
|
57
|
-
import textEscaping_default from "./rules/textEscaping.js";
|
|
58
|
-
import validTypes_default from "./rules/validTypes.js";
|
|
1
|
+
import plugin_default from "./plugin.js";
|
|
59
2
|
|
|
60
|
-
|
|
61
|
-
/**
|
|
62
|
-
* @typedef {"recommended" | "stylistic" | "contents" | "logical" | "requirements"} ConfigGroups
|
|
63
|
-
* @typedef {"" | "-typescript" | "-typescript-flavor"} ConfigVariants
|
|
64
|
-
* @typedef {"" | "-error"} ErrorLevelVariants
|
|
65
|
-
* @type {import('eslint').ESLint.Plugin & {
|
|
66
|
-
* configs: Record<`flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}`,
|
|
67
|
-
* import('eslint').Linter.Config>
|
|
68
|
-
* }}
|
|
69
|
-
*/
|
|
70
|
-
const index = {
|
|
71
|
-
configs: {},
|
|
72
|
-
rules: {
|
|
73
|
-
"check-access": checkAccess_default,
|
|
74
|
-
"check-alignment": checkAlignment_default,
|
|
75
|
-
"check-examples": checkExamples_default,
|
|
76
|
-
"check-indentation": checkIndentation_default,
|
|
77
|
-
"check-line-alignment": checkLineAlignment_default,
|
|
78
|
-
"check-param-names": checkParamNames_default,
|
|
79
|
-
"check-property-names": checkPropertyNames_default,
|
|
80
|
-
"check-syntax": checkSyntax_default,
|
|
81
|
-
"check-tag-names": checkTagNames_default,
|
|
82
|
-
"check-template-names": checkTemplateNames_default,
|
|
83
|
-
"check-types": checkTypes_default,
|
|
84
|
-
"check-values": checkValues_default,
|
|
85
|
-
"convert-to-jsdoc-comments": convertToJsdocComments_default,
|
|
86
|
-
"empty-tags": emptyTags_default,
|
|
87
|
-
"implements-on-classes": implementsOnClasses_default,
|
|
88
|
-
"imports-as-dependencies": importsAsDependencies_default,
|
|
89
|
-
"informative-docs": informativeDocs_default,
|
|
90
|
-
"lines-before-block": linesBeforeBlock_default,
|
|
91
|
-
"match-description": matchDescription_default,
|
|
92
|
-
"match-name": matchName_default,
|
|
93
|
-
"multiline-blocks": multilineBlocks_default,
|
|
94
|
-
"no-bad-blocks": noBadBlocks_default,
|
|
95
|
-
"no-blank-block-descriptions": noBlankBlockDescriptions_default,
|
|
96
|
-
"no-blank-blocks": noBlankBlocks_default,
|
|
97
|
-
"no-defaults": noDefaults_default,
|
|
98
|
-
"no-missing-syntax": noMissingSyntax_default,
|
|
99
|
-
"no-multi-asterisks": noMultiAsterisks_default,
|
|
100
|
-
"no-restricted-syntax": noRestrictedSyntax_default,
|
|
101
|
-
"no-types": noTypes_default,
|
|
102
|
-
"no-undefined-types": noUndefinedTypes_default,
|
|
103
|
-
"require-asterisk-prefix": requireAsteriskPrefix_default,
|
|
104
|
-
"require-description": requireDescription_default,
|
|
105
|
-
"require-description-complete-sentence": requireDescriptionCompleteSentence_default,
|
|
106
|
-
"require-example": requireExample_default,
|
|
107
|
-
"require-file-overview": requireFileOverview_default,
|
|
108
|
-
"require-hyphen-before-param-description": requireHyphenBeforeParamDescription_default,
|
|
109
|
-
"require-jsdoc": requireJsdoc_default,
|
|
110
|
-
"require-param": requireParam_default,
|
|
111
|
-
"require-param-description": requireParamDescription_default,
|
|
112
|
-
"require-param-name": requireParamName_default,
|
|
113
|
-
"require-param-type": requireParamType_default,
|
|
114
|
-
"require-property": requireProperty_default,
|
|
115
|
-
"require-property-description": requirePropertyDescription_default,
|
|
116
|
-
"require-property-name": requirePropertyName_default,
|
|
117
|
-
"require-property-type": requirePropertyType_default,
|
|
118
|
-
"require-returns": requireReturns_default,
|
|
119
|
-
"require-returns-check": requireReturnsCheck_default,
|
|
120
|
-
"require-returns-description": requireReturnsDescription_default,
|
|
121
|
-
"require-returns-type": requireReturnsType_default,
|
|
122
|
-
"require-template": requireTemplate_default,
|
|
123
|
-
"require-throws": requireThrows_default,
|
|
124
|
-
"require-yields": requireYields_default,
|
|
125
|
-
"require-yields-check": requireYieldsCheck_default,
|
|
126
|
-
"sort-tags": sortTags_default,
|
|
127
|
-
"tag-lines": tagLines_default,
|
|
128
|
-
"text-escaping": textEscaping_default,
|
|
129
|
-
"valid-types": validTypes_default
|
|
130
|
-
}
|
|
131
|
-
};
|
|
132
|
-
/**
|
|
133
|
-
* @param {"warn"|"error"} warnOrError
|
|
134
|
-
* @param {string} [flatName]
|
|
135
|
-
* @returns {import('eslint').Linter.FlatConfig}
|
|
136
|
-
*/
|
|
137
|
-
const createRecommendedRuleset = (warnOrError, flatName) => {
|
|
138
|
-
return {
|
|
139
|
-
...flatName ? { name: "jsdoc/" + flatName } : {},
|
|
140
|
-
plugins: flatName ? { jsdoc: index } : ["jsdoc"],
|
|
141
|
-
rules: {
|
|
142
|
-
"jsdoc/check-access": warnOrError,
|
|
143
|
-
"jsdoc/check-alignment": warnOrError,
|
|
144
|
-
"jsdoc/check-examples": "off",
|
|
145
|
-
"jsdoc/check-indentation": "off",
|
|
146
|
-
"jsdoc/check-line-alignment": "off",
|
|
147
|
-
"jsdoc/check-param-names": warnOrError,
|
|
148
|
-
"jsdoc/check-property-names": warnOrError,
|
|
149
|
-
"jsdoc/check-syntax": "off",
|
|
150
|
-
"jsdoc/check-tag-names": warnOrError,
|
|
151
|
-
"jsdoc/check-template-names": "off",
|
|
152
|
-
"jsdoc/check-types": warnOrError,
|
|
153
|
-
"jsdoc/check-values": warnOrError,
|
|
154
|
-
"jsdoc/convert-to-jsdoc-comments": "off",
|
|
155
|
-
"jsdoc/empty-tags": warnOrError,
|
|
156
|
-
"jsdoc/implements-on-classes": warnOrError,
|
|
157
|
-
"jsdoc/imports-as-dependencies": "off",
|
|
158
|
-
"jsdoc/informative-docs": "off",
|
|
159
|
-
"jsdoc/lines-before-block": "off",
|
|
160
|
-
"jsdoc/match-description": "off",
|
|
161
|
-
"jsdoc/match-name": "off",
|
|
162
|
-
"jsdoc/multiline-blocks": warnOrError,
|
|
163
|
-
"jsdoc/no-bad-blocks": "off",
|
|
164
|
-
"jsdoc/no-blank-block-descriptions": "off",
|
|
165
|
-
"jsdoc/no-blank-blocks": "off",
|
|
166
|
-
"jsdoc/no-defaults": warnOrError,
|
|
167
|
-
"jsdoc/no-missing-syntax": "off",
|
|
168
|
-
"jsdoc/no-multi-asterisks": warnOrError,
|
|
169
|
-
"jsdoc/no-restricted-syntax": "off",
|
|
170
|
-
"jsdoc/no-types": "off",
|
|
171
|
-
"jsdoc/no-undefined-types": warnOrError,
|
|
172
|
-
"jsdoc/require-asterisk-prefix": "off",
|
|
173
|
-
"jsdoc/require-description": "off",
|
|
174
|
-
"jsdoc/require-description-complete-sentence": "off",
|
|
175
|
-
"jsdoc/require-example": "off",
|
|
176
|
-
"jsdoc/require-file-overview": "off",
|
|
177
|
-
"jsdoc/require-hyphen-before-param-description": "off",
|
|
178
|
-
"jsdoc/require-jsdoc": warnOrError,
|
|
179
|
-
"jsdoc/require-param": warnOrError,
|
|
180
|
-
"jsdoc/require-param-description": warnOrError,
|
|
181
|
-
"jsdoc/require-param-name": warnOrError,
|
|
182
|
-
"jsdoc/require-param-type": warnOrError,
|
|
183
|
-
"jsdoc/require-property": warnOrError,
|
|
184
|
-
"jsdoc/require-property-description": warnOrError,
|
|
185
|
-
"jsdoc/require-property-name": warnOrError,
|
|
186
|
-
"jsdoc/require-property-type": warnOrError,
|
|
187
|
-
"jsdoc/require-returns": warnOrError,
|
|
188
|
-
"jsdoc/require-returns-check": warnOrError,
|
|
189
|
-
"jsdoc/require-returns-description": warnOrError,
|
|
190
|
-
"jsdoc/require-returns-type": warnOrError,
|
|
191
|
-
"jsdoc/require-template": "off",
|
|
192
|
-
"jsdoc/require-throws": "off",
|
|
193
|
-
"jsdoc/require-yields": warnOrError,
|
|
194
|
-
"jsdoc/require-yields-check": warnOrError,
|
|
195
|
-
"jsdoc/sort-tags": "off",
|
|
196
|
-
"jsdoc/tag-lines": warnOrError,
|
|
197
|
-
"jsdoc/text-escaping": "off",
|
|
198
|
-
"jsdoc/valid-types": warnOrError
|
|
199
|
-
}
|
|
200
|
-
};
|
|
201
|
-
};
|
|
202
|
-
/**
|
|
203
|
-
* @param {"warn"|"error"} warnOrError
|
|
204
|
-
* @param {string} [flatName]
|
|
205
|
-
* @returns {import('eslint').Linter.FlatConfig}
|
|
206
|
-
*/
|
|
207
|
-
const createRecommendedTypeScriptRuleset = (warnOrError, flatName) => {
|
|
208
|
-
const ruleset = createRecommendedRuleset(warnOrError, flatName);
|
|
209
|
-
return {
|
|
210
|
-
...ruleset,
|
|
211
|
-
rules: {
|
|
212
|
-
...ruleset.rules,
|
|
213
|
-
"jsdoc/check-tag-names": [warnOrError, { typed: true }],
|
|
214
|
-
"jsdoc/no-types": warnOrError,
|
|
215
|
-
"jsdoc/no-undefined-types": "off",
|
|
216
|
-
"jsdoc/require-param-type": "off",
|
|
217
|
-
"jsdoc/require-property-type": "off",
|
|
218
|
-
"jsdoc/require-returns-type": "off"
|
|
219
|
-
}
|
|
220
|
-
};
|
|
221
|
-
};
|
|
222
|
-
/**
|
|
223
|
-
* @param {"warn"|"error"} warnOrError
|
|
224
|
-
* @param {string} [flatName]
|
|
225
|
-
* @returns {import('eslint').Linter.FlatConfig}
|
|
226
|
-
*/
|
|
227
|
-
const createRecommendedTypeScriptFlavorRuleset = (warnOrError, flatName) => {
|
|
228
|
-
const ruleset = createRecommendedRuleset(warnOrError, flatName);
|
|
229
|
-
return {
|
|
230
|
-
...ruleset,
|
|
231
|
-
rules: {
|
|
232
|
-
...ruleset.rules,
|
|
233
|
-
"jsdoc/no-undefined-types": "off"
|
|
234
|
-
}
|
|
235
|
-
};
|
|
236
|
-
};
|
|
237
|
-
/**
|
|
238
|
-
* @param {(string | unknown[])[]} ruleNames
|
|
239
|
-
*/
|
|
240
|
-
const createStandaloneRulesetFactory = (ruleNames) => {
|
|
241
|
-
/**
|
|
242
|
-
* @param {"warn"|"error"} warnOrError
|
|
243
|
-
* @param {string} [flatName]
|
|
244
|
-
* @returns {import('eslint').Linter.FlatConfig}
|
|
245
|
-
*/
|
|
246
|
-
return (warnOrError, flatName) => {
|
|
247
|
-
return {
|
|
248
|
-
name: "jsdoc/" + flatName,
|
|
249
|
-
plugins: { jsdoc: index },
|
|
250
|
-
rules: Object.fromEntries(ruleNames.map((ruleName) => {
|
|
251
|
-
return typeof ruleName === "string" ? [ruleName, warnOrError] : [ruleName[0], [warnOrError, ...ruleName.slice(1)]];
|
|
252
|
-
}))
|
|
253
|
-
};
|
|
254
|
-
};
|
|
255
|
-
};
|
|
256
|
-
const contentsRules = [
|
|
257
|
-
"jsdoc/informative-docs",
|
|
258
|
-
"jsdoc/match-description",
|
|
259
|
-
"jsdoc/no-blank-block-descriptions",
|
|
260
|
-
"jsdoc/no-blank-blocks",
|
|
261
|
-
["jsdoc/text-escaping", { escapeHTML: true }]
|
|
262
|
-
];
|
|
263
|
-
const createContentsTypescriptRuleset = createStandaloneRulesetFactory(contentsRules);
|
|
264
|
-
const createContentsTypescriptFlavorRuleset = createStandaloneRulesetFactory(contentsRules);
|
|
265
|
-
const logicalRules = [
|
|
266
|
-
"jsdoc/check-access",
|
|
267
|
-
"jsdoc/check-param-names",
|
|
268
|
-
"jsdoc/check-property-names",
|
|
269
|
-
"jsdoc/check-syntax",
|
|
270
|
-
"jsdoc/check-tag-names",
|
|
271
|
-
"jsdoc/check-template-names",
|
|
272
|
-
"jsdoc/check-types",
|
|
273
|
-
"jsdoc/check-values",
|
|
274
|
-
"jsdoc/empty-tags",
|
|
275
|
-
"jsdoc/implements-on-classes",
|
|
276
|
-
"jsdoc/require-returns-check",
|
|
277
|
-
"jsdoc/require-yields-check",
|
|
278
|
-
"jsdoc/no-bad-blocks",
|
|
279
|
-
"jsdoc/no-defaults",
|
|
280
|
-
"jsdoc/no-types",
|
|
281
|
-
"jsdoc/no-undefined-types",
|
|
282
|
-
"jsdoc/valid-types"
|
|
283
|
-
];
|
|
284
|
-
const createLogicalTypescriptRuleset = createStandaloneRulesetFactory(logicalRules);
|
|
285
|
-
const createLogicalTypescriptFlavorRuleset = createStandaloneRulesetFactory(logicalRules);
|
|
286
|
-
const requirementsRules = [
|
|
287
|
-
"jsdoc/require-example",
|
|
288
|
-
"jsdoc/require-jsdoc",
|
|
289
|
-
"jsdoc/require-param",
|
|
290
|
-
"jsdoc/require-param-description",
|
|
291
|
-
"jsdoc/require-param-name",
|
|
292
|
-
"jsdoc/require-property",
|
|
293
|
-
"jsdoc/require-property-description",
|
|
294
|
-
"jsdoc/require-property-name",
|
|
295
|
-
"jsdoc/require-returns",
|
|
296
|
-
"jsdoc/require-returns-description",
|
|
297
|
-
"jsdoc/require-yields"
|
|
298
|
-
];
|
|
299
|
-
const createRequirementsTypeScriptRuleset = createStandaloneRulesetFactory(requirementsRules);
|
|
300
|
-
const createRequirementsTypeScriptFlavorRuleset = createStandaloneRulesetFactory([
|
|
301
|
-
...requirementsRules,
|
|
302
|
-
"jsdoc/require-param-type",
|
|
303
|
-
"jsdoc/require-property-type",
|
|
304
|
-
"jsdoc/require-returns-type",
|
|
305
|
-
"jsdoc/require-template"
|
|
306
|
-
]);
|
|
307
|
-
const stylisticRules = [
|
|
308
|
-
"jsdoc/check-alignment",
|
|
309
|
-
"jsdoc/check-line-alignment",
|
|
310
|
-
"jsdoc/lines-before-block",
|
|
311
|
-
"jsdoc/multiline-blocks",
|
|
312
|
-
"jsdoc/no-multi-asterisks",
|
|
313
|
-
"jsdoc/require-asterisk-prefix",
|
|
314
|
-
["jsdoc/require-hyphen-before-param-description", "never"],
|
|
315
|
-
"jsdoc/tag-lines"
|
|
316
|
-
];
|
|
317
|
-
const createStylisticTypeScriptRuleset = createStandaloneRulesetFactory(stylisticRules);
|
|
318
|
-
const createStylisticTypeScriptFlavorRuleset = createStandaloneRulesetFactory(stylisticRules);
|
|
319
|
-
/* c8 ignore next 3 -- TS */
|
|
320
|
-
if (!index.configs) throw new Error("TypeScript guard");
|
|
321
|
-
index.configs.recommended = createRecommendedRuleset("warn");
|
|
322
|
-
index.configs["recommended-error"] = createRecommendedRuleset("error");
|
|
323
|
-
index.configs["recommended-typescript"] = createRecommendedTypeScriptRuleset("warn");
|
|
324
|
-
index.configs["recommended-typescript-error"] = createRecommendedTypeScriptRuleset("error");
|
|
325
|
-
index.configs["recommended-typescript-flavor"] = createRecommendedTypeScriptFlavorRuleset("warn");
|
|
326
|
-
index.configs["recommended-typescript-flavor-error"] = createRecommendedTypeScriptFlavorRuleset("error");
|
|
327
|
-
index.configs["flat/recommended"] = createRecommendedRuleset("warn", "flat/recommended");
|
|
328
|
-
index.configs["flat/recommended-error"] = createRecommendedRuleset("error", "flat/recommended-error");
|
|
329
|
-
index.configs["flat/recommended-typescript"] = createRecommendedTypeScriptRuleset("warn", "flat/recommended-typescript");
|
|
330
|
-
index.configs["flat/recommended-typescript-error"] = createRecommendedTypeScriptRuleset("error", "flat/recommended-typescript-error");
|
|
331
|
-
index.configs["flat/recommended-typescript-flavor"] = createRecommendedTypeScriptFlavorRuleset("warn", "flat/recommended-typescript-flavor");
|
|
332
|
-
index.configs["flat/recommended-typescript-flavor-error"] = createRecommendedTypeScriptFlavorRuleset("error", "flat/recommended-typescript-flavor-error");
|
|
333
|
-
index.configs["flat/contents-typescript"] = createContentsTypescriptRuleset("warn", "flat/contents-typescript");
|
|
334
|
-
index.configs["flat/contents-typescript-error"] = createContentsTypescriptRuleset("error", "flat/contents-typescript-error");
|
|
335
|
-
index.configs["flat/contents-typescript-flavor"] = createContentsTypescriptFlavorRuleset("warn", "flat/contents-typescript-flavor");
|
|
336
|
-
index.configs["flat/contents-typescript-flavor-error"] = createContentsTypescriptFlavorRuleset("error", "flat/contents-typescript-error-flavor");
|
|
337
|
-
index.configs["flat/logical-typescript"] = createLogicalTypescriptRuleset("warn", "flat/logical-typescript");
|
|
338
|
-
index.configs["flat/logical-typescript-error"] = createLogicalTypescriptRuleset("error", "flat/logical-typescript-error");
|
|
339
|
-
index.configs["flat/logical-typescript-flavor"] = createLogicalTypescriptFlavorRuleset("warn", "flat/logical-typescript-flavor");
|
|
340
|
-
index.configs["flat/logical-typescript-flavor-error"] = createLogicalTypescriptFlavorRuleset("error", "flat/logical-typescript-error-flavor");
|
|
341
|
-
index.configs["flat/requirements-typescript"] = createRequirementsTypeScriptRuleset("warn", "flat/requirements-typescript");
|
|
342
|
-
index.configs["flat/requirements-typescript-error"] = createRequirementsTypeScriptRuleset("error", "flat/requirements-typescript-error");
|
|
343
|
-
index.configs["flat/requirements-typescript-flavor"] = createRequirementsTypeScriptFlavorRuleset("warn", "flat/requirements-typescript-flavor");
|
|
344
|
-
index.configs["flat/requirements-typescript-flavor-error"] = createRequirementsTypeScriptFlavorRuleset("error", "flat/requirements-typescript-error-flavor");
|
|
345
|
-
index.configs["flat/stylistic-typescript"] = createStylisticTypeScriptRuleset("warn", "flat/stylistic-typescript");
|
|
346
|
-
index.configs["flat/stylistic-typescript-error"] = createStylisticTypeScriptRuleset("error", "flat/stylistic-typescript-error");
|
|
347
|
-
index.configs["flat/stylistic-typescript-flavor"] = createStylisticTypeScriptFlavorRuleset("warn", "flat/stylistic-typescript-flavor");
|
|
348
|
-
index.configs["flat/stylistic-typescript-flavor-error"] = createStylisticTypeScriptFlavorRuleset("error", "flat/stylistic-typescript-error-flavor");
|
|
349
|
-
index.configs.examples = [{
|
|
350
|
-
files: ["**/*.js"],
|
|
351
|
-
name: "jsdoc/examples/processor",
|
|
352
|
-
plugins: { examples: getJsdocProcessorPlugin() },
|
|
353
|
-
processor: "examples/examples"
|
|
354
|
-
}, {
|
|
355
|
-
files: ["**/*.md/*.js"],
|
|
356
|
-
name: "jsdoc/examples/rules",
|
|
357
|
-
rules: {
|
|
358
|
-
"eol-last": 0,
|
|
359
|
-
"import/no-unresolved": 0,
|
|
360
|
-
"import/unambiguous": 0,
|
|
361
|
-
"jsdoc/require-file-overview": 0,
|
|
362
|
-
"jsdoc/require-jsdoc": 0,
|
|
363
|
-
"no-console": 0,
|
|
364
|
-
"no-multiple-empty-lines": 0,
|
|
365
|
-
"no-undef": 0,
|
|
366
|
-
"no-unused-vars": 0,
|
|
367
|
-
"node/no-missing-import": 0,
|
|
368
|
-
"node/no-missing-require": 0,
|
|
369
|
-
"padded-blocks": 0
|
|
370
|
-
}
|
|
371
|
-
}];
|
|
372
|
-
index.configs["default-expressions"] = [{
|
|
373
|
-
files: ["**/*.js"],
|
|
374
|
-
name: "jsdoc/default-expressions/processor",
|
|
375
|
-
plugins: { examples: getJsdocProcessorPlugin({
|
|
376
|
-
checkDefaults: true,
|
|
377
|
-
checkParams: true,
|
|
378
|
-
checkProperties: true
|
|
379
|
-
}) },
|
|
380
|
-
processor: "examples/examples"
|
|
381
|
-
}, {
|
|
382
|
-
files: [
|
|
383
|
-
"**/*.jsdoc-defaults",
|
|
384
|
-
"**/*.jsdoc-params",
|
|
385
|
-
"**/*.jsdoc-properties"
|
|
386
|
-
],
|
|
387
|
-
name: "jsdoc/default-expressions/rules",
|
|
388
|
-
rules: {
|
|
389
|
-
...index.configs.examples[1].rules,
|
|
390
|
-
"chai-friendly/no-unused-expressions": 0,
|
|
391
|
-
"no-empty-function": 0,
|
|
392
|
-
"no-new": 0,
|
|
393
|
-
"no-unused-expressions": 0,
|
|
394
|
-
quotes: ["error", "double"],
|
|
395
|
-
semi: ["error", "never"],
|
|
396
|
-
strict: 0
|
|
397
|
-
}
|
|
398
|
-
}];
|
|
399
|
-
index.configs["examples-and-default-expressions"] = [
|
|
400
|
-
{
|
|
401
|
-
name: "jsdoc/examples-and-default-expressions",
|
|
402
|
-
plugins: { examples: getJsdocProcessorPlugin({
|
|
403
|
-
checkDefaults: true,
|
|
404
|
-
checkParams: true,
|
|
405
|
-
checkProperties: true
|
|
406
|
-
}) }
|
|
407
|
-
},
|
|
408
|
-
...index.configs.examples.map((config) => {
|
|
409
|
-
return {
|
|
410
|
-
...config,
|
|
411
|
-
plugins: {}
|
|
412
|
-
};
|
|
413
|
-
}),
|
|
414
|
-
...index.configs["default-expressions"].map((config) => {
|
|
415
|
-
return {
|
|
416
|
-
...config,
|
|
417
|
-
plugins: {}
|
|
418
|
-
};
|
|
419
|
-
})
|
|
420
|
-
];
|
|
421
|
-
var src_default = index;
|
|
422
|
-
|
|
423
|
-
//#endregion
|
|
424
|
-
export { src_default as default };
|
|
425
|
-
//# sourceMappingURL=index.js.map
|
|
3
|
+
export { plugin_default as default };
|
package/dist/iterateJsdoc.d.cts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import * as
|
|
1
|
+
import * as eslint0 from "eslint";
|
|
2
2
|
import * as _es_joy_jsdoccomment0 from "@es-joy/jsdoccomment";
|
|
3
3
|
import { parseComment } from "@es-joy/jsdoccomment";
|
|
4
4
|
import * as comment_parser0 from "comment-parser";
|
|
@@ -12,7 +12,7 @@ import * as estree0 from "estree";
|
|
|
12
12
|
* @param {RuleConfig} ruleConfig
|
|
13
13
|
* @returns {import('eslint').Rule.RuleModule}
|
|
14
14
|
*/
|
|
15
|
-
declare function iterateJsdoc(iterator: JsdocVisitor, ruleConfig: RuleConfig):
|
|
15
|
+
declare function iterateJsdoc(iterator: JsdocVisitor, ruleConfig: RuleConfig): eslint0.Rule.RuleModule;
|
|
16
16
|
type Integer = number;
|
|
17
17
|
type JsdocBlockWithInline = _es_joy_jsdoccomment0.JsdocBlockWithInline;
|
|
18
18
|
type ContextObject = {
|
|
@@ -32,7 +32,7 @@ type CheckJsdoc = (info: {
|
|
|
32
32
|
isFunctionContext?: boolean;
|
|
33
33
|
selector?: string;
|
|
34
34
|
comment?: string;
|
|
35
|
-
}, handler: null | ((jsdoc: _es_joy_jsdoccomment0.JsdocBlockWithInline) => boolean | undefined), node:
|
|
35
|
+
}, handler: null | ((jsdoc: _es_joy_jsdoccomment0.JsdocBlockWithInline) => boolean | undefined), node: eslint0.Rule.Node) => void;
|
|
36
36
|
type ForEachPreferredTag = (tagName: string, arrayHandler: (matchingJsdocTag: _es_joy_jsdoccomment0.JsdocTagWithInline, targetTagName: string) => void, skipReportingBlockedTag?: boolean | undefined) => void;
|
|
37
37
|
type ReportSettings = (message: string) => void;
|
|
38
38
|
type ParseClosureTemplateTag = (tag: comment_parser0.Spec) => string[];
|
|
@@ -217,7 +217,7 @@ type Utils = BasicUtils & {
|
|
|
217
217
|
/**
|
|
218
218
|
* Should use ESLint rule's typing.
|
|
219
219
|
*/
|
|
220
|
-
type EslintRuleMeta =
|
|
220
|
+
type EslintRuleMeta = eslint0.Rule.RuleMetaData;
|
|
221
221
|
/**
|
|
222
222
|
* A plain object for tracking state as needed by rules across iterations.
|
|
223
223
|
*/
|
|
@@ -242,8 +242,8 @@ type StateObject = {
|
|
|
242
242
|
/**
|
|
243
243
|
* The Node AST as supplied by the parser.
|
|
244
244
|
*/
|
|
245
|
-
type Node =
|
|
246
|
-
type Report = (message: string, fix?:
|
|
245
|
+
type Node = eslint0.Rule.Node;
|
|
246
|
+
type Report = (message: string, fix?: eslint0.Rule.ReportFixer | null | undefined, jsdocLoc?: {
|
|
247
247
|
line?: Integer;
|
|
248
248
|
column?: Integer;
|
|
249
249
|
} | (comment_parser0.Spec & {
|
|
@@ -301,10 +301,10 @@ type JSDocSettings = {
|
|
|
301
301
|
/**
|
|
302
302
|
* Create the report function
|
|
303
303
|
*/
|
|
304
|
-
type MakeReport = (context:
|
|
304
|
+
type MakeReport = (context: eslint0.Rule.RuleContext, commentNode: estree0.Node) => Report;
|
|
305
305
|
type JsdocVisitorBasic = (arg: {
|
|
306
|
-
context:
|
|
307
|
-
sourceCode:
|
|
306
|
+
context: eslint0.Rule.RuleContext;
|
|
307
|
+
sourceCode: eslint0.SourceCode;
|
|
308
308
|
indent?: string;
|
|
309
309
|
info?: {
|
|
310
310
|
comment?: string | undefined;
|
|
@@ -313,7 +313,7 @@ type JsdocVisitorBasic = (arg: {
|
|
|
313
313
|
state?: StateObject;
|
|
314
314
|
globalState?: Map<string, Map<string, string>>;
|
|
315
315
|
jsdoc?: JsdocBlockWithInline;
|
|
316
|
-
jsdocNode?:
|
|
316
|
+
jsdocNode?: eslint0.Rule.Node & {
|
|
317
317
|
range: [number, number];
|
|
318
318
|
};
|
|
319
319
|
node?: Node;
|
|
@@ -324,8 +324,8 @@ type JsdocVisitorBasic = (arg: {
|
|
|
324
324
|
utils: BasicUtils;
|
|
325
325
|
}) => any;
|
|
326
326
|
type JsdocVisitor = (arg: {
|
|
327
|
-
context:
|
|
328
|
-
sourceCode:
|
|
327
|
+
context: eslint0.Rule.RuleContext;
|
|
328
|
+
sourceCode: eslint0.SourceCode;
|
|
329
329
|
indent: string;
|
|
330
330
|
info: {
|
|
331
331
|
comment?: string | undefined;
|
|
@@ -334,7 +334,7 @@ type JsdocVisitor = (arg: {
|
|
|
334
334
|
state: StateObject;
|
|
335
335
|
globalState: Map<string, Map<string, string>>;
|
|
336
336
|
jsdoc: JsdocBlockWithInline;
|
|
337
|
-
jsdocNode:
|
|
337
|
+
jsdocNode: eslint0.Rule.Node & {
|
|
338
338
|
range: [number, number];
|
|
339
339
|
};
|
|
340
340
|
node: Node | null;
|
|
@@ -397,7 +397,7 @@ type RuleConfig = {
|
|
|
397
397
|
* Handler to be executed upon exiting iteration of program AST
|
|
398
398
|
*/
|
|
399
399
|
exit?: ((args: {
|
|
400
|
-
context:
|
|
400
|
+
context: eslint0.Rule.RuleContext;
|
|
401
401
|
state: StateObject;
|
|
402
402
|
settings: Settings;
|
|
403
403
|
utils: BasicUtils;
|
|
@@ -465,7 +465,7 @@ type RuleConfig = {
|
|
|
465
465
|
* @param {import('eslint').Rule.RuleContext & JSDocSettings} context
|
|
466
466
|
* @returns {Settings|false}
|
|
467
467
|
*/
|
|
468
|
-
declare function getSettings(context:
|
|
468
|
+
declare function getSettings(context: eslint0.Rule.RuleContext & JSDocSettings): Settings | false;
|
|
469
469
|
//#endregion
|
|
470
470
|
export { AddLine, AddLines, AddTag, AvoidDocs, BasicUtils, ChangeTag, CheckJsdoc, ClassHasTag, ComparePaths, Context, ContextObject, DropPathSegmentQuotes, EmptyTokens, EslintRuleMeta, FilterAllTags, FilterTags, FindContext, ForEachPreferredTag, GetClassJsdoc, GetClassNode, GetDescription, GetFirstLine, GetFunctionParameterNames, GetJsdocTagsDeep, GetPreferredTagName, GetPreferredTagNameObject, GetPresentTags, GetRegexFromString, GetTagDescription, GetTagStructureForMode, GetTags, GetTagsByType, HasATag, HasOptionTag, HasParams, HasTag, HasThrowValue, HasValueOrExecutorHasNonEmptyResolveValue, HasYieldReturnValue, HasYieldValue, Integer, IsAsync, IsConstructor, IsGenerator, IsIteratingFunction, IsNamepathX, IsValidTag, IsVirtualFunction, JSDocSettings, JsdocBlockWithInline, JsdocVisitor, JsdocVisitorBasic, MakeMultiline, MakeReport, MayBeUndefinedTypeTag, Node, NonCommentArgs, ParseClosureTemplateTag, PreferredTypes, RemoveTag, Report, ReportJSDoc, ReportSettings, RuleConfig, SeedTokens, SetBlockDescription, SetDescriptionLines, SetTag, SetTagDescription, Settings, StateObject, Stringify, StructuredTags, TagMightHaveNamePositionTypePosition, TagMissingRequiredTypeOrNamepath, TagMustHave, Utils, iterateJsdoc as default, getSettings, parseComment };
|
|
471
471
|
//# sourceMappingURL=iterateJsdoc.d.cts.map
|
package/dist/iterateJsdoc.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import * as _es_joy_jsdoccomment0 from "@es-joy/jsdoccomment";
|
|
2
2
|
import { parseComment } from "@es-joy/jsdoccomment";
|
|
3
3
|
import * as comment_parser0 from "comment-parser";
|
|
4
|
-
import * as
|
|
4
|
+
import * as eslint0 from "eslint";
|
|
5
5
|
import * as __jsdocUtils_js0 from "./jsdocUtils.js";
|
|
6
6
|
import * as __getDefaultTagStructureForMode_js0 from "./getDefaultTagStructureForMode.js";
|
|
7
7
|
import * as estree0 from "estree";
|
|
@@ -12,7 +12,7 @@ import * as estree0 from "estree";
|
|
|
12
12
|
* @param {RuleConfig} ruleConfig
|
|
13
13
|
* @returns {import('eslint').Rule.RuleModule}
|
|
14
14
|
*/
|
|
15
|
-
declare function iterateJsdoc(iterator: JsdocVisitor, ruleConfig: RuleConfig):
|
|
15
|
+
declare function iterateJsdoc(iterator: JsdocVisitor, ruleConfig: RuleConfig): eslint0.Rule.RuleModule;
|
|
16
16
|
type Integer = number;
|
|
17
17
|
type JsdocBlockWithInline = _es_joy_jsdoccomment0.JsdocBlockWithInline;
|
|
18
18
|
type ContextObject = {
|
|
@@ -32,7 +32,7 @@ type CheckJsdoc = (info: {
|
|
|
32
32
|
isFunctionContext?: boolean;
|
|
33
33
|
selector?: string;
|
|
34
34
|
comment?: string;
|
|
35
|
-
}, handler: null | ((jsdoc: _es_joy_jsdoccomment0.JsdocBlockWithInline) => boolean | undefined), node:
|
|
35
|
+
}, handler: null | ((jsdoc: _es_joy_jsdoccomment0.JsdocBlockWithInline) => boolean | undefined), node: eslint0.Rule.Node) => void;
|
|
36
36
|
type ForEachPreferredTag = (tagName: string, arrayHandler: (matchingJsdocTag: _es_joy_jsdoccomment0.JsdocTagWithInline, targetTagName: string) => void, skipReportingBlockedTag?: boolean | undefined) => void;
|
|
37
37
|
type ReportSettings = (message: string) => void;
|
|
38
38
|
type ParseClosureTemplateTag = (tag: comment_parser0.Spec) => string[];
|
|
@@ -217,7 +217,7 @@ type Utils = BasicUtils & {
|
|
|
217
217
|
/**
|
|
218
218
|
* Should use ESLint rule's typing.
|
|
219
219
|
*/
|
|
220
|
-
type EslintRuleMeta =
|
|
220
|
+
type EslintRuleMeta = eslint0.Rule.RuleMetaData;
|
|
221
221
|
/**
|
|
222
222
|
* A plain object for tracking state as needed by rules across iterations.
|
|
223
223
|
*/
|
|
@@ -242,8 +242,8 @@ type StateObject = {
|
|
|
242
242
|
/**
|
|
243
243
|
* The Node AST as supplied by the parser.
|
|
244
244
|
*/
|
|
245
|
-
type Node =
|
|
246
|
-
type Report = (message: string, fix?:
|
|
245
|
+
type Node = eslint0.Rule.Node;
|
|
246
|
+
type Report = (message: string, fix?: eslint0.Rule.ReportFixer | null | undefined, jsdocLoc?: {
|
|
247
247
|
line?: Integer;
|
|
248
248
|
column?: Integer;
|
|
249
249
|
} | (comment_parser0.Spec & {
|
|
@@ -301,10 +301,10 @@ type JSDocSettings = {
|
|
|
301
301
|
/**
|
|
302
302
|
* Create the report function
|
|
303
303
|
*/
|
|
304
|
-
type MakeReport = (context:
|
|
304
|
+
type MakeReport = (context: eslint0.Rule.RuleContext, commentNode: estree0.Node) => Report;
|
|
305
305
|
type JsdocVisitorBasic = (arg: {
|
|
306
|
-
context:
|
|
307
|
-
sourceCode:
|
|
306
|
+
context: eslint0.Rule.RuleContext;
|
|
307
|
+
sourceCode: eslint0.SourceCode;
|
|
308
308
|
indent?: string;
|
|
309
309
|
info?: {
|
|
310
310
|
comment?: string | undefined;
|
|
@@ -313,7 +313,7 @@ type JsdocVisitorBasic = (arg: {
|
|
|
313
313
|
state?: StateObject;
|
|
314
314
|
globalState?: Map<string, Map<string, string>>;
|
|
315
315
|
jsdoc?: JsdocBlockWithInline;
|
|
316
|
-
jsdocNode?:
|
|
316
|
+
jsdocNode?: eslint0.Rule.Node & {
|
|
317
317
|
range: [number, number];
|
|
318
318
|
};
|
|
319
319
|
node?: Node;
|
|
@@ -324,8 +324,8 @@ type JsdocVisitorBasic = (arg: {
|
|
|
324
324
|
utils: BasicUtils;
|
|
325
325
|
}) => any;
|
|
326
326
|
type JsdocVisitor = (arg: {
|
|
327
|
-
context:
|
|
328
|
-
sourceCode:
|
|
327
|
+
context: eslint0.Rule.RuleContext;
|
|
328
|
+
sourceCode: eslint0.SourceCode;
|
|
329
329
|
indent: string;
|
|
330
330
|
info: {
|
|
331
331
|
comment?: string | undefined;
|
|
@@ -334,7 +334,7 @@ type JsdocVisitor = (arg: {
|
|
|
334
334
|
state: StateObject;
|
|
335
335
|
globalState: Map<string, Map<string, string>>;
|
|
336
336
|
jsdoc: JsdocBlockWithInline;
|
|
337
|
-
jsdocNode:
|
|
337
|
+
jsdocNode: eslint0.Rule.Node & {
|
|
338
338
|
range: [number, number];
|
|
339
339
|
};
|
|
340
340
|
node: Node | null;
|
|
@@ -397,7 +397,7 @@ type RuleConfig = {
|
|
|
397
397
|
* Handler to be executed upon exiting iteration of program AST
|
|
398
398
|
*/
|
|
399
399
|
exit?: ((args: {
|
|
400
|
-
context:
|
|
400
|
+
context: eslint0.Rule.RuleContext;
|
|
401
401
|
state: StateObject;
|
|
402
402
|
settings: Settings;
|
|
403
403
|
utils: BasicUtils;
|
|
@@ -465,7 +465,7 @@ type RuleConfig = {
|
|
|
465
465
|
* @param {import('eslint').Rule.RuleContext & JSDocSettings} context
|
|
466
466
|
* @returns {Settings|false}
|
|
467
467
|
*/
|
|
468
|
-
declare function getSettings(context:
|
|
468
|
+
declare function getSettings(context: eslint0.Rule.RuleContext & JSDocSettings): Settings | false;
|
|
469
469
|
//#endregion
|
|
470
470
|
export { AddLine, AddLines, AddTag, AvoidDocs, BasicUtils, ChangeTag, CheckJsdoc, ClassHasTag, ComparePaths, Context, ContextObject, DropPathSegmentQuotes, EmptyTokens, EslintRuleMeta, FilterAllTags, FilterTags, FindContext, ForEachPreferredTag, GetClassJsdoc, GetClassNode, GetDescription, GetFirstLine, GetFunctionParameterNames, GetJsdocTagsDeep, GetPreferredTagName, GetPreferredTagNameObject, GetPresentTags, GetRegexFromString, GetTagDescription, GetTagStructureForMode, GetTags, GetTagsByType, HasATag, HasOptionTag, HasParams, HasTag, HasThrowValue, HasValueOrExecutorHasNonEmptyResolveValue, HasYieldReturnValue, HasYieldValue, Integer, IsAsync, IsConstructor, IsGenerator, IsIteratingFunction, IsNamepathX, IsValidTag, IsVirtualFunction, JSDocSettings, JsdocBlockWithInline, JsdocVisitor, JsdocVisitorBasic, MakeMultiline, MakeReport, MayBeUndefinedTypeTag, Node, NonCommentArgs, ParseClosureTemplateTag, PreferredTypes, RemoveTag, Report, ReportJSDoc, ReportSettings, RuleConfig, SeedTokens, SetBlockDescription, SetDescriptionLines, SetTag, SetTagDescription, Settings, StateObject, Stringify, StructuredTags, TagMightHaveNamePositionTypePosition, TagMissingRequiredTypeOrNamepath, TagMustHave, Utils, iterateJsdoc as default, getSettings, parseComment };
|
|
471
471
|
//# sourceMappingURL=iterateJsdoc.d.ts.map
|