eslint-plugin-jsdoc 52.0.4 → 53.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/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 +1539 -1988
- package/dist/iterateJsdoc.cjs.map +1 -1
- package/dist/iterateJsdoc.d.cts +472 -0
- package/dist/iterateJsdoc.d.cts.map +1 -0
- package/dist/iterateJsdoc.d.ts +359 -349
- package/dist/iterateJsdoc.d.ts.map +1 -1
- package/dist/iterateJsdoc.js +1628 -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,40 +1,33 @@
|
|
|
1
|
-
|
|
1
|
+
const require_iterateJsdoc = require('../iterateJsdoc.cjs');
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
var
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
});
|
|
20
|
-
const accessLength = utils.getTags('access').length;
|
|
21
|
-
const individualTagLength = utils.getPresentTags(accessLevels).length;
|
|
22
|
-
if (accessLength && individualTagLength) {
|
|
23
|
-
report('The @access tag may not be used with specific access-control tags (@package, @private, @protected, or @public).');
|
|
24
|
-
}
|
|
25
|
-
if (accessLength > 1 || individualTagLength > 1) {
|
|
26
|
-
report('At most one access-control tag may be present on a jsdoc block.');
|
|
27
|
-
}
|
|
3
|
+
//#region src/rules/checkAccess.js
|
|
4
|
+
const accessLevels = [
|
|
5
|
+
"package",
|
|
6
|
+
"private",
|
|
7
|
+
"protected",
|
|
8
|
+
"public"
|
|
9
|
+
];
|
|
10
|
+
var checkAccess_default = require_iterateJsdoc.default(({ report, utils }) => {
|
|
11
|
+
utils.forEachPreferredTag("access", (jsdocParameter, targetTagName) => {
|
|
12
|
+
const desc = jsdocParameter.name + " " + jsdocParameter.description;
|
|
13
|
+
if (!accessLevels.includes(desc.trim())) report(`Missing valid JSDoc @${targetTagName} level.`, null, jsdocParameter);
|
|
14
|
+
});
|
|
15
|
+
const accessLength = utils.getTags("access").length;
|
|
16
|
+
const individualTagLength = utils.getPresentTags(accessLevels).length;
|
|
17
|
+
if (accessLength && individualTagLength) report("The @access tag may not be used with specific access-control tags (@package, @private, @protected, or @public).");
|
|
18
|
+
if (accessLength > 1 || individualTagLength > 1) report("At most one access-control tag may be present on a jsdoc block.");
|
|
28
19
|
}, {
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
20
|
+
checkPrivate: true,
|
|
21
|
+
iterateAllJsdocs: true,
|
|
22
|
+
meta: {
|
|
23
|
+
docs: {
|
|
24
|
+
description: "Checks that `@access` tags have a valid value.",
|
|
25
|
+
url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-access.md#repos-sticky-header"
|
|
26
|
+
},
|
|
27
|
+
type: "suggestion"
|
|
28
|
+
}
|
|
38
29
|
});
|
|
39
|
-
|
|
30
|
+
|
|
31
|
+
//#endregion
|
|
32
|
+
exports.default = checkAccess_default;
|
|
40
33
|
//# sourceMappingURL=checkAccess.cjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"checkAccess.cjs","names":["
|
|
1
|
+
{"version":3,"file":"checkAccess.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/checkAccess.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nconst accessLevels = [\n 'package', 'private', 'protected', 'public',\n];\n\nexport default iterateJsdoc(({\n report,\n utils,\n}) => {\n utils.forEachPreferredTag('access', (jsdocParameter, targetTagName) => {\n const desc = jsdocParameter.name + ' ' + jsdocParameter.description;\n\n if (!accessLevels.includes(desc.trim())) {\n report(\n `Missing valid JSDoc @${targetTagName} level.`,\n null,\n jsdocParameter,\n );\n }\n });\n const accessLength = utils.getTags('access').length;\n const individualTagLength = utils.getPresentTags(accessLevels).length;\n if (accessLength && individualTagLength) {\n report(\n 'The @access tag may not be used with specific access-control tags (@package, @private, @protected, or @public).',\n );\n }\n\n if (accessLength > 1 || individualTagLength > 1) {\n report(\n 'At most one access-control tag may be present on a jsdoc block.',\n );\n }\n}, {\n checkPrivate: true,\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Checks that `@access` tags have a valid value.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-access.md#repos-sticky-header',\n },\n type: 'suggestion',\n },\n});\n"],"mappings":";;;AAEA,MAAM,eAAe;CACnB;CAAW;CAAW;CAAa;AACpC;AAED,0BAAeA,6BAAa,CAAC,EAC3B,QACA,OACD,KAAK;CACJ,MAAM,oBAAoB,UAAU,CAAC,gBAAgB,kBAAkB;EACrE,MAAM,OAAO,eAAe,OAAO,MAAM,eAAe;AAExD,MAAI,CAAC,aAAa,SAAS,KAAK,MAAM,CAAC,EACrC,OACE,CAAC,qBAAqB,EAAE,cAAc,OAAO,CAAC,EAC9C,MACA,eACD;CAEJ,EAAC;CACF,MAAM,eAAe,MAAM,QAAQ,SAAS,CAAC;CAC7C,MAAM,sBAAsB,MAAM,eAAe,aAAa,CAAC;AAC/D,KAAI,gBAAgB,qBAClB,OACE,kHACD;AAGH,KAAI,eAAe,KAAK,sBAAsB,GAC5C,OACE,kEACD;AAEJ,GAAE;CACD,cAAc;CACd,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,MAAM;CACP;AACF,EAAC"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import iterateJsdoc from "../iterateJsdoc.js";
|
|
2
|
+
|
|
3
|
+
//#region src/rules/checkAccess.js
|
|
4
|
+
const accessLevels = [
|
|
5
|
+
"package",
|
|
6
|
+
"private",
|
|
7
|
+
"protected",
|
|
8
|
+
"public"
|
|
9
|
+
];
|
|
10
|
+
var checkAccess_default = iterateJsdoc(({ report, utils }) => {
|
|
11
|
+
utils.forEachPreferredTag("access", (jsdocParameter, targetTagName) => {
|
|
12
|
+
const desc = jsdocParameter.name + " " + jsdocParameter.description;
|
|
13
|
+
if (!accessLevels.includes(desc.trim())) report(`Missing valid JSDoc @${targetTagName} level.`, null, jsdocParameter);
|
|
14
|
+
});
|
|
15
|
+
const accessLength = utils.getTags("access").length;
|
|
16
|
+
const individualTagLength = utils.getPresentTags(accessLevels).length;
|
|
17
|
+
if (accessLength && individualTagLength) report("The @access tag may not be used with specific access-control tags (@package, @private, @protected, or @public).");
|
|
18
|
+
if (accessLength > 1 || individualTagLength > 1) report("At most one access-control tag may be present on a jsdoc block.");
|
|
19
|
+
}, {
|
|
20
|
+
checkPrivate: true,
|
|
21
|
+
iterateAllJsdocs: true,
|
|
22
|
+
meta: {
|
|
23
|
+
docs: {
|
|
24
|
+
description: "Checks that `@access` tags have a valid value.",
|
|
25
|
+
url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-access.md#repos-sticky-header"
|
|
26
|
+
},
|
|
27
|
+
type: "suggestion"
|
|
28
|
+
}
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
//#endregion
|
|
32
|
+
export { checkAccess_default as default };
|
|
33
|
+
//# sourceMappingURL=checkAccess.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"checkAccess.js","names":[],"sources":["../../src/rules/checkAccess.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nconst accessLevels = [\n 'package', 'private', 'protected', 'public',\n];\n\nexport default iterateJsdoc(({\n report,\n utils,\n}) => {\n utils.forEachPreferredTag('access', (jsdocParameter, targetTagName) => {\n const desc = jsdocParameter.name + ' ' + jsdocParameter.description;\n\n if (!accessLevels.includes(desc.trim())) {\n report(\n `Missing valid JSDoc @${targetTagName} level.`,\n null,\n jsdocParameter,\n );\n }\n });\n const accessLength = utils.getTags('access').length;\n const individualTagLength = utils.getPresentTags(accessLevels).length;\n if (accessLength && individualTagLength) {\n report(\n 'The @access tag may not be used with specific access-control tags (@package, @private, @protected, or @public).',\n );\n }\n\n if (accessLength > 1 || individualTagLength > 1) {\n report(\n 'At most one access-control tag may be present on a jsdoc block.',\n );\n }\n}, {\n checkPrivate: true,\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Checks that `@access` tags have a valid value.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-access.md#repos-sticky-header',\n },\n type: 'suggestion',\n },\n});\n"],"mappings":";;;AAEA,MAAM,eAAe;CACnB;CAAW;CAAW;CAAa;AACpC;AAED,0BAAe,aAAa,CAAC,EAC3B,QACA,OACD,KAAK;CACJ,MAAM,oBAAoB,UAAU,CAAC,gBAAgB,kBAAkB;EACrE,MAAM,OAAO,eAAe,OAAO,MAAM,eAAe;AAExD,MAAI,CAAC,aAAa,SAAS,KAAK,MAAM,CAAC,EACrC,OACE,CAAC,qBAAqB,EAAE,cAAc,OAAO,CAAC,EAC9C,MACA,eACD;CAEJ,EAAC;CACF,MAAM,eAAe,MAAM,QAAQ,SAAS,CAAC;CAC7C,MAAM,sBAAsB,MAAM,eAAe,aAAa,CAAC;AAC/D,KAAI,gBAAgB,qBAClB,OACE,kHACD;AAGH,KAAI,eAAe,KAAK,sBAAsB,GAC5C,OACE,kEACD;AAEJ,GAAE;CACD,cAAc;CACd,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,MAAM;CACP;AACF,EAAC"}
|
|
@@ -1,60 +1,47 @@
|
|
|
1
|
-
|
|
1
|
+
const require_iterateJsdoc = require('../iterateJsdoc.cjs');
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
value: true
|
|
5
|
-
});
|
|
6
|
-
exports.default = void 0;
|
|
7
|
-
var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
|
|
8
|
-
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
|
|
3
|
+
//#region src/rules/checkAlignment.js
|
|
9
4
|
/**
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
const trimStart = string => {
|
|
14
|
-
|
|
5
|
+
* @param {string} string
|
|
6
|
+
* @returns {string}
|
|
7
|
+
*/
|
|
8
|
+
const trimStart = (string) => {
|
|
9
|
+
return string.replace(/^\s+/v, "");
|
|
15
10
|
};
|
|
16
|
-
var
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
};
|
|
39
|
-
sourceLines.some((line, lineNum) => {
|
|
40
|
-
if (line.length !== indentLevel) {
|
|
41
|
-
report('Expected JSDoc block to be aligned.', fix, {
|
|
42
|
-
line: lineNum + 1
|
|
43
|
-
});
|
|
44
|
-
return true;
|
|
45
|
-
}
|
|
46
|
-
return false;
|
|
47
|
-
});
|
|
11
|
+
var checkAlignment_default = require_iterateJsdoc.default(({ indent, jsdocNode, report, sourceCode }) => {
|
|
12
|
+
const indentLevel = indent.length + 1;
|
|
13
|
+
const sourceLines = sourceCode.getText(jsdocNode).split("\n").slice(1).map((line) => {
|
|
14
|
+
return line.split("*")[0];
|
|
15
|
+
}).filter((line) => {
|
|
16
|
+
return !trimStart(line).length;
|
|
17
|
+
});
|
|
18
|
+
/** @type {import('eslint').Rule.ReportFixer} */
|
|
19
|
+
const fix = (fixer) => {
|
|
20
|
+
const replacement = sourceCode.getText(jsdocNode).split("\n").map((line, index) => {
|
|
21
|
+
const ignored = !index || trimStart(line.split("*")[0]).length;
|
|
22
|
+
return ignored ? line : `${indent} ${trimStart(line)}`;
|
|
23
|
+
}).join("\n");
|
|
24
|
+
return fixer.replaceText(jsdocNode, replacement);
|
|
25
|
+
};
|
|
26
|
+
sourceLines.some((line, lineNum) => {
|
|
27
|
+
if (line.length !== indentLevel) {
|
|
28
|
+
report("Expected JSDoc block to be aligned.", fix, { line: lineNum + 1 });
|
|
29
|
+
return true;
|
|
30
|
+
}
|
|
31
|
+
return false;
|
|
32
|
+
});
|
|
48
33
|
}, {
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
34
|
+
iterateAllJsdocs: true,
|
|
35
|
+
meta: {
|
|
36
|
+
docs: {
|
|
37
|
+
description: "Reports invalid alignment of JSDoc block asterisks.",
|
|
38
|
+
url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-alignment.md#repos-sticky-header"
|
|
39
|
+
},
|
|
40
|
+
fixable: "code",
|
|
41
|
+
type: "layout"
|
|
42
|
+
}
|
|
58
43
|
});
|
|
59
|
-
|
|
44
|
+
|
|
45
|
+
//#endregion
|
|
46
|
+
exports.default = checkAlignment_default;
|
|
60
47
|
//# sourceMappingURL=checkAlignment.cjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"checkAlignment.cjs","names":["
|
|
1
|
+
{"version":3,"file":"checkAlignment.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/checkAlignment.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {string} string\n * @returns {string}\n */\nconst trimStart = (string) => {\n return string.replace(/^\\s+/v, '');\n};\n\nexport default iterateJsdoc(({\n indent,\n jsdocNode,\n report,\n sourceCode,\n}) => {\n // `indent` is whitespace from line 1 (`/**`), so slice and account for \"/\".\n const indentLevel = indent.length + 1;\n const sourceLines = sourceCode.getText(jsdocNode).split('\\n')\n .slice(1)\n .map((line) => {\n return line.split('*')[0];\n })\n .filter((line) => {\n return !trimStart(line).length;\n });\n\n /** @type {import('eslint').Rule.ReportFixer} */\n const fix = (fixer) => {\n const replacement = sourceCode.getText(jsdocNode).split('\\n')\n .map((line, index) => {\n // Ignore the first line and all lines not starting with `*`\n const ignored = !index || trimStart(line.split('*')[0]).length;\n\n return ignored ? line : `${indent} ${trimStart(line)}`;\n })\n .join('\\n');\n\n return fixer.replaceText(jsdocNode, replacement);\n };\n\n sourceLines.some((line, lineNum) => {\n if (line.length !== indentLevel) {\n report('Expected JSDoc block to be aligned.', fix, {\n line: lineNum + 1,\n });\n\n return true;\n }\n\n return false;\n });\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Reports invalid alignment of JSDoc block asterisks.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-alignment.md#repos-sticky-header',\n },\n fixable: 'code',\n type: 'layout',\n },\n});\n"],"mappings":";;;;;;;AAMA,MAAM,YAAY,CAAC,WAAW;AAC5B,QAAO,OAAO,QAAQ,SAAS,GAAG;AACnC;AAED,6BAAeA,6BAAa,CAAC,EAC3B,QACA,WACA,QACA,YACD,KAAK;CAEJ,MAAM,cAAc,OAAO,SAAS;CACpC,MAAM,cAAc,WAAW,QAAQ,UAAU,CAAC,MAAM,KAAK,CAC1D,MAAM,EAAE,CACR,IAAI,CAAC,SAAS;AACb,SAAO,KAAK,MAAM,IAAI,CAAC;CACxB,EAAC,CACD,OAAO,CAAC,SAAS;AAChB,SAAO,CAAC,UAAU,KAAK,CAAC;CACzB,EAAC;;CAGJ,MAAM,MAAM,CAAC,UAAU;EACrB,MAAM,cAAc,WAAW,QAAQ,UAAU,CAAC,MAAM,KAAK,CAC1D,IAAI,CAAC,MAAM,UAAU;GAEpB,MAAM,UAAU,CAAC,SAAS,UAAU,KAAK,MAAM,IAAI,CAAC,GAAG,CAAC;AAExD,UAAO,UAAU,OAAO,GAAG,OAAO,CAAC,EAAE,UAAU,KAAK,EAAE;EACvD,EAAC,CACD,KAAK,KAAK;AAEb,SAAO,MAAM,YAAY,WAAW,YAAY;CACjD;CAED,YAAY,KAAK,CAAC,MAAM,YAAY;AAClC,MAAI,KAAK,WAAW,aAAa;GAC/B,OAAO,uCAAuC,KAAK,EACjD,MAAM,UAAU,EACjB,EAAC;AAEF,UAAO;EACR;AAED,SAAO;CACR,EAAC;AACH,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,MAAM;CACP;AACF,EAAC"}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import iterateJsdoc from "../iterateJsdoc.js";
|
|
2
|
+
|
|
3
|
+
//#region src/rules/checkAlignment.js
|
|
4
|
+
/**
|
|
5
|
+
* @param {string} string
|
|
6
|
+
* @returns {string}
|
|
7
|
+
*/
|
|
8
|
+
const trimStart = (string) => {
|
|
9
|
+
return string.replace(/^\s+/v, "");
|
|
10
|
+
};
|
|
11
|
+
var checkAlignment_default = iterateJsdoc(({ indent, jsdocNode, report, sourceCode }) => {
|
|
12
|
+
const indentLevel = indent.length + 1;
|
|
13
|
+
const sourceLines = sourceCode.getText(jsdocNode).split("\n").slice(1).map((line) => {
|
|
14
|
+
return line.split("*")[0];
|
|
15
|
+
}).filter((line) => {
|
|
16
|
+
return !trimStart(line).length;
|
|
17
|
+
});
|
|
18
|
+
/** @type {import('eslint').Rule.ReportFixer} */
|
|
19
|
+
const fix = (fixer) => {
|
|
20
|
+
const replacement = sourceCode.getText(jsdocNode).split("\n").map((line, index) => {
|
|
21
|
+
const ignored = !index || trimStart(line.split("*")[0]).length;
|
|
22
|
+
return ignored ? line : `${indent} ${trimStart(line)}`;
|
|
23
|
+
}).join("\n");
|
|
24
|
+
return fixer.replaceText(jsdocNode, replacement);
|
|
25
|
+
};
|
|
26
|
+
sourceLines.some((line, lineNum) => {
|
|
27
|
+
if (line.length !== indentLevel) {
|
|
28
|
+
report("Expected JSDoc block to be aligned.", fix, { line: lineNum + 1 });
|
|
29
|
+
return true;
|
|
30
|
+
}
|
|
31
|
+
return false;
|
|
32
|
+
});
|
|
33
|
+
}, {
|
|
34
|
+
iterateAllJsdocs: true,
|
|
35
|
+
meta: {
|
|
36
|
+
docs: {
|
|
37
|
+
description: "Reports invalid alignment of JSDoc block asterisks.",
|
|
38
|
+
url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-alignment.md#repos-sticky-header"
|
|
39
|
+
},
|
|
40
|
+
fixable: "code",
|
|
41
|
+
type: "layout"
|
|
42
|
+
}
|
|
43
|
+
});
|
|
44
|
+
|
|
45
|
+
//#endregion
|
|
46
|
+
export { checkAlignment_default as default };
|
|
47
|
+
//# sourceMappingURL=checkAlignment.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"checkAlignment.js","names":[],"sources":["../../src/rules/checkAlignment.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {string} string\n * @returns {string}\n */\nconst trimStart = (string) => {\n return string.replace(/^\\s+/v, '');\n};\n\nexport default iterateJsdoc(({\n indent,\n jsdocNode,\n report,\n sourceCode,\n}) => {\n // `indent` is whitespace from line 1 (`/**`), so slice and account for \"/\".\n const indentLevel = indent.length + 1;\n const sourceLines = sourceCode.getText(jsdocNode).split('\\n')\n .slice(1)\n .map((line) => {\n return line.split('*')[0];\n })\n .filter((line) => {\n return !trimStart(line).length;\n });\n\n /** @type {import('eslint').Rule.ReportFixer} */\n const fix = (fixer) => {\n const replacement = sourceCode.getText(jsdocNode).split('\\n')\n .map((line, index) => {\n // Ignore the first line and all lines not starting with `*`\n const ignored = !index || trimStart(line.split('*')[0]).length;\n\n return ignored ? line : `${indent} ${trimStart(line)}`;\n })\n .join('\\n');\n\n return fixer.replaceText(jsdocNode, replacement);\n };\n\n sourceLines.some((line, lineNum) => {\n if (line.length !== indentLevel) {\n report('Expected JSDoc block to be aligned.', fix, {\n line: lineNum + 1,\n });\n\n return true;\n }\n\n return false;\n });\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Reports invalid alignment of JSDoc block asterisks.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-alignment.md#repos-sticky-header',\n },\n fixable: 'code',\n type: 'layout',\n },\n});\n"],"mappings":";;;;;;;AAMA,MAAM,YAAY,CAAC,WAAW;AAC5B,QAAO,OAAO,QAAQ,SAAS,GAAG;AACnC;AAED,6BAAe,aAAa,CAAC,EAC3B,QACA,WACA,QACA,YACD,KAAK;CAEJ,MAAM,cAAc,OAAO,SAAS;CACpC,MAAM,cAAc,WAAW,QAAQ,UAAU,CAAC,MAAM,KAAK,CAC1D,MAAM,EAAE,CACR,IAAI,CAAC,SAAS;AACb,SAAO,KAAK,MAAM,IAAI,CAAC;CACxB,EAAC,CACD,OAAO,CAAC,SAAS;AAChB,SAAO,CAAC,UAAU,KAAK,CAAC;CACzB,EAAC;;CAGJ,MAAM,MAAM,CAAC,UAAU;EACrB,MAAM,cAAc,WAAW,QAAQ,UAAU,CAAC,MAAM,KAAK,CAC1D,IAAI,CAAC,MAAM,UAAU;GAEpB,MAAM,UAAU,CAAC,SAAS,UAAU,KAAK,MAAM,IAAI,CAAC,GAAG,CAAC;AAExD,UAAO,UAAU,OAAO,GAAG,OAAO,CAAC,EAAE,UAAU,KAAK,EAAE;EACvD,EAAC,CACD,KAAK,KAAK;AAEb,SAAO,MAAM,YAAY,WAAW,YAAY;CACjD;CAED,YAAY,KAAK,CAAC,MAAM,YAAY;AAClC,MAAI,KAAK,WAAW,aAAa;GAC/B,OAAO,uCAAuC,KAAK,EACjD,MAAM,UAAU,EACjB,EAAC;AAEF,UAAO;EACR;AAED,SAAO;CACR,EAAC;AACH,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,MAAM;CACP;AACF,EAAC"}
|