eslint-plugin-jsdoc 52.0.4 → 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/WarnSettings.cjs +18 -35
- package/dist/WarnSettings.cjs.map +1 -1
- package/dist/WarnSettings.js +20 -0
- package/dist/WarnSettings.js.map +1 -0
- package/dist/_virtual/rolldown_runtime.cjs +32 -0
- package/dist/_virtual/rolldown_runtime.js +11 -0
- package/dist/alignTransform.cjs +224 -305
- package/dist/alignTransform.cjs.map +1 -1
- package/dist/alignTransform.js +241 -0
- package/dist/alignTransform.js.map +1 -0
- package/dist/defaultTagOrder.cjs +132 -43
- package/dist/defaultTagOrder.cjs.map +1 -1
- package/dist/defaultTagOrder.js +134 -0
- package/dist/defaultTagOrder.js.map +1 -0
- package/dist/exportParser.cjs +478 -696
- package/dist/exportParser.cjs.map +1 -1
- package/dist/exportParser.js +518 -0
- package/dist/exportParser.js.map +1 -0
- package/dist/getDefaultTagStructureForMode.cjs +184 -288
- package/dist/getDefaultTagStructureForMode.cjs.map +1 -1
- package/dist/getDefaultTagStructureForMode.js +188 -0
- package/dist/getDefaultTagStructureForMode.js.map +1 -0
- package/dist/getJsdocProcessorPlugin.cjs +364 -550
- package/dist/getJsdocProcessorPlugin.cjs.map +1 -1
- package/dist/getJsdocProcessorPlugin.d.cts +70 -0
- package/dist/getJsdocProcessorPlugin.d.cts.map +1 -0
- package/dist/getJsdocProcessorPlugin.d.ts +68 -65
- package/dist/getJsdocProcessorPlugin.d.ts.map +1 -1
- package/dist/getJsdocProcessorPlugin.js +383 -0
- package/dist/getJsdocProcessorPlugin.js.map +1 -0
- package/dist/index.cjs +2 -410
- package/dist/index.d.cts +2 -0
- package/dist/index.d.ts +2 -17
- package/dist/index.js +3 -0
- package/dist/iterateJsdoc.cjs +1528 -1988
- package/dist/iterateJsdoc.cjs.map +1 -1
- package/dist/iterateJsdoc.d.cts +471 -0
- package/dist/iterateJsdoc.d.cts.map +1 -0
- package/dist/iterateJsdoc.d.ts +358 -349
- package/dist/iterateJsdoc.d.ts.map +1 -1
- package/dist/iterateJsdoc.js +1617 -0
- package/dist/iterateJsdoc.js.map +1 -0
- package/dist/jsdocUtils.cjs +1009 -1376
- package/dist/jsdocUtils.cjs.map +1 -1
- package/dist/jsdocUtils.js +1123 -0
- package/dist/jsdocUtils.js.map +1 -0
- 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/dist/rules/checkAccess.cjs +29 -36
- package/dist/rules/checkAccess.cjs.map +1 -1
- package/dist/rules/checkAccess.js +33 -0
- package/dist/rules/checkAccess.js.map +1 -0
- package/dist/rules/checkAlignment.cjs +41 -54
- package/dist/rules/checkAlignment.cjs.map +1 -1
- package/dist/rules/checkAlignment.js +47 -0
- package/dist/rules/checkAlignment.js.map +1 -0
- package/dist/rules/checkExamples.cjs +327 -484
- package/dist/rules/checkExamples.cjs.map +1 -1
- package/dist/rules/checkExamples.js +348 -0
- package/dist/rules/checkExamples.js.map +1 -0
- package/dist/rules/checkIndentation.cjs +50 -65
- package/dist/rules/checkIndentation.cjs.map +1 -1
- package/dist/rules/checkIndentation.js +59 -0
- package/dist/rules/checkIndentation.js.map +1 -0
- package/dist/rules/checkLineAlignment.cjs +220 -311
- package/dist/rules/checkLineAlignment.cjs.map +1 -1
- package/dist/rules/checkLineAlignment.js +229 -0
- package/dist/rules/checkLineAlignment.js.map +1 -0
- package/dist/rules/checkParamNames.cjs +227 -335
- package/dist/rules/checkParamNames.cjs.map +1 -1
- package/dist/rules/checkParamNames.js +237 -0
- package/dist/rules/checkParamNames.js.map +1 -0
- package/dist/rules/checkPropertyNames.cjs +78 -106
- package/dist/rules/checkPropertyNames.cjs.map +1 -1
- package/dist/rules/checkPropertyNames.js +88 -0
- package/dist/rules/checkPropertyNames.js.map +1 -0
- package/dist/rules/checkSyntax.cjs +21 -34
- package/dist/rules/checkSyntax.cjs.map +1 -1
- package/dist/rules/checkSyntax.js +25 -0
- package/dist/rules/checkSyntax.js.map +1 -0
- package/dist/rules/checkTagNames.cjs +188 -210
- package/dist/rules/checkTagNames.cjs.map +1 -1
- package/dist/rules/checkTagNames.js +191 -0
- package/dist/rules/checkTagNames.js.map +1 -0
- package/dist/rules/checkTemplateNames.cjs +121 -178
- package/dist/rules/checkTemplateNames.cjs.map +1 -1
- package/dist/rules/checkTemplateNames.js +124 -0
- package/dist/rules/checkTemplateNames.js.map +1 -0
- package/dist/rules/checkTypes.cjs +291 -385
- package/dist/rules/checkTypes.cjs.map +1 -1
- package/dist/rules/checkTypes.js +299 -0
- package/dist/rules/checkTypes.js.map +1 -0
- package/dist/rules/checkValues.cjs +100 -146
- package/dist/rules/checkValues.cjs.map +1 -1
- package/dist/rules/checkValues.js +103 -0
- package/dist/rules/checkValues.js.map +1 -0
- package/dist/rules/convertToJsdocComments.cjs +228 -306
- package/dist/rules/convertToJsdocComments.cjs.map +1 -1
- package/dist/rules/convertToJsdocComments.js +231 -0
- package/dist/rules/convertToJsdocComments.js.map +1 -0
- package/dist/rules/emptyTags.cjs +62 -72
- package/dist/rules/emptyTags.cjs.map +1 -1
- package/dist/rules/emptyTags.js +67 -0
- package/dist/rules/emptyTags.js.map +1 -0
- package/dist/rules/implementsOnClasses.cjs +36 -56
- package/dist/rules/implementsOnClasses.cjs.map +1 -1
- package/dist/rules/implementsOnClasses.js +40 -0
- package/dist/rules/implementsOnClasses.js.map +1 -0
- package/dist/rules/importsAsDependencies.cjs +62 -99
- package/dist/rules/importsAsDependencies.cjs.map +1 -1
- package/dist/rules/importsAsDependencies.js +68 -0
- package/dist/rules/importsAsDependencies.js.map +1 -0
- package/dist/rules/informativeDocs.cjs +105 -142
- package/dist/rules/informativeDocs.cjs.map +1 -1
- package/dist/rules/informativeDocs.js +110 -0
- package/dist/rules/informativeDocs.js.map +1 -0
- package/dist/rules/linesBeforeBlock.cjs +70 -105
- package/dist/rules/linesBeforeBlock.cjs.map +1 -1
- package/dist/rules/linesBeforeBlock.js +75 -0
- package/dist/rules/linesBeforeBlock.js.map +1 -0
- package/dist/rules/matchDescription.cjs +160 -222
- package/dist/rules/matchDescription.cjs.map +1 -1
- package/dist/rules/matchDescription.js +167 -0
- package/dist/rules/matchDescription.js.map +1 -0
- package/dist/rules/matchName.cjs +73 -128
- package/dist/rules/matchName.cjs.map +1 -1
- package/dist/rules/matchName.js +77 -0
- package/dist/rules/matchName.js.map +1 -0
- package/dist/rules/multilineBlocks.cjs +235 -352
- package/dist/rules/multilineBlocks.cjs.map +1 -1
- package/dist/rules/multilineBlocks.js +245 -0
- package/dist/rules/multilineBlocks.js.map +1 -0
- package/dist/rules/noBadBlocks.cjs +63 -86
- package/dist/rules/noBadBlocks.cjs.map +1 -1
- package/dist/rules/noBadBlocks.js +68 -0
- package/dist/rules/noBadBlocks.js.map +1 -0
- package/dist/rules/noBlankBlockDescriptions.cjs +35 -57
- package/dist/rules/noBlankBlockDescriptions.cjs.map +1 -1
- package/dist/rules/noBlankBlockDescriptions.js +41 -0
- package/dist/rules/noBlankBlockDescriptions.js.map +1 -0
- package/dist/rules/noBlankBlocks.cjs +26 -48
- package/dist/rules/noBlankBlocks.cjs.map +1 -1
- package/dist/rules/noBlankBlocks.js +30 -0
- package/dist/rules/noBlankBlocks.js.map +1 -0
- package/dist/rules/noDefaults.cjs +52 -79
- package/dist/rules/noDefaults.cjs.map +1 -1
- package/dist/rules/noDefaults.js +56 -0
- package/dist/rules/noDefaults.js.map +1 -0
- package/dist/rules/noMissingSyntax.cjs +115 -165
- package/dist/rules/noMissingSyntax.cjs.map +1 -1
- package/dist/rules/noMissingSyntax.js +126 -0
- package/dist/rules/noMissingSyntax.js.map +1 -0
- package/dist/rules/noMultiAsterisks.cjs +48 -89
- package/dist/rules/noMultiAsterisks.cjs.map +1 -1
- package/dist/rules/noMultiAsterisks.js +58 -0
- package/dist/rules/noMultiAsterisks.js.map +1 -0
- package/dist/rules/noRestrictedSyntax.cjs +45 -79
- package/dist/rules/noRestrictedSyntax.cjs.map +1 -1
- package/dist/rules/noRestrictedSyntax.js +49 -0
- package/dist/rules/noRestrictedSyntax.js.map +1 -0
- package/dist/rules/noTypes.cjs +59 -80
- package/dist/rules/noTypes.cjs.map +1 -1
- package/dist/rules/noTypes.js +65 -0
- package/dist/rules/noTypes.js.map +1 -0
- package/dist/rules/noUndefinedTypes.cjs +297 -388
- package/dist/rules/noUndefinedTypes.cjs.map +1 -1
- package/dist/rules/noUndefinedTypes.js +303 -0
- package/dist/rules/noUndefinedTypes.js.map +1 -0
- package/dist/rules/requireAsteriskPrefix.cjs +108 -159
- package/dist/rules/requireAsteriskPrefix.cjs.map +1 -1
- package/dist/rules/requireAsteriskPrefix.js +112 -0
- package/dist/rules/requireAsteriskPrefix.js.map +1 -0
- package/dist/rules/requireDescription.cjs +89 -129
- package/dist/rules/requireDescription.cjs.map +1 -1
- package/dist/rules/requireDescription.js +95 -0
- package/dist/rules/requireDescription.js.map +1 -0
- package/dist/rules/requireDescriptionCompleteSentence.cjs +201 -262
- package/dist/rules/requireDescriptionCompleteSentence.cjs.map +1 -1
- package/dist/rules/requireDescriptionCompleteSentence.js +220 -0
- package/dist/rules/requireDescriptionCompleteSentence.js.map +1 -0
- package/dist/rules/requireExample.cjs +73 -104
- package/dist/rules/requireExample.cjs.map +1 -1
- package/dist/rules/requireExample.js +77 -0
- package/dist/rules/requireExample.js.map +1 -0
- package/dist/rules/requireFileOverview.cjs +75 -129
- package/dist/rules/requireFileOverview.cjs.map +1 -1
- package/dist/rules/requireFileOverview.js +81 -0
- package/dist/rules/requireFileOverview.js.map +1 -0
- package/dist/rules/requireHyphenBeforeParamDescription.cjs +85 -133
- package/dist/rules/requireHyphenBeforeParamDescription.cjs.map +1 -1
- package/dist/rules/requireHyphenBeforeParamDescription.js +89 -0
- package/dist/rules/requireHyphenBeforeParamDescription.js.map +1 -0
- package/dist/rules/requireJsdoc.cjs +384 -557
- package/dist/rules/requireJsdoc.cjs.map +1 -1
- package/dist/rules/requireJsdoc.js +404 -0
- package/dist/rules/requireJsdoc.js.map +1 -0
- package/dist/rules/requireParam.cjs +336 -526
- package/dist/rules/requireParam.cjs.map +1 -1
- package/dist/rules/requireParam.js +344 -0
- package/dist/rules/requireParam.js.map +1 -0
- package/dist/rules/requireParamDescription.cjs +55 -80
- package/dist/rules/requireParamDescription.cjs.map +1 -1
- package/dist/rules/requireParamDescription.js +59 -0
- package/dist/rules/requireParamDescription.js.map +1 -0
- package/dist/rules/requireParamName.cjs +32 -50
- package/dist/rules/requireParamName.cjs.map +1 -1
- package/dist/rules/requireParamName.js +36 -0
- package/dist/rules/requireParamName.js.map +1 -0
- package/dist/rules/requireParamType.cjs +55 -80
- package/dist/rules/requireParamType.cjs.map +1 -1
- package/dist/rules/requireParamType.js +59 -0
- package/dist/rules/requireParamType.js.map +1 -0
- package/dist/rules/requireProperty.cjs +31 -42
- package/dist/rules/requireProperty.cjs.map +1 -1
- package/dist/rules/requireProperty.js +35 -0
- package/dist/rules/requireProperty.js.map +1 -0
- package/dist/rules/requirePropertyDescription.cjs +17 -25
- package/dist/rules/requirePropertyDescription.cjs.map +1 -1
- package/dist/rules/requirePropertyDescription.js +21 -0
- package/dist/rules/requirePropertyDescription.js.map +1 -0
- package/dist/rules/requirePropertyName.cjs +17 -25
- package/dist/rules/requirePropertyName.cjs.map +1 -1
- package/dist/rules/requirePropertyName.js +21 -0
- package/dist/rules/requirePropertyName.js.map +1 -0
- package/dist/rules/requirePropertyType.cjs +17 -25
- package/dist/rules/requirePropertyType.cjs.map +1 -1
- package/dist/rules/requirePropertyType.js +21 -0
- package/dist/rules/requirePropertyType.js.map +1 -0
- package/dist/rules/requireReturns.cjs +125 -203
- package/dist/rules/requireReturns.cjs.map +1 -1
- package/dist/rules/requireReturns.js +131 -0
- package/dist/rules/requireReturns.js.map +1 -0
- package/dist/rules/requireReturnsCheck.cjs +60 -103
- package/dist/rules/requireReturnsCheck.cjs.map +1 -1
- package/dist/rules/requireReturnsCheck.js +66 -0
- package/dist/rules/requireReturnsCheck.js.map +1 -0
- package/dist/rules/requireReturnsDescription.cjs +39 -54
- package/dist/rules/requireReturnsDescription.cjs.map +1 -1
- package/dist/rules/requireReturnsDescription.js +43 -0
- package/dist/rules/requireReturnsDescription.js.map +1 -0
- package/dist/rules/requireReturnsType.cjs +32 -50
- package/dist/rules/requireReturnsType.cjs.map +1 -1
- package/dist/rules/requireReturnsType.js +36 -0
- package/dist/rules/requireReturnsType.js.map +1 -0
- package/dist/rules/requireTemplate.cjs +119 -178
- package/dist/rules/requireTemplate.cjs.map +1 -1
- package/dist/rules/requireTemplate.js +122 -0
- package/dist/rules/requireTemplate.js.map +1 -0
- package/dist/rules/requireThrows.cjs +61 -95
- package/dist/rules/requireThrows.cjs.map +1 -1
- package/dist/rules/requireThrows.js +67 -0
- package/dist/rules/requireThrows.js.map +1 -0
- package/dist/rules/requireYields.cjs +106 -166
- package/dist/rules/requireYields.cjs.map +1 -1
- package/dist/rules/requireYields.js +115 -0
- package/dist/rules/requireYields.js.map +1 -0
- package/dist/rules/requireYieldsCheck.cjs +96 -152
- package/dist/rules/requireYieldsCheck.cjs.map +1 -1
- package/dist/rules/requireYieldsCheck.js +105 -0
- package/dist/rules/requireYieldsCheck.js.map +1 -0
- package/dist/rules/sortTags.cjs +258 -444
- package/dist/rules/sortTags.cjs.map +1 -1
- package/dist/rules/sortTags.js +262 -0
- package/dist/rules/sortTags.js.map +1 -0
- package/dist/rules/tagLines.cjs +179 -266
- package/dist/rules/tagLines.cjs.map +1 -1
- package/dist/rules/tagLines.js +183 -0
- package/dist/rules/tagLines.js.map +1 -0
- package/dist/rules/textEscaping.cjs +92 -127
- package/dist/rules/textEscaping.cjs.map +1 -1
- package/dist/rules/textEscaping.js +102 -0
- package/dist/rules/textEscaping.js.map +1 -0
- package/dist/rules/validTypes.cjs +252 -265
- package/dist/rules/validTypes.cjs.map +1 -1
- package/dist/rules/validTypes.js +259 -0
- package/dist/rules/validTypes.js.map +1 -0
- package/dist/tagNames.cjs +134 -170
- package/dist/tagNames.cjs.map +1 -1
- package/dist/tagNames.js +144 -0
- package/dist/tagNames.js.map +1 -0
- package/dist/utils/hasReturnValue.cjs +246 -474
- package/dist/utils/hasReturnValue.cjs.map +1 -1
- package/dist/utils/hasReturnValue.js +265 -0
- package/dist/utils/hasReturnValue.js.map +1 -0
- package/package.json +40 -24
- package/dist/generateRule.cjs +0 -242
- package/dist/generateRule.cjs.map +0 -1
- package/dist/index.cjs.map +0 -1
- package/dist/index.d.ts.map +0 -1
- package/src/WarnSettings.js +0 -34
- package/src/alignTransform.js +0 -358
- package/src/defaultTagOrder.js +0 -169
- package/src/exportParser.js +0 -978
- package/src/getDefaultTagStructureForMode.js +0 -969
- package/src/getJsdocProcessorPlugin.js +0 -672
- package/src/index.js +0 -530
- package/src/iterateJsdoc.js +0 -2518
- package/src/jsdocUtils.js +0 -1896
- package/src/rules/checkAccess.js +0 -45
- package/src/rules/checkAlignment.js +0 -63
- package/src/rules/checkExamples.js +0 -589
- package/src/rules/checkIndentation.js +0 -75
- package/src/rules/checkLineAlignment.js +0 -372
- package/src/rules/checkParamNames.js +0 -474
- package/src/rules/checkPropertyNames.js +0 -152
- package/src/rules/checkSyntax.js +0 -30
- package/src/rules/checkTagNames.js +0 -314
- package/src/rules/checkTemplateNames.js +0 -204
- package/src/rules/checkTypes.js +0 -535
- package/src/rules/checkValues.js +0 -248
- package/src/rules/convertToJsdocComments.js +0 -398
- package/src/rules/emptyTags.js +0 -98
- package/src/rules/implementsOnClasses.js +0 -64
- package/src/rules/importsAsDependencies.js +0 -133
- package/src/rules/informativeDocs.js +0 -189
- package/src/rules/linesBeforeBlock.js +0 -134
- package/src/rules/matchDescription.js +0 -286
- package/src/rules/matchName.js +0 -151
- package/src/rules/multilineBlocks.js +0 -493
- package/src/rules/noBadBlocks.js +0 -119
- package/src/rules/noBlankBlockDescriptions.js +0 -69
- package/src/rules/noBlankBlocks.js +0 -53
- package/src/rules/noDefaults.js +0 -85
- package/src/rules/noMissingSyntax.js +0 -195
- package/src/rules/noMultiAsterisks.js +0 -134
- package/src/rules/noRestrictedSyntax.js +0 -91
- package/src/rules/noTypes.js +0 -93
- package/src/rules/noUndefinedTypes.js +0 -543
- package/src/rules/requireAsteriskPrefix.js +0 -190
- package/src/rules/requireDescription.js +0 -161
- package/src/rules/requireDescriptionCompleteSentence.js +0 -335
- package/src/rules/requireExample.js +0 -118
- package/src/rules/requireFileOverview.js +0 -154
- package/src/rules/requireHyphenBeforeParamDescription.js +0 -176
- package/src/rules/requireJsdoc.js +0 -743
- package/src/rules/requireParam.js +0 -602
- package/src/rules/requireParamDescription.js +0 -89
- package/src/rules/requireParamName.js +0 -55
- package/src/rules/requireParamType.js +0 -89
- package/src/rules/requireProperty.js +0 -48
- package/src/rules/requirePropertyDescription.js +0 -25
- package/src/rules/requirePropertyName.js +0 -25
- package/src/rules/requirePropertyType.js +0 -25
- package/src/rules/requireReturns.js +0 -238
- package/src/rules/requireReturnsCheck.js +0 -145
- package/src/rules/requireReturnsDescription.js +0 -59
- package/src/rules/requireReturnsType.js +0 -51
- package/src/rules/requireTemplate.js +0 -201
- package/src/rules/requireThrows.js +0 -111
- package/src/rules/requireYields.js +0 -216
- package/src/rules/requireYieldsCheck.js +0 -208
- package/src/rules/sortTags.js +0 -558
- package/src/rules/tagLines.js +0 -359
- package/src/rules/textEscaping.js +0 -154
- package/src/rules/validTypes.js +0 -401
- package/src/tagNames.js +0 -238
- package/src/utils/hasReturnValue.js +0 -572
|
@@ -1,293 +1,189 @@
|
|
|
1
|
-
"use strict";
|
|
2
1
|
|
|
3
|
-
|
|
4
|
-
value: true
|
|
5
|
-
});
|
|
6
|
-
exports.default = void 0;
|
|
2
|
+
//#region src/getDefaultTagStructureForMode.js
|
|
7
3
|
/**
|
|
8
|
-
|
|
9
|
-
|
|
4
|
+
* @typedef {Map<string, Map<string, (string|boolean)>>} TagStructure
|
|
5
|
+
*/
|
|
10
6
|
/**
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
const getDefaultTagStructureForMode = mode => {
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
// "name" would be suggested rather than "namepath" based on example;
|
|
189
|
-
// not sure if name is required
|
|
190
|
-
['typeAllowed', true]])], ['module', new Map(/** @type {[string, string|boolean][]} */[
|
|
191
|
-
// Optional "name" and no curly brackets
|
|
192
|
-
// this block impacts `no-undefined-types` and `valid-types` (search for
|
|
193
|
-
// "isNamepathDefiningTag|tagMightHaveNamepath|tagMightHaveEitherTypeOrNamePosition")
|
|
194
|
-
['namepathRole', isJsdoc ? 'namepath-defining' : 'text'],
|
|
195
|
-
// Shows the signature with curly brackets but not in the example
|
|
196
|
-
['typeAllowed', true]])], ['name', new Map(/** @type {[string, string|boolean][]} */[
|
|
197
|
-
// Seems to require a "namepath" in the signature (with no
|
|
198
|
-
// counter-examples)
|
|
199
|
-
['namepathRole', 'namepath-defining'],
|
|
200
|
-
// "namepath"
|
|
201
|
-
['nameRequired', true],
|
|
202
|
-
// "namepath"
|
|
203
|
-
['typeOrNameRequired', true]])], ['namespace', new Map(/** @type {[string, string|boolean][]} */[
|
|
204
|
-
// Allows for "name"'s in signature, but indicated as optional
|
|
205
|
-
['namepathRole', 'namepath-defining'],
|
|
206
|
-
// Shows the signature with curly brackets but not in the example
|
|
207
|
-
['typeAllowed', true]])], ['package', new Map(/** @type {[string, string|boolean][]} */[
|
|
208
|
-
// Shows the signature with curly brackets but not in the example
|
|
209
|
-
// "typeExpression"
|
|
210
|
-
['typeAllowed', isClosureOrPermissive]])], ['param', new Map(/** @type {[string, string|boolean][]} */[['namepathRole', 'namepath-defining'],
|
|
211
|
-
// Though no signature provided requiring, per
|
|
212
|
-
// https://jsdoc.app/tags-param.html:
|
|
213
|
-
// "The @param tag requires you to specify the name of the parameter you
|
|
214
|
-
// are documenting."
|
|
215
|
-
['nameRequired', true],
|
|
216
|
-
// Has no formal signature in the docs but shows curly brackets
|
|
217
|
-
// in the examples
|
|
218
|
-
['typeAllowed', true]])], ['private', new Map(/** @type {[string, string|boolean][]} */[
|
|
219
|
-
// Shows the signature with curly brackets but not in the example
|
|
220
|
-
// "typeExpression"
|
|
221
|
-
['typeAllowed', isClosureOrPermissive]])], ['prop', new Map(/** @type {[string, string|boolean][]} */[['namepathRole', 'namepath-defining'],
|
|
222
|
-
// See `property`
|
|
223
|
-
['nameRequired', true],
|
|
224
|
-
// Has no formal signature in the docs but shows curly brackets
|
|
225
|
-
// in the examples
|
|
226
|
-
['typeAllowed', true]])], ['property', new Map(/** @type {[string, string|boolean][]} */[['namepathRole', 'namepath-defining'],
|
|
227
|
-
// No docs indicate required, but since parallel to `param`, we treat as
|
|
228
|
-
// such:
|
|
229
|
-
['nameRequired', true],
|
|
230
|
-
// Has no formal signature in the docs but shows curly brackets
|
|
231
|
-
// in the examples
|
|
232
|
-
['typeAllowed', true]])], ['protected', new Map(/** @type {[string, string|boolean][]} */[
|
|
233
|
-
// Shows the signature with curly brackets but not in the example
|
|
234
|
-
// "typeExpression"
|
|
235
|
-
['typeAllowed', isClosureOrPermissive]])], ['public', new Map(/** @type {[string, string|boolean][]} */[
|
|
236
|
-
// Does not show a signature nor show curly brackets in the example
|
|
237
|
-
['typeAllowed', isClosureOrPermissive]])], ['requires', new Map(/** @type {[string, string|boolean][]} */[
|
|
238
|
-
// <someModuleName>
|
|
239
|
-
['namepathRole', 'namepath-referencing'], ['nameRequired', true], ['typeAllowed', false]])], ['return', new Map(/** @type {[string, string|boolean][]} */[
|
|
240
|
-
// Shows curly brackets in the signature and in the examples
|
|
241
|
-
['typeAllowed', true]])], ['returns', new Map(/** @type {[string, string|boolean][]} */[
|
|
242
|
-
// Shows curly brackets in the signature and in the examples
|
|
243
|
-
['typeAllowed', true]])], ['satisfies', new Map(/** @type {[string, string|boolean][]} */[
|
|
244
|
-
// Shows curly brackets in the doc signature and examples
|
|
245
|
-
['typeRequired', true]])], ['see', new Map(/** @type {[string, string|boolean][]} */[
|
|
246
|
-
// Signature allows for "namepath" or text, so user must configure to
|
|
247
|
-
// 'namepath-referencing' to enforce checks
|
|
248
|
-
['namepathRole', 'text']])], ['static', new Map(/** @type {[string, string|boolean][]} */[
|
|
249
|
-
// Does not show a signature nor show curly brackets in the example
|
|
250
|
-
['typeAllowed', isClosureOrPermissive]])], ['suppress', new Map(/** @type {[string, string|boolean][]} */[['namepathRole', !isClosure], ['typeRequired', isClosure]])], ['template', new Map(/** @type {[string, string|boolean][]} */[['namepathRole', isJsdoc ? 'text' : 'namepath-referencing'], ['nameRequired', !isJsdoc],
|
|
251
|
-
// Though defines `namepathRole: 'namepath-defining'` in a sense, it is
|
|
252
|
-
// not parseable in the same way for template (e.g., allowing commas),
|
|
253
|
-
// so not adding
|
|
254
|
-
['typeAllowed', isTypescriptOrClosure || isPermissive]])], ['this', new Map(/** @type {[string, string|boolean][]} */[
|
|
255
|
-
// Signature seems to require a "namepath" (and no counter-examples)
|
|
256
|
-
// Not used with namepath in Closure/TypeScript, however
|
|
257
|
-
['namepathRole', isJsdoc ? 'namepath-referencing' : false],
|
|
258
|
-
// namepath
|
|
259
|
-
['typeOrNameRequired', isJsdoc], ['typeRequired', isTypescriptOrClosure]])], ['throws', new Map(/** @type {[string, string|boolean][]} */[
|
|
260
|
-
// Shows curly brackets in the signature and in the examples
|
|
261
|
-
['typeAllowed', true]])], ['tutorial', new Map(/** @type {[string, string|boolean][]} */[
|
|
262
|
-
// (a tutorial ID)
|
|
263
|
-
['nameRequired', true], ['typeAllowed', false]])], ['type', new Map(/** @type {[string, string|boolean][]} */[
|
|
264
|
-
// Shows curly brackets in the doc signature and examples
|
|
265
|
-
// "typeName"
|
|
266
|
-
['typeRequired', true]])], ['typedef', new Map(/** @type {[string, string|boolean][]} */[
|
|
267
|
-
// Seems to require a "namepath" in the signature (with no
|
|
268
|
-
// counter-examples)
|
|
269
|
-
['namepathRole', 'namepath-defining'],
|
|
270
|
-
// TypeScript may allow it to be dropped if followed by @property or @member;
|
|
271
|
-
// also shown as missing in Closure
|
|
272
|
-
// "namepath"
|
|
273
|
-
['nameRequired', isJsdocOrPermissive],
|
|
274
|
-
// Is not `typeRequired` for TypeScript because it gives an error:
|
|
275
|
-
// JSDoc '@typedef' tag should either have a type annotation or be followed by '@property' or '@member' tags.
|
|
276
|
-
|
|
277
|
-
// Has example showing curly brackets but not in doc signature
|
|
278
|
-
['typeAllowed', true],
|
|
279
|
-
// TypeScript may allow it to be dropped if followed by @property or @member
|
|
280
|
-
// "namepath"
|
|
281
|
-
['typeOrNameRequired', !isTypescript]])], ['var', new Map(/** @type {[string, string|boolean][]} */[
|
|
282
|
-
// Allows for "name"'s in signature, but indicated as optional
|
|
283
|
-
['namepathRole', 'namepath-defining'],
|
|
284
|
-
// Has example showing curly brackets but not in doc signature
|
|
285
|
-
['typeAllowed', true]])], ['yield', new Map(/** @type {[string, string|boolean][]} */[
|
|
286
|
-
// Shows curly brackets in the signature and in the examples
|
|
287
|
-
['typeAllowed', true]])], ['yields', new Map(/** @type {[string, string|boolean][]} */[
|
|
288
|
-
// Shows curly brackets in the signature and in the examples
|
|
289
|
-
['typeAllowed', true]])]]);
|
|
7
|
+
* @param {import('./jsdocUtils.js').ParserMode} mode
|
|
8
|
+
* @returns {TagStructure}
|
|
9
|
+
*/
|
|
10
|
+
const getDefaultTagStructureForMode = (mode) => {
|
|
11
|
+
const isJsdoc = mode === "jsdoc";
|
|
12
|
+
const isClosure = mode === "closure";
|
|
13
|
+
const isTypescript = mode === "typescript";
|
|
14
|
+
const isPermissive = mode === "permissive";
|
|
15
|
+
const isJsdocOrPermissive = isJsdoc || isPermissive;
|
|
16
|
+
const isJsdocOrTypescript = isJsdoc || isTypescript;
|
|
17
|
+
const isTypescriptOrClosure = isTypescript || isClosure;
|
|
18
|
+
const isClosureOrPermissive = isClosure || isPermissive;
|
|
19
|
+
const isJsdocTypescriptOrPermissive = isJsdocOrTypescript || isPermissive;
|
|
20
|
+
/**
|
|
21
|
+
* @type {TagStructure}
|
|
22
|
+
*/
|
|
23
|
+
return new Map([
|
|
24
|
+
["alias", new Map([["namepathRole", "namepath-defining"], ["typeOrNameRequired", true]])],
|
|
25
|
+
["arg", new Map([
|
|
26
|
+
["namepathRole", "namepath-defining"],
|
|
27
|
+
["nameRequired", true],
|
|
28
|
+
["typeAllowed", true]
|
|
29
|
+
])],
|
|
30
|
+
["argument", new Map([
|
|
31
|
+
["namepathRole", "namepath-defining"],
|
|
32
|
+
["nameRequired", true],
|
|
33
|
+
["typeAllowed", true]
|
|
34
|
+
])],
|
|
35
|
+
["augments", new Map([
|
|
36
|
+
["namepathRole", "namepath-referencing"],
|
|
37
|
+
["typeAllowed", true],
|
|
38
|
+
["typeOrNameRequired", true]
|
|
39
|
+
])],
|
|
40
|
+
["borrows", new Map([["namepathRole", "namepath-referencing"], ["typeOrNameRequired", true]])],
|
|
41
|
+
["callback", new Map([["namepathRole", "namepath-defining"], ["nameRequired", true]])],
|
|
42
|
+
["class", new Map([
|
|
43
|
+
["nameAllowed", true],
|
|
44
|
+
["namepathRole", "namepath-defining"],
|
|
45
|
+
["typeAllowed", true]
|
|
46
|
+
])],
|
|
47
|
+
["const", new Map([["namepathRole", "namepath-defining"], ["typeAllowed", true]])],
|
|
48
|
+
["constant", new Map([["namepathRole", "namepath-defining"], ["typeAllowed", true]])],
|
|
49
|
+
["constructor", new Map([["namepathRole", "namepath-defining"], ["typeAllowed", true]])],
|
|
50
|
+
["constructs", new Map([
|
|
51
|
+
["namepathRole", "namepath-defining"],
|
|
52
|
+
["nameRequired", false],
|
|
53
|
+
["typeAllowed", false]
|
|
54
|
+
])],
|
|
55
|
+
["define", new Map([["typeRequired", isClosure]])],
|
|
56
|
+
["emits", new Map([
|
|
57
|
+
["namepathRole", "namepath-referencing"],
|
|
58
|
+
["nameRequired", true],
|
|
59
|
+
["typeAllowed", false]
|
|
60
|
+
])],
|
|
61
|
+
["enum", new Map([["typeAllowed", true]])],
|
|
62
|
+
["event", new Map([["namepathRole", "namepath-defining"], ["nameRequired", true]])],
|
|
63
|
+
["exception", new Map([["typeAllowed", true]])],
|
|
64
|
+
["export", new Map([["typeAllowed", isClosureOrPermissive]])],
|
|
65
|
+
["exports", new Map([
|
|
66
|
+
["namepathRole", "namepath-defining"],
|
|
67
|
+
["nameRequired", isJsdoc],
|
|
68
|
+
["typeAllowed", isClosureOrPermissive]
|
|
69
|
+
])],
|
|
70
|
+
["extends", new Map([
|
|
71
|
+
["namepathRole", "namepath-referencing"],
|
|
72
|
+
["nameRequired", isJsdoc],
|
|
73
|
+
["typeAllowed", isTypescriptOrClosure || isPermissive],
|
|
74
|
+
["typeOrNameRequired", isTypescriptOrClosure || isPermissive]
|
|
75
|
+
])],
|
|
76
|
+
["external", new Map([
|
|
77
|
+
["namepathRole", "namepath-defining"],
|
|
78
|
+
["nameRequired", true],
|
|
79
|
+
["typeAllowed", false]
|
|
80
|
+
])],
|
|
81
|
+
["fires", new Map([
|
|
82
|
+
["namepathRole", "namepath-referencing"],
|
|
83
|
+
["nameRequired", true],
|
|
84
|
+
["typeAllowed", false]
|
|
85
|
+
])],
|
|
86
|
+
["func", new Map([["namepathRole", "namepath-defining"]])],
|
|
87
|
+
["function", new Map([
|
|
88
|
+
["namepathRole", "namepath-defining"],
|
|
89
|
+
["nameRequired", false],
|
|
90
|
+
["typeAllowed", false]
|
|
91
|
+
])],
|
|
92
|
+
["host", new Map([
|
|
93
|
+
["namepathRole", "namepath-defining"],
|
|
94
|
+
["nameRequired", true],
|
|
95
|
+
["typeAllowed", false]
|
|
96
|
+
])],
|
|
97
|
+
["implements", new Map([["typeRequired", true]])],
|
|
98
|
+
["interface", new Map([
|
|
99
|
+
["nameAllowed", isClosure],
|
|
100
|
+
["namepathRole", isJsdocTypescriptOrPermissive ? "namepath-defining" : false],
|
|
101
|
+
["typeAllowed", false]
|
|
102
|
+
])],
|
|
103
|
+
["internal", new Map([["nameAllowed", false], ["namepathRole", false]])],
|
|
104
|
+
["lends", new Map([["namepathRole", "namepath-referencing"], ["typeOrNameRequired", true]])],
|
|
105
|
+
["link", new Map([["namepathRole", "namepath-or-url-referencing"]])],
|
|
106
|
+
["linkcode", new Map([["namepathRole", "namepath-or-url-referencing"]])],
|
|
107
|
+
["linkplain", new Map([["namepathRole", "namepath-or-url-referencing"]])],
|
|
108
|
+
["listens", new Map([
|
|
109
|
+
["namepathRole", "namepath-referencing"],
|
|
110
|
+
["nameRequired", true],
|
|
111
|
+
["typeAllowed", false]
|
|
112
|
+
])],
|
|
113
|
+
["member", new Map([["namepathRole", "namepath-defining"], ["typeAllowed", true]])],
|
|
114
|
+
["memberof!", new Map([["namepathRole", "namepath-referencing"], ["typeOrNameRequired", true]])],
|
|
115
|
+
["memberof", new Map([["namepathRole", "namepath-referencing"], ["typeOrNameRequired", true]])],
|
|
116
|
+
["method", new Map([["namepathRole", "namepath-defining"]])],
|
|
117
|
+
["mixes", new Map([["namepathRole", "namepath-referencing"], ["typeOrNameRequired", true]])],
|
|
118
|
+
["mixin", new Map([
|
|
119
|
+
["namepathRole", "namepath-defining"],
|
|
120
|
+
["nameRequired", false],
|
|
121
|
+
["typeAllowed", false]
|
|
122
|
+
])],
|
|
123
|
+
["modifies", new Map([["typeAllowed", true]])],
|
|
124
|
+
["module", new Map([["namepathRole", isJsdoc ? "namepath-defining" : "text"], ["typeAllowed", true]])],
|
|
125
|
+
["name", new Map([
|
|
126
|
+
["namepathRole", "namepath-defining"],
|
|
127
|
+
["nameRequired", true],
|
|
128
|
+
["typeOrNameRequired", true]
|
|
129
|
+
])],
|
|
130
|
+
["namespace", new Map([["namepathRole", "namepath-defining"], ["typeAllowed", true]])],
|
|
131
|
+
["package", new Map([["typeAllowed", isClosureOrPermissive]])],
|
|
132
|
+
["param", new Map([
|
|
133
|
+
["namepathRole", "namepath-defining"],
|
|
134
|
+
["nameRequired", true],
|
|
135
|
+
["typeAllowed", true]
|
|
136
|
+
])],
|
|
137
|
+
["private", new Map([["typeAllowed", isClosureOrPermissive]])],
|
|
138
|
+
["prop", new Map([
|
|
139
|
+
["namepathRole", "namepath-defining"],
|
|
140
|
+
["nameRequired", true],
|
|
141
|
+
["typeAllowed", true]
|
|
142
|
+
])],
|
|
143
|
+
["property", new Map([
|
|
144
|
+
["namepathRole", "namepath-defining"],
|
|
145
|
+
["nameRequired", true],
|
|
146
|
+
["typeAllowed", true]
|
|
147
|
+
])],
|
|
148
|
+
["protected", new Map([["typeAllowed", isClosureOrPermissive]])],
|
|
149
|
+
["public", new Map([["typeAllowed", isClosureOrPermissive]])],
|
|
150
|
+
["requires", new Map([
|
|
151
|
+
["namepathRole", "namepath-referencing"],
|
|
152
|
+
["nameRequired", true],
|
|
153
|
+
["typeAllowed", false]
|
|
154
|
+
])],
|
|
155
|
+
["return", new Map([["typeAllowed", true]])],
|
|
156
|
+
["returns", new Map([["typeAllowed", true]])],
|
|
157
|
+
["satisfies", new Map([["typeRequired", true]])],
|
|
158
|
+
["see", new Map([["namepathRole", "text"]])],
|
|
159
|
+
["static", new Map([["typeAllowed", isClosureOrPermissive]])],
|
|
160
|
+
["suppress", new Map([["namepathRole", !isClosure], ["typeRequired", isClosure]])],
|
|
161
|
+
["template", new Map([
|
|
162
|
+
["namepathRole", isJsdoc ? "text" : "namepath-referencing"],
|
|
163
|
+
["nameRequired", !isJsdoc],
|
|
164
|
+
["typeAllowed", isTypescriptOrClosure || isPermissive]
|
|
165
|
+
])],
|
|
166
|
+
["this", new Map([
|
|
167
|
+
["namepathRole", isJsdoc ? "namepath-referencing" : false],
|
|
168
|
+
["typeOrNameRequired", isJsdoc],
|
|
169
|
+
["typeRequired", isTypescriptOrClosure]
|
|
170
|
+
])],
|
|
171
|
+
["throws", new Map([["typeAllowed", true]])],
|
|
172
|
+
["tutorial", new Map([["nameRequired", true], ["typeAllowed", false]])],
|
|
173
|
+
["type", new Map([["typeRequired", true]])],
|
|
174
|
+
["typedef", new Map([
|
|
175
|
+
["namepathRole", "namepath-defining"],
|
|
176
|
+
["nameRequired", isJsdocOrPermissive],
|
|
177
|
+
["typeAllowed", true],
|
|
178
|
+
["typeOrNameRequired", !isTypescript]
|
|
179
|
+
])],
|
|
180
|
+
["var", new Map([["namepathRole", "namepath-defining"], ["typeAllowed", true]])],
|
|
181
|
+
["yield", new Map([["typeAllowed", true]])],
|
|
182
|
+
["yields", new Map([["typeAllowed", true]])]
|
|
183
|
+
]);
|
|
290
184
|
};
|
|
291
|
-
var
|
|
292
|
-
|
|
185
|
+
var getDefaultTagStructureForMode_default = getDefaultTagStructureForMode;
|
|
186
|
+
|
|
187
|
+
//#endregion
|
|
188
|
+
exports.default = getDefaultTagStructureForMode_default;
|
|
293
189
|
//# sourceMappingURL=getDefaultTagStructureForMode.cjs.map
|