eslint-plugin-jsdoc 52.0.3 → 52.0.4
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 +35 -18
- package/dist/WarnSettings.cjs.map +1 -1
- package/dist/alignTransform.cjs +305 -224
- package/dist/alignTransform.cjs.map +1 -1
- package/dist/defaultTagOrder.cjs +43 -132
- package/dist/defaultTagOrder.cjs.map +1 -1
- package/dist/exportParser.cjs +696 -478
- package/dist/exportParser.cjs.map +1 -1
- package/dist/generateRule.cjs +242 -0
- package/dist/generateRule.cjs.map +1 -0
- package/dist/getDefaultTagStructureForMode.cjs +288 -184
- package/dist/getDefaultTagStructureForMode.cjs.map +1 -1
- package/dist/getJsdocProcessorPlugin.cjs +550 -364
- package/dist/getJsdocProcessorPlugin.cjs.map +1 -1
- package/dist/getJsdocProcessorPlugin.d.ts +65 -68
- package/dist/getJsdocProcessorPlugin.d.ts.map +1 -1
- package/dist/index.cjs +383 -398
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +6 -11
- package/dist/index.d.ts.map +1 -1
- package/dist/iterateJsdoc.cjs +1988 -1528
- package/dist/iterateJsdoc.cjs.map +1 -1
- package/dist/iterateJsdoc.d.ts +349 -358
- package/dist/iterateJsdoc.d.ts.map +1 -1
- package/dist/jsdocUtils.cjs +1376 -1009
- package/dist/jsdocUtils.cjs.map +1 -1
- package/dist/rules/checkAccess.cjs +36 -29
- package/dist/rules/checkAccess.cjs.map +1 -1
- package/dist/rules/checkAlignment.cjs +54 -41
- package/dist/rules/checkAlignment.cjs.map +1 -1
- package/dist/rules/checkExamples.cjs +484 -327
- package/dist/rules/checkExamples.cjs.map +1 -1
- package/dist/rules/checkIndentation.cjs +65 -50
- package/dist/rules/checkIndentation.cjs.map +1 -1
- package/dist/rules/checkLineAlignment.cjs +311 -220
- package/dist/rules/checkLineAlignment.cjs.map +1 -1
- package/dist/rules/checkParamNames.cjs +335 -227
- package/dist/rules/checkParamNames.cjs.map +1 -1
- package/dist/rules/checkPropertyNames.cjs +106 -78
- package/dist/rules/checkPropertyNames.cjs.map +1 -1
- package/dist/rules/checkSyntax.cjs +34 -21
- package/dist/rules/checkSyntax.cjs.map +1 -1
- package/dist/rules/checkTagNames.cjs +210 -188
- package/dist/rules/checkTagNames.cjs.map +1 -1
- package/dist/rules/checkTemplateNames.cjs +178 -121
- package/dist/rules/checkTemplateNames.cjs.map +1 -1
- package/dist/rules/checkTypes.cjs +385 -291
- package/dist/rules/checkTypes.cjs.map +1 -1
- package/dist/rules/checkValues.cjs +146 -100
- package/dist/rules/checkValues.cjs.map +1 -1
- package/dist/rules/convertToJsdocComments.cjs +306 -228
- package/dist/rules/convertToJsdocComments.cjs.map +1 -1
- package/dist/rules/emptyTags.cjs +72 -62
- package/dist/rules/emptyTags.cjs.map +1 -1
- package/dist/rules/implementsOnClasses.cjs +56 -36
- package/dist/rules/implementsOnClasses.cjs.map +1 -1
- package/dist/rules/importsAsDependencies.cjs +99 -62
- package/dist/rules/importsAsDependencies.cjs.map +1 -1
- package/dist/rules/informativeDocs.cjs +142 -105
- package/dist/rules/informativeDocs.cjs.map +1 -1
- package/dist/rules/linesBeforeBlock.cjs +105 -70
- package/dist/rules/linesBeforeBlock.cjs.map +1 -1
- package/dist/rules/matchDescription.cjs +222 -160
- package/dist/rules/matchDescription.cjs.map +1 -1
- package/dist/rules/matchName.cjs +128 -73
- package/dist/rules/matchName.cjs.map +1 -1
- package/dist/rules/multilineBlocks.cjs +352 -235
- package/dist/rules/multilineBlocks.cjs.map +1 -1
- package/dist/rules/noBadBlocks.cjs +86 -63
- package/dist/rules/noBadBlocks.cjs.map +1 -1
- package/dist/rules/noBlankBlockDescriptions.cjs +57 -35
- package/dist/rules/noBlankBlockDescriptions.cjs.map +1 -1
- package/dist/rules/noBlankBlocks.cjs +48 -26
- package/dist/rules/noBlankBlocks.cjs.map +1 -1
- package/dist/rules/noDefaults.cjs +79 -52
- package/dist/rules/noDefaults.cjs.map +1 -1
- package/dist/rules/noMissingSyntax.cjs +165 -115
- package/dist/rules/noMissingSyntax.cjs.map +1 -1
- package/dist/rules/noMultiAsterisks.cjs +89 -48
- package/dist/rules/noMultiAsterisks.cjs.map +1 -1
- package/dist/rules/noRestrictedSyntax.cjs +79 -45
- package/dist/rules/noRestrictedSyntax.cjs.map +1 -1
- package/dist/rules/noTypes.cjs +80 -59
- package/dist/rules/noTypes.cjs.map +1 -1
- package/dist/rules/noUndefinedTypes.cjs +388 -297
- package/dist/rules/noUndefinedTypes.cjs.map +1 -1
- package/dist/rules/requireAsteriskPrefix.cjs +159 -108
- package/dist/rules/requireAsteriskPrefix.cjs.map +1 -1
- package/dist/rules/requireDescription.cjs +129 -89
- package/dist/rules/requireDescription.cjs.map +1 -1
- package/dist/rules/requireDescriptionCompleteSentence.cjs +262 -201
- package/dist/rules/requireDescriptionCompleteSentence.cjs.map +1 -1
- package/dist/rules/requireExample.cjs +104 -73
- package/dist/rules/requireExample.cjs.map +1 -1
- package/dist/rules/requireFileOverview.cjs +129 -75
- package/dist/rules/requireFileOverview.cjs.map +1 -1
- package/dist/rules/requireHyphenBeforeParamDescription.cjs +133 -85
- package/dist/rules/requireHyphenBeforeParamDescription.cjs.map +1 -1
- package/dist/rules/requireJsdoc.cjs +557 -384
- package/dist/rules/requireJsdoc.cjs.map +1 -1
- package/dist/rules/requireParam.cjs +526 -336
- package/dist/rules/requireParam.cjs.map +1 -1
- package/dist/rules/requireParamDescription.cjs +80 -55
- package/dist/rules/requireParamDescription.cjs.map +1 -1
- package/dist/rules/requireParamName.cjs +50 -32
- package/dist/rules/requireParamName.cjs.map +1 -1
- package/dist/rules/requireParamType.cjs +80 -55
- package/dist/rules/requireParamType.cjs.map +1 -1
- package/dist/rules/requireProperty.cjs +42 -31
- package/dist/rules/requireProperty.cjs.map +1 -1
- package/dist/rules/requirePropertyDescription.cjs +25 -17
- package/dist/rules/requirePropertyDescription.cjs.map +1 -1
- package/dist/rules/requirePropertyName.cjs +25 -17
- package/dist/rules/requirePropertyName.cjs.map +1 -1
- package/dist/rules/requirePropertyType.cjs +25 -17
- package/dist/rules/requirePropertyType.cjs.map +1 -1
- package/dist/rules/requireReturns.cjs +203 -125
- package/dist/rules/requireReturns.cjs.map +1 -1
- package/dist/rules/requireReturnsCheck.cjs +103 -60
- package/dist/rules/requireReturnsCheck.cjs.map +1 -1
- package/dist/rules/requireReturnsDescription.cjs +54 -39
- package/dist/rules/requireReturnsDescription.cjs.map +1 -1
- package/dist/rules/requireReturnsType.cjs +50 -32
- package/dist/rules/requireReturnsType.cjs.map +1 -1
- package/dist/rules/requireTemplate.cjs +178 -119
- package/dist/rules/requireTemplate.cjs.map +1 -1
- package/dist/rules/requireThrows.cjs +95 -61
- package/dist/rules/requireThrows.cjs.map +1 -1
- package/dist/rules/requireYields.cjs +166 -106
- package/dist/rules/requireYields.cjs.map +1 -1
- package/dist/rules/requireYieldsCheck.cjs +152 -96
- package/dist/rules/requireYieldsCheck.cjs.map +1 -1
- package/dist/rules/sortTags.cjs +444 -258
- package/dist/rules/sortTags.cjs.map +1 -1
- package/dist/rules/tagLines.cjs +266 -179
- package/dist/rules/tagLines.cjs.map +1 -1
- package/dist/rules/textEscaping.cjs +127 -92
- package/dist/rules/textEscaping.cjs.map +1 -1
- package/dist/rules/validTypes.cjs +265 -252
- package/dist/rules/validTypes.cjs.map +1 -1
- package/dist/tagNames.cjs +170 -134
- package/dist/tagNames.cjs.map +1 -1
- package/dist/utils/hasReturnValue.cjs +474 -246
- package/dist/utils/hasReturnValue.cjs.map +1 -1
- package/package.json +24 -40
- package/src/WarnSettings.js +34 -0
- package/src/alignTransform.js +358 -0
- package/src/defaultTagOrder.js +169 -0
- package/src/exportParser.js +978 -0
- package/src/getDefaultTagStructureForMode.js +969 -0
- package/src/getJsdocProcessorPlugin.js +672 -0
- package/src/index.js +530 -0
- package/src/iterateJsdoc.js +2518 -0
- package/src/jsdocUtils.js +1896 -0
- package/src/rules/checkAccess.js +45 -0
- package/src/rules/checkAlignment.js +63 -0
- package/src/rules/checkExamples.js +589 -0
- package/src/rules/checkIndentation.js +75 -0
- package/src/rules/checkLineAlignment.js +372 -0
- package/src/rules/checkParamNames.js +474 -0
- package/src/rules/checkPropertyNames.js +152 -0
- package/src/rules/checkSyntax.js +30 -0
- package/src/rules/checkTagNames.js +314 -0
- package/src/rules/checkTemplateNames.js +204 -0
- package/src/rules/checkTypes.js +535 -0
- package/src/rules/checkValues.js +248 -0
- package/src/rules/convertToJsdocComments.js +398 -0
- package/src/rules/emptyTags.js +98 -0
- package/src/rules/implementsOnClasses.js +64 -0
- package/src/rules/importsAsDependencies.js +133 -0
- package/src/rules/informativeDocs.js +189 -0
- package/src/rules/linesBeforeBlock.js +134 -0
- package/src/rules/matchDescription.js +286 -0
- package/src/rules/matchName.js +151 -0
- package/src/rules/multilineBlocks.js +493 -0
- package/src/rules/noBadBlocks.js +119 -0
- package/src/rules/noBlankBlockDescriptions.js +69 -0
- package/src/rules/noBlankBlocks.js +53 -0
- package/src/rules/noDefaults.js +85 -0
- package/src/rules/noMissingSyntax.js +195 -0
- package/src/rules/noMultiAsterisks.js +134 -0
- package/src/rules/noRestrictedSyntax.js +91 -0
- package/src/rules/noTypes.js +93 -0
- package/src/rules/noUndefinedTypes.js +543 -0
- package/src/rules/requireAsteriskPrefix.js +190 -0
- package/src/rules/requireDescription.js +161 -0
- package/src/rules/requireDescriptionCompleteSentence.js +335 -0
- package/src/rules/requireExample.js +118 -0
- package/src/rules/requireFileOverview.js +154 -0
- package/src/rules/requireHyphenBeforeParamDescription.js +176 -0
- package/src/rules/requireJsdoc.js +743 -0
- package/src/rules/requireParam.js +602 -0
- package/src/rules/requireParamDescription.js +89 -0
- package/src/rules/requireParamName.js +55 -0
- package/src/rules/requireParamType.js +89 -0
- package/src/rules/requireProperty.js +48 -0
- package/src/rules/requirePropertyDescription.js +25 -0
- package/src/rules/requirePropertyName.js +25 -0
- package/src/rules/requirePropertyType.js +25 -0
- package/src/rules/requireReturns.js +238 -0
- package/src/rules/requireReturnsCheck.js +145 -0
- package/src/rules/requireReturnsDescription.js +59 -0
- package/src/rules/requireReturnsType.js +51 -0
- package/src/rules/requireTemplate.js +201 -0
- package/src/rules/requireThrows.js +111 -0
- package/src/rules/requireYields.js +216 -0
- package/src/rules/requireYieldsCheck.js +208 -0
- package/src/rules/sortTags.js +558 -0
- package/src/rules/tagLines.js +359 -0
- package/src/rules/textEscaping.js +154 -0
- package/src/rules/validTypes.js +401 -0
- package/src/tagNames.js +238 -0
- package/src/utils/hasReturnValue.js +572 -0
- package/dist/WarnSettings.js +0 -20
- package/dist/WarnSettings.js.map +0 -1
- package/dist/_virtual/rolldown_runtime.cjs +0 -32
- package/dist/_virtual/rolldown_runtime.js +0 -11
- package/dist/alignTransform.js +0 -241
- package/dist/alignTransform.js.map +0 -1
- package/dist/defaultTagOrder.js +0 -134
- package/dist/defaultTagOrder.js.map +0 -1
- package/dist/exportParser.js +0 -518
- package/dist/exportParser.js.map +0 -1
- package/dist/getDefaultTagStructureForMode.js +0 -188
- package/dist/getDefaultTagStructureForMode.js.map +0 -1
- package/dist/getJsdocProcessorPlugin.d.cts +0 -70
- package/dist/getJsdocProcessorPlugin.d.cts.map +0 -1
- package/dist/getJsdocProcessorPlugin.js +0 -383
- package/dist/getJsdocProcessorPlugin.js.map +0 -1
- package/dist/index.d.cts +0 -22
- package/dist/index.d.cts.map +0 -1
- package/dist/index.js +0 -425
- package/dist/index.js.map +0 -1
- package/dist/iterateJsdoc.d.cts +0 -471
- package/dist/iterateJsdoc.d.cts.map +0 -1
- package/dist/iterateJsdoc.js +0 -1617
- package/dist/iterateJsdoc.js.map +0 -1
- package/dist/jsdocUtils.js +0 -1123
- package/dist/jsdocUtils.js.map +0 -1
- package/dist/rules/checkAccess.js +0 -33
- package/dist/rules/checkAccess.js.map +0 -1
- package/dist/rules/checkAlignment.js +0 -47
- package/dist/rules/checkAlignment.js.map +0 -1
- package/dist/rules/checkExamples.js +0 -348
- package/dist/rules/checkExamples.js.map +0 -1
- package/dist/rules/checkIndentation.js +0 -59
- package/dist/rules/checkIndentation.js.map +0 -1
- package/dist/rules/checkLineAlignment.js +0 -229
- package/dist/rules/checkLineAlignment.js.map +0 -1
- package/dist/rules/checkParamNames.js +0 -237
- package/dist/rules/checkParamNames.js.map +0 -1
- package/dist/rules/checkPropertyNames.js +0 -88
- package/dist/rules/checkPropertyNames.js.map +0 -1
- package/dist/rules/checkSyntax.js +0 -25
- package/dist/rules/checkSyntax.js.map +0 -1
- package/dist/rules/checkTagNames.js +0 -191
- package/dist/rules/checkTagNames.js.map +0 -1
- package/dist/rules/checkTemplateNames.js +0 -124
- package/dist/rules/checkTemplateNames.js.map +0 -1
- package/dist/rules/checkTypes.js +0 -299
- package/dist/rules/checkTypes.js.map +0 -1
- package/dist/rules/checkValues.js +0 -103
- package/dist/rules/checkValues.js.map +0 -1
- package/dist/rules/convertToJsdocComments.js +0 -231
- package/dist/rules/convertToJsdocComments.js.map +0 -1
- package/dist/rules/emptyTags.js +0 -67
- package/dist/rules/emptyTags.js.map +0 -1
- package/dist/rules/implementsOnClasses.js +0 -40
- package/dist/rules/implementsOnClasses.js.map +0 -1
- package/dist/rules/importsAsDependencies.js +0 -68
- package/dist/rules/importsAsDependencies.js.map +0 -1
- package/dist/rules/informativeDocs.js +0 -110
- package/dist/rules/informativeDocs.js.map +0 -1
- package/dist/rules/linesBeforeBlock.js +0 -75
- package/dist/rules/linesBeforeBlock.js.map +0 -1
- package/dist/rules/matchDescription.js +0 -167
- package/dist/rules/matchDescription.js.map +0 -1
- package/dist/rules/matchName.js +0 -77
- package/dist/rules/matchName.js.map +0 -1
- package/dist/rules/multilineBlocks.js +0 -245
- package/dist/rules/multilineBlocks.js.map +0 -1
- package/dist/rules/noBadBlocks.js +0 -68
- package/dist/rules/noBadBlocks.js.map +0 -1
- package/dist/rules/noBlankBlockDescriptions.js +0 -41
- package/dist/rules/noBlankBlockDescriptions.js.map +0 -1
- package/dist/rules/noBlankBlocks.js +0 -30
- package/dist/rules/noBlankBlocks.js.map +0 -1
- package/dist/rules/noDefaults.js +0 -56
- package/dist/rules/noDefaults.js.map +0 -1
- package/dist/rules/noMissingSyntax.js +0 -126
- package/dist/rules/noMissingSyntax.js.map +0 -1
- package/dist/rules/noMultiAsterisks.js +0 -58
- package/dist/rules/noMultiAsterisks.js.map +0 -1
- package/dist/rules/noRestrictedSyntax.js +0 -49
- package/dist/rules/noRestrictedSyntax.js.map +0 -1
- package/dist/rules/noTypes.js +0 -65
- package/dist/rules/noTypes.js.map +0 -1
- package/dist/rules/noUndefinedTypes.js +0 -303
- package/dist/rules/noUndefinedTypes.js.map +0 -1
- package/dist/rules/requireAsteriskPrefix.js +0 -112
- package/dist/rules/requireAsteriskPrefix.js.map +0 -1
- package/dist/rules/requireDescription.js +0 -95
- package/dist/rules/requireDescription.js.map +0 -1
- package/dist/rules/requireDescriptionCompleteSentence.js +0 -220
- package/dist/rules/requireDescriptionCompleteSentence.js.map +0 -1
- package/dist/rules/requireExample.js +0 -77
- package/dist/rules/requireExample.js.map +0 -1
- package/dist/rules/requireFileOverview.js +0 -81
- package/dist/rules/requireFileOverview.js.map +0 -1
- package/dist/rules/requireHyphenBeforeParamDescription.js +0 -89
- package/dist/rules/requireHyphenBeforeParamDescription.js.map +0 -1
- package/dist/rules/requireJsdoc.js +0 -404
- package/dist/rules/requireJsdoc.js.map +0 -1
- package/dist/rules/requireParam.js +0 -344
- package/dist/rules/requireParam.js.map +0 -1
- package/dist/rules/requireParamDescription.js +0 -59
- package/dist/rules/requireParamDescription.js.map +0 -1
- package/dist/rules/requireParamName.js +0 -36
- package/dist/rules/requireParamName.js.map +0 -1
- package/dist/rules/requireParamType.js +0 -59
- package/dist/rules/requireParamType.js.map +0 -1
- package/dist/rules/requireProperty.js +0 -35
- package/dist/rules/requireProperty.js.map +0 -1
- package/dist/rules/requirePropertyDescription.js +0 -21
- package/dist/rules/requirePropertyDescription.js.map +0 -1
- package/dist/rules/requirePropertyName.js +0 -21
- package/dist/rules/requirePropertyName.js.map +0 -1
- package/dist/rules/requirePropertyType.js +0 -21
- package/dist/rules/requirePropertyType.js.map +0 -1
- package/dist/rules/requireReturns.js +0 -131
- package/dist/rules/requireReturns.js.map +0 -1
- package/dist/rules/requireReturnsCheck.js +0 -66
- package/dist/rules/requireReturnsCheck.js.map +0 -1
- package/dist/rules/requireReturnsDescription.js +0 -43
- package/dist/rules/requireReturnsDescription.js.map +0 -1
- package/dist/rules/requireReturnsType.js +0 -36
- package/dist/rules/requireReturnsType.js.map +0 -1
- package/dist/rules/requireTemplate.js +0 -122
- package/dist/rules/requireTemplate.js.map +0 -1
- package/dist/rules/requireThrows.js +0 -67
- package/dist/rules/requireThrows.js.map +0 -1
- package/dist/rules/requireYields.js +0 -115
- package/dist/rules/requireYields.js.map +0 -1
- package/dist/rules/requireYieldsCheck.js +0 -105
- package/dist/rules/requireYieldsCheck.js.map +0 -1
- package/dist/rules/sortTags.js +0 -262
- package/dist/rules/sortTags.js.map +0 -1
- package/dist/rules/tagLines.js +0 -183
- package/dist/rules/tagLines.js.map +0 -1
- package/dist/rules/textEscaping.js +0 -102
- package/dist/rules/textEscaping.js.map +0 -1
- package/dist/rules/validTypes.js +0 -259
- package/dist/rules/validTypes.js.map +0 -1
- package/dist/tagNames.js +0 -144
- package/dist/tagNames.js.map +0 -1
- package/dist/utils/hasReturnValue.js +0 -265
- package/dist/utils/hasReturnValue.js.map +0 -1
package/dist/index.cjs
CHANGED
|
@@ -1,426 +1,411 @@
|
|
|
1
|
-
|
|
2
|
-
const require_getJsdocProcessorPlugin = require('./getJsdocProcessorPlugin.cjs');
|
|
3
|
-
const require_checkAccess = require('./rules/checkAccess.cjs');
|
|
4
|
-
const require_checkAlignment = require('./rules/checkAlignment.cjs');
|
|
5
|
-
const require_checkExamples = require('./rules/checkExamples.cjs');
|
|
6
|
-
const require_checkIndentation = require('./rules/checkIndentation.cjs');
|
|
7
|
-
const require_checkLineAlignment = require('./rules/checkLineAlignment.cjs');
|
|
8
|
-
const require_checkParamNames = require('./rules/checkParamNames.cjs');
|
|
9
|
-
const require_checkPropertyNames = require('./rules/checkPropertyNames.cjs');
|
|
10
|
-
const require_checkSyntax = require('./rules/checkSyntax.cjs');
|
|
11
|
-
const require_checkTagNames = require('./rules/checkTagNames.cjs');
|
|
12
|
-
const require_checkTemplateNames = require('./rules/checkTemplateNames.cjs');
|
|
13
|
-
const require_checkTypes = require('./rules/checkTypes.cjs');
|
|
14
|
-
const require_checkValues = require('./rules/checkValues.cjs');
|
|
15
|
-
const require_convertToJsdocComments = require('./rules/convertToJsdocComments.cjs');
|
|
16
|
-
const require_emptyTags = require('./rules/emptyTags.cjs');
|
|
17
|
-
const require_implementsOnClasses = require('./rules/implementsOnClasses.cjs');
|
|
18
|
-
const require_importsAsDependencies = require('./rules/importsAsDependencies.cjs');
|
|
19
|
-
const require_informativeDocs = require('./rules/informativeDocs.cjs');
|
|
20
|
-
const require_linesBeforeBlock = require('./rules/linesBeforeBlock.cjs');
|
|
21
|
-
const require_matchDescription = require('./rules/matchDescription.cjs');
|
|
22
|
-
const require_matchName = require('./rules/matchName.cjs');
|
|
23
|
-
const require_multilineBlocks = require('./rules/multilineBlocks.cjs');
|
|
24
|
-
const require_noBadBlocks = require('./rules/noBadBlocks.cjs');
|
|
25
|
-
const require_noBlankBlockDescriptions = require('./rules/noBlankBlockDescriptions.cjs');
|
|
26
|
-
const require_noBlankBlocks = require('./rules/noBlankBlocks.cjs');
|
|
27
|
-
const require_noDefaults = require('./rules/noDefaults.cjs');
|
|
28
|
-
const require_noMissingSyntax = require('./rules/noMissingSyntax.cjs');
|
|
29
|
-
const require_noMultiAsterisks = require('./rules/noMultiAsterisks.cjs');
|
|
30
|
-
const require_noRestrictedSyntax = require('./rules/noRestrictedSyntax.cjs');
|
|
31
|
-
const require_noTypes = require('./rules/noTypes.cjs');
|
|
32
|
-
const require_noUndefinedTypes = require('./rules/noUndefinedTypes.cjs');
|
|
33
|
-
const require_requireAsteriskPrefix = require('./rules/requireAsteriskPrefix.cjs');
|
|
34
|
-
const require_requireDescription = require('./rules/requireDescription.cjs');
|
|
35
|
-
const require_requireDescriptionCompleteSentence = require('./rules/requireDescriptionCompleteSentence.cjs');
|
|
36
|
-
const require_requireExample = require('./rules/requireExample.cjs');
|
|
37
|
-
const require_requireFileOverview = require('./rules/requireFileOverview.cjs');
|
|
38
|
-
const require_requireHyphenBeforeParamDescription = require('./rules/requireHyphenBeforeParamDescription.cjs');
|
|
39
|
-
const require_requireJsdoc = require('./rules/requireJsdoc.cjs');
|
|
40
|
-
const require_requireParam = require('./rules/requireParam.cjs');
|
|
41
|
-
const require_requireParamDescription = require('./rules/requireParamDescription.cjs');
|
|
42
|
-
const require_requireParamName = require('./rules/requireParamName.cjs');
|
|
43
|
-
const require_requireParamType = require('./rules/requireParamType.cjs');
|
|
44
|
-
const require_requireProperty = require('./rules/requireProperty.cjs');
|
|
45
|
-
const require_requirePropertyDescription = require('./rules/requirePropertyDescription.cjs');
|
|
46
|
-
const require_requirePropertyName = require('./rules/requirePropertyName.cjs');
|
|
47
|
-
const require_requirePropertyType = require('./rules/requirePropertyType.cjs');
|
|
48
|
-
const require_requireReturns = require('./rules/requireReturns.cjs');
|
|
49
|
-
const require_requireReturnsCheck = require('./rules/requireReturnsCheck.cjs');
|
|
50
|
-
const require_requireReturnsDescription = require('./rules/requireReturnsDescription.cjs');
|
|
51
|
-
const require_requireReturnsType = require('./rules/requireReturnsType.cjs');
|
|
52
|
-
const require_requireTemplate = require('./rules/requireTemplate.cjs');
|
|
53
|
-
const require_requireThrows = require('./rules/requireThrows.cjs');
|
|
54
|
-
const require_requireYields = require('./rules/requireYields.cjs');
|
|
55
|
-
const require_requireYieldsCheck = require('./rules/requireYieldsCheck.cjs');
|
|
56
|
-
const require_sortTags = require('./rules/sortTags.cjs');
|
|
57
|
-
const require_tagLines = require('./rules/tagLines.cjs');
|
|
58
|
-
const require_textEscaping = require('./rules/textEscaping.cjs');
|
|
59
|
-
const require_validTypes = require('./rules/validTypes.cjs');
|
|
1
|
+
"use strict";
|
|
60
2
|
|
|
61
|
-
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports.default = void 0;
|
|
7
|
+
var _getJsdocProcessorPlugin = require("./getJsdocProcessorPlugin.cjs");
|
|
8
|
+
var _checkAccess = _interopRequireDefault(require("./rules/checkAccess.cjs"));
|
|
9
|
+
var _checkAlignment = _interopRequireDefault(require("./rules/checkAlignment.cjs"));
|
|
10
|
+
var _checkExamples = _interopRequireDefault(require("./rules/checkExamples.cjs"));
|
|
11
|
+
var _checkIndentation = _interopRequireDefault(require("./rules/checkIndentation.cjs"));
|
|
12
|
+
var _checkLineAlignment = _interopRequireDefault(require("./rules/checkLineAlignment.cjs"));
|
|
13
|
+
var _checkParamNames = _interopRequireDefault(require("./rules/checkParamNames.cjs"));
|
|
14
|
+
var _checkPropertyNames = _interopRequireDefault(require("./rules/checkPropertyNames.cjs"));
|
|
15
|
+
var _checkSyntax = _interopRequireDefault(require("./rules/checkSyntax.cjs"));
|
|
16
|
+
var _checkTagNames = _interopRequireDefault(require("./rules/checkTagNames.cjs"));
|
|
17
|
+
var _checkTemplateNames = _interopRequireDefault(require("./rules/checkTemplateNames.cjs"));
|
|
18
|
+
var _checkTypes = _interopRequireDefault(require("./rules/checkTypes.cjs"));
|
|
19
|
+
var _checkValues = _interopRequireDefault(require("./rules/checkValues.cjs"));
|
|
20
|
+
var _convertToJsdocComments = _interopRequireDefault(require("./rules/convertToJsdocComments.cjs"));
|
|
21
|
+
var _emptyTags = _interopRequireDefault(require("./rules/emptyTags.cjs"));
|
|
22
|
+
var _implementsOnClasses = _interopRequireDefault(require("./rules/implementsOnClasses.cjs"));
|
|
23
|
+
var _importsAsDependencies = _interopRequireDefault(require("./rules/importsAsDependencies.cjs"));
|
|
24
|
+
var _informativeDocs = _interopRequireDefault(require("./rules/informativeDocs.cjs"));
|
|
25
|
+
var _linesBeforeBlock = _interopRequireDefault(require("./rules/linesBeforeBlock.cjs"));
|
|
26
|
+
var _matchDescription = _interopRequireDefault(require("./rules/matchDescription.cjs"));
|
|
27
|
+
var _matchName = _interopRequireDefault(require("./rules/matchName.cjs"));
|
|
28
|
+
var _multilineBlocks = _interopRequireDefault(require("./rules/multilineBlocks.cjs"));
|
|
29
|
+
var _noBadBlocks = _interopRequireDefault(require("./rules/noBadBlocks.cjs"));
|
|
30
|
+
var _noBlankBlockDescriptions = _interopRequireDefault(require("./rules/noBlankBlockDescriptions.cjs"));
|
|
31
|
+
var _noBlankBlocks = _interopRequireDefault(require("./rules/noBlankBlocks.cjs"));
|
|
32
|
+
var _noDefaults = _interopRequireDefault(require("./rules/noDefaults.cjs"));
|
|
33
|
+
var _noMissingSyntax = _interopRequireDefault(require("./rules/noMissingSyntax.cjs"));
|
|
34
|
+
var _noMultiAsterisks = _interopRequireDefault(require("./rules/noMultiAsterisks.cjs"));
|
|
35
|
+
var _noRestrictedSyntax = _interopRequireDefault(require("./rules/noRestrictedSyntax.cjs"));
|
|
36
|
+
var _noTypes = _interopRequireDefault(require("./rules/noTypes.cjs"));
|
|
37
|
+
var _noUndefinedTypes = _interopRequireDefault(require("./rules/noUndefinedTypes.cjs"));
|
|
38
|
+
var _requireAsteriskPrefix = _interopRequireDefault(require("./rules/requireAsteriskPrefix.cjs"));
|
|
39
|
+
var _requireDescription = _interopRequireDefault(require("./rules/requireDescription.cjs"));
|
|
40
|
+
var _requireDescriptionCompleteSentence = _interopRequireDefault(require("./rules/requireDescriptionCompleteSentence.cjs"));
|
|
41
|
+
var _requireExample = _interopRequireDefault(require("./rules/requireExample.cjs"));
|
|
42
|
+
var _requireFileOverview = _interopRequireDefault(require("./rules/requireFileOverview.cjs"));
|
|
43
|
+
var _requireHyphenBeforeParamDescription = _interopRequireDefault(require("./rules/requireHyphenBeforeParamDescription.cjs"));
|
|
44
|
+
var _requireJsdoc = _interopRequireDefault(require("./rules/requireJsdoc.cjs"));
|
|
45
|
+
var _requireParam = _interopRequireDefault(require("./rules/requireParam.cjs"));
|
|
46
|
+
var _requireParamDescription = _interopRequireDefault(require("./rules/requireParamDescription.cjs"));
|
|
47
|
+
var _requireParamName = _interopRequireDefault(require("./rules/requireParamName.cjs"));
|
|
48
|
+
var _requireParamType = _interopRequireDefault(require("./rules/requireParamType.cjs"));
|
|
49
|
+
var _requireProperty = _interopRequireDefault(require("./rules/requireProperty.cjs"));
|
|
50
|
+
var _requirePropertyDescription = _interopRequireDefault(require("./rules/requirePropertyDescription.cjs"));
|
|
51
|
+
var _requirePropertyName = _interopRequireDefault(require("./rules/requirePropertyName.cjs"));
|
|
52
|
+
var _requirePropertyType = _interopRequireDefault(require("./rules/requirePropertyType.cjs"));
|
|
53
|
+
var _requireReturns = _interopRequireDefault(require("./rules/requireReturns.cjs"));
|
|
54
|
+
var _requireReturnsCheck = _interopRequireDefault(require("./rules/requireReturnsCheck.cjs"));
|
|
55
|
+
var _requireReturnsDescription = _interopRequireDefault(require("./rules/requireReturnsDescription.cjs"));
|
|
56
|
+
var _requireReturnsType = _interopRequireDefault(require("./rules/requireReturnsType.cjs"));
|
|
57
|
+
var _requireTemplate = _interopRequireDefault(require("./rules/requireTemplate.cjs"));
|
|
58
|
+
var _requireThrows = _interopRequireDefault(require("./rules/requireThrows.cjs"));
|
|
59
|
+
var _requireYields = _interopRequireDefault(require("./rules/requireYields.cjs"));
|
|
60
|
+
var _requireYieldsCheck = _interopRequireDefault(require("./rules/requireYieldsCheck.cjs"));
|
|
61
|
+
var _sortTags = _interopRequireDefault(require("./rules/sortTags.cjs"));
|
|
62
|
+
var _tagLines = _interopRequireDefault(require("./rules/tagLines.cjs"));
|
|
63
|
+
var _textEscaping = _interopRequireDefault(require("./rules/textEscaping.cjs"));
|
|
64
|
+
var _validTypes = _interopRequireDefault(require("./rules/validTypes.cjs"));
|
|
65
|
+
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
|
|
66
|
+
/* eslint-disable jsdoc/valid-types -- Bug */
|
|
62
67
|
/**
|
|
63
|
-
* @typedef {"recommended" | "stylistic" | "contents" | "logical" | "requirements"} ConfigGroups
|
|
64
|
-
* @typedef {"" | "-typescript" | "-typescript-flavor"} ConfigVariants
|
|
65
|
-
* @typedef {"" | "-error"} ErrorLevelVariants
|
|
66
|
-
* @type {import('eslint').ESLint.Plugin & {
|
|
67
|
-
* configs: Record<`flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}`,
|
|
68
|
-
* import('eslint').Linter.Config>
|
|
69
|
-
* }}
|
|
70
|
-
*/
|
|
68
|
+
* @typedef {"recommended" | "stylistic" | "contents" | "logical" | "requirements"} ConfigGroups
|
|
69
|
+
* @typedef {"" | "-typescript" | "-typescript-flavor"} ConfigVariants
|
|
70
|
+
* @typedef {"" | "-error"} ErrorLevelVariants
|
|
71
|
+
* @type {import('eslint').ESLint.Plugin & {
|
|
72
|
+
* configs: Record<`flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}`,
|
|
73
|
+
* import('eslint').Linter.Config>
|
|
74
|
+
* }}
|
|
75
|
+
*/
|
|
71
76
|
const index = {
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
77
|
+
/* eslint-enable jsdoc/valid-types -- Bug */
|
|
78
|
+
// @ts-expect-error Ok
|
|
79
|
+
configs: {},
|
|
80
|
+
rules: {
|
|
81
|
+
'check-access': _checkAccess.default,
|
|
82
|
+
'check-alignment': _checkAlignment.default,
|
|
83
|
+
'check-examples': _checkExamples.default,
|
|
84
|
+
'check-indentation': _checkIndentation.default,
|
|
85
|
+
'check-line-alignment': _checkLineAlignment.default,
|
|
86
|
+
'check-param-names': _checkParamNames.default,
|
|
87
|
+
'check-property-names': _checkPropertyNames.default,
|
|
88
|
+
'check-syntax': _checkSyntax.default,
|
|
89
|
+
'check-tag-names': _checkTagNames.default,
|
|
90
|
+
'check-template-names': _checkTemplateNames.default,
|
|
91
|
+
'check-types': _checkTypes.default,
|
|
92
|
+
'check-values': _checkValues.default,
|
|
93
|
+
'convert-to-jsdoc-comments': _convertToJsdocComments.default,
|
|
94
|
+
'empty-tags': _emptyTags.default,
|
|
95
|
+
'implements-on-classes': _implementsOnClasses.default,
|
|
96
|
+
'imports-as-dependencies': _importsAsDependencies.default,
|
|
97
|
+
'informative-docs': _informativeDocs.default,
|
|
98
|
+
'lines-before-block': _linesBeforeBlock.default,
|
|
99
|
+
'match-description': _matchDescription.default,
|
|
100
|
+
'match-name': _matchName.default,
|
|
101
|
+
'multiline-blocks': _multilineBlocks.default,
|
|
102
|
+
'no-bad-blocks': _noBadBlocks.default,
|
|
103
|
+
'no-blank-block-descriptions': _noBlankBlockDescriptions.default,
|
|
104
|
+
'no-blank-blocks': _noBlankBlocks.default,
|
|
105
|
+
'no-defaults': _noDefaults.default,
|
|
106
|
+
'no-missing-syntax': _noMissingSyntax.default,
|
|
107
|
+
'no-multi-asterisks': _noMultiAsterisks.default,
|
|
108
|
+
'no-restricted-syntax': _noRestrictedSyntax.default,
|
|
109
|
+
'no-types': _noTypes.default,
|
|
110
|
+
'no-undefined-types': _noUndefinedTypes.default,
|
|
111
|
+
'require-asterisk-prefix': _requireAsteriskPrefix.default,
|
|
112
|
+
'require-description': _requireDescription.default,
|
|
113
|
+
'require-description-complete-sentence': _requireDescriptionCompleteSentence.default,
|
|
114
|
+
'require-example': _requireExample.default,
|
|
115
|
+
'require-file-overview': _requireFileOverview.default,
|
|
116
|
+
'require-hyphen-before-param-description': _requireHyphenBeforeParamDescription.default,
|
|
117
|
+
'require-jsdoc': _requireJsdoc.default,
|
|
118
|
+
'require-param': _requireParam.default,
|
|
119
|
+
'require-param-description': _requireParamDescription.default,
|
|
120
|
+
'require-param-name': _requireParamName.default,
|
|
121
|
+
'require-param-type': _requireParamType.default,
|
|
122
|
+
'require-property': _requireProperty.default,
|
|
123
|
+
'require-property-description': _requirePropertyDescription.default,
|
|
124
|
+
'require-property-name': _requirePropertyName.default,
|
|
125
|
+
'require-property-type': _requirePropertyType.default,
|
|
126
|
+
'require-returns': _requireReturns.default,
|
|
127
|
+
'require-returns-check': _requireReturnsCheck.default,
|
|
128
|
+
'require-returns-description': _requireReturnsDescription.default,
|
|
129
|
+
'require-returns-type': _requireReturnsType.default,
|
|
130
|
+
'require-template': _requireTemplate.default,
|
|
131
|
+
'require-throws': _requireThrows.default,
|
|
132
|
+
'require-yields': _requireYields.default,
|
|
133
|
+
'require-yields-check': _requireYieldsCheck.default,
|
|
134
|
+
'sort-tags': _sortTags.default,
|
|
135
|
+
'tag-lines': _tagLines.default,
|
|
136
|
+
'text-escaping': _textEscaping.default,
|
|
137
|
+
'valid-types': _validTypes.default
|
|
138
|
+
}
|
|
132
139
|
};
|
|
140
|
+
|
|
133
141
|
/**
|
|
134
|
-
* @param {"warn"|"error"} warnOrError
|
|
135
|
-
* @param {string} [flatName]
|
|
136
|
-
* @returns {import('eslint').Linter.FlatConfig}
|
|
137
|
-
*/
|
|
142
|
+
* @param {"warn"|"error"} warnOrError
|
|
143
|
+
* @param {string} [flatName]
|
|
144
|
+
* @returns {import('eslint').Linter.FlatConfig}
|
|
145
|
+
*/
|
|
138
146
|
const createRecommendedRuleset = (warnOrError, flatName) => {
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
147
|
+
return {
|
|
148
|
+
...(flatName ? {
|
|
149
|
+
name: 'jsdoc/' + flatName
|
|
150
|
+
} : {}),
|
|
151
|
+
// @ts-expect-error Ok
|
|
152
|
+
plugins: flatName ? {
|
|
153
|
+
jsdoc: index
|
|
154
|
+
} : ['jsdoc'],
|
|
155
|
+
rules: {
|
|
156
|
+
'jsdoc/check-access': warnOrError,
|
|
157
|
+
'jsdoc/check-alignment': warnOrError,
|
|
158
|
+
'jsdoc/check-examples': 'off',
|
|
159
|
+
'jsdoc/check-indentation': 'off',
|
|
160
|
+
'jsdoc/check-line-alignment': 'off',
|
|
161
|
+
'jsdoc/check-param-names': warnOrError,
|
|
162
|
+
'jsdoc/check-property-names': warnOrError,
|
|
163
|
+
'jsdoc/check-syntax': 'off',
|
|
164
|
+
'jsdoc/check-tag-names': warnOrError,
|
|
165
|
+
'jsdoc/check-template-names': 'off',
|
|
166
|
+
'jsdoc/check-types': warnOrError,
|
|
167
|
+
'jsdoc/check-values': warnOrError,
|
|
168
|
+
'jsdoc/convert-to-jsdoc-comments': 'off',
|
|
169
|
+
'jsdoc/empty-tags': warnOrError,
|
|
170
|
+
'jsdoc/implements-on-classes': warnOrError,
|
|
171
|
+
'jsdoc/imports-as-dependencies': 'off',
|
|
172
|
+
'jsdoc/informative-docs': 'off',
|
|
173
|
+
'jsdoc/lines-before-block': 'off',
|
|
174
|
+
'jsdoc/match-description': 'off',
|
|
175
|
+
'jsdoc/match-name': 'off',
|
|
176
|
+
'jsdoc/multiline-blocks': warnOrError,
|
|
177
|
+
'jsdoc/no-bad-blocks': 'off',
|
|
178
|
+
'jsdoc/no-blank-block-descriptions': 'off',
|
|
179
|
+
'jsdoc/no-blank-blocks': 'off',
|
|
180
|
+
'jsdoc/no-defaults': warnOrError,
|
|
181
|
+
'jsdoc/no-missing-syntax': 'off',
|
|
182
|
+
'jsdoc/no-multi-asterisks': warnOrError,
|
|
183
|
+
'jsdoc/no-restricted-syntax': 'off',
|
|
184
|
+
'jsdoc/no-types': 'off',
|
|
185
|
+
'jsdoc/no-undefined-types': warnOrError,
|
|
186
|
+
'jsdoc/require-asterisk-prefix': 'off',
|
|
187
|
+
'jsdoc/require-description': 'off',
|
|
188
|
+
'jsdoc/require-description-complete-sentence': 'off',
|
|
189
|
+
'jsdoc/require-example': 'off',
|
|
190
|
+
'jsdoc/require-file-overview': 'off',
|
|
191
|
+
'jsdoc/require-hyphen-before-param-description': 'off',
|
|
192
|
+
'jsdoc/require-jsdoc': warnOrError,
|
|
193
|
+
'jsdoc/require-param': warnOrError,
|
|
194
|
+
'jsdoc/require-param-description': warnOrError,
|
|
195
|
+
'jsdoc/require-param-name': warnOrError,
|
|
196
|
+
'jsdoc/require-param-type': warnOrError,
|
|
197
|
+
'jsdoc/require-property': warnOrError,
|
|
198
|
+
'jsdoc/require-property-description': warnOrError,
|
|
199
|
+
'jsdoc/require-property-name': warnOrError,
|
|
200
|
+
'jsdoc/require-property-type': warnOrError,
|
|
201
|
+
'jsdoc/require-returns': warnOrError,
|
|
202
|
+
'jsdoc/require-returns-check': warnOrError,
|
|
203
|
+
'jsdoc/require-returns-description': warnOrError,
|
|
204
|
+
'jsdoc/require-returns-type': warnOrError,
|
|
205
|
+
'jsdoc/require-template': 'off',
|
|
206
|
+
'jsdoc/require-throws': 'off',
|
|
207
|
+
'jsdoc/require-yields': warnOrError,
|
|
208
|
+
'jsdoc/require-yields-check': warnOrError,
|
|
209
|
+
'jsdoc/sort-tags': 'off',
|
|
210
|
+
'jsdoc/tag-lines': warnOrError,
|
|
211
|
+
'jsdoc/text-escaping': 'off',
|
|
212
|
+
'jsdoc/valid-types': warnOrError
|
|
213
|
+
}
|
|
214
|
+
};
|
|
202
215
|
};
|
|
216
|
+
|
|
203
217
|
/**
|
|
204
|
-
* @param {"warn"|"error"} warnOrError
|
|
205
|
-
* @param {string} [flatName]
|
|
206
|
-
* @returns {import('eslint').Linter.FlatConfig}
|
|
207
|
-
*/
|
|
218
|
+
* @param {"warn"|"error"} warnOrError
|
|
219
|
+
* @param {string} [flatName]
|
|
220
|
+
* @returns {import('eslint').Linter.FlatConfig}
|
|
221
|
+
*/
|
|
208
222
|
const createRecommendedTypeScriptRuleset = (warnOrError, flatName) => {
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
223
|
+
const ruleset = createRecommendedRuleset(warnOrError, flatName);
|
|
224
|
+
return {
|
|
225
|
+
...ruleset,
|
|
226
|
+
rules: {
|
|
227
|
+
...ruleset.rules,
|
|
228
|
+
/* eslint-disable @stylistic/indent -- Extra indent to avoid use by auto-rule-editing */
|
|
229
|
+
'jsdoc/check-tag-names': [warnOrError, {
|
|
230
|
+
typed: true
|
|
231
|
+
}],
|
|
232
|
+
'jsdoc/no-types': warnOrError,
|
|
233
|
+
'jsdoc/no-undefined-types': 'off',
|
|
234
|
+
'jsdoc/require-param-type': 'off',
|
|
235
|
+
'jsdoc/require-property-type': 'off',
|
|
236
|
+
'jsdoc/require-returns-type': 'off'
|
|
237
|
+
/* eslint-enable @stylistic/indent */
|
|
238
|
+
}
|
|
239
|
+
};
|
|
222
240
|
};
|
|
241
|
+
|
|
223
242
|
/**
|
|
224
|
-
* @param {"warn"|"error"} warnOrError
|
|
225
|
-
* @param {string} [flatName]
|
|
226
|
-
* @returns {import('eslint').Linter.FlatConfig}
|
|
227
|
-
*/
|
|
243
|
+
* @param {"warn"|"error"} warnOrError
|
|
244
|
+
* @param {string} [flatName]
|
|
245
|
+
* @returns {import('eslint').Linter.FlatConfig}
|
|
246
|
+
*/
|
|
228
247
|
const createRecommendedTypeScriptFlavorRuleset = (warnOrError, flatName) => {
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
248
|
+
const ruleset = createRecommendedRuleset(warnOrError, flatName);
|
|
249
|
+
return {
|
|
250
|
+
...ruleset,
|
|
251
|
+
rules: {
|
|
252
|
+
...ruleset.rules,
|
|
253
|
+
/* eslint-disable @stylistic/indent -- Extra indent to avoid use by auto-rule-editing */
|
|
254
|
+
'jsdoc/no-undefined-types': 'off'
|
|
255
|
+
/* eslint-enable @stylistic/indent */
|
|
256
|
+
}
|
|
257
|
+
};
|
|
237
258
|
};
|
|
259
|
+
|
|
238
260
|
/**
|
|
239
|
-
* @param {(string | unknown[])[]} ruleNames
|
|
240
|
-
*/
|
|
241
|
-
const createStandaloneRulesetFactory =
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
261
|
+
* @param {(string | unknown[])[]} ruleNames
|
|
262
|
+
*/
|
|
263
|
+
const createStandaloneRulesetFactory = ruleNames => {
|
|
264
|
+
/**
|
|
265
|
+
* @param {"warn"|"error"} warnOrError
|
|
266
|
+
* @param {string} [flatName]
|
|
267
|
+
* @returns {import('eslint').Linter.FlatConfig}
|
|
268
|
+
*/
|
|
269
|
+
return (warnOrError, flatName) => {
|
|
270
|
+
return {
|
|
271
|
+
name: 'jsdoc/' + flatName,
|
|
272
|
+
plugins: {
|
|
273
|
+
jsdoc: index
|
|
274
|
+
},
|
|
275
|
+
rules: Object.fromEntries(ruleNames.map(ruleName => {
|
|
276
|
+
return typeof ruleName === 'string' ? [ruleName, warnOrError] : [ruleName[0], [warnOrError, ...ruleName.slice(1)]];
|
|
277
|
+
}))
|
|
278
|
+
};
|
|
279
|
+
};
|
|
256
280
|
};
|
|
257
|
-
const contentsRules = [
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
"jsdoc/no-blank-block-descriptions",
|
|
261
|
-
"jsdoc/no-blank-blocks",
|
|
262
|
-
["jsdoc/text-escaping", { escapeHTML: true }]
|
|
263
|
-
];
|
|
281
|
+
const contentsRules = ['jsdoc/informative-docs', 'jsdoc/match-description', 'jsdoc/no-blank-block-descriptions', 'jsdoc/no-blank-blocks', ['jsdoc/text-escaping', {
|
|
282
|
+
escapeHTML: true
|
|
283
|
+
}]];
|
|
264
284
|
const createContentsTypescriptRuleset = createStandaloneRulesetFactory(contentsRules);
|
|
265
285
|
const createContentsTypescriptFlavorRuleset = createStandaloneRulesetFactory(contentsRules);
|
|
266
|
-
const logicalRules = [
|
|
267
|
-
"jsdoc/check-access",
|
|
268
|
-
"jsdoc/check-param-names",
|
|
269
|
-
"jsdoc/check-property-names",
|
|
270
|
-
"jsdoc/check-syntax",
|
|
271
|
-
"jsdoc/check-tag-names",
|
|
272
|
-
"jsdoc/check-template-names",
|
|
273
|
-
"jsdoc/check-types",
|
|
274
|
-
"jsdoc/check-values",
|
|
275
|
-
"jsdoc/empty-tags",
|
|
276
|
-
"jsdoc/implements-on-classes",
|
|
277
|
-
"jsdoc/require-returns-check",
|
|
278
|
-
"jsdoc/require-yields-check",
|
|
279
|
-
"jsdoc/no-bad-blocks",
|
|
280
|
-
"jsdoc/no-defaults",
|
|
281
|
-
"jsdoc/no-types",
|
|
282
|
-
"jsdoc/no-undefined-types",
|
|
283
|
-
"jsdoc/valid-types"
|
|
284
|
-
];
|
|
286
|
+
const logicalRules = ['jsdoc/check-access', 'jsdoc/check-param-names', 'jsdoc/check-property-names', 'jsdoc/check-syntax', 'jsdoc/check-tag-names', 'jsdoc/check-template-names', 'jsdoc/check-types', 'jsdoc/check-values', 'jsdoc/empty-tags', 'jsdoc/implements-on-classes', 'jsdoc/require-returns-check', 'jsdoc/require-yields-check', 'jsdoc/no-bad-blocks', 'jsdoc/no-defaults', 'jsdoc/no-types', 'jsdoc/no-undefined-types', 'jsdoc/valid-types'];
|
|
285
287
|
const createLogicalTypescriptRuleset = createStandaloneRulesetFactory(logicalRules);
|
|
286
288
|
const createLogicalTypescriptFlavorRuleset = createStandaloneRulesetFactory(logicalRules);
|
|
287
|
-
const requirementsRules = [
|
|
288
|
-
"jsdoc/require-example",
|
|
289
|
-
"jsdoc/require-jsdoc",
|
|
290
|
-
"jsdoc/require-param",
|
|
291
|
-
"jsdoc/require-param-description",
|
|
292
|
-
"jsdoc/require-param-name",
|
|
293
|
-
"jsdoc/require-property",
|
|
294
|
-
"jsdoc/require-property-description",
|
|
295
|
-
"jsdoc/require-property-name",
|
|
296
|
-
"jsdoc/require-returns",
|
|
297
|
-
"jsdoc/require-returns-description",
|
|
298
|
-
"jsdoc/require-yields"
|
|
299
|
-
];
|
|
289
|
+
const requirementsRules = ['jsdoc/require-example', 'jsdoc/require-jsdoc', 'jsdoc/require-param', 'jsdoc/require-param-description', 'jsdoc/require-param-name', 'jsdoc/require-property', 'jsdoc/require-property-description', 'jsdoc/require-property-name', 'jsdoc/require-returns', 'jsdoc/require-returns-description', 'jsdoc/require-yields'];
|
|
300
290
|
const createRequirementsTypeScriptRuleset = createStandaloneRulesetFactory(requirementsRules);
|
|
301
|
-
const createRequirementsTypeScriptFlavorRuleset = createStandaloneRulesetFactory([
|
|
302
|
-
|
|
303
|
-
"jsdoc/require-param-type",
|
|
304
|
-
"jsdoc/require-property-type",
|
|
305
|
-
"jsdoc/require-returns-type",
|
|
306
|
-
"jsdoc/require-template"
|
|
307
|
-
]);
|
|
308
|
-
const stylisticRules = [
|
|
309
|
-
"jsdoc/check-alignment",
|
|
310
|
-
"jsdoc/check-line-alignment",
|
|
311
|
-
"jsdoc/lines-before-block",
|
|
312
|
-
"jsdoc/multiline-blocks",
|
|
313
|
-
"jsdoc/no-multi-asterisks",
|
|
314
|
-
"jsdoc/require-asterisk-prefix",
|
|
315
|
-
["jsdoc/require-hyphen-before-param-description", "never"],
|
|
316
|
-
"jsdoc/tag-lines"
|
|
317
|
-
];
|
|
291
|
+
const createRequirementsTypeScriptFlavorRuleset = createStandaloneRulesetFactory([...requirementsRules, 'jsdoc/require-param-type', 'jsdoc/require-property-type', 'jsdoc/require-returns-type', 'jsdoc/require-template']);
|
|
292
|
+
const stylisticRules = ['jsdoc/check-alignment', 'jsdoc/check-line-alignment', 'jsdoc/lines-before-block', 'jsdoc/multiline-blocks', 'jsdoc/no-multi-asterisks', 'jsdoc/require-asterisk-prefix', ['jsdoc/require-hyphen-before-param-description', 'never'], 'jsdoc/tag-lines'];
|
|
318
293
|
const createStylisticTypeScriptRuleset = createStandaloneRulesetFactory(stylisticRules);
|
|
319
294
|
const createStylisticTypeScriptFlavorRuleset = createStandaloneRulesetFactory(stylisticRules);
|
|
295
|
+
|
|
320
296
|
/* c8 ignore next 3 -- TS */
|
|
321
|
-
if (!index.configs)
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
index.configs
|
|
325
|
-
index.configs[
|
|
326
|
-
index.configs[
|
|
327
|
-
index.configs[
|
|
328
|
-
index.configs[
|
|
329
|
-
index.configs[
|
|
330
|
-
index.configs[
|
|
331
|
-
index.configs[
|
|
332
|
-
index.configs[
|
|
333
|
-
index.configs[
|
|
334
|
-
index.configs[
|
|
335
|
-
index.configs[
|
|
336
|
-
index.configs[
|
|
337
|
-
index.configs[
|
|
338
|
-
index.configs[
|
|
339
|
-
index.configs[
|
|
340
|
-
index.configs[
|
|
341
|
-
index.configs[
|
|
342
|
-
index.configs[
|
|
343
|
-
index.configs[
|
|
344
|
-
index.configs[
|
|
345
|
-
index.configs[
|
|
346
|
-
index.configs[
|
|
347
|
-
index.configs[
|
|
348
|
-
index.configs[
|
|
349
|
-
index.configs[
|
|
350
|
-
index.configs
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
297
|
+
if (!index.configs) {
|
|
298
|
+
throw new Error('TypeScript guard');
|
|
299
|
+
}
|
|
300
|
+
index.configs.recommended = createRecommendedRuleset('warn');
|
|
301
|
+
index.configs['recommended-error'] = createRecommendedRuleset('error');
|
|
302
|
+
index.configs['recommended-typescript'] = createRecommendedTypeScriptRuleset('warn');
|
|
303
|
+
index.configs['recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error');
|
|
304
|
+
index.configs['recommended-typescript-flavor'] = createRecommendedTypeScriptFlavorRuleset('warn');
|
|
305
|
+
index.configs['recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error');
|
|
306
|
+
index.configs['flat/recommended'] = createRecommendedRuleset('warn', 'flat/recommended');
|
|
307
|
+
index.configs['flat/recommended-error'] = createRecommendedRuleset('error', 'flat/recommended-error');
|
|
308
|
+
index.configs['flat/recommended-typescript'] = createRecommendedTypeScriptRuleset('warn', 'flat/recommended-typescript');
|
|
309
|
+
index.configs['flat/recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error', 'flat/recommended-typescript-error');
|
|
310
|
+
index.configs['flat/recommended-typescript-flavor'] = createRecommendedTypeScriptFlavorRuleset('warn', 'flat/recommended-typescript-flavor');
|
|
311
|
+
index.configs['flat/recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error', 'flat/recommended-typescript-flavor-error');
|
|
312
|
+
index.configs['flat/contents-typescript'] = createContentsTypescriptRuleset('warn', 'flat/contents-typescript');
|
|
313
|
+
index.configs['flat/contents-typescript-error'] = createContentsTypescriptRuleset('error', 'flat/contents-typescript-error');
|
|
314
|
+
index.configs['flat/contents-typescript-flavor'] = createContentsTypescriptFlavorRuleset('warn', 'flat/contents-typescript-flavor');
|
|
315
|
+
index.configs['flat/contents-typescript-flavor-error'] = createContentsTypescriptFlavorRuleset('error', 'flat/contents-typescript-error-flavor');
|
|
316
|
+
index.configs['flat/logical-typescript'] = createLogicalTypescriptRuleset('warn', 'flat/logical-typescript');
|
|
317
|
+
index.configs['flat/logical-typescript-error'] = createLogicalTypescriptRuleset('error', 'flat/logical-typescript-error');
|
|
318
|
+
index.configs['flat/logical-typescript-flavor'] = createLogicalTypescriptFlavorRuleset('warn', 'flat/logical-typescript-flavor');
|
|
319
|
+
index.configs['flat/logical-typescript-flavor-error'] = createLogicalTypescriptFlavorRuleset('error', 'flat/logical-typescript-error-flavor');
|
|
320
|
+
index.configs['flat/requirements-typescript'] = createRequirementsTypeScriptRuleset('warn', 'flat/requirements-typescript');
|
|
321
|
+
index.configs['flat/requirements-typescript-error'] = createRequirementsTypeScriptRuleset('error', 'flat/requirements-typescript-error');
|
|
322
|
+
index.configs['flat/requirements-typescript-flavor'] = createRequirementsTypeScriptFlavorRuleset('warn', 'flat/requirements-typescript-flavor');
|
|
323
|
+
index.configs['flat/requirements-typescript-flavor-error'] = createRequirementsTypeScriptFlavorRuleset('error', 'flat/requirements-typescript-error-flavor');
|
|
324
|
+
index.configs['flat/stylistic-typescript'] = createStylisticTypeScriptRuleset('warn', 'flat/stylistic-typescript');
|
|
325
|
+
index.configs['flat/stylistic-typescript-error'] = createStylisticTypeScriptRuleset('error', 'flat/stylistic-typescript-error');
|
|
326
|
+
index.configs['flat/stylistic-typescript-flavor'] = createStylisticTypeScriptFlavorRuleset('warn', 'flat/stylistic-typescript-flavor');
|
|
327
|
+
index.configs['flat/stylistic-typescript-flavor-error'] = createStylisticTypeScriptFlavorRuleset('error', 'flat/stylistic-typescript-error-flavor');
|
|
328
|
+
index.configs.examples = /** @type {import('eslint').Linter.FlatConfig[]} */[{
|
|
329
|
+
files: ['**/*.js'],
|
|
330
|
+
name: 'jsdoc/examples/processor',
|
|
331
|
+
plugins: {
|
|
332
|
+
examples: (0, _getJsdocProcessorPlugin.getJsdocProcessorPlugin)()
|
|
333
|
+
},
|
|
334
|
+
processor: 'examples/examples'
|
|
355
335
|
}, {
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
336
|
+
files: ['**/*.md/*.js'],
|
|
337
|
+
name: 'jsdoc/examples/rules',
|
|
338
|
+
rules: {
|
|
339
|
+
// "always" newline rule at end unlikely in sample code
|
|
340
|
+
'eol-last': 0,
|
|
341
|
+
// Wouldn't generally expect example paths to resolve relative to JS file
|
|
342
|
+
'import/no-unresolved': 0,
|
|
343
|
+
// Snippets likely too short to always include import/export info
|
|
344
|
+
'import/unambiguous': 0,
|
|
345
|
+
'jsdoc/require-file-overview': 0,
|
|
346
|
+
// The end of a multiline comment would end the comment the example is in.
|
|
347
|
+
'jsdoc/require-jsdoc': 0,
|
|
348
|
+
// Unlikely to have inadvertent debugging within examples
|
|
349
|
+
'no-console': 0,
|
|
350
|
+
// Often wish to start `@example` code after newline; also may use
|
|
351
|
+
// empty lines for spacing
|
|
352
|
+
'no-multiple-empty-lines': 0,
|
|
353
|
+
// Many variables in examples will be `undefined`
|
|
354
|
+
'no-undef': 0,
|
|
355
|
+
// Common to define variables for clarity without always using them
|
|
356
|
+
'no-unused-vars': 0,
|
|
357
|
+
// See import/no-unresolved
|
|
358
|
+
'node/no-missing-import': 0,
|
|
359
|
+
'node/no-missing-require': 0,
|
|
360
|
+
// Can generally look nicer to pad a little even if code imposes more stringency
|
|
361
|
+
'padded-blocks': 0
|
|
362
|
+
}
|
|
372
363
|
}];
|
|
373
|
-
index.configs[
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
364
|
+
index.configs['default-expressions'] = /** @type {import('eslint').Linter.FlatConfig[]} */[{
|
|
365
|
+
files: ['**/*.js'],
|
|
366
|
+
name: 'jsdoc/default-expressions/processor',
|
|
367
|
+
plugins: {
|
|
368
|
+
examples: (0, _getJsdocProcessorPlugin.getJsdocProcessorPlugin)({
|
|
369
|
+
checkDefaults: true,
|
|
370
|
+
checkParams: true,
|
|
371
|
+
checkProperties: true
|
|
372
|
+
})
|
|
373
|
+
},
|
|
374
|
+
processor: 'examples/examples'
|
|
382
375
|
}, {
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
quotes: ["error", "double"],
|
|
396
|
-
semi: ["error", "never"],
|
|
397
|
-
strict: 0
|
|
398
|
-
}
|
|
376
|
+
files: ['**/*.jsdoc-defaults', '**/*.jsdoc-params', '**/*.jsdoc-properties'],
|
|
377
|
+
name: 'jsdoc/default-expressions/rules',
|
|
378
|
+
rules: {
|
|
379
|
+
...index.configs.examples[1].rules,
|
|
380
|
+
'chai-friendly/no-unused-expressions': 0,
|
|
381
|
+
'no-empty-function': 0,
|
|
382
|
+
'no-new': 0,
|
|
383
|
+
'no-unused-expressions': 0,
|
|
384
|
+
quotes: ['error', 'double'],
|
|
385
|
+
semi: ['error', 'never'],
|
|
386
|
+
strict: 0
|
|
387
|
+
}
|
|
399
388
|
}];
|
|
400
|
-
index.configs[
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
var src_default = index;
|
|
423
|
-
|
|
424
|
-
//#endregion
|
|
425
|
-
exports.default = src_default;
|
|
389
|
+
index.configs['examples-and-default-expressions'] = /** @type {import('eslint').Linter.FlatConfig[]} */[{
|
|
390
|
+
name: 'jsdoc/examples-and-default-expressions',
|
|
391
|
+
plugins: {
|
|
392
|
+
examples: (0, _getJsdocProcessorPlugin.getJsdocProcessorPlugin)({
|
|
393
|
+
checkDefaults: true,
|
|
394
|
+
checkParams: true,
|
|
395
|
+
checkProperties: true
|
|
396
|
+
})
|
|
397
|
+
}
|
|
398
|
+
}, ...index.configs.examples.map(config => {
|
|
399
|
+
return {
|
|
400
|
+
...config,
|
|
401
|
+
plugins: {}
|
|
402
|
+
};
|
|
403
|
+
}), ...index.configs['default-expressions'].map(config => {
|
|
404
|
+
return {
|
|
405
|
+
...config,
|
|
406
|
+
plugins: {}
|
|
407
|
+
};
|
|
408
|
+
})];
|
|
409
|
+
var _default = exports.default = index;
|
|
410
|
+
module.exports = exports.default;
|
|
426
411
|
//# sourceMappingURL=index.cjs.map
|