eslint-plugin-jsdoc 52.0.1 → 52.0.3
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 +365 -532
- 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 -90
- 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 +398 -383
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +22 -0
- package/dist/index.d.cts.map +1 -0
- package/dist/index.d.ts +11 -6
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +425 -0
- package/dist/index.js.map +1 -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/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 +48 -38
- package/dist/generateRule.cjs +0 -242
- package/dist/generateRule.cjs.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 -652
- 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
package/dist/index.js
ADDED
|
@@ -0,0 +1,425 @@
|
|
|
1
|
+
import { getJsdocProcessorPlugin } from "./getJsdocProcessorPlugin.js";
|
|
2
|
+
import checkAccess_default from "./rules/checkAccess.js";
|
|
3
|
+
import checkAlignment_default from "./rules/checkAlignment.js";
|
|
4
|
+
import checkExamples_default from "./rules/checkExamples.js";
|
|
5
|
+
import checkIndentation_default from "./rules/checkIndentation.js";
|
|
6
|
+
import checkLineAlignment_default from "./rules/checkLineAlignment.js";
|
|
7
|
+
import checkParamNames_default from "./rules/checkParamNames.js";
|
|
8
|
+
import checkPropertyNames_default from "./rules/checkPropertyNames.js";
|
|
9
|
+
import checkSyntax_default from "./rules/checkSyntax.js";
|
|
10
|
+
import checkTagNames_default from "./rules/checkTagNames.js";
|
|
11
|
+
import checkTemplateNames_default from "./rules/checkTemplateNames.js";
|
|
12
|
+
import checkTypes_default from "./rules/checkTypes.js";
|
|
13
|
+
import checkValues_default from "./rules/checkValues.js";
|
|
14
|
+
import convertToJsdocComments_default from "./rules/convertToJsdocComments.js";
|
|
15
|
+
import emptyTags_default from "./rules/emptyTags.js";
|
|
16
|
+
import implementsOnClasses_default from "./rules/implementsOnClasses.js";
|
|
17
|
+
import importsAsDependencies_default from "./rules/importsAsDependencies.js";
|
|
18
|
+
import informativeDocs_default from "./rules/informativeDocs.js";
|
|
19
|
+
import linesBeforeBlock_default from "./rules/linesBeforeBlock.js";
|
|
20
|
+
import matchDescription_default from "./rules/matchDescription.js";
|
|
21
|
+
import matchName_default from "./rules/matchName.js";
|
|
22
|
+
import multilineBlocks_default from "./rules/multilineBlocks.js";
|
|
23
|
+
import noBadBlocks_default from "./rules/noBadBlocks.js";
|
|
24
|
+
import noBlankBlockDescriptions_default from "./rules/noBlankBlockDescriptions.js";
|
|
25
|
+
import noBlankBlocks_default from "./rules/noBlankBlocks.js";
|
|
26
|
+
import noDefaults_default from "./rules/noDefaults.js";
|
|
27
|
+
import noMissingSyntax_default from "./rules/noMissingSyntax.js";
|
|
28
|
+
import noMultiAsterisks_default from "./rules/noMultiAsterisks.js";
|
|
29
|
+
import noRestrictedSyntax_default from "./rules/noRestrictedSyntax.js";
|
|
30
|
+
import noTypes_default from "./rules/noTypes.js";
|
|
31
|
+
import noUndefinedTypes_default from "./rules/noUndefinedTypes.js";
|
|
32
|
+
import requireAsteriskPrefix_default from "./rules/requireAsteriskPrefix.js";
|
|
33
|
+
import requireDescription_default from "./rules/requireDescription.js";
|
|
34
|
+
import requireDescriptionCompleteSentence_default from "./rules/requireDescriptionCompleteSentence.js";
|
|
35
|
+
import requireExample_default from "./rules/requireExample.js";
|
|
36
|
+
import requireFileOverview_default from "./rules/requireFileOverview.js";
|
|
37
|
+
import requireHyphenBeforeParamDescription_default from "./rules/requireHyphenBeforeParamDescription.js";
|
|
38
|
+
import requireJsdoc_default from "./rules/requireJsdoc.js";
|
|
39
|
+
import requireParam_default from "./rules/requireParam.js";
|
|
40
|
+
import requireParamDescription_default from "./rules/requireParamDescription.js";
|
|
41
|
+
import requireParamName_default from "./rules/requireParamName.js";
|
|
42
|
+
import requireParamType_default from "./rules/requireParamType.js";
|
|
43
|
+
import requireProperty_default from "./rules/requireProperty.js";
|
|
44
|
+
import requirePropertyDescription_default from "./rules/requirePropertyDescription.js";
|
|
45
|
+
import requirePropertyName_default from "./rules/requirePropertyName.js";
|
|
46
|
+
import requirePropertyType_default from "./rules/requirePropertyType.js";
|
|
47
|
+
import requireReturns_default from "./rules/requireReturns.js";
|
|
48
|
+
import requireReturnsCheck_default from "./rules/requireReturnsCheck.js";
|
|
49
|
+
import requireReturnsDescription_default from "./rules/requireReturnsDescription.js";
|
|
50
|
+
import requireReturnsType_default from "./rules/requireReturnsType.js";
|
|
51
|
+
import requireTemplate_default from "./rules/requireTemplate.js";
|
|
52
|
+
import requireThrows_default from "./rules/requireThrows.js";
|
|
53
|
+
import requireYields_default from "./rules/requireYields.js";
|
|
54
|
+
import requireYieldsCheck_default from "./rules/requireYieldsCheck.js";
|
|
55
|
+
import sortTags_default from "./rules/sortTags.js";
|
|
56
|
+
import tagLines_default from "./rules/tagLines.js";
|
|
57
|
+
import textEscaping_default from "./rules/textEscaping.js";
|
|
58
|
+
import validTypes_default from "./rules/validTypes.js";
|
|
59
|
+
|
|
60
|
+
//#region src/index.js
|
|
61
|
+
/**
|
|
62
|
+
* @typedef {"recommended" | "stylistic" | "contents" | "logical" | "requirements"} ConfigGroups
|
|
63
|
+
* @typedef {"" | "-typescript" | "-typescript-flavor"} ConfigVariants
|
|
64
|
+
* @typedef {"" | "-error"} ErrorLevelVariants
|
|
65
|
+
* @type {import('eslint').ESLint.Plugin & {
|
|
66
|
+
* configs: Record<`flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}`,
|
|
67
|
+
* import('eslint').Linter.Config>
|
|
68
|
+
* }}
|
|
69
|
+
*/
|
|
70
|
+
const index = {
|
|
71
|
+
configs: {},
|
|
72
|
+
rules: {
|
|
73
|
+
"check-access": checkAccess_default,
|
|
74
|
+
"check-alignment": checkAlignment_default,
|
|
75
|
+
"check-examples": checkExamples_default,
|
|
76
|
+
"check-indentation": checkIndentation_default,
|
|
77
|
+
"check-line-alignment": checkLineAlignment_default,
|
|
78
|
+
"check-param-names": checkParamNames_default,
|
|
79
|
+
"check-property-names": checkPropertyNames_default,
|
|
80
|
+
"check-syntax": checkSyntax_default,
|
|
81
|
+
"check-tag-names": checkTagNames_default,
|
|
82
|
+
"check-template-names": checkTemplateNames_default,
|
|
83
|
+
"check-types": checkTypes_default,
|
|
84
|
+
"check-values": checkValues_default,
|
|
85
|
+
"convert-to-jsdoc-comments": convertToJsdocComments_default,
|
|
86
|
+
"empty-tags": emptyTags_default,
|
|
87
|
+
"implements-on-classes": implementsOnClasses_default,
|
|
88
|
+
"imports-as-dependencies": importsAsDependencies_default,
|
|
89
|
+
"informative-docs": informativeDocs_default,
|
|
90
|
+
"lines-before-block": linesBeforeBlock_default,
|
|
91
|
+
"match-description": matchDescription_default,
|
|
92
|
+
"match-name": matchName_default,
|
|
93
|
+
"multiline-blocks": multilineBlocks_default,
|
|
94
|
+
"no-bad-blocks": noBadBlocks_default,
|
|
95
|
+
"no-blank-block-descriptions": noBlankBlockDescriptions_default,
|
|
96
|
+
"no-blank-blocks": noBlankBlocks_default,
|
|
97
|
+
"no-defaults": noDefaults_default,
|
|
98
|
+
"no-missing-syntax": noMissingSyntax_default,
|
|
99
|
+
"no-multi-asterisks": noMultiAsterisks_default,
|
|
100
|
+
"no-restricted-syntax": noRestrictedSyntax_default,
|
|
101
|
+
"no-types": noTypes_default,
|
|
102
|
+
"no-undefined-types": noUndefinedTypes_default,
|
|
103
|
+
"require-asterisk-prefix": requireAsteriskPrefix_default,
|
|
104
|
+
"require-description": requireDescription_default,
|
|
105
|
+
"require-description-complete-sentence": requireDescriptionCompleteSentence_default,
|
|
106
|
+
"require-example": requireExample_default,
|
|
107
|
+
"require-file-overview": requireFileOverview_default,
|
|
108
|
+
"require-hyphen-before-param-description": requireHyphenBeforeParamDescription_default,
|
|
109
|
+
"require-jsdoc": requireJsdoc_default,
|
|
110
|
+
"require-param": requireParam_default,
|
|
111
|
+
"require-param-description": requireParamDescription_default,
|
|
112
|
+
"require-param-name": requireParamName_default,
|
|
113
|
+
"require-param-type": requireParamType_default,
|
|
114
|
+
"require-property": requireProperty_default,
|
|
115
|
+
"require-property-description": requirePropertyDescription_default,
|
|
116
|
+
"require-property-name": requirePropertyName_default,
|
|
117
|
+
"require-property-type": requirePropertyType_default,
|
|
118
|
+
"require-returns": requireReturns_default,
|
|
119
|
+
"require-returns-check": requireReturnsCheck_default,
|
|
120
|
+
"require-returns-description": requireReturnsDescription_default,
|
|
121
|
+
"require-returns-type": requireReturnsType_default,
|
|
122
|
+
"require-template": requireTemplate_default,
|
|
123
|
+
"require-throws": requireThrows_default,
|
|
124
|
+
"require-yields": requireYields_default,
|
|
125
|
+
"require-yields-check": requireYieldsCheck_default,
|
|
126
|
+
"sort-tags": sortTags_default,
|
|
127
|
+
"tag-lines": tagLines_default,
|
|
128
|
+
"text-escaping": textEscaping_default,
|
|
129
|
+
"valid-types": validTypes_default
|
|
130
|
+
}
|
|
131
|
+
};
|
|
132
|
+
/**
|
|
133
|
+
* @param {"warn"|"error"} warnOrError
|
|
134
|
+
* @param {string} [flatName]
|
|
135
|
+
* @returns {import('eslint').Linter.FlatConfig}
|
|
136
|
+
*/
|
|
137
|
+
const createRecommendedRuleset = (warnOrError, flatName) => {
|
|
138
|
+
return {
|
|
139
|
+
...flatName ? { name: "jsdoc/" + flatName } : {},
|
|
140
|
+
plugins: flatName ? { jsdoc: index } : ["jsdoc"],
|
|
141
|
+
rules: {
|
|
142
|
+
"jsdoc/check-access": warnOrError,
|
|
143
|
+
"jsdoc/check-alignment": warnOrError,
|
|
144
|
+
"jsdoc/check-examples": "off",
|
|
145
|
+
"jsdoc/check-indentation": "off",
|
|
146
|
+
"jsdoc/check-line-alignment": "off",
|
|
147
|
+
"jsdoc/check-param-names": warnOrError,
|
|
148
|
+
"jsdoc/check-property-names": warnOrError,
|
|
149
|
+
"jsdoc/check-syntax": "off",
|
|
150
|
+
"jsdoc/check-tag-names": warnOrError,
|
|
151
|
+
"jsdoc/check-template-names": "off",
|
|
152
|
+
"jsdoc/check-types": warnOrError,
|
|
153
|
+
"jsdoc/check-values": warnOrError,
|
|
154
|
+
"jsdoc/convert-to-jsdoc-comments": "off",
|
|
155
|
+
"jsdoc/empty-tags": warnOrError,
|
|
156
|
+
"jsdoc/implements-on-classes": warnOrError,
|
|
157
|
+
"jsdoc/imports-as-dependencies": "off",
|
|
158
|
+
"jsdoc/informative-docs": "off",
|
|
159
|
+
"jsdoc/lines-before-block": "off",
|
|
160
|
+
"jsdoc/match-description": "off",
|
|
161
|
+
"jsdoc/match-name": "off",
|
|
162
|
+
"jsdoc/multiline-blocks": warnOrError,
|
|
163
|
+
"jsdoc/no-bad-blocks": "off",
|
|
164
|
+
"jsdoc/no-blank-block-descriptions": "off",
|
|
165
|
+
"jsdoc/no-blank-blocks": "off",
|
|
166
|
+
"jsdoc/no-defaults": warnOrError,
|
|
167
|
+
"jsdoc/no-missing-syntax": "off",
|
|
168
|
+
"jsdoc/no-multi-asterisks": warnOrError,
|
|
169
|
+
"jsdoc/no-restricted-syntax": "off",
|
|
170
|
+
"jsdoc/no-types": "off",
|
|
171
|
+
"jsdoc/no-undefined-types": warnOrError,
|
|
172
|
+
"jsdoc/require-asterisk-prefix": "off",
|
|
173
|
+
"jsdoc/require-description": "off",
|
|
174
|
+
"jsdoc/require-description-complete-sentence": "off",
|
|
175
|
+
"jsdoc/require-example": "off",
|
|
176
|
+
"jsdoc/require-file-overview": "off",
|
|
177
|
+
"jsdoc/require-hyphen-before-param-description": "off",
|
|
178
|
+
"jsdoc/require-jsdoc": warnOrError,
|
|
179
|
+
"jsdoc/require-param": warnOrError,
|
|
180
|
+
"jsdoc/require-param-description": warnOrError,
|
|
181
|
+
"jsdoc/require-param-name": warnOrError,
|
|
182
|
+
"jsdoc/require-param-type": warnOrError,
|
|
183
|
+
"jsdoc/require-property": warnOrError,
|
|
184
|
+
"jsdoc/require-property-description": warnOrError,
|
|
185
|
+
"jsdoc/require-property-name": warnOrError,
|
|
186
|
+
"jsdoc/require-property-type": warnOrError,
|
|
187
|
+
"jsdoc/require-returns": warnOrError,
|
|
188
|
+
"jsdoc/require-returns-check": warnOrError,
|
|
189
|
+
"jsdoc/require-returns-description": warnOrError,
|
|
190
|
+
"jsdoc/require-returns-type": warnOrError,
|
|
191
|
+
"jsdoc/require-template": "off",
|
|
192
|
+
"jsdoc/require-throws": "off",
|
|
193
|
+
"jsdoc/require-yields": warnOrError,
|
|
194
|
+
"jsdoc/require-yields-check": warnOrError,
|
|
195
|
+
"jsdoc/sort-tags": "off",
|
|
196
|
+
"jsdoc/tag-lines": warnOrError,
|
|
197
|
+
"jsdoc/text-escaping": "off",
|
|
198
|
+
"jsdoc/valid-types": warnOrError
|
|
199
|
+
}
|
|
200
|
+
};
|
|
201
|
+
};
|
|
202
|
+
/**
|
|
203
|
+
* @param {"warn"|"error"} warnOrError
|
|
204
|
+
* @param {string} [flatName]
|
|
205
|
+
* @returns {import('eslint').Linter.FlatConfig}
|
|
206
|
+
*/
|
|
207
|
+
const createRecommendedTypeScriptRuleset = (warnOrError, flatName) => {
|
|
208
|
+
const ruleset = createRecommendedRuleset(warnOrError, flatName);
|
|
209
|
+
return {
|
|
210
|
+
...ruleset,
|
|
211
|
+
rules: {
|
|
212
|
+
...ruleset.rules,
|
|
213
|
+
"jsdoc/check-tag-names": [warnOrError, { typed: true }],
|
|
214
|
+
"jsdoc/no-types": warnOrError,
|
|
215
|
+
"jsdoc/no-undefined-types": "off",
|
|
216
|
+
"jsdoc/require-param-type": "off",
|
|
217
|
+
"jsdoc/require-property-type": "off",
|
|
218
|
+
"jsdoc/require-returns-type": "off"
|
|
219
|
+
}
|
|
220
|
+
};
|
|
221
|
+
};
|
|
222
|
+
/**
|
|
223
|
+
* @param {"warn"|"error"} warnOrError
|
|
224
|
+
* @param {string} [flatName]
|
|
225
|
+
* @returns {import('eslint').Linter.FlatConfig}
|
|
226
|
+
*/
|
|
227
|
+
const createRecommendedTypeScriptFlavorRuleset = (warnOrError, flatName) => {
|
|
228
|
+
const ruleset = createRecommendedRuleset(warnOrError, flatName);
|
|
229
|
+
return {
|
|
230
|
+
...ruleset,
|
|
231
|
+
rules: {
|
|
232
|
+
...ruleset.rules,
|
|
233
|
+
"jsdoc/no-undefined-types": "off"
|
|
234
|
+
}
|
|
235
|
+
};
|
|
236
|
+
};
|
|
237
|
+
/**
|
|
238
|
+
* @param {(string | unknown[])[]} ruleNames
|
|
239
|
+
*/
|
|
240
|
+
const createStandaloneRulesetFactory = (ruleNames) => {
|
|
241
|
+
/**
|
|
242
|
+
* @param {"warn"|"error"} warnOrError
|
|
243
|
+
* @param {string} [flatName]
|
|
244
|
+
* @returns {import('eslint').Linter.FlatConfig}
|
|
245
|
+
*/
|
|
246
|
+
return (warnOrError, flatName) => {
|
|
247
|
+
return {
|
|
248
|
+
name: "jsdoc/" + flatName,
|
|
249
|
+
plugins: { jsdoc: index },
|
|
250
|
+
rules: Object.fromEntries(ruleNames.map((ruleName) => {
|
|
251
|
+
return typeof ruleName === "string" ? [ruleName, warnOrError] : [ruleName[0], [warnOrError, ...ruleName.slice(1)]];
|
|
252
|
+
}))
|
|
253
|
+
};
|
|
254
|
+
};
|
|
255
|
+
};
|
|
256
|
+
const contentsRules = [
|
|
257
|
+
"jsdoc/informative-docs",
|
|
258
|
+
"jsdoc/match-description",
|
|
259
|
+
"jsdoc/no-blank-block-descriptions",
|
|
260
|
+
"jsdoc/no-blank-blocks",
|
|
261
|
+
["jsdoc/text-escaping", { escapeHTML: true }]
|
|
262
|
+
];
|
|
263
|
+
const createContentsTypescriptRuleset = createStandaloneRulesetFactory(contentsRules);
|
|
264
|
+
const createContentsTypescriptFlavorRuleset = createStandaloneRulesetFactory(contentsRules);
|
|
265
|
+
const logicalRules = [
|
|
266
|
+
"jsdoc/check-access",
|
|
267
|
+
"jsdoc/check-param-names",
|
|
268
|
+
"jsdoc/check-property-names",
|
|
269
|
+
"jsdoc/check-syntax",
|
|
270
|
+
"jsdoc/check-tag-names",
|
|
271
|
+
"jsdoc/check-template-names",
|
|
272
|
+
"jsdoc/check-types",
|
|
273
|
+
"jsdoc/check-values",
|
|
274
|
+
"jsdoc/empty-tags",
|
|
275
|
+
"jsdoc/implements-on-classes",
|
|
276
|
+
"jsdoc/require-returns-check",
|
|
277
|
+
"jsdoc/require-yields-check",
|
|
278
|
+
"jsdoc/no-bad-blocks",
|
|
279
|
+
"jsdoc/no-defaults",
|
|
280
|
+
"jsdoc/no-types",
|
|
281
|
+
"jsdoc/no-undefined-types",
|
|
282
|
+
"jsdoc/valid-types"
|
|
283
|
+
];
|
|
284
|
+
const createLogicalTypescriptRuleset = createStandaloneRulesetFactory(logicalRules);
|
|
285
|
+
const createLogicalTypescriptFlavorRuleset = createStandaloneRulesetFactory(logicalRules);
|
|
286
|
+
const requirementsRules = [
|
|
287
|
+
"jsdoc/require-example",
|
|
288
|
+
"jsdoc/require-jsdoc",
|
|
289
|
+
"jsdoc/require-param",
|
|
290
|
+
"jsdoc/require-param-description",
|
|
291
|
+
"jsdoc/require-param-name",
|
|
292
|
+
"jsdoc/require-property",
|
|
293
|
+
"jsdoc/require-property-description",
|
|
294
|
+
"jsdoc/require-property-name",
|
|
295
|
+
"jsdoc/require-returns",
|
|
296
|
+
"jsdoc/require-returns-description",
|
|
297
|
+
"jsdoc/require-yields"
|
|
298
|
+
];
|
|
299
|
+
const createRequirementsTypeScriptRuleset = createStandaloneRulesetFactory(requirementsRules);
|
|
300
|
+
const createRequirementsTypeScriptFlavorRuleset = createStandaloneRulesetFactory([
|
|
301
|
+
...requirementsRules,
|
|
302
|
+
"jsdoc/require-param-type",
|
|
303
|
+
"jsdoc/require-property-type",
|
|
304
|
+
"jsdoc/require-returns-type",
|
|
305
|
+
"jsdoc/require-template"
|
|
306
|
+
]);
|
|
307
|
+
const stylisticRules = [
|
|
308
|
+
"jsdoc/check-alignment",
|
|
309
|
+
"jsdoc/check-line-alignment",
|
|
310
|
+
"jsdoc/lines-before-block",
|
|
311
|
+
"jsdoc/multiline-blocks",
|
|
312
|
+
"jsdoc/no-multi-asterisks",
|
|
313
|
+
"jsdoc/require-asterisk-prefix",
|
|
314
|
+
["jsdoc/require-hyphen-before-param-description", "never"],
|
|
315
|
+
"jsdoc/tag-lines"
|
|
316
|
+
];
|
|
317
|
+
const createStylisticTypeScriptRuleset = createStandaloneRulesetFactory(stylisticRules);
|
|
318
|
+
const createStylisticTypeScriptFlavorRuleset = createStandaloneRulesetFactory(stylisticRules);
|
|
319
|
+
/* c8 ignore next 3 -- TS */
|
|
320
|
+
if (!index.configs) throw new Error("TypeScript guard");
|
|
321
|
+
index.configs.recommended = createRecommendedRuleset("warn");
|
|
322
|
+
index.configs["recommended-error"] = createRecommendedRuleset("error");
|
|
323
|
+
index.configs["recommended-typescript"] = createRecommendedTypeScriptRuleset("warn");
|
|
324
|
+
index.configs["recommended-typescript-error"] = createRecommendedTypeScriptRuleset("error");
|
|
325
|
+
index.configs["recommended-typescript-flavor"] = createRecommendedTypeScriptFlavorRuleset("warn");
|
|
326
|
+
index.configs["recommended-typescript-flavor-error"] = createRecommendedTypeScriptFlavorRuleset("error");
|
|
327
|
+
index.configs["flat/recommended"] = createRecommendedRuleset("warn", "flat/recommended");
|
|
328
|
+
index.configs["flat/recommended-error"] = createRecommendedRuleset("error", "flat/recommended-error");
|
|
329
|
+
index.configs["flat/recommended-typescript"] = createRecommendedTypeScriptRuleset("warn", "flat/recommended-typescript");
|
|
330
|
+
index.configs["flat/recommended-typescript-error"] = createRecommendedTypeScriptRuleset("error", "flat/recommended-typescript-error");
|
|
331
|
+
index.configs["flat/recommended-typescript-flavor"] = createRecommendedTypeScriptFlavorRuleset("warn", "flat/recommended-typescript-flavor");
|
|
332
|
+
index.configs["flat/recommended-typescript-flavor-error"] = createRecommendedTypeScriptFlavorRuleset("error", "flat/recommended-typescript-flavor-error");
|
|
333
|
+
index.configs["flat/contents-typescript"] = createContentsTypescriptRuleset("warn", "flat/contents-typescript");
|
|
334
|
+
index.configs["flat/contents-typescript-error"] = createContentsTypescriptRuleset("error", "flat/contents-typescript-error");
|
|
335
|
+
index.configs["flat/contents-typescript-flavor"] = createContentsTypescriptFlavorRuleset("warn", "flat/contents-typescript-flavor");
|
|
336
|
+
index.configs["flat/contents-typescript-flavor-error"] = createContentsTypescriptFlavorRuleset("error", "flat/contents-typescript-error-flavor");
|
|
337
|
+
index.configs["flat/logical-typescript"] = createLogicalTypescriptRuleset("warn", "flat/logical-typescript");
|
|
338
|
+
index.configs["flat/logical-typescript-error"] = createLogicalTypescriptRuleset("error", "flat/logical-typescript-error");
|
|
339
|
+
index.configs["flat/logical-typescript-flavor"] = createLogicalTypescriptFlavorRuleset("warn", "flat/logical-typescript-flavor");
|
|
340
|
+
index.configs["flat/logical-typescript-flavor-error"] = createLogicalTypescriptFlavorRuleset("error", "flat/logical-typescript-error-flavor");
|
|
341
|
+
index.configs["flat/requirements-typescript"] = createRequirementsTypeScriptRuleset("warn", "flat/requirements-typescript");
|
|
342
|
+
index.configs["flat/requirements-typescript-error"] = createRequirementsTypeScriptRuleset("error", "flat/requirements-typescript-error");
|
|
343
|
+
index.configs["flat/requirements-typescript-flavor"] = createRequirementsTypeScriptFlavorRuleset("warn", "flat/requirements-typescript-flavor");
|
|
344
|
+
index.configs["flat/requirements-typescript-flavor-error"] = createRequirementsTypeScriptFlavorRuleset("error", "flat/requirements-typescript-error-flavor");
|
|
345
|
+
index.configs["flat/stylistic-typescript"] = createStylisticTypeScriptRuleset("warn", "flat/stylistic-typescript");
|
|
346
|
+
index.configs["flat/stylistic-typescript-error"] = createStylisticTypeScriptRuleset("error", "flat/stylistic-typescript-error");
|
|
347
|
+
index.configs["flat/stylistic-typescript-flavor"] = createStylisticTypeScriptFlavorRuleset("warn", "flat/stylistic-typescript-flavor");
|
|
348
|
+
index.configs["flat/stylistic-typescript-flavor-error"] = createStylisticTypeScriptFlavorRuleset("error", "flat/stylistic-typescript-error-flavor");
|
|
349
|
+
index.configs.examples = [{
|
|
350
|
+
files: ["**/*.js"],
|
|
351
|
+
name: "jsdoc/examples/processor",
|
|
352
|
+
plugins: { examples: getJsdocProcessorPlugin() },
|
|
353
|
+
processor: "examples/examples"
|
|
354
|
+
}, {
|
|
355
|
+
files: ["**/*.md/*.js"],
|
|
356
|
+
name: "jsdoc/examples/rules",
|
|
357
|
+
rules: {
|
|
358
|
+
"eol-last": 0,
|
|
359
|
+
"import/no-unresolved": 0,
|
|
360
|
+
"import/unambiguous": 0,
|
|
361
|
+
"jsdoc/require-file-overview": 0,
|
|
362
|
+
"jsdoc/require-jsdoc": 0,
|
|
363
|
+
"no-console": 0,
|
|
364
|
+
"no-multiple-empty-lines": 0,
|
|
365
|
+
"no-undef": 0,
|
|
366
|
+
"no-unused-vars": 0,
|
|
367
|
+
"node/no-missing-import": 0,
|
|
368
|
+
"node/no-missing-require": 0,
|
|
369
|
+
"padded-blocks": 0
|
|
370
|
+
}
|
|
371
|
+
}];
|
|
372
|
+
index.configs["default-expressions"] = [{
|
|
373
|
+
files: ["**/*.js"],
|
|
374
|
+
name: "jsdoc/default-expressions/processor",
|
|
375
|
+
plugins: { examples: getJsdocProcessorPlugin({
|
|
376
|
+
checkDefaults: true,
|
|
377
|
+
checkParams: true,
|
|
378
|
+
checkProperties: true
|
|
379
|
+
}) },
|
|
380
|
+
processor: "examples/examples"
|
|
381
|
+
}, {
|
|
382
|
+
files: [
|
|
383
|
+
"**/*.jsdoc-defaults",
|
|
384
|
+
"**/*.jsdoc-params",
|
|
385
|
+
"**/*.jsdoc-properties"
|
|
386
|
+
],
|
|
387
|
+
name: "jsdoc/default-expressions/rules",
|
|
388
|
+
rules: {
|
|
389
|
+
...index.configs.examples[1].rules,
|
|
390
|
+
"chai-friendly/no-unused-expressions": 0,
|
|
391
|
+
"no-empty-function": 0,
|
|
392
|
+
"no-new": 0,
|
|
393
|
+
"no-unused-expressions": 0,
|
|
394
|
+
quotes: ["error", "double"],
|
|
395
|
+
semi: ["error", "never"],
|
|
396
|
+
strict: 0
|
|
397
|
+
}
|
|
398
|
+
}];
|
|
399
|
+
index.configs["examples-and-default-expressions"] = [
|
|
400
|
+
{
|
|
401
|
+
name: "jsdoc/examples-and-default-expressions",
|
|
402
|
+
plugins: { examples: getJsdocProcessorPlugin({
|
|
403
|
+
checkDefaults: true,
|
|
404
|
+
checkParams: true,
|
|
405
|
+
checkProperties: true
|
|
406
|
+
}) }
|
|
407
|
+
},
|
|
408
|
+
...index.configs.examples.map((config) => {
|
|
409
|
+
return {
|
|
410
|
+
...config,
|
|
411
|
+
plugins: {}
|
|
412
|
+
};
|
|
413
|
+
}),
|
|
414
|
+
...index.configs["default-expressions"].map((config) => {
|
|
415
|
+
return {
|
|
416
|
+
...config,
|
|
417
|
+
plugins: {}
|
|
418
|
+
};
|
|
419
|
+
})
|
|
420
|
+
];
|
|
421
|
+
var src_default = index;
|
|
422
|
+
|
|
423
|
+
//#endregion
|
|
424
|
+
export { src_default as default };
|
|
425
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","names":["checkAccess","checkAlignment","checkExamples","checkIndentation","checkLineAlignment","checkParamNames","checkPropertyNames","checkSyntax","checkTagNames","checkTemplateNames","checkTypes","checkValues","convertToJsdocComments","emptyTags","implementsOnClasses","importsAsDependencies","informativeDocs","linesBeforeBlock","matchDescription","matchName","multilineBlocks","noBadBlocks","noBlankBlockDescriptions","noBlankBlocks","noDefaults","noMissingSyntax","noMultiAsterisks","noRestrictedSyntax","noTypes","noUndefinedTypes","requireAsteriskPrefix","requireDescription","requireDescriptionCompleteSentence","requireExample","requireFileOverview","requireHyphenBeforeParamDescription","requireJsdoc","requireParam","requireParamDescription","requireParamName","requireParamType","requireProperty","requirePropertyDescription","requirePropertyName","requirePropertyType","requireReturns","requireReturnsCheck","requireReturnsDescription","requireReturnsType","requireTemplate","requireThrows","requireYields","requireYieldsCheck","sortTags","tagLines","textEscaping","validTypes"],"sources":["../src/index.js"],"sourcesContent":["import {\n getJsdocProcessorPlugin,\n} from './getJsdocProcessorPlugin.js';\nimport checkAccess from './rules/checkAccess.js';\nimport checkAlignment from './rules/checkAlignment.js';\nimport checkExamples from './rules/checkExamples.js';\nimport checkIndentation from './rules/checkIndentation.js';\nimport checkLineAlignment from './rules/checkLineAlignment.js';\nimport checkParamNames from './rules/checkParamNames.js';\nimport checkPropertyNames from './rules/checkPropertyNames.js';\nimport checkSyntax from './rules/checkSyntax.js';\nimport checkTagNames from './rules/checkTagNames.js';\nimport checkTemplateNames from './rules/checkTemplateNames.js';\nimport checkTypes from './rules/checkTypes.js';\nimport checkValues from './rules/checkValues.js';\nimport convertToJsdocComments from './rules/convertToJsdocComments.js';\nimport emptyTags from './rules/emptyTags.js';\nimport implementsOnClasses from './rules/implementsOnClasses.js';\nimport importsAsDependencies from './rules/importsAsDependencies.js';\nimport informativeDocs from './rules/informativeDocs.js';\nimport linesBeforeBlock from './rules/linesBeforeBlock.js';\nimport matchDescription from './rules/matchDescription.js';\nimport matchName from './rules/matchName.js';\nimport multilineBlocks from './rules/multilineBlocks.js';\nimport noBadBlocks from './rules/noBadBlocks.js';\nimport noBlankBlockDescriptions from './rules/noBlankBlockDescriptions.js';\nimport noBlankBlocks from './rules/noBlankBlocks.js';\nimport noDefaults from './rules/noDefaults.js';\nimport noMissingSyntax from './rules/noMissingSyntax.js';\nimport noMultiAsterisks from './rules/noMultiAsterisks.js';\nimport noRestrictedSyntax from './rules/noRestrictedSyntax.js';\nimport noTypes from './rules/noTypes.js';\nimport noUndefinedTypes from './rules/noUndefinedTypes.js';\nimport requireAsteriskPrefix from './rules/requireAsteriskPrefix.js';\nimport requireDescription from './rules/requireDescription.js';\nimport requireDescriptionCompleteSentence from './rules/requireDescriptionCompleteSentence.js';\nimport requireExample from './rules/requireExample.js';\nimport requireFileOverview from './rules/requireFileOverview.js';\nimport requireHyphenBeforeParamDescription from './rules/requireHyphenBeforeParamDescription.js';\nimport requireJsdoc from './rules/requireJsdoc.js';\nimport requireParam from './rules/requireParam.js';\nimport requireParamDescription from './rules/requireParamDescription.js';\nimport requireParamName from './rules/requireParamName.js';\nimport requireParamType from './rules/requireParamType.js';\nimport requireProperty from './rules/requireProperty.js';\nimport requirePropertyDescription from './rules/requirePropertyDescription.js';\nimport requirePropertyName from './rules/requirePropertyName.js';\nimport requirePropertyType from './rules/requirePropertyType.js';\nimport requireReturns from './rules/requireReturns.js';\nimport requireReturnsCheck from './rules/requireReturnsCheck.js';\nimport requireReturnsDescription from './rules/requireReturnsDescription.js';\nimport requireReturnsType from './rules/requireReturnsType.js';\nimport requireTemplate from './rules/requireTemplate.js';\nimport requireThrows from './rules/requireThrows.js';\nimport requireYields from './rules/requireYields.js';\nimport requireYieldsCheck from './rules/requireYieldsCheck.js';\nimport sortTags from './rules/sortTags.js';\nimport tagLines from './rules/tagLines.js';\nimport textEscaping from './rules/textEscaping.js';\nimport validTypes from './rules/validTypes.js';\n\n/* eslint-disable jsdoc/valid-types -- Bug */\n/**\n * @typedef {\"recommended\" | \"stylistic\" | \"contents\" | \"logical\" | \"requirements\"} ConfigGroups\n * @typedef {\"\" | \"-typescript\" | \"-typescript-flavor\"} ConfigVariants\n * @typedef {\"\" | \"-error\"} ErrorLevelVariants\n * @type {import('eslint').ESLint.Plugin & {\n * configs: Record<`flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}`,\n * import('eslint').Linter.Config>\n * }}\n */\nconst index = {\n /* eslint-enable jsdoc/valid-types -- Bug */\n // @ts-expect-error Ok\n configs: {},\n rules: {\n 'check-access': checkAccess,\n 'check-alignment': checkAlignment,\n 'check-examples': checkExamples,\n 'check-indentation': checkIndentation,\n 'check-line-alignment': checkLineAlignment,\n 'check-param-names': checkParamNames,\n 'check-property-names': checkPropertyNames,\n 'check-syntax': checkSyntax,\n 'check-tag-names': checkTagNames,\n 'check-template-names': checkTemplateNames,\n 'check-types': checkTypes,\n 'check-values': checkValues,\n 'convert-to-jsdoc-comments': convertToJsdocComments,\n 'empty-tags': emptyTags,\n 'implements-on-classes': implementsOnClasses,\n 'imports-as-dependencies': importsAsDependencies,\n 'informative-docs': informativeDocs,\n 'lines-before-block': linesBeforeBlock,\n 'match-description': matchDescription,\n 'match-name': matchName,\n 'multiline-blocks': multilineBlocks,\n 'no-bad-blocks': noBadBlocks,\n 'no-blank-block-descriptions': noBlankBlockDescriptions,\n 'no-blank-blocks': noBlankBlocks,\n 'no-defaults': noDefaults,\n 'no-missing-syntax': noMissingSyntax,\n 'no-multi-asterisks': noMultiAsterisks,\n 'no-restricted-syntax': noRestrictedSyntax,\n 'no-types': noTypes,\n 'no-undefined-types': noUndefinedTypes,\n 'require-asterisk-prefix': requireAsteriskPrefix,\n 'require-description': requireDescription,\n 'require-description-complete-sentence': requireDescriptionCompleteSentence,\n 'require-example': requireExample,\n 'require-file-overview': requireFileOverview,\n 'require-hyphen-before-param-description': requireHyphenBeforeParamDescription,\n 'require-jsdoc': requireJsdoc,\n 'require-param': requireParam,\n 'require-param-description': requireParamDescription,\n 'require-param-name': requireParamName,\n 'require-param-type': requireParamType,\n 'require-property': requireProperty,\n 'require-property-description': requirePropertyDescription,\n 'require-property-name': requirePropertyName,\n 'require-property-type': requirePropertyType,\n 'require-returns': requireReturns,\n 'require-returns-check': requireReturnsCheck,\n 'require-returns-description': requireReturnsDescription,\n 'require-returns-type': requireReturnsType,\n 'require-template': requireTemplate,\n 'require-throws': requireThrows,\n 'require-yields': requireYields,\n 'require-yields-check': requireYieldsCheck,\n 'sort-tags': sortTags,\n 'tag-lines': tagLines,\n 'text-escaping': textEscaping,\n 'valid-types': validTypes,\n },\n};\n\n/**\n * @param {\"warn\"|\"error\"} warnOrError\n * @param {string} [flatName]\n * @returns {import('eslint').Linter.FlatConfig}\n */\nconst createRecommendedRuleset = (warnOrError, flatName) => {\n return {\n ...(flatName ? {\n name: 'jsdoc/' + flatName,\n } : {}),\n // @ts-expect-error Ok\n plugins:\n flatName ? {\n jsdoc: index,\n } : [\n 'jsdoc',\n ],\n rules: {\n 'jsdoc/check-access': warnOrError,\n 'jsdoc/check-alignment': warnOrError,\n 'jsdoc/check-examples': 'off',\n 'jsdoc/check-indentation': 'off',\n 'jsdoc/check-line-alignment': 'off',\n 'jsdoc/check-param-names': warnOrError,\n 'jsdoc/check-property-names': warnOrError,\n 'jsdoc/check-syntax': 'off',\n 'jsdoc/check-tag-names': warnOrError,\n 'jsdoc/check-template-names': 'off',\n 'jsdoc/check-types': warnOrError,\n 'jsdoc/check-values': warnOrError,\n 'jsdoc/convert-to-jsdoc-comments': 'off',\n 'jsdoc/empty-tags': warnOrError,\n 'jsdoc/implements-on-classes': warnOrError,\n 'jsdoc/imports-as-dependencies': 'off',\n 'jsdoc/informative-docs': 'off',\n 'jsdoc/lines-before-block': 'off',\n 'jsdoc/match-description': 'off',\n 'jsdoc/match-name': 'off',\n 'jsdoc/multiline-blocks': warnOrError,\n 'jsdoc/no-bad-blocks': 'off',\n 'jsdoc/no-blank-block-descriptions': 'off',\n 'jsdoc/no-blank-blocks': 'off',\n 'jsdoc/no-defaults': warnOrError,\n 'jsdoc/no-missing-syntax': 'off',\n 'jsdoc/no-multi-asterisks': warnOrError,\n 'jsdoc/no-restricted-syntax': 'off',\n 'jsdoc/no-types': 'off',\n 'jsdoc/no-undefined-types': warnOrError,\n 'jsdoc/require-asterisk-prefix': 'off',\n 'jsdoc/require-description': 'off',\n 'jsdoc/require-description-complete-sentence': 'off',\n 'jsdoc/require-example': 'off',\n 'jsdoc/require-file-overview': 'off',\n 'jsdoc/require-hyphen-before-param-description': 'off',\n 'jsdoc/require-jsdoc': warnOrError,\n 'jsdoc/require-param': warnOrError,\n 'jsdoc/require-param-description': warnOrError,\n 'jsdoc/require-param-name': warnOrError,\n 'jsdoc/require-param-type': warnOrError,\n 'jsdoc/require-property': warnOrError,\n 'jsdoc/require-property-description': warnOrError,\n 'jsdoc/require-property-name': warnOrError,\n 'jsdoc/require-property-type': warnOrError,\n 'jsdoc/require-returns': warnOrError,\n 'jsdoc/require-returns-check': warnOrError,\n 'jsdoc/require-returns-description': warnOrError,\n 'jsdoc/require-returns-type': warnOrError,\n 'jsdoc/require-template': 'off',\n 'jsdoc/require-throws': 'off',\n 'jsdoc/require-yields': warnOrError,\n 'jsdoc/require-yields-check': warnOrError,\n 'jsdoc/sort-tags': 'off',\n 'jsdoc/tag-lines': warnOrError,\n 'jsdoc/text-escaping': 'off',\n 'jsdoc/valid-types': warnOrError,\n },\n };\n};\n\n/**\n * @param {\"warn\"|\"error\"} warnOrError\n * @param {string} [flatName]\n * @returns {import('eslint').Linter.FlatConfig}\n */\nconst createRecommendedTypeScriptRuleset = (warnOrError, flatName) => {\n const ruleset = createRecommendedRuleset(warnOrError, flatName);\n\n return {\n ...ruleset,\n rules: {\n ...ruleset.rules,\n /* eslint-disable @stylistic/indent -- Extra indent to avoid use by auto-rule-editing */\n 'jsdoc/check-tag-names': [\n warnOrError, {\n typed: true,\n },\n ],\n 'jsdoc/no-types': warnOrError,\n 'jsdoc/no-undefined-types': 'off',\n 'jsdoc/require-param-type': 'off',\n 'jsdoc/require-property-type': 'off',\n 'jsdoc/require-returns-type': 'off',\n /* eslint-enable @stylistic/indent */\n },\n };\n};\n\n/**\n * @param {\"warn\"|\"error\"} warnOrError\n * @param {string} [flatName]\n * @returns {import('eslint').Linter.FlatConfig}\n */\nconst createRecommendedTypeScriptFlavorRuleset = (warnOrError, flatName) => {\n const ruleset = createRecommendedRuleset(warnOrError, flatName);\n\n return {\n ...ruleset,\n rules: {\n ...ruleset.rules,\n /* eslint-disable @stylistic/indent -- Extra indent to avoid use by auto-rule-editing */\n 'jsdoc/no-undefined-types': 'off',\n /* eslint-enable @stylistic/indent */\n },\n };\n};\n\n/**\n * @param {(string | unknown[])[]} ruleNames\n */\nconst createStandaloneRulesetFactory = (ruleNames) => {\n /**\n * @param {\"warn\"|\"error\"} warnOrError\n * @param {string} [flatName]\n * @returns {import('eslint').Linter.FlatConfig}\n */\n return (warnOrError, flatName) => {\n return {\n name: 'jsdoc/' + flatName,\n plugins: {\n jsdoc: index,\n },\n rules: Object.fromEntries(\n ruleNames.map(\n (ruleName) => {\n return (typeof ruleName === 'string' ?\n [\n ruleName, warnOrError,\n ] :\n [\n ruleName[0], [\n warnOrError, ...ruleName.slice(1),\n ],\n ]);\n },\n ),\n ),\n };\n };\n};\n\nconst contentsRules = [\n 'jsdoc/informative-docs',\n 'jsdoc/match-description',\n 'jsdoc/no-blank-block-descriptions',\n 'jsdoc/no-blank-blocks',\n [\n 'jsdoc/text-escaping', {\n escapeHTML: true,\n },\n ],\n];\n\nconst createContentsTypescriptRuleset = createStandaloneRulesetFactory(contentsRules);\n\nconst createContentsTypescriptFlavorRuleset = createStandaloneRulesetFactory(contentsRules);\n\nconst logicalRules = [\n 'jsdoc/check-access',\n 'jsdoc/check-param-names',\n 'jsdoc/check-property-names',\n 'jsdoc/check-syntax',\n 'jsdoc/check-tag-names',\n 'jsdoc/check-template-names',\n 'jsdoc/check-types',\n 'jsdoc/check-values',\n 'jsdoc/empty-tags',\n 'jsdoc/implements-on-classes',\n 'jsdoc/require-returns-check',\n 'jsdoc/require-yields-check',\n 'jsdoc/no-bad-blocks',\n 'jsdoc/no-defaults',\n 'jsdoc/no-types',\n 'jsdoc/no-undefined-types',\n 'jsdoc/valid-types',\n];\n\nconst createLogicalTypescriptRuleset = createStandaloneRulesetFactory(logicalRules);\n\nconst createLogicalTypescriptFlavorRuleset = createStandaloneRulesetFactory(logicalRules);\n\nconst requirementsRules = [\n 'jsdoc/require-example',\n 'jsdoc/require-jsdoc',\n 'jsdoc/require-param',\n 'jsdoc/require-param-description',\n 'jsdoc/require-param-name',\n 'jsdoc/require-property',\n 'jsdoc/require-property-description',\n 'jsdoc/require-property-name',\n 'jsdoc/require-returns',\n 'jsdoc/require-returns-description',\n 'jsdoc/require-yields',\n];\n\nconst createRequirementsTypeScriptRuleset = createStandaloneRulesetFactory(requirementsRules);\n\nconst createRequirementsTypeScriptFlavorRuleset = createStandaloneRulesetFactory([\n ...requirementsRules,\n 'jsdoc/require-param-type',\n 'jsdoc/require-property-type',\n 'jsdoc/require-returns-type',\n 'jsdoc/require-template',\n]);\n\nconst stylisticRules = [\n 'jsdoc/check-alignment',\n 'jsdoc/check-line-alignment',\n 'jsdoc/lines-before-block',\n 'jsdoc/multiline-blocks',\n 'jsdoc/no-multi-asterisks',\n 'jsdoc/require-asterisk-prefix',\n [\n 'jsdoc/require-hyphen-before-param-description', 'never',\n ],\n 'jsdoc/tag-lines',\n];\n\nconst createStylisticTypeScriptRuleset = createStandaloneRulesetFactory(stylisticRules);\n\nconst createStylisticTypeScriptFlavorRuleset = createStandaloneRulesetFactory(stylisticRules);\n\n/* c8 ignore next 3 -- TS */\nif (!index.configs) {\n throw new Error('TypeScript guard');\n}\n\nindex.configs.recommended = createRecommendedRuleset('warn');\nindex.configs['recommended-error'] = createRecommendedRuleset('error');\nindex.configs['recommended-typescript'] = createRecommendedTypeScriptRuleset('warn');\nindex.configs['recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error');\nindex.configs['recommended-typescript-flavor'] = createRecommendedTypeScriptFlavorRuleset('warn');\nindex.configs['recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error');\n\nindex.configs['flat/recommended'] = createRecommendedRuleset('warn', 'flat/recommended');\nindex.configs['flat/recommended-error'] = createRecommendedRuleset('error', 'flat/recommended-error');\nindex.configs['flat/recommended-typescript'] = createRecommendedTypeScriptRuleset('warn', 'flat/recommended-typescript');\nindex.configs['flat/recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error', 'flat/recommended-typescript-error');\nindex.configs['flat/recommended-typescript-flavor'] = createRecommendedTypeScriptFlavorRuleset('warn', 'flat/recommended-typescript-flavor');\nindex.configs['flat/recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error', 'flat/recommended-typescript-flavor-error');\n\nindex.configs['flat/contents-typescript'] = createContentsTypescriptRuleset('warn', 'flat/contents-typescript');\nindex.configs['flat/contents-typescript-error'] = createContentsTypescriptRuleset('error', 'flat/contents-typescript-error');\nindex.configs['flat/contents-typescript-flavor'] = createContentsTypescriptFlavorRuleset('warn', 'flat/contents-typescript-flavor');\nindex.configs['flat/contents-typescript-flavor-error'] = createContentsTypescriptFlavorRuleset('error', 'flat/contents-typescript-error-flavor');\nindex.configs['flat/logical-typescript'] = createLogicalTypescriptRuleset('warn', 'flat/logical-typescript');\nindex.configs['flat/logical-typescript-error'] = createLogicalTypescriptRuleset('error', 'flat/logical-typescript-error');\nindex.configs['flat/logical-typescript-flavor'] = createLogicalTypescriptFlavorRuleset('warn', 'flat/logical-typescript-flavor');\nindex.configs['flat/logical-typescript-flavor-error'] = createLogicalTypescriptFlavorRuleset('error', 'flat/logical-typescript-error-flavor');\nindex.configs['flat/requirements-typescript'] = createRequirementsTypeScriptRuleset('warn', 'flat/requirements-typescript');\nindex.configs['flat/requirements-typescript-error'] = createRequirementsTypeScriptRuleset('error', 'flat/requirements-typescript-error');\nindex.configs['flat/requirements-typescript-flavor'] = createRequirementsTypeScriptFlavorRuleset('warn', 'flat/requirements-typescript-flavor');\nindex.configs['flat/requirements-typescript-flavor-error'] = createRequirementsTypeScriptFlavorRuleset('error', 'flat/requirements-typescript-error-flavor');\nindex.configs['flat/stylistic-typescript'] = createStylisticTypeScriptRuleset('warn', 'flat/stylistic-typescript');\nindex.configs['flat/stylistic-typescript-error'] = createStylisticTypeScriptRuleset('error', 'flat/stylistic-typescript-error');\nindex.configs['flat/stylistic-typescript-flavor'] = createStylisticTypeScriptFlavorRuleset('warn', 'flat/stylistic-typescript-flavor');\nindex.configs['flat/stylistic-typescript-flavor-error'] = createStylisticTypeScriptFlavorRuleset('error', 'flat/stylistic-typescript-error-flavor');\n\nindex.configs.examples = /** @type {import('eslint').Linter.FlatConfig[]} */ ([\n {\n files: [\n '**/*.js',\n ],\n name: 'jsdoc/examples/processor',\n plugins: {\n examples: getJsdocProcessorPlugin(),\n },\n processor: 'examples/examples',\n },\n {\n files: [\n '**/*.md/*.js',\n ],\n name: 'jsdoc/examples/rules',\n rules: {\n // \"always\" newline rule at end unlikely in sample code\n 'eol-last': 0,\n\n // Wouldn't generally expect example paths to resolve relative to JS file\n 'import/no-unresolved': 0,\n\n // Snippets likely too short to always include import/export info\n 'import/unambiguous': 0,\n\n 'jsdoc/require-file-overview': 0,\n\n // The end of a multiline comment would end the comment the example is in.\n 'jsdoc/require-jsdoc': 0,\n\n // Unlikely to have inadvertent debugging within examples\n 'no-console': 0,\n\n // Often wish to start `@example` code after newline; also may use\n // empty lines for spacing\n 'no-multiple-empty-lines': 0,\n\n // Many variables in examples will be `undefined`\n 'no-undef': 0,\n\n // Common to define variables for clarity without always using them\n 'no-unused-vars': 0,\n\n // See import/no-unresolved\n 'node/no-missing-import': 0,\n 'node/no-missing-require': 0,\n\n // Can generally look nicer to pad a little even if code imposes more stringency\n 'padded-blocks': 0,\n },\n },\n]);\n\nindex.configs['default-expressions'] = /** @type {import('eslint').Linter.FlatConfig[]} */ ([\n {\n files: [\n '**/*.js',\n ],\n name: 'jsdoc/default-expressions/processor',\n plugins: {\n examples: getJsdocProcessorPlugin({\n checkDefaults: true,\n checkParams: true,\n checkProperties: true,\n }),\n },\n processor: 'examples/examples',\n },\n {\n files: [\n '**/*.jsdoc-defaults', '**/*.jsdoc-params', '**/*.jsdoc-properties',\n ],\n name: 'jsdoc/default-expressions/rules',\n rules: {\n ...index.configs.examples[1].rules,\n 'chai-friendly/no-unused-expressions': 0,\n 'no-empty-function': 0,\n 'no-new': 0,\n 'no-unused-expressions': 0,\n quotes: [\n 'error', 'double',\n ],\n semi: [\n 'error', 'never',\n ],\n strict: 0,\n },\n },\n]);\n\nindex.configs['examples-and-default-expressions'] = /** @type {import('eslint').Linter.FlatConfig[]} */ ([\n {\n name: 'jsdoc/examples-and-default-expressions',\n plugins: {\n examples: getJsdocProcessorPlugin({\n checkDefaults: true,\n checkParams: true,\n checkProperties: true,\n }),\n },\n },\n ...index.configs.examples.map((config) => {\n return {\n ...config,\n plugins: {},\n };\n }),\n ...index.configs['default-expressions'].map((config) => {\n return {\n ...config,\n plugins: {},\n };\n }),\n]);\n\nexport default index;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuEA,MAAM,QAAQ;CAGZ,SAAS,CAAE;CACX,OAAO;EACL,gBAAgBA;EAChB,mBAAmBC;EACnB,kBAAkBC;EAClB,qBAAqBC;EACrB,wBAAwBC;EACxB,qBAAqBC;EACrB,wBAAwBC;EACxB,gBAAgBC;EAChB,mBAAmBC;EACnB,wBAAwBC;EACxB,eAAeC;EACf,gBAAgBC;EAChB,6BAA6BC;EAC7B,cAAcC;EACd,yBAAyBC;EACzB,2BAA2BC;EAC3B,oBAAoBC;EACpB,sBAAsBC;EACtB,qBAAqBC;EACrB,cAAcC;EACd,oBAAoBC;EACpB,iBAAiBC;EACjB,+BAA+BC;EAC/B,mBAAmBC;EACnB,eAAeC;EACf,qBAAqBC;EACrB,sBAAsBC;EACtB,wBAAwBC;EACxB,YAAYC;EACZ,sBAAsBC;EACtB,2BAA2BC;EAC3B,uBAAuBC;EACvB,yCAAyCC;EACzC,mBAAmBC;EACnB,yBAAyBC;EACzB,2CAA2CC;EAC3C,iBAAiBC;EACjB,iBAAiBC;EACjB,6BAA6BC;EAC7B,sBAAsBC;EACtB,sBAAsBC;EACtB,oBAAoBC;EACpB,gCAAgCC;EAChC,yBAAyBC;EACzB,yBAAyBC;EACzB,mBAAmBC;EACnB,yBAAyBC;EACzB,+BAA+BC;EAC/B,wBAAwBC;EACxB,oBAAoBC;EACpB,kBAAkBC;EAClB,kBAAkBC;EAClB,wBAAwBC;EACxB,aAAaC;EACb,aAAaC;EACb,iBAAiBC;EACjB,eAAeC;CAChB;AACF;;;;;;AAOD,MAAM,2BAA2B,CAAC,aAAa,aAAa;AAC1D,QAAO;EACL,GAAI,WAAW,EACb,MAAM,WAAW,SAClB,IAAG,CAAE;EAEN,SACE,WAAW,EACT,OAAO,MACR,IAAG,CACF,OACD;EACH,OAAO;GACL,sBAAsB;GACtB,yBAAyB;GACzB,wBAAwB;GACxB,2BAA2B;GAC3B,8BAA8B;GAC9B,2BAA2B;GAC3B,8BAA8B;GAC9B,sBAAsB;GACtB,yBAAyB;GACzB,8BAA8B;GAC9B,qBAAqB;GACrB,sBAAsB;GACtB,mCAAmC;GACnC,oBAAoB;GACpB,+BAA+B;GAC/B,iCAAiC;GACjC,0BAA0B;GAC1B,4BAA4B;GAC5B,2BAA2B;GAC3B,oBAAoB;GACpB,0BAA0B;GAC1B,uBAAuB;GACvB,qCAAqC;GACrC,yBAAyB;GACzB,qBAAqB;GACrB,2BAA2B;GAC3B,4BAA4B;GAC5B,8BAA8B;GAC9B,kBAAkB;GAClB,4BAA4B;GAC5B,iCAAiC;GACjC,6BAA6B;GAC7B,+CAA+C;GAC/C,yBAAyB;GACzB,+BAA+B;GAC/B,iDAAiD;GACjD,uBAAuB;GACvB,uBAAuB;GACvB,mCAAmC;GACnC,4BAA4B;GAC5B,4BAA4B;GAC5B,0BAA0B;GAC1B,sCAAsC;GACtC,+BAA+B;GAC/B,+BAA+B;GAC/B,yBAAyB;GACzB,+BAA+B;GAC/B,qCAAqC;GACrC,8BAA8B;GAC9B,0BAA0B;GAC1B,wBAAwB;GACxB,wBAAwB;GACxB,8BAA8B;GAC9B,mBAAmB;GACnB,mBAAmB;GACnB,uBAAuB;GACvB,qBAAqB;EACtB;CACF;AACF;;;;;;AAOD,MAAM,qCAAqC,CAAC,aAAa,aAAa;CACpE,MAAM,UAAU,yBAAyB,aAAa,SAAS;AAE/D,QAAO;EACL,GAAG;EACH,OAAO;GACL,GAAG,QAAQ;GAET,yBAAyB,CACvB,aAAa,EACX,OAAO,KACR,CACF;GACD,kBAAkB;GAClB,4BAA4B;GAC5B,4BAA4B;GAC5B,+BAA+B;GAC/B,8BAA8B;EAEjC;CACF;AACF;;;;;;AAOD,MAAM,2CAA2C,CAAC,aAAa,aAAa;CAC1E,MAAM,UAAU,yBAAyB,aAAa,SAAS;AAE/D,QAAO;EACL,GAAG;EACH,OAAO;GACL,GAAG,QAAQ;GAET,4BAA4B;EAE/B;CACF;AACF;;;;AAKD,MAAM,iCAAiC,CAAC,cAAc;;;;;;AAMpD,QAAO,CAAC,aAAa,aAAa;AAChC,SAAO;GACL,MAAM,WAAW;GACjB,SAAS,EACP,OAAO,MACR;GACD,OAAO,OAAO,YACZ,UAAU,IACR,CAAC,aAAa;AACZ,WAAQ,OAAO,aAAa,WAC1B,CACE,UAAU,WACX,IACD,CACE,SAAS,IAAI,CACX,aAAa,GAAG,SAAS,MAAM,EAAE,AAClC,CACF;GACJ,EACF,CACF;EACF;CACF;AACF;AAED,MAAM,gBAAgB;CACpB;CACA;CACA;CACA;CACA,CACE,uBAAuB,EACrB,YAAY,KACb,CACF;AACF;AAED,MAAM,kCAAkC,+BAA+B,cAAc;AAErF,MAAM,wCAAwC,+BAA+B,cAAc;AAE3F,MAAM,eAAe;CACnB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD;AAED,MAAM,iCAAiC,+BAA+B,aAAa;AAEnF,MAAM,uCAAuC,+BAA+B,aAAa;AAEzF,MAAM,oBAAoB;CACxB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD;AAED,MAAM,sCAAsC,+BAA+B,kBAAkB;AAE7F,MAAM,4CAA4C,+BAA+B;CAC/E,GAAG;CACH;CACA;CACA;CACA;AACD,EAAC;AAEF,MAAM,iBAAiB;CACrB;CACA;CACA;CACA;CACA;CACA;CACA,CACE,iDAAiD,OAClD;CACD;AACD;AAED,MAAM,mCAAmC,+BAA+B,eAAe;AAEvF,MAAM,yCAAyC,+BAA+B,eAAe;;AAG7F,IAAI,CAAC,MAAM,QACT,OAAM,IAAI,MAAM;AAGlB,MAAM,QAAQ,cAAc,yBAAyB,OAAO;AAC5D,MAAM,QAAQ,uBAAuB,yBAAyB,QAAQ;AACtE,MAAM,QAAQ,4BAA4B,mCAAmC,OAAO;AACpF,MAAM,QAAQ,kCAAkC,mCAAmC,QAAQ;AAC3F,MAAM,QAAQ,mCAAmC,yCAAyC,OAAO;AACjG,MAAM,QAAQ,yCAAyC,yCAAyC,QAAQ;AAExG,MAAM,QAAQ,sBAAsB,yBAAyB,QAAQ,mBAAmB;AACxF,MAAM,QAAQ,4BAA4B,yBAAyB,SAAS,yBAAyB;AACrG,MAAM,QAAQ,iCAAiC,mCAAmC,QAAQ,8BAA8B;AACxH,MAAM,QAAQ,uCAAuC,mCAAmC,SAAS,oCAAoC;AACrI,MAAM,QAAQ,wCAAwC,yCAAyC,QAAQ,qCAAqC;AAC5I,MAAM,QAAQ,8CAA8C,yCAAyC,SAAS,2CAA2C;AAEzJ,MAAM,QAAQ,8BAA8B,gCAAgC,QAAQ,2BAA2B;AAC/G,MAAM,QAAQ,oCAAoC,gCAAgC,SAAS,iCAAiC;AAC5H,MAAM,QAAQ,qCAAqC,sCAAsC,QAAQ,kCAAkC;AACnI,MAAM,QAAQ,2CAA2C,sCAAsC,SAAS,wCAAwC;AAChJ,MAAM,QAAQ,6BAA6B,+BAA+B,QAAQ,0BAA0B;AAC5G,MAAM,QAAQ,mCAAmC,+BAA+B,SAAS,gCAAgC;AACzH,MAAM,QAAQ,oCAAoC,qCAAqC,QAAQ,iCAAiC;AAChI,MAAM,QAAQ,0CAA0C,qCAAqC,SAAS,uCAAuC;AAC7I,MAAM,QAAQ,kCAAkC,oCAAoC,QAAQ,+BAA+B;AAC3H,MAAM,QAAQ,wCAAwC,oCAAoC,SAAS,qCAAqC;AACxI,MAAM,QAAQ,yCAAyC,0CAA0C,QAAQ,sCAAsC;AAC/I,MAAM,QAAQ,+CAA+C,0CAA0C,SAAS,4CAA4C;AAC5J,MAAM,QAAQ,+BAA+B,iCAAiC,QAAQ,4BAA4B;AAClH,MAAM,QAAQ,qCAAqC,iCAAiC,SAAS,kCAAkC;AAC/H,MAAM,QAAQ,sCAAsC,uCAAuC,QAAQ,mCAAmC;AACtI,MAAM,QAAQ,4CAA4C,uCAAuC,SAAS,yCAAyC;AAEnJ,MAAM,QAAQ,WAAgE,CAC5E;CACE,OAAO,CACL,SACD;CACD,MAAM;CACN,SAAS,EACP,UAAU,yBAAyB,CACpC;CACD,WAAW;AACZ,GACD;CACE,OAAO,CACL,cACD;CACD,MAAM;CACN,OAAO;EAEL,YAAY;EAGZ,wBAAwB;EAGxB,sBAAsB;EAEtB,+BAA+B;EAG/B,uBAAuB;EAGvB,cAAc;EAId,2BAA2B;EAG3B,YAAY;EAGZ,kBAAkB;EAGlB,0BAA0B;EAC1B,2BAA2B;EAG3B,iBAAiB;CAClB;AACF,CACF;AAED,MAAM,QAAQ,yBAA8E,CAC1F;CACE,OAAO,CACL,SACD;CACD,MAAM;CACN,SAAS,EACP,UAAU,wBAAwB;EAChC,eAAe;EACf,aAAa;EACb,iBAAiB;CAClB,EAAC,CACH;CACD,WAAW;AACZ,GACD;CACE,OAAO;EACL;EAAuB;EAAqB;CAC7C;CACD,MAAM;CACN,OAAO;EACL,GAAG,MAAM,QAAQ,SAAS,GAAG;EAC7B,uCAAuC;EACvC,qBAAqB;EACrB,UAAU;EACV,yBAAyB;EACzB,QAAQ,CACN,SAAS,QACV;EACD,MAAM,CACJ,SAAS,OACV;EACD,QAAQ;CACT;AACF,CACF;AAED,MAAM,QAAQ,sCAA2F;CACvG;EACE,MAAM;EACN,SAAS,EACP,UAAU,wBAAwB;GAChC,eAAe;GACf,aAAa;GACb,iBAAiB;EAClB,EAAC,CACH;CACF;CACD,GAAG,MAAM,QAAQ,SAAS,IAAI,CAAC,WAAW;AACxC,SAAO;GACL,GAAG;GACH,SAAS,CAAE;EACZ;CACF,EAAC;CACF,GAAG,MAAM,QAAQ,uBAAuB,IAAI,CAAC,WAAW;AACtD,SAAO;GACL,GAAG;GACH,SAAS,CAAE;EACZ;CACF,EAAC;AACH;AAED,kBAAe"}
|