eslint-plugin-jsdoc 56.0.0 → 56.0.1
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/package.json +4 -4
- package/dist/cjs/WarnSettings.js +0 -30
- package/dist/cjs/alignTransform.js +0 -285
- package/dist/cjs/defaultTagOrder.js +0 -152
- package/dist/cjs/exportParser.js +0 -754
- package/dist/cjs/getDefaultTagStructureForMode.js +0 -840
- package/dist/cjs/getJsdocProcessorPlugin.cjs +0 -4
- package/dist/cjs/getJsdocProcessorPlugin.js +0 -553
- package/dist/cjs/index-cjs.js +0 -492
- package/dist/cjs/index.cjs.cjs +0 -6
- package/dist/cjs/iterateJsdoc.cjs +0 -38
- package/dist/cjs/iterateJsdoc.js +0 -1981
- package/dist/cjs/jsdocUtils.js +0 -1470
- package/dist/cjs/rules/checkAccess.js +0 -35
- package/dist/cjs/rules/checkAlignment.js +0 -63
- package/dist/cjs/rules/checkExamples.js +0 -486
- package/dist/cjs/rules/checkIndentation.js +0 -66
- package/dist/cjs/rules/checkLineAlignment.js +0 -297
- package/dist/cjs/rules/checkParamNames.js +0 -320
- package/dist/cjs/rules/checkPropertyNames.js +0 -105
- package/dist/cjs/rules/checkSyntax.js +0 -27
- package/dist/cjs/rules/checkTagNames.js +0 -252
- package/dist/cjs/rules/checkTemplateNames.js +0 -189
- package/dist/cjs/rules/checkTypes.js +0 -421
- package/dist/cjs/rules/checkValues.js +0 -163
- package/dist/cjs/rules/convertToJsdocComments.js +0 -313
- package/dist/cjs/rules/emptyTags.js +0 -79
- package/dist/cjs/rules/implementsOnClasses.js +0 -63
- package/dist/cjs/rules/importsAsDependencies.js +0 -105
- package/dist/cjs/rules/informativeDocs.js +0 -153
- package/dist/cjs/rules/linesBeforeBlock.js +0 -106
- package/dist/cjs/rules/matchDescription.js +0 -240
- package/dist/cjs/rules/matchName.js +0 -122
- package/dist/cjs/rules/multilineBlocks.js +0 -339
- package/dist/cjs/rules/noBadBlocks.js +0 -88
- package/dist/cjs/rules/noBlankBlockDescriptions.js +0 -56
- package/dist/cjs/rules/noBlankBlocks.js +0 -41
- package/dist/cjs/rules/noDefaults.js +0 -84
- package/dist/cjs/rules/noMissingSyntax.js +0 -164
- package/dist/cjs/rules/noMultiAsterisks.js +0 -83
- package/dist/cjs/rules/noRestrictedSyntax.js +0 -75
- package/dist/cjs/rules/noTypes.js +0 -88
- package/dist/cjs/rules/noUndefinedTypes.js +0 -451
- package/dist/cjs/rules/requireAsteriskPrefix.js +0 -144
- package/dist/cjs/rules/requireDescription.js +0 -136
- package/dist/cjs/rules/requireDescriptionCompleteSentence.js +0 -258
- package/dist/cjs/rules/requireExample.js +0 -103
- package/dist/cjs/rules/requireFileOverview.js +0 -117
- package/dist/cjs/rules/requireHyphenBeforeParamDescription.js +0 -144
- package/dist/cjs/rules/requireJsdoc.js +0 -629
- package/dist/cjs/rules/requireParam.js +0 -480
- package/dist/cjs/rules/requireParamDescription.js +0 -77
- package/dist/cjs/rules/requireParamName.js +0 -52
- package/dist/cjs/rules/requireParamType.js +0 -77
- package/dist/cjs/rules/requireProperty.js +0 -44
- package/dist/cjs/rules/requirePropertyDescription.js +0 -22
- package/dist/cjs/rules/requirePropertyName.js +0 -22
- package/dist/cjs/rules/requirePropertyType.js +0 -22
- package/dist/cjs/rules/requireReturns.js +0 -197
- package/dist/cjs/rules/requireReturnsCheck.js +0 -108
- package/dist/cjs/rules/requireReturnsDescription.js +0 -58
- package/dist/cjs/rules/requireReturnsType.js +0 -52
- package/dist/cjs/rules/requireTemplate.js +0 -173
- package/dist/cjs/rules/requireThrows.js +0 -101
- package/dist/cjs/rules/requireYields.js +0 -172
- package/dist/cjs/rules/requireYieldsCheck.js +0 -164
- package/dist/cjs/rules/sortTags.js +0 -392
- package/dist/cjs/rules/tagLines.js +0 -259
- package/dist/cjs/rules/textEscaping.js +0 -125
- package/dist/cjs/rules/typeFormatting.js +0 -328
- package/dist/cjs/rules/validTypes.js +0 -333
- package/dist/cjs/tagNames.js +0 -209
- package/dist/cjs/utils/hasReturnValue.js +0 -469
package/dist/cjs/index-cjs.js
DELETED
|
@@ -1,492 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
-
};
|
|
5
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
const getJsdocProcessorPlugin_js_1 = require("./getJsdocProcessorPlugin.js");
|
|
7
|
-
const checkAccess_js_1 = __importDefault(require("./rules/checkAccess.js"));
|
|
8
|
-
const checkAlignment_js_1 = __importDefault(require("./rules/checkAlignment.js"));
|
|
9
|
-
const checkExamples_js_1 = __importDefault(require("./rules/checkExamples.js"));
|
|
10
|
-
const checkIndentation_js_1 = __importDefault(require("./rules/checkIndentation.js"));
|
|
11
|
-
const checkLineAlignment_js_1 = __importDefault(require("./rules/checkLineAlignment.js"));
|
|
12
|
-
const checkParamNames_js_1 = __importDefault(require("./rules/checkParamNames.js"));
|
|
13
|
-
const checkPropertyNames_js_1 = __importDefault(require("./rules/checkPropertyNames.js"));
|
|
14
|
-
const checkSyntax_js_1 = __importDefault(require("./rules/checkSyntax.js"));
|
|
15
|
-
const checkTagNames_js_1 = __importDefault(require("./rules/checkTagNames.js"));
|
|
16
|
-
const checkTemplateNames_js_1 = __importDefault(require("./rules/checkTemplateNames.js"));
|
|
17
|
-
const checkTypes_js_1 = __importDefault(require("./rules/checkTypes.js"));
|
|
18
|
-
const checkValues_js_1 = __importDefault(require("./rules/checkValues.js"));
|
|
19
|
-
const convertToJsdocComments_js_1 = __importDefault(require("./rules/convertToJsdocComments.js"));
|
|
20
|
-
const emptyTags_js_1 = __importDefault(require("./rules/emptyTags.js"));
|
|
21
|
-
const implementsOnClasses_js_1 = __importDefault(require("./rules/implementsOnClasses.js"));
|
|
22
|
-
const importsAsDependencies_js_1 = __importDefault(require("./rules/importsAsDependencies.js"));
|
|
23
|
-
const informativeDocs_js_1 = __importDefault(require("./rules/informativeDocs.js"));
|
|
24
|
-
const linesBeforeBlock_js_1 = __importDefault(require("./rules/linesBeforeBlock.js"));
|
|
25
|
-
const matchDescription_js_1 = __importDefault(require("./rules/matchDescription.js"));
|
|
26
|
-
const matchName_js_1 = __importDefault(require("./rules/matchName.js"));
|
|
27
|
-
const multilineBlocks_js_1 = __importDefault(require("./rules/multilineBlocks.js"));
|
|
28
|
-
const noBadBlocks_js_1 = __importDefault(require("./rules/noBadBlocks.js"));
|
|
29
|
-
const noBlankBlockDescriptions_js_1 = __importDefault(require("./rules/noBlankBlockDescriptions.js"));
|
|
30
|
-
const noBlankBlocks_js_1 = __importDefault(require("./rules/noBlankBlocks.js"));
|
|
31
|
-
const noDefaults_js_1 = __importDefault(require("./rules/noDefaults.js"));
|
|
32
|
-
const noMissingSyntax_js_1 = __importDefault(require("./rules/noMissingSyntax.js"));
|
|
33
|
-
const noMultiAsterisks_js_1 = __importDefault(require("./rules/noMultiAsterisks.js"));
|
|
34
|
-
const noRestrictedSyntax_js_1 = __importDefault(require("./rules/noRestrictedSyntax.js"));
|
|
35
|
-
const noTypes_js_1 = __importDefault(require("./rules/noTypes.js"));
|
|
36
|
-
const noUndefinedTypes_js_1 = __importDefault(require("./rules/noUndefinedTypes.js"));
|
|
37
|
-
const requireAsteriskPrefix_js_1 = __importDefault(require("./rules/requireAsteriskPrefix.js"));
|
|
38
|
-
const requireDescription_js_1 = __importDefault(require("./rules/requireDescription.js"));
|
|
39
|
-
const requireDescriptionCompleteSentence_js_1 = __importDefault(require("./rules/requireDescriptionCompleteSentence.js"));
|
|
40
|
-
const requireExample_js_1 = __importDefault(require("./rules/requireExample.js"));
|
|
41
|
-
const requireFileOverview_js_1 = __importDefault(require("./rules/requireFileOverview.js"));
|
|
42
|
-
const requireHyphenBeforeParamDescription_js_1 = __importDefault(require("./rules/requireHyphenBeforeParamDescription.js"));
|
|
43
|
-
const requireJsdoc_js_1 = __importDefault(require("./rules/requireJsdoc.js"));
|
|
44
|
-
const requireParam_js_1 = __importDefault(require("./rules/requireParam.js"));
|
|
45
|
-
const requireParamDescription_js_1 = __importDefault(require("./rules/requireParamDescription.js"));
|
|
46
|
-
const requireParamName_js_1 = __importDefault(require("./rules/requireParamName.js"));
|
|
47
|
-
const requireParamType_js_1 = __importDefault(require("./rules/requireParamType.js"));
|
|
48
|
-
const requireProperty_js_1 = __importDefault(require("./rules/requireProperty.js"));
|
|
49
|
-
const requirePropertyDescription_js_1 = __importDefault(require("./rules/requirePropertyDescription.js"));
|
|
50
|
-
const requirePropertyName_js_1 = __importDefault(require("./rules/requirePropertyName.js"));
|
|
51
|
-
const requirePropertyType_js_1 = __importDefault(require("./rules/requirePropertyType.js"));
|
|
52
|
-
const requireReturns_js_1 = __importDefault(require("./rules/requireReturns.js"));
|
|
53
|
-
const requireReturnsCheck_js_1 = __importDefault(require("./rules/requireReturnsCheck.js"));
|
|
54
|
-
const requireReturnsDescription_js_1 = __importDefault(require("./rules/requireReturnsDescription.js"));
|
|
55
|
-
const requireReturnsType_js_1 = __importDefault(require("./rules/requireReturnsType.js"));
|
|
56
|
-
const requireTemplate_js_1 = __importDefault(require("./rules/requireTemplate.js"));
|
|
57
|
-
const requireThrows_js_1 = __importDefault(require("./rules/requireThrows.js"));
|
|
58
|
-
const requireYields_js_1 = __importDefault(require("./rules/requireYields.js"));
|
|
59
|
-
const requireYieldsCheck_js_1 = __importDefault(require("./rules/requireYieldsCheck.js"));
|
|
60
|
-
const sortTags_js_1 = __importDefault(require("./rules/sortTags.js"));
|
|
61
|
-
const tagLines_js_1 = __importDefault(require("./rules/tagLines.js"));
|
|
62
|
-
const textEscaping_js_1 = __importDefault(require("./rules/textEscaping.js"));
|
|
63
|
-
const typeFormatting_js_1 = __importDefault(require("./rules/typeFormatting.js"));
|
|
64
|
-
const validTypes_js_1 = __importDefault(require("./rules/validTypes.js"));
|
|
65
|
-
/* eslint-disable jsdoc/valid-types -- Bug */
|
|
66
|
-
/**
|
|
67
|
-
* @typedef {"recommended" | "stylistic" | "contents" | "logical" | "requirements"} ConfigGroups
|
|
68
|
-
* @typedef {"" | "-typescript" | "-typescript-flavor"} ConfigVariants
|
|
69
|
-
* @typedef {"" | "-error"} ErrorLevelVariants
|
|
70
|
-
* @type {import('eslint').ESLint.Plugin & {
|
|
71
|
-
* configs: Record<`flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}`,
|
|
72
|
-
* import('eslint').Linter.Config>
|
|
73
|
-
* }}
|
|
74
|
-
*/
|
|
75
|
-
const index = {};
|
|
76
|
-
/* eslint-enable jsdoc/valid-types -- Bug */
|
|
77
|
-
index.configs = {};
|
|
78
|
-
index.rules = {
|
|
79
|
-
'check-access': checkAccess_js_1.default,
|
|
80
|
-
'check-alignment': checkAlignment_js_1.default,
|
|
81
|
-
'check-examples': checkExamples_js_1.default,
|
|
82
|
-
'check-indentation': checkIndentation_js_1.default,
|
|
83
|
-
'check-line-alignment': checkLineAlignment_js_1.default,
|
|
84
|
-
'check-param-names': checkParamNames_js_1.default,
|
|
85
|
-
'check-property-names': checkPropertyNames_js_1.default,
|
|
86
|
-
'check-syntax': checkSyntax_js_1.default,
|
|
87
|
-
'check-tag-names': checkTagNames_js_1.default,
|
|
88
|
-
'check-template-names': checkTemplateNames_js_1.default,
|
|
89
|
-
'check-types': checkTypes_js_1.default,
|
|
90
|
-
'check-values': checkValues_js_1.default,
|
|
91
|
-
'convert-to-jsdoc-comments': convertToJsdocComments_js_1.default,
|
|
92
|
-
'empty-tags': emptyTags_js_1.default,
|
|
93
|
-
'implements-on-classes': implementsOnClasses_js_1.default,
|
|
94
|
-
'imports-as-dependencies': importsAsDependencies_js_1.default,
|
|
95
|
-
'informative-docs': informativeDocs_js_1.default,
|
|
96
|
-
'lines-before-block': linesBeforeBlock_js_1.default,
|
|
97
|
-
'match-description': matchDescription_js_1.default,
|
|
98
|
-
'match-name': matchName_js_1.default,
|
|
99
|
-
'multiline-blocks': multilineBlocks_js_1.default,
|
|
100
|
-
'no-bad-blocks': noBadBlocks_js_1.default,
|
|
101
|
-
'no-blank-block-descriptions': noBlankBlockDescriptions_js_1.default,
|
|
102
|
-
'no-blank-blocks': noBlankBlocks_js_1.default,
|
|
103
|
-
'no-defaults': noDefaults_js_1.default,
|
|
104
|
-
'no-missing-syntax': noMissingSyntax_js_1.default,
|
|
105
|
-
'no-multi-asterisks': noMultiAsterisks_js_1.default,
|
|
106
|
-
'no-restricted-syntax': noRestrictedSyntax_js_1.default,
|
|
107
|
-
'no-types': noTypes_js_1.default,
|
|
108
|
-
'no-undefined-types': noUndefinedTypes_js_1.default,
|
|
109
|
-
'require-asterisk-prefix': requireAsteriskPrefix_js_1.default,
|
|
110
|
-
'require-description': requireDescription_js_1.default,
|
|
111
|
-
'require-description-complete-sentence': requireDescriptionCompleteSentence_js_1.default,
|
|
112
|
-
'require-example': requireExample_js_1.default,
|
|
113
|
-
'require-file-overview': requireFileOverview_js_1.default,
|
|
114
|
-
'require-hyphen-before-param-description': requireHyphenBeforeParamDescription_js_1.default,
|
|
115
|
-
'require-jsdoc': requireJsdoc_js_1.default,
|
|
116
|
-
'require-param': requireParam_js_1.default,
|
|
117
|
-
'require-param-description': requireParamDescription_js_1.default,
|
|
118
|
-
'require-param-name': requireParamName_js_1.default,
|
|
119
|
-
'require-param-type': requireParamType_js_1.default,
|
|
120
|
-
'require-property': requireProperty_js_1.default,
|
|
121
|
-
'require-property-description': requirePropertyDescription_js_1.default,
|
|
122
|
-
'require-property-name': requirePropertyName_js_1.default,
|
|
123
|
-
'require-property-type': requirePropertyType_js_1.default,
|
|
124
|
-
'require-returns': requireReturns_js_1.default,
|
|
125
|
-
'require-returns-check': requireReturnsCheck_js_1.default,
|
|
126
|
-
'require-returns-description': requireReturnsDescription_js_1.default,
|
|
127
|
-
'require-returns-type': requireReturnsType_js_1.default,
|
|
128
|
-
'require-template': requireTemplate_js_1.default,
|
|
129
|
-
'require-throws': requireThrows_js_1.default,
|
|
130
|
-
'require-yields': requireYields_js_1.default,
|
|
131
|
-
'require-yields-check': requireYieldsCheck_js_1.default,
|
|
132
|
-
'sort-tags': sortTags_js_1.default,
|
|
133
|
-
'tag-lines': tagLines_js_1.default,
|
|
134
|
-
'text-escaping': textEscaping_js_1.default,
|
|
135
|
-
'type-formatting': typeFormatting_js_1.default,
|
|
136
|
-
'valid-types': validTypes_js_1.default,
|
|
137
|
-
};
|
|
138
|
-
/**
|
|
139
|
-
* @param {"warn"|"error"} warnOrError
|
|
140
|
-
* @param {string} [flatName]
|
|
141
|
-
* @returns {import('eslint').Linter.Config}
|
|
142
|
-
*/
|
|
143
|
-
const createRecommendedRuleset = (warnOrError, flatName) => {
|
|
144
|
-
return {
|
|
145
|
-
...(flatName ? {
|
|
146
|
-
name: 'jsdoc/' + flatName,
|
|
147
|
-
} : {}),
|
|
148
|
-
// @ts-expect-error ESLint 8 plugins
|
|
149
|
-
plugins: flatName ? {
|
|
150
|
-
jsdoc: index,
|
|
151
|
-
} : [
|
|
152
|
-
'jsdoc',
|
|
153
|
-
],
|
|
154
|
-
rules: {
|
|
155
|
-
'jsdoc/check-access': warnOrError,
|
|
156
|
-
'jsdoc/check-alignment': warnOrError,
|
|
157
|
-
'jsdoc/check-examples': 'off',
|
|
158
|
-
'jsdoc/check-indentation': 'off',
|
|
159
|
-
'jsdoc/check-line-alignment': 'off',
|
|
160
|
-
'jsdoc/check-param-names': warnOrError,
|
|
161
|
-
'jsdoc/check-property-names': warnOrError,
|
|
162
|
-
'jsdoc/check-syntax': 'off',
|
|
163
|
-
'jsdoc/check-tag-names': warnOrError,
|
|
164
|
-
'jsdoc/check-template-names': 'off',
|
|
165
|
-
'jsdoc/check-types': warnOrError,
|
|
166
|
-
'jsdoc/check-values': warnOrError,
|
|
167
|
-
'jsdoc/convert-to-jsdoc-comments': 'off',
|
|
168
|
-
'jsdoc/empty-tags': warnOrError,
|
|
169
|
-
'jsdoc/implements-on-classes': warnOrError,
|
|
170
|
-
'jsdoc/imports-as-dependencies': 'off',
|
|
171
|
-
'jsdoc/informative-docs': 'off',
|
|
172
|
-
'jsdoc/lines-before-block': 'off',
|
|
173
|
-
'jsdoc/match-description': 'off',
|
|
174
|
-
'jsdoc/match-name': 'off',
|
|
175
|
-
'jsdoc/multiline-blocks': warnOrError,
|
|
176
|
-
'jsdoc/no-bad-blocks': 'off',
|
|
177
|
-
'jsdoc/no-blank-block-descriptions': 'off',
|
|
178
|
-
'jsdoc/no-blank-blocks': 'off',
|
|
179
|
-
'jsdoc/no-defaults': warnOrError,
|
|
180
|
-
'jsdoc/no-missing-syntax': 'off',
|
|
181
|
-
'jsdoc/no-multi-asterisks': warnOrError,
|
|
182
|
-
'jsdoc/no-restricted-syntax': 'off',
|
|
183
|
-
'jsdoc/no-types': 'off',
|
|
184
|
-
'jsdoc/no-undefined-types': warnOrError,
|
|
185
|
-
'jsdoc/require-asterisk-prefix': 'off',
|
|
186
|
-
'jsdoc/require-description': 'off',
|
|
187
|
-
'jsdoc/require-description-complete-sentence': 'off',
|
|
188
|
-
'jsdoc/require-example': 'off',
|
|
189
|
-
'jsdoc/require-file-overview': 'off',
|
|
190
|
-
'jsdoc/require-hyphen-before-param-description': 'off',
|
|
191
|
-
'jsdoc/require-jsdoc': warnOrError,
|
|
192
|
-
'jsdoc/require-param': warnOrError,
|
|
193
|
-
'jsdoc/require-param-description': warnOrError,
|
|
194
|
-
'jsdoc/require-param-name': warnOrError,
|
|
195
|
-
'jsdoc/require-param-type': warnOrError,
|
|
196
|
-
'jsdoc/require-property': warnOrError,
|
|
197
|
-
'jsdoc/require-property-description': warnOrError,
|
|
198
|
-
'jsdoc/require-property-name': warnOrError,
|
|
199
|
-
'jsdoc/require-property-type': warnOrError,
|
|
200
|
-
'jsdoc/require-returns': warnOrError,
|
|
201
|
-
'jsdoc/require-returns-check': warnOrError,
|
|
202
|
-
'jsdoc/require-returns-description': warnOrError,
|
|
203
|
-
'jsdoc/require-returns-type': warnOrError,
|
|
204
|
-
'jsdoc/require-template': 'off',
|
|
205
|
-
'jsdoc/require-throws': 'off',
|
|
206
|
-
'jsdoc/require-yields': warnOrError,
|
|
207
|
-
'jsdoc/require-yields-check': warnOrError,
|
|
208
|
-
'jsdoc/sort-tags': 'off',
|
|
209
|
-
'jsdoc/tag-lines': warnOrError,
|
|
210
|
-
'jsdoc/text-escaping': 'off',
|
|
211
|
-
'jsdoc/type-formatting': 'off',
|
|
212
|
-
'jsdoc/valid-types': warnOrError,
|
|
213
|
-
},
|
|
214
|
-
};
|
|
215
|
-
};
|
|
216
|
-
/**
|
|
217
|
-
* @param {"warn"|"error"} warnOrError
|
|
218
|
-
* @param {string} [flatName]
|
|
219
|
-
* @returns {import('eslint').Linter.Config}
|
|
220
|
-
*/
|
|
221
|
-
const createRecommendedTypeScriptRuleset = (warnOrError, flatName) => {
|
|
222
|
-
const ruleset = createRecommendedRuleset(warnOrError, flatName);
|
|
223
|
-
return {
|
|
224
|
-
...ruleset,
|
|
225
|
-
rules: {
|
|
226
|
-
...ruleset.rules,
|
|
227
|
-
/* eslint-disable @stylistic/indent -- Extra indent to avoid use by auto-rule-editing */
|
|
228
|
-
'jsdoc/check-tag-names': [
|
|
229
|
-
warnOrError, {
|
|
230
|
-
typed: true,
|
|
231
|
-
},
|
|
232
|
-
],
|
|
233
|
-
'jsdoc/no-types': warnOrError,
|
|
234
|
-
'jsdoc/no-undefined-types': 'off',
|
|
235
|
-
'jsdoc/require-param-type': 'off',
|
|
236
|
-
'jsdoc/require-property-type': 'off',
|
|
237
|
-
'jsdoc/require-returns-type': 'off',
|
|
238
|
-
/* eslint-enable @stylistic/indent */
|
|
239
|
-
},
|
|
240
|
-
};
|
|
241
|
-
};
|
|
242
|
-
/**
|
|
243
|
-
* @param {"warn"|"error"} warnOrError
|
|
244
|
-
* @param {string} [flatName]
|
|
245
|
-
* @returns {import('eslint').Linter.Config}
|
|
246
|
-
*/
|
|
247
|
-
const createRecommendedTypeScriptFlavorRuleset = (warnOrError, flatName) => {
|
|
248
|
-
const ruleset = createRecommendedRuleset(warnOrError, flatName);
|
|
249
|
-
return {
|
|
250
|
-
...ruleset,
|
|
251
|
-
rules: {
|
|
252
|
-
...ruleset.rules,
|
|
253
|
-
/* eslint-disable @stylistic/indent -- Extra indent to avoid use by auto-rule-editing */
|
|
254
|
-
'jsdoc/no-undefined-types': 'off',
|
|
255
|
-
/* eslint-enable @stylistic/indent */
|
|
256
|
-
},
|
|
257
|
-
};
|
|
258
|
-
};
|
|
259
|
-
/**
|
|
260
|
-
* @param {(string | unknown[])[]} ruleNames
|
|
261
|
-
*/
|
|
262
|
-
const createStandaloneRulesetFactory = (ruleNames) => {
|
|
263
|
-
/**
|
|
264
|
-
* @param {"warn"|"error"} warnOrError
|
|
265
|
-
* @param {string} [flatName]
|
|
266
|
-
* @returns {import('eslint').Linter.Config}
|
|
267
|
-
*/
|
|
268
|
-
return (warnOrError, flatName) => {
|
|
269
|
-
return {
|
|
270
|
-
name: 'jsdoc/' + flatName,
|
|
271
|
-
plugins: {
|
|
272
|
-
jsdoc: index,
|
|
273
|
-
},
|
|
274
|
-
rules: Object.fromEntries(ruleNames.map((ruleName) => {
|
|
275
|
-
return (typeof ruleName === 'string' ?
|
|
276
|
-
[
|
|
277
|
-
ruleName, warnOrError,
|
|
278
|
-
] :
|
|
279
|
-
[
|
|
280
|
-
ruleName[0], [
|
|
281
|
-
warnOrError, ...ruleName.slice(1),
|
|
282
|
-
],
|
|
283
|
-
]);
|
|
284
|
-
})),
|
|
285
|
-
};
|
|
286
|
-
};
|
|
287
|
-
};
|
|
288
|
-
const contentsRules = [
|
|
289
|
-
'jsdoc/informative-docs',
|
|
290
|
-
'jsdoc/match-description',
|
|
291
|
-
'jsdoc/no-blank-block-descriptions',
|
|
292
|
-
'jsdoc/no-blank-blocks',
|
|
293
|
-
[
|
|
294
|
-
'jsdoc/text-escaping', {
|
|
295
|
-
escapeHTML: true,
|
|
296
|
-
},
|
|
297
|
-
],
|
|
298
|
-
];
|
|
299
|
-
const createContentsTypescriptRuleset = createStandaloneRulesetFactory(contentsRules);
|
|
300
|
-
const createContentsTypescriptFlavorRuleset = createStandaloneRulesetFactory(contentsRules);
|
|
301
|
-
const logicalRules = [
|
|
302
|
-
'jsdoc/check-access',
|
|
303
|
-
'jsdoc/check-param-names',
|
|
304
|
-
'jsdoc/check-property-names',
|
|
305
|
-
'jsdoc/check-syntax',
|
|
306
|
-
'jsdoc/check-tag-names',
|
|
307
|
-
'jsdoc/check-template-names',
|
|
308
|
-
'jsdoc/check-types',
|
|
309
|
-
'jsdoc/check-values',
|
|
310
|
-
'jsdoc/empty-tags',
|
|
311
|
-
'jsdoc/implements-on-classes',
|
|
312
|
-
'jsdoc/require-returns-check',
|
|
313
|
-
'jsdoc/require-yields-check',
|
|
314
|
-
'jsdoc/no-bad-blocks',
|
|
315
|
-
'jsdoc/no-defaults',
|
|
316
|
-
'jsdoc/no-types',
|
|
317
|
-
'jsdoc/no-undefined-types',
|
|
318
|
-
'jsdoc/valid-types',
|
|
319
|
-
];
|
|
320
|
-
const createLogicalTypescriptRuleset = createStandaloneRulesetFactory(logicalRules);
|
|
321
|
-
const createLogicalTypescriptFlavorRuleset = createStandaloneRulesetFactory(logicalRules);
|
|
322
|
-
const requirementsRules = [
|
|
323
|
-
'jsdoc/require-example',
|
|
324
|
-
'jsdoc/require-jsdoc',
|
|
325
|
-
'jsdoc/require-param',
|
|
326
|
-
'jsdoc/require-param-description',
|
|
327
|
-
'jsdoc/require-param-name',
|
|
328
|
-
'jsdoc/require-property',
|
|
329
|
-
'jsdoc/require-property-description',
|
|
330
|
-
'jsdoc/require-property-name',
|
|
331
|
-
'jsdoc/require-returns',
|
|
332
|
-
'jsdoc/require-returns-description',
|
|
333
|
-
'jsdoc/require-yields',
|
|
334
|
-
];
|
|
335
|
-
const createRequirementsTypeScriptRuleset = createStandaloneRulesetFactory(requirementsRules);
|
|
336
|
-
const createRequirementsTypeScriptFlavorRuleset = createStandaloneRulesetFactory([
|
|
337
|
-
...requirementsRules,
|
|
338
|
-
'jsdoc/require-param-type',
|
|
339
|
-
'jsdoc/require-property-type',
|
|
340
|
-
'jsdoc/require-returns-type',
|
|
341
|
-
'jsdoc/require-template',
|
|
342
|
-
]);
|
|
343
|
-
const stylisticRules = [
|
|
344
|
-
'jsdoc/check-alignment',
|
|
345
|
-
'jsdoc/check-line-alignment',
|
|
346
|
-
'jsdoc/lines-before-block',
|
|
347
|
-
'jsdoc/multiline-blocks',
|
|
348
|
-
'jsdoc/no-multi-asterisks',
|
|
349
|
-
'jsdoc/require-asterisk-prefix',
|
|
350
|
-
[
|
|
351
|
-
'jsdoc/require-hyphen-before-param-description', 'never',
|
|
352
|
-
],
|
|
353
|
-
'jsdoc/tag-lines',
|
|
354
|
-
];
|
|
355
|
-
const createStylisticTypeScriptRuleset = createStandaloneRulesetFactory(stylisticRules);
|
|
356
|
-
const createStylisticTypeScriptFlavorRuleset = createStandaloneRulesetFactory(stylisticRules);
|
|
357
|
-
/* c8 ignore next 3 -- TS */
|
|
358
|
-
if (!index.configs) {
|
|
359
|
-
throw new Error('TypeScript guard');
|
|
360
|
-
}
|
|
361
|
-
index.configs.recommended = createRecommendedRuleset('warn');
|
|
362
|
-
index.configs['recommended-error'] = createRecommendedRuleset('error');
|
|
363
|
-
index.configs['recommended-typescript'] = createRecommendedTypeScriptRuleset('warn');
|
|
364
|
-
index.configs['recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error');
|
|
365
|
-
index.configs['recommended-typescript-flavor'] = createRecommendedTypeScriptFlavorRuleset('warn');
|
|
366
|
-
index.configs['recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error');
|
|
367
|
-
index.configs['flat/recommended'] = createRecommendedRuleset('warn', 'flat/recommended');
|
|
368
|
-
index.configs['flat/recommended-error'] = createRecommendedRuleset('error', 'flat/recommended-error');
|
|
369
|
-
index.configs['flat/recommended-typescript'] = createRecommendedTypeScriptRuleset('warn', 'flat/recommended-typescript');
|
|
370
|
-
index.configs['flat/recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error', 'flat/recommended-typescript-error');
|
|
371
|
-
index.configs['flat/recommended-typescript-flavor'] = createRecommendedTypeScriptFlavorRuleset('warn', 'flat/recommended-typescript-flavor');
|
|
372
|
-
index.configs['flat/recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error', 'flat/recommended-typescript-flavor-error');
|
|
373
|
-
index.configs['flat/contents-typescript'] = createContentsTypescriptRuleset('warn', 'flat/contents-typescript');
|
|
374
|
-
index.configs['flat/contents-typescript-error'] = createContentsTypescriptRuleset('error', 'flat/contents-typescript-error');
|
|
375
|
-
index.configs['flat/contents-typescript-flavor'] = createContentsTypescriptFlavorRuleset('warn', 'flat/contents-typescript-flavor');
|
|
376
|
-
index.configs['flat/contents-typescript-flavor-error'] = createContentsTypescriptFlavorRuleset('error', 'flat/contents-typescript-error-flavor');
|
|
377
|
-
index.configs['flat/logical-typescript'] = createLogicalTypescriptRuleset('warn', 'flat/logical-typescript');
|
|
378
|
-
index.configs['flat/logical-typescript-error'] = createLogicalTypescriptRuleset('error', 'flat/logical-typescript-error');
|
|
379
|
-
index.configs['flat/logical-typescript-flavor'] = createLogicalTypescriptFlavorRuleset('warn', 'flat/logical-typescript-flavor');
|
|
380
|
-
index.configs['flat/logical-typescript-flavor-error'] = createLogicalTypescriptFlavorRuleset('error', 'flat/logical-typescript-error-flavor');
|
|
381
|
-
index.configs['flat/requirements-typescript'] = createRequirementsTypeScriptRuleset('warn', 'flat/requirements-typescript');
|
|
382
|
-
index.configs['flat/requirements-typescript-error'] = createRequirementsTypeScriptRuleset('error', 'flat/requirements-typescript-error');
|
|
383
|
-
index.configs['flat/requirements-typescript-flavor'] = createRequirementsTypeScriptFlavorRuleset('warn', 'flat/requirements-typescript-flavor');
|
|
384
|
-
index.configs['flat/requirements-typescript-flavor-error'] = createRequirementsTypeScriptFlavorRuleset('error', 'flat/requirements-typescript-error-flavor');
|
|
385
|
-
index.configs['flat/stylistic-typescript'] = createStylisticTypeScriptRuleset('warn', 'flat/stylistic-typescript');
|
|
386
|
-
index.configs['flat/stylistic-typescript-error'] = createStylisticTypeScriptRuleset('error', 'flat/stylistic-typescript-error');
|
|
387
|
-
index.configs['flat/stylistic-typescript-flavor'] = createStylisticTypeScriptFlavorRuleset('warn', 'flat/stylistic-typescript-flavor');
|
|
388
|
-
index.configs['flat/stylistic-typescript-flavor-error'] = createStylisticTypeScriptFlavorRuleset('error', 'flat/stylistic-typescript-error-flavor');
|
|
389
|
-
index.configs.examples = /** @type {import('eslint').Linter.Config[]} */ ([
|
|
390
|
-
{
|
|
391
|
-
files: [
|
|
392
|
-
'**/*.js',
|
|
393
|
-
],
|
|
394
|
-
name: 'jsdoc/examples/processor',
|
|
395
|
-
plugins: {
|
|
396
|
-
examples: (0, getJsdocProcessorPlugin_js_1.getJsdocProcessorPlugin)(),
|
|
397
|
-
},
|
|
398
|
-
processor: 'examples/examples',
|
|
399
|
-
},
|
|
400
|
-
{
|
|
401
|
-
files: [
|
|
402
|
-
'**/*.md/*.js',
|
|
403
|
-
],
|
|
404
|
-
name: 'jsdoc/examples/rules',
|
|
405
|
-
rules: {
|
|
406
|
-
// "always" newline rule at end unlikely in sample code
|
|
407
|
-
'eol-last': 0,
|
|
408
|
-
// Wouldn't generally expect example paths to resolve relative to JS file
|
|
409
|
-
'import/no-unresolved': 0,
|
|
410
|
-
// Snippets likely too short to always include import/export info
|
|
411
|
-
'import/unambiguous': 0,
|
|
412
|
-
'jsdoc/require-file-overview': 0,
|
|
413
|
-
// The end of a multiline comment would end the comment the example is in.
|
|
414
|
-
'jsdoc/require-jsdoc': 0,
|
|
415
|
-
// Unlikely to have inadvertent debugging within examples
|
|
416
|
-
'no-console': 0,
|
|
417
|
-
// Often wish to start `@example` code after newline; also may use
|
|
418
|
-
// empty lines for spacing
|
|
419
|
-
'no-multiple-empty-lines': 0,
|
|
420
|
-
// Many variables in examples will be `undefined`
|
|
421
|
-
'no-undef': 0,
|
|
422
|
-
// Common to define variables for clarity without always using them
|
|
423
|
-
'no-unused-vars': 0,
|
|
424
|
-
// See import/no-unresolved
|
|
425
|
-
'node/no-missing-import': 0,
|
|
426
|
-
'node/no-missing-require': 0,
|
|
427
|
-
// Can generally look nicer to pad a little even if code imposes more stringency
|
|
428
|
-
'padded-blocks': 0,
|
|
429
|
-
},
|
|
430
|
-
},
|
|
431
|
-
]);
|
|
432
|
-
index.configs['default-expressions'] = /** @type {import('eslint').Linter.Config[]} */ ([
|
|
433
|
-
{
|
|
434
|
-
files: [
|
|
435
|
-
'**/*.js',
|
|
436
|
-
],
|
|
437
|
-
name: 'jsdoc/default-expressions/processor',
|
|
438
|
-
plugins: {
|
|
439
|
-
examples: (0, getJsdocProcessorPlugin_js_1.getJsdocProcessorPlugin)({
|
|
440
|
-
checkDefaults: true,
|
|
441
|
-
checkParams: true,
|
|
442
|
-
checkProperties: true,
|
|
443
|
-
}),
|
|
444
|
-
},
|
|
445
|
-
processor: 'examples/examples',
|
|
446
|
-
},
|
|
447
|
-
{
|
|
448
|
-
files: [
|
|
449
|
-
'**/*.jsdoc-defaults', '**/*.jsdoc-params', '**/*.jsdoc-properties',
|
|
450
|
-
],
|
|
451
|
-
name: 'jsdoc/default-expressions/rules',
|
|
452
|
-
rules: {
|
|
453
|
-
...index.configs.examples[1].rules,
|
|
454
|
-
'chai-friendly/no-unused-expressions': 0,
|
|
455
|
-
'no-empty-function': 0,
|
|
456
|
-
'no-new': 0,
|
|
457
|
-
'no-unused-expressions': 0,
|
|
458
|
-
quotes: [
|
|
459
|
-
'error', 'double',
|
|
460
|
-
],
|
|
461
|
-
semi: [
|
|
462
|
-
'error', 'never',
|
|
463
|
-
],
|
|
464
|
-
strict: 0,
|
|
465
|
-
},
|
|
466
|
-
},
|
|
467
|
-
]);
|
|
468
|
-
index.configs['examples-and-default-expressions'] = /** @type {import('eslint').Linter.Config[]} */ ([
|
|
469
|
-
{
|
|
470
|
-
name: 'jsdoc/examples-and-default-expressions',
|
|
471
|
-
plugins: {
|
|
472
|
-
examples: (0, getJsdocProcessorPlugin_js_1.getJsdocProcessorPlugin)({
|
|
473
|
-
checkDefaults: true,
|
|
474
|
-
checkParams: true,
|
|
475
|
-
checkProperties: true,
|
|
476
|
-
}),
|
|
477
|
-
},
|
|
478
|
-
},
|
|
479
|
-
...index.configs.examples.map((config) => {
|
|
480
|
-
return {
|
|
481
|
-
...config,
|
|
482
|
-
plugins: {},
|
|
483
|
-
};
|
|
484
|
-
}),
|
|
485
|
-
...index.configs['default-expressions'].map((config) => {
|
|
486
|
-
return {
|
|
487
|
-
...config,
|
|
488
|
-
plugins: {},
|
|
489
|
-
};
|
|
490
|
-
}),
|
|
491
|
-
]);
|
|
492
|
-
exports.default = index;
|
package/dist/cjs/index.cjs.cjs
DELETED
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
-
if (k2 === undefined) k2 = k;
|
|
4
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
-
}
|
|
8
|
-
Object.defineProperty(o, k2, desc);
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
-
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
-
}) : function(o, v) {
|
|
16
|
-
o["default"] = v;
|
|
17
|
-
});
|
|
18
|
-
var __importStar = (this && this.__importStar) || (function () {
|
|
19
|
-
var ownKeys = function(o) {
|
|
20
|
-
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
21
|
-
var ar = [];
|
|
22
|
-
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
23
|
-
return ar;
|
|
24
|
-
};
|
|
25
|
-
return ownKeys(o);
|
|
26
|
-
};
|
|
27
|
-
return function (mod) {
|
|
28
|
-
if (mod && mod.__esModule) return mod;
|
|
29
|
-
var result = {};
|
|
30
|
-
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
31
|
-
__setModuleDefault(result, mod);
|
|
32
|
-
return result;
|
|
33
|
-
};
|
|
34
|
-
})();
|
|
35
|
-
const iterateJsdoc_js_1 = __importStar(require("./iterateJsdoc.js"));
|
|
36
|
-
exports.getSettings = iterateJsdoc_js_1.getSettings;
|
|
37
|
-
exports.parseComment = iterateJsdoc_js_1.parseComment;
|
|
38
|
-
module.exports = iterateJsdoc_js_1.default;
|