@depup/eslint-plugin-jsdoc 62.8.0-depup.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +24 -0
- package/README.md +33 -0
- package/changes.json +18 -0
- package/dist/WarnSettings.cjs +38 -0
- package/dist/WarnSettings.cjs.map +1 -0
- package/dist/WarnSettings.d.ts +17 -0
- package/dist/alignTransform.cjs +402 -0
- package/dist/alignTransform.cjs.map +1 -0
- package/dist/alignTransform.d.ts +34 -0
- package/dist/buildForbidRuleDefinition.cjs +101 -0
- package/dist/buildForbidRuleDefinition.cjs.map +1 -0
- package/dist/buildForbidRuleDefinition.d.ts +15 -0
- package/dist/buildRejectOrPreferRuleDefinition.cjs +352 -0
- package/dist/buildRejectOrPreferRuleDefinition.cjs.map +1 -0
- package/dist/buildRejectOrPreferRuleDefinition.d.ts +9 -0
- package/dist/cjs/WarnSettings.d.ts +16 -0
- package/dist/cjs/alignTransform.d.ts +33 -0
- package/dist/cjs/buildForbidRuleDefinition.d.ts +14 -0
- package/dist/cjs/buildRejectOrPreferRuleDefinition.d.ts +8 -0
- package/dist/cjs/defaultTagOrder.d.ts +4 -0
- package/dist/cjs/exportParser.d.ts +40 -0
- package/dist/cjs/getDefaultTagStructureForMode.d.ts +10 -0
- package/dist/cjs/getJsdocProcessorPlugin.d.cts +5 -0
- package/dist/cjs/getJsdocProcessorPlugin.d.ts +66 -0
- package/dist/cjs/index-cjs.d.ts +23 -0
- package/dist/cjs/index.cjs.d.cts +2 -0
- package/dist/cjs/iterateJsdoc.d.cts +7 -0
- package/dist/cjs/iterateJsdoc.d.ts +495 -0
- package/dist/cjs/jsdocUtils.d.ts +493 -0
- package/dist/cjs/rules/checkAccess.d.ts +2 -0
- package/dist/cjs/rules/checkAlignment.d.ts +2 -0
- package/dist/cjs/rules/checkExamples.d.ts +3 -0
- package/dist/cjs/rules/checkIndentation.d.ts +2 -0
- package/dist/cjs/rules/checkLineAlignment.d.ts +9 -0
- package/dist/cjs/rules/checkParamNames.d.ts +2 -0
- package/dist/cjs/rules/checkPropertyNames.d.ts +2 -0
- package/dist/cjs/rules/checkSyntax.d.ts +2 -0
- package/dist/cjs/rules/checkTagNames.d.ts +2 -0
- package/dist/cjs/rules/checkTemplateNames.d.ts +2 -0
- package/dist/cjs/rules/checkTypes.d.ts +7 -0
- package/dist/cjs/rules/checkValues.d.ts +2 -0
- package/dist/cjs/rules/convertToJsdocComments.d.ts +266 -0
- package/dist/cjs/rules/emptyTags.d.ts +2 -0
- package/dist/cjs/rules/escapeInlineTags.d.ts +2 -0
- package/dist/cjs/rules/implementsOnClasses.d.ts +2 -0
- package/dist/cjs/rules/importsAsDependencies.d.ts +2 -0
- package/dist/cjs/rules/informativeDocs.d.ts +2 -0
- package/dist/cjs/rules/linesBeforeBlock.d.ts +2 -0
- package/dist/cjs/rules/matchDescription.d.ts +2 -0
- package/dist/cjs/rules/matchName.d.ts +2 -0
- package/dist/cjs/rules/multilineBlocks.d.ts +2 -0
- package/dist/cjs/rules/noBadBlocks.d.ts +2 -0
- package/dist/cjs/rules/noBlankBlockDescriptions.d.ts +2 -0
- package/dist/cjs/rules/noBlankBlocks.d.ts +2 -0
- package/dist/cjs/rules/noDefaults.d.ts +2 -0
- package/dist/cjs/rules/noMissingSyntax.d.ts +9 -0
- package/dist/cjs/rules/noMultiAsterisks.d.ts +2 -0
- package/dist/cjs/rules/noRestrictedSyntax.d.ts +2 -0
- package/dist/cjs/rules/noTypes.d.ts +2 -0
- package/dist/cjs/rules/noUndefinedTypes.d.ts +2 -0
- package/dist/cjs/rules/preferImportTag.d.ts +2 -0
- package/dist/cjs/rules/requireAsteriskPrefix.d.ts +2 -0
- package/dist/cjs/rules/requireDescription.d.ts +2 -0
- package/dist/cjs/rules/requireDescriptionCompleteSentence.d.ts +2 -0
- package/dist/cjs/rules/requireExample.d.ts +2 -0
- package/dist/cjs/rules/requireFileOverview.d.ts +2 -0
- package/dist/cjs/rules/requireHyphenBeforeParamDescription.d.ts +2 -0
- package/dist/cjs/rules/requireJsdoc.d.ts +24 -0
- package/dist/cjs/rules/requireParam.d.ts +3 -0
- package/dist/cjs/rules/requireParamDescription.d.ts +2 -0
- package/dist/cjs/rules/requireParamName.d.ts +2 -0
- package/dist/cjs/rules/requireParamType.d.ts +2 -0
- package/dist/cjs/rules/requireProperty.d.ts +2 -0
- package/dist/cjs/rules/requirePropertyDescription.d.ts +2 -0
- package/dist/cjs/rules/requirePropertyName.d.ts +2 -0
- package/dist/cjs/rules/requirePropertyType.d.ts +2 -0
- package/dist/cjs/rules/requireRejects.d.ts +2 -0
- package/dist/cjs/rules/requireReturns.d.ts +2 -0
- package/dist/cjs/rules/requireReturnsCheck.d.ts +2 -0
- package/dist/cjs/rules/requireReturnsDescription.d.ts +2 -0
- package/dist/cjs/rules/requireReturnsType.d.ts +2 -0
- package/dist/cjs/rules/requireTags.d.ts +2 -0
- package/dist/cjs/rules/requireTemplate.d.ts +2 -0
- package/dist/cjs/rules/requireThrows.d.ts +2 -0
- package/dist/cjs/rules/requireYields.d.ts +2 -0
- package/dist/cjs/rules/requireYieldsCheck.d.ts +2 -0
- package/dist/cjs/rules/sortTags.d.ts +2 -0
- package/dist/cjs/rules/tagLines.d.ts +2 -0
- package/dist/cjs/rules/textEscaping.d.ts +2 -0
- package/dist/cjs/rules/tsMethodSignatureStyle.d.ts +2 -0
- package/dist/cjs/rules/tsNoEmptyObjectType.d.ts +2 -0
- package/dist/cjs/rules/tsNoUnnecessaryTemplateExpression.d.ts +2 -0
- package/dist/cjs/rules/tsPreferFunctionType.d.ts +2 -0
- package/dist/cjs/rules/typeFormatting.d.ts +2 -0
- package/dist/cjs/rules/validTypes.d.ts +2 -0
- package/dist/cjs/tagNames.d.ts +15 -0
- package/dist/cjs/utils/hasReturnValue.d.ts +19 -0
- package/dist/defaultTagOrder.cjs +46 -0
- package/dist/defaultTagOrder.cjs.map +1 -0
- package/dist/defaultTagOrder.d.ts +5 -0
- package/dist/exportParser.cjs +732 -0
- package/dist/exportParser.cjs.map +1 -0
- package/dist/exportParser.d.ts +41 -0
- package/dist/generateDocs.cjs +342 -0
- package/dist/generateDocs.cjs.map +1 -0
- package/dist/generateOptions.cjs +62 -0
- package/dist/generateOptions.cjs.map +1 -0
- package/dist/generateRule.cjs +248 -0
- package/dist/generateRule.cjs.map +1 -0
- package/dist/generateRuleTypes.cjs +24 -0
- package/dist/generateRuleTypes.cjs.map +1 -0
- package/dist/getDefaultTagStructureForMode.cjs +289 -0
- package/dist/getDefaultTagStructureForMode.cjs.map +1 -0
- package/dist/getDefaultTagStructureForMode.d.ts +11 -0
- package/dist/getJsdocProcessorPlugin.cjs +587 -0
- package/dist/getJsdocProcessorPlugin.cjs.map +1 -0
- package/dist/getJsdocProcessorPlugin.cts +5 -0
- package/dist/getJsdocProcessorPlugin.d.ts +67 -0
- package/dist/index-cjs.cjs +595 -0
- package/dist/index-cjs.cjs.map +1 -0
- package/dist/index-cjs.d.ts +24 -0
- package/dist/index-esm.cjs +162 -0
- package/dist/index-esm.cjs.map +1 -0
- package/dist/index-esm.d.ts +72 -0
- package/dist/index.cjs +743 -0
- package/dist/index.cjs.cts +3 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.ts +93 -0
- package/dist/iterateJsdoc.cjs +2150 -0
- package/dist/iterateJsdoc.cjs.map +1 -0
- package/dist/iterateJsdoc.cts +7 -0
- package/dist/iterateJsdoc.d.ts +496 -0
- package/dist/jsdocUtils.cjs +1725 -0
- package/dist/jsdocUtils.cjs.map +1 -0
- package/dist/jsdocUtils.d.ts +494 -0
- package/dist/rules/checkAccess.cjs +40 -0
- package/dist/rules/checkAccess.cjs.map +1 -0
- package/dist/rules/checkAccess.d.ts +3 -0
- package/dist/rules/checkAlignment.cjs +78 -0
- package/dist/rules/checkAlignment.cjs.map +1 -0
- package/dist/rules/checkAlignment.d.ts +3 -0
- package/dist/rules/checkExamples.cjs +521 -0
- package/dist/rules/checkExamples.cjs.map +1 -0
- package/dist/rules/checkExamples.d.ts +4 -0
- package/dist/rules/checkIndentation.cjs +170 -0
- package/dist/rules/checkIndentation.cjs.map +1 -0
- package/dist/rules/checkIndentation.d.ts +3 -0
- package/dist/rules/checkLineAlignment.cjs +398 -0
- package/dist/rules/checkLineAlignment.cjs.map +1 -0
- package/dist/rules/checkLineAlignment.d.ts +10 -0
- package/dist/rules/checkParamNames.cjs +407 -0
- package/dist/rules/checkParamNames.cjs.map +1 -0
- package/dist/rules/checkParamNames.d.ts +3 -0
- package/dist/rules/checkPropertyNames.cjs +135 -0
- package/dist/rules/checkPropertyNames.cjs.map +1 -0
- package/dist/rules/checkPropertyNames.d.ts +3 -0
- package/dist/rules/checkSyntax.cjs +38 -0
- package/dist/rules/checkSyntax.cjs.map +1 -0
- package/dist/rules/checkSyntax.d.ts +3 -0
- package/dist/rules/checkTagNames.cjs +312 -0
- package/dist/rules/checkTagNames.cjs.map +1 -0
- package/dist/rules/checkTagNames.d.ts +3 -0
- package/dist/rules/checkTemplateNames.cjs +185 -0
- package/dist/rules/checkTemplateNames.cjs.map +1 -0
- package/dist/rules/checkTemplateNames.d.ts +3 -0
- package/dist/rules/checkTypes.cjs +111 -0
- package/dist/rules/checkTypes.cjs.map +1 -0
- package/dist/rules/checkTypes.d.ts +8 -0
- package/dist/rules/checkValues.cjs +166 -0
- package/dist/rules/checkValues.cjs.map +1 -0
- package/dist/rules/checkValues.d.ts +3 -0
- package/dist/rules/convertToJsdocComments.cjs +356 -0
- package/dist/rules/convertToJsdocComments.cjs.map +1 -0
- package/dist/rules/convertToJsdocComments.d.ts +267 -0
- package/dist/rules/emptyTags.cjs +85 -0
- package/dist/rules/emptyTags.cjs.map +1 -0
- package/dist/rules/emptyTags.d.ts +3 -0
- package/dist/rules/escapeInlineTags.cjs +149 -0
- package/dist/rules/escapeInlineTags.cjs.map +1 -0
- package/dist/rules/escapeInlineTags.d.ts +3 -0
- package/dist/rules/implementsOnClasses.cjs +74 -0
- package/dist/rules/implementsOnClasses.cjs.map +1 -0
- package/dist/rules/implementsOnClasses.d.ts +3 -0
- package/dist/rules/importsAsDependencies.cjs +104 -0
- package/dist/rules/importsAsDependencies.cjs.map +1 -0
- package/dist/rules/importsAsDependencies.d.ts +3 -0
- package/dist/rules/informativeDocs.cjs +187 -0
- package/dist/rules/informativeDocs.cjs.map +1 -0
- package/dist/rules/informativeDocs.d.ts +3 -0
- package/dist/rules/linesBeforeBlock.cjs +120 -0
- package/dist/rules/linesBeforeBlock.cjs.map +1 -0
- package/dist/rules/linesBeforeBlock.d.ts +3 -0
- package/dist/rules/matchDescription.cjs +356 -0
- package/dist/rules/matchDescription.cjs.map +1 -0
- package/dist/rules/matchDescription.d.ts +3 -0
- package/dist/rules/matchName.cjs +160 -0
- package/dist/rules/matchName.cjs.map +1 -0
- package/dist/rules/matchName.d.ts +3 -0
- package/dist/rules/multilineBlocks.cjs +431 -0
- package/dist/rules/multilineBlocks.cjs.map +1 -0
- package/dist/rules/multilineBlocks.d.ts +3 -0
- package/dist/rules/noBadBlocks.cjs +100 -0
- package/dist/rules/noBadBlocks.cjs.map +1 -0
- package/dist/rules/noBadBlocks.d.ts +3 -0
- package/dist/rules/noBlankBlockDescriptions.cjs +63 -0
- package/dist/rules/noBlankBlockDescriptions.cjs.map +1 -0
- package/dist/rules/noBlankBlockDescriptions.d.ts +3 -0
- package/dist/rules/noBlankBlocks.cjs +54 -0
- package/dist/rules/noBlankBlocks.cjs.map +1 -0
- package/dist/rules/noBlankBlocks.d.ts +3 -0
- package/dist/rules/noDefaults.cjs +102 -0
- package/dist/rules/noDefaults.cjs.map +1 -0
- package/dist/rules/noDefaults.d.ts +3 -0
- package/dist/rules/noMissingSyntax.cjs +196 -0
- package/dist/rules/noMissingSyntax.cjs.map +1 -0
- package/dist/rules/noMissingSyntax.d.ts +10 -0
- package/dist/rules/noMultiAsterisks.cjs +126 -0
- package/dist/rules/noMultiAsterisks.cjs.map +1 -0
- package/dist/rules/noMultiAsterisks.d.ts +3 -0
- package/dist/rules/noRestrictedSyntax.cjs +68 -0
- package/dist/rules/noRestrictedSyntax.cjs.map +1 -0
- package/dist/rules/noRestrictedSyntax.d.ts +3 -0
- package/dist/rules/noTypes.cjs +101 -0
- package/dist/rules/noTypes.cjs.map +1 -0
- package/dist/rules/noTypes.d.ts +3 -0
- package/dist/rules/noUndefinedTypes.cjs +588 -0
- package/dist/rules/noUndefinedTypes.cjs.map +1 -0
- package/dist/rules/noUndefinedTypes.d.ts +3 -0
- package/dist/rules/preferImportTag.cjs +362 -0
- package/dist/rules/preferImportTag.cjs.map +1 -0
- package/dist/rules/preferImportTag.d.ts +3 -0
- package/dist/rules/requireAsteriskPrefix.cjs +190 -0
- package/dist/rules/requireAsteriskPrefix.cjs.map +1 -0
- package/dist/rules/requireAsteriskPrefix.d.ts +3 -0
- package/dist/rules/requireDescription.cjs +164 -0
- package/dist/rules/requireDescription.cjs.map +1 -0
- package/dist/rules/requireDescription.d.ts +3 -0
- package/dist/rules/requireDescriptionCompleteSentence.cjs +321 -0
- package/dist/rules/requireDescriptionCompleteSentence.cjs.map +1 -0
- package/dist/rules/requireDescriptionCompleteSentence.d.ts +3 -0
- package/dist/rules/requireExample.cjs +133 -0
- package/dist/rules/requireExample.cjs.map +1 -0
- package/dist/rules/requireExample.d.ts +3 -0
- package/dist/rules/requireFileOverview.cjs +194 -0
- package/dist/rules/requireFileOverview.cjs.map +1 -0
- package/dist/rules/requireFileOverview.d.ts +3 -0
- package/dist/rules/requireHyphenBeforeParamDescription.cjs +166 -0
- package/dist/rules/requireHyphenBeforeParamDescription.cjs.map +1 -0
- package/dist/rules/requireHyphenBeforeParamDescription.d.ts +3 -0
- package/dist/rules/requireJsdoc.cjs +722 -0
- package/dist/rules/requireJsdoc.cjs.map +1 -0
- package/dist/rules/requireJsdoc.d.ts +25 -0
- package/dist/rules/requireParam.cjs +772 -0
- package/dist/rules/requireParam.cjs.map +1 -0
- package/dist/rules/requireParam.d.ts +4 -0
- package/dist/rules/requireParamDescription.cjs +105 -0
- package/dist/rules/requireParamDescription.cjs.map +1 -0
- package/dist/rules/requireParamDescription.d.ts +3 -0
- package/dist/rules/requireParamName.cjs +68 -0
- package/dist/rules/requireParamName.cjs.map +1 -0
- package/dist/rules/requireParamName.d.ts +3 -0
- package/dist/rules/requireParamType.cjs +104 -0
- package/dist/rules/requireParamType.cjs.map +1 -0
- package/dist/rules/requireParamType.d.ts +3 -0
- package/dist/rules/requireProperty.cjs +63 -0
- package/dist/rules/requireProperty.cjs.map +1 -0
- package/dist/rules/requireProperty.d.ts +3 -0
- package/dist/rules/requirePropertyDescription.cjs +29 -0
- package/dist/rules/requirePropertyDescription.cjs.map +1 -0
- package/dist/rules/requirePropertyDescription.d.ts +3 -0
- package/dist/rules/requirePropertyName.cjs +29 -0
- package/dist/rules/requirePropertyName.cjs.map +1 -0
- package/dist/rules/requirePropertyName.d.ts +3 -0
- package/dist/rules/requirePropertyType.cjs +29 -0
- package/dist/rules/requirePropertyType.cjs.map +1 -0
- package/dist/rules/requirePropertyType.d.ts +3 -0
- package/dist/rules/requireRejects.cjs +226 -0
- package/dist/rules/requireRejects.cjs.map +1 -0
- package/dist/rules/requireRejects.d.ts +3 -0
- package/dist/rules/requireReturns.cjs +262 -0
- package/dist/rules/requireReturns.cjs.map +1 -0
- package/dist/rules/requireReturns.d.ts +3 -0
- package/dist/rules/requireReturnsCheck.cjs +140 -0
- package/dist/rules/requireReturnsCheck.cjs.map +1 -0
- package/dist/rules/requireReturnsCheck.d.ts +3 -0
- package/dist/rules/requireReturnsDescription.cjs +72 -0
- package/dist/rules/requireReturnsDescription.cjs.map +1 -0
- package/dist/rules/requireReturnsDescription.d.ts +3 -0
- package/dist/rules/requireReturnsType.cjs +68 -0
- package/dist/rules/requireReturnsType.cjs.map +1 -0
- package/dist/rules/requireReturnsType.d.ts +3 -0
- package/dist/rules/requireTags.cjs +74 -0
- package/dist/rules/requireTags.cjs.map +1 -0
- package/dist/rules/requireTags.d.ts +3 -0
- package/dist/rules/requireTemplate.cjs +220 -0
- package/dist/rules/requireTemplate.cjs.map +1 -0
- package/dist/rules/requireTemplate.d.ts +3 -0
- package/dist/rules/requireThrows.cjs +118 -0
- package/dist/rules/requireThrows.cjs.map +1 -0
- package/dist/rules/requireThrows.d.ts +3 -0
- package/dist/rules/requireYields.cjs +224 -0
- package/dist/rules/requireYields.cjs.map +1 -0
- package/dist/rules/requireYields.d.ts +3 -0
- package/dist/rules/requireYieldsCheck.cjs +179 -0
- package/dist/rules/requireYieldsCheck.cjs.map +1 -0
- package/dist/rules/requireYieldsCheck.d.ts +3 -0
- package/dist/rules/sortTags.cjs +656 -0
- package/dist/rules/sortTags.cjs.map +1 -0
- package/dist/rules/sortTags.d.ts +3 -0
- package/dist/rules/tagLines.cjs +374 -0
- package/dist/rules/tagLines.cjs.map +1 -0
- package/dist/rules/tagLines.d.ts +3 -0
- package/dist/rules/textEscaping.cjs +141 -0
- package/dist/rules/textEscaping.cjs.map +1 -0
- package/dist/rules/textEscaping.d.ts +3 -0
- package/dist/rules/tsMethodSignatureStyle.cjs +240 -0
- package/dist/rules/tsMethodSignatureStyle.cjs.map +1 -0
- package/dist/rules/tsMethodSignatureStyle.d.ts +3 -0
- package/dist/rules/tsNoEmptyObjectType.cjs +62 -0
- package/dist/rules/tsNoEmptyObjectType.cjs.map +1 -0
- package/dist/rules/tsNoEmptyObjectType.d.ts +3 -0
- package/dist/rules/tsNoUnnecessaryTemplateExpression.cjs +104 -0
- package/dist/rules/tsNoUnnecessaryTemplateExpression.cjs.map +1 -0
- package/dist/rules/tsNoUnnecessaryTemplateExpression.d.ts +3 -0
- package/dist/rules/tsPreferFunctionType.cjs +110 -0
- package/dist/rules/tsPreferFunctionType.cjs.map +1 -0
- package/dist/rules/tsPreferFunctionType.d.ts +3 -0
- package/dist/rules/typeFormatting.cjs +607 -0
- package/dist/rules/typeFormatting.cjs.map +1 -0
- package/dist/rules/typeFormatting.d.ts +3 -0
- package/dist/rules/validTypes.cjs +328 -0
- package/dist/rules/validTypes.cjs.map +1 -0
- package/dist/rules/validTypes.d.ts +3 -0
- package/dist/rules.d.ts +3203 -0
- package/dist/tagNames.cjs +244 -0
- package/dist/tagNames.cjs.map +1 -0
- package/dist/tagNames.d.ts +16 -0
- package/dist/to-valid-identifier.cjs +263 -0
- package/dist/utils/hasReturnValue.cjs +495 -0
- package/dist/utils/hasReturnValue.cjs.map +1 -0
- package/dist/utils/hasReturnValue.d.ts +20 -0
- package/package.json +220 -0
- package/rollup.config.js +16 -0
- package/src/WarnSettings.js +34 -0
- package/src/alignTransform.js +444 -0
- package/src/buildForbidRuleDefinition.js +106 -0
- package/src/buildRejectOrPreferRuleDefinition.js +481 -0
- package/src/defaultTagOrder.js +169 -0
- package/src/exportParser.js +973 -0
- package/src/getDefaultTagStructureForMode.js +968 -0
- package/src/getJsdocProcessorPlugin.cts +5 -0
- package/src/getJsdocProcessorPlugin.js +692 -0
- package/src/index-cjs.js +755 -0
- package/src/index-esm.js +196 -0
- package/src/index.cjs.cts +3 -0
- package/src/index.js +940 -0
- package/src/iterateJsdoc.cts +7 -0
- package/src/iterateJsdoc.js +2612 -0
- package/src/jsdocUtils.js +2158 -0
- package/src/rules/checkAccess.js +45 -0
- package/src/rules/checkAlignment.js +82 -0
- package/src/rules/checkExamples.js +613 -0
- package/src/rules/checkIndentation.js +176 -0
- package/src/rules/checkLineAlignment.js +453 -0
- package/src/rules/checkParamNames.js +541 -0
- package/src/rules/checkPropertyNames.js +174 -0
- package/src/rules/checkSyntax.js +30 -0
- package/src/rules/checkTagNames.js +414 -0
- package/src/rules/checkTemplateNames.js +208 -0
- package/src/rules/checkTypes.js +130 -0
- package/src/rules/checkValues.js +264 -0
- package/src/rules/convertToJsdocComments.js +444 -0
- package/src/rules/emptyTags.js +106 -0
- package/src/rules/escapeInlineTags.js +189 -0
- package/src/rules/implementsOnClasses.js +78 -0
- package/src/rules/importsAsDependencies.js +132 -0
- package/src/rules/informativeDocs.js +228 -0
- package/src/rules/linesBeforeBlock.js +144 -0
- package/src/rules/matchDescription.js +413 -0
- package/src/rules/matchName.js +179 -0
- package/src/rules/multilineBlocks.js +562 -0
- package/src/rules/noBadBlocks.js +127 -0
- package/src/rules/noBlankBlockDescriptions.js +69 -0
- package/src/rules/noBlankBlocks.js +55 -0
- package/src/rules/noDefaults.js +104 -0
- package/src/rules/noMissingSyntax.js +215 -0
- package/src/rules/noMultiAsterisks.js +162 -0
- package/src/rules/noRestrictedSyntax.js +72 -0
- package/src/rules/noTypes.js +108 -0
- package/src/rules/noUndefinedTypes.js +797 -0
- package/src/rules/preferImportTag.js +521 -0
- package/src/rules/requireAsteriskPrefix.js +217 -0
- package/src/rules/requireDescription.js +190 -0
- package/src/rules/requireDescriptionCompleteSentence.js +376 -0
- package/src/rules/requireExample.js +143 -0
- package/src/rules/requireFileOverview.js +213 -0
- package/src/rules/requireHyphenBeforeParamDescription.js +210 -0
- package/src/rules/requireJsdoc.js +897 -0
- package/src/rules/requireParam.js +848 -0
- package/src/rules/requireParamDescription.js +110 -0
- package/src/rules/requireParamName.js +69 -0
- package/src/rules/requireParamType.js +109 -0
- package/src/rules/requireProperty.js +66 -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/requireRejects.js +246 -0
- package/src/rules/requireReturns.js +291 -0
- package/src/rules/requireReturnsCheck.js +180 -0
- package/src/rules/requireReturnsDescription.js +73 -0
- package/src/rules/requireReturnsType.js +65 -0
- package/src/rules/requireTags.js +85 -0
- package/src/rules/requireTemplate.js +246 -0
- package/src/rules/requireThrows.js +128 -0
- package/src/rules/requireYields.js +265 -0
- package/src/rules/requireYieldsCheck.js +226 -0
- package/src/rules/sortTags.js +766 -0
- package/src/rules/tagLines.js +486 -0
- package/src/rules/textEscaping.js +158 -0
- package/src/rules/tsMethodSignatureStyle.js +300 -0
- package/src/rules/tsNoEmptyObjectType.js +61 -0
- package/src/rules/tsNoUnnecessaryTemplateExpression.js +130 -0
- package/src/rules/tsPreferFunctionType.js +127 -0
- package/src/rules/typeFormatting.js +690 -0
- package/src/rules/validTypes.js +466 -0
- package/src/rules.d.ts +3203 -0
- package/src/tagNames.js +301 -0
- package/src/utils/hasReturnValue.js +572 -0
- package/typings/babel__eslint-parser.d.ts +1 -0
- package/typings/gitdown.d.ts +16 -0
package/package.json
ADDED
|
@@ -0,0 +1,220 @@
|
|
|
1
|
+
{
|
|
2
|
+
"author": {
|
|
3
|
+
"email": "gajus@gajus.com",
|
|
4
|
+
"name": "Gajus Kuizinas",
|
|
5
|
+
"url": "http://gajus.com"
|
|
6
|
+
},
|
|
7
|
+
"dependencies": {
|
|
8
|
+
"@es-joy/jsdoccomment": "~0.84.0",
|
|
9
|
+
"@es-joy/resolve.exports": "1.2.0",
|
|
10
|
+
"are-docs-informative": "^0.1.1",
|
|
11
|
+
"comment-parser": "1.4.5",
|
|
12
|
+
"debug": "^4.4.3",
|
|
13
|
+
"escape-string-regexp": "^5.0.0",
|
|
14
|
+
"espree": "^11.2.0",
|
|
15
|
+
"esquery": "^1.7.0",
|
|
16
|
+
"html-entities": "^2.6.0",
|
|
17
|
+
"object-deep-merge": "^2.0.0",
|
|
18
|
+
"parse-imports-exports": "^0.2.4",
|
|
19
|
+
"semver": "^7.7.4",
|
|
20
|
+
"spdx-expression-parse": "^4.0.0",
|
|
21
|
+
"to-valid-identifier": "^1.0.0"
|
|
22
|
+
},
|
|
23
|
+
"description": "[DepUp] JSDoc linting rules for ESLint.",
|
|
24
|
+
"devDependencies": {
|
|
25
|
+
"@arethetypeswrong/cli": "^0.18.2",
|
|
26
|
+
"@babel/cli": "^7.28.6",
|
|
27
|
+
"@babel/core": "8.0.0-rc.1",
|
|
28
|
+
"@babel/eslint-parser": "8.0.0-rc.1",
|
|
29
|
+
"@babel/plugin-transform-flow-strip-types": "8.0.0-rc.1",
|
|
30
|
+
"@babel/preset-env": "8.0.0-rc.1",
|
|
31
|
+
"@es-joy/escodegen": "^4.2.0",
|
|
32
|
+
"@es-joy/jsdoc-eslint-parser": "^0.27.0",
|
|
33
|
+
"@eslint/core": "^1.1.0",
|
|
34
|
+
"@hkdobrev/run-if-changed": "^0.6.3",
|
|
35
|
+
"@rollup/plugin-node-resolve": "^16.0.3",
|
|
36
|
+
"@semantic-release/commit-analyzer": "^13.0.1",
|
|
37
|
+
"@semantic-release/github": "^12.0.6",
|
|
38
|
+
"@semantic-release/npm": "^13.1.4",
|
|
39
|
+
"@types/chai": "^5.2.3",
|
|
40
|
+
"@types/debug": "^4.1.12",
|
|
41
|
+
"@types/espree": "^10.1.0",
|
|
42
|
+
"@types/esquery": "^1.5.4",
|
|
43
|
+
"@types/estree": "^1.0.8",
|
|
44
|
+
"@types/json-schema": "^7.0.15",
|
|
45
|
+
"@types/mocha": "^10.0.10",
|
|
46
|
+
"@types/node": "^25.3.0",
|
|
47
|
+
"@types/semver": "^7.7.1",
|
|
48
|
+
"@types/spdx-expression-parse": "^3.0.5",
|
|
49
|
+
"@typescript-eslint/types": "8.56.0",
|
|
50
|
+
"babel-plugin-add-module-exports": "^1.0.4",
|
|
51
|
+
"babel-plugin-istanbul": "^7.0.1",
|
|
52
|
+
"babel-plugin-transform-import-meta": "^2.3.3",
|
|
53
|
+
"c8": "^10.1.3",
|
|
54
|
+
"camelcase": "^9.0.0",
|
|
55
|
+
"chai": "^6.2.2",
|
|
56
|
+
"decamelize": "^6.0.1",
|
|
57
|
+
"eslint": "10.0.0",
|
|
58
|
+
"eslint-config-canonical": "^47.4.2",
|
|
59
|
+
"gitdown": "^4.1.1",
|
|
60
|
+
"glob": "^13.0.5",
|
|
61
|
+
"globals": "^17.3.0",
|
|
62
|
+
"husky": "^9.1.7",
|
|
63
|
+
"jsdoc-type-pratt-parser": "^7.1.1",
|
|
64
|
+
"json-schema": "^0.4.0",
|
|
65
|
+
"json-schema-to-typescript": "^15.0.4",
|
|
66
|
+
"lint-staged": "^16.2.7",
|
|
67
|
+
"mocha": "^11.7.5",
|
|
68
|
+
"open-editor": "^6.0.0",
|
|
69
|
+
"playwright": "^1.58.2",
|
|
70
|
+
"replace": "^1.2.2",
|
|
71
|
+
"rimraf": "^6.1.3",
|
|
72
|
+
"rollup": "^4.57.1",
|
|
73
|
+
"semantic-release": "^25.0.3",
|
|
74
|
+
"sinon": "^21.0.1",
|
|
75
|
+
"ts-api-utils": "^2.4.0",
|
|
76
|
+
"typescript": "5.9.3",
|
|
77
|
+
"typescript-eslint": "8.56.0"
|
|
78
|
+
},
|
|
79
|
+
"engines": {
|
|
80
|
+
"node": "^20.19.0 || ^22.13.0 || >=24"
|
|
81
|
+
},
|
|
82
|
+
"keywords": [
|
|
83
|
+
"depup",
|
|
84
|
+
"dependency-bumped",
|
|
85
|
+
"updated-deps",
|
|
86
|
+
"eslint-plugin-jsdoc",
|
|
87
|
+
"eslint",
|
|
88
|
+
"plugin",
|
|
89
|
+
"jsdoc"
|
|
90
|
+
],
|
|
91
|
+
"license": "BSD-3-Clause",
|
|
92
|
+
"lint-staged": {
|
|
93
|
+
"*.js": "eslint --fix"
|
|
94
|
+
},
|
|
95
|
+
"type": "module",
|
|
96
|
+
"main": "./dist/index.cjs",
|
|
97
|
+
"types": "./dist/index.d.ts",
|
|
98
|
+
"exports": {
|
|
99
|
+
".": {
|
|
100
|
+
"import": {
|
|
101
|
+
"types": "./dist/index.d.ts",
|
|
102
|
+
"default": "./src/index.js"
|
|
103
|
+
},
|
|
104
|
+
"require": {
|
|
105
|
+
"types": "./dist/cjs/index.cjs.d.cts",
|
|
106
|
+
"default": "./dist/index-cjs.cjs"
|
|
107
|
+
}
|
|
108
|
+
},
|
|
109
|
+
"./getJsdocProcessorPlugin.js": {
|
|
110
|
+
"import": {
|
|
111
|
+
"types": "./dist/getJsdocProcessorPlugin.d.ts",
|
|
112
|
+
"default": "./src/getJsdocProcessorPlugin.js"
|
|
113
|
+
},
|
|
114
|
+
"require": {
|
|
115
|
+
"types": "./dist/cjs/getJsdocProcessorPlugin.d.cts",
|
|
116
|
+
"default": "./dist/getJsdocProcessorPlugin.cjs"
|
|
117
|
+
}
|
|
118
|
+
},
|
|
119
|
+
"./iterateJsdoc.js": {
|
|
120
|
+
"import": {
|
|
121
|
+
"types": "./dist/iterateJsdoc.d.ts",
|
|
122
|
+
"default": "./src/iterateJsdoc.js"
|
|
123
|
+
},
|
|
124
|
+
"require": {
|
|
125
|
+
"types": "./dist/cjs/iterateJsdoc.d.cts",
|
|
126
|
+
"default": "./dist/iterateJsdoc.cjs"
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
},
|
|
130
|
+
"name": "@depup/eslint-plugin-jsdoc",
|
|
131
|
+
"mocha": {
|
|
132
|
+
"reporter": "dot",
|
|
133
|
+
"recursive": true,
|
|
134
|
+
"timeout": 12000
|
|
135
|
+
},
|
|
136
|
+
"c8": {
|
|
137
|
+
"branches": 100,
|
|
138
|
+
"check-coverage": true,
|
|
139
|
+
"exclude": [
|
|
140
|
+
"src/rules/checkExamples.js"
|
|
141
|
+
],
|
|
142
|
+
"functions": 100,
|
|
143
|
+
"include": [
|
|
144
|
+
"src/"
|
|
145
|
+
],
|
|
146
|
+
"instrument": false,
|
|
147
|
+
"lines": 100,
|
|
148
|
+
"reporter": "text-summary",
|
|
149
|
+
"sourceMap": false,
|
|
150
|
+
"statements": 100
|
|
151
|
+
},
|
|
152
|
+
"peerDependencies": {
|
|
153
|
+
"eslint": "^7.0.0 || ^8.0.0 || ^9.0.0 || ^10.0.0"
|
|
154
|
+
},
|
|
155
|
+
"repository": {
|
|
156
|
+
"type": "git",
|
|
157
|
+
"url": "git+https://github.com/gajus/eslint-plugin-jsdoc.git"
|
|
158
|
+
},
|
|
159
|
+
"homepage": "https://github.com/gajus/eslint-plugin-jsdoc#readme",
|
|
160
|
+
"bugs": {
|
|
161
|
+
"url": "https://github.com/gajus/eslint-plugin-jsdoc/issues"
|
|
162
|
+
},
|
|
163
|
+
"run-if-changed": {
|
|
164
|
+
"pnpm-lock.yaml": "pnpm run install-offline"
|
|
165
|
+
},
|
|
166
|
+
"pnpm": {
|
|
167
|
+
"overrides": {
|
|
168
|
+
"@types/eslint": "0.0.0-interferes-with-eslint-now",
|
|
169
|
+
"eslint-scope": "9.1.0"
|
|
170
|
+
},
|
|
171
|
+
"ignoredBuiltDependencies": [
|
|
172
|
+
"core-js",
|
|
173
|
+
"core-js-pure",
|
|
174
|
+
"re2",
|
|
175
|
+
"unrs-resolver"
|
|
176
|
+
]
|
|
177
|
+
},
|
|
178
|
+
"scripts": {
|
|
179
|
+
"ruleTypes": "node ./src/bin/generateRuleTypes.js",
|
|
180
|
+
"tsc": "tsc",
|
|
181
|
+
"tsc-build": "tsc -p tsconfig-prod.json",
|
|
182
|
+
"tsc-cjs": "tsc -p tsconfig-cjs.json",
|
|
183
|
+
"rollup": "rollup -c",
|
|
184
|
+
"build": "node ./src/bin/buildEntryFileForTS.js && rimraf ./dist && mkdir dist && pnpm rollup && NODE_ENV=production babel ./src --out-file-extension .cjs --out-dir ./dist --copy-files --source-maps --ignore ./src/bin/*.js --no-copy-ignored && replace 'to-valid-identifier' '../to-valid-identifier.cjs' 'dist' -r --include=\"*.cjs\" && replace 'require\\(\"\\.(.*?)\\.[^.]*?\"\\)' 'require(\".$1.cjs\")' 'dist' -r --include=\"*.cjs\" && pnpm tsc-build && pnpm tsc-cjs",
|
|
185
|
+
"attw": "attw --pack .",
|
|
186
|
+
"check-docs": "node ./src/bin/generateDocs.js --check",
|
|
187
|
+
"create-docs": "pnpm run create-options && node ./src/bin/generateDocs.js && pnpm ruleTypes",
|
|
188
|
+
"create-rule": "node ./src/bin/generateRule.js",
|
|
189
|
+
"create-options": "node ./src/bin/generateOptions.js",
|
|
190
|
+
"install-offline": "pnpm install --prefer-offline",
|
|
191
|
+
"lint": "eslint",
|
|
192
|
+
"lint-fix": "eslint --fix",
|
|
193
|
+
"test-no-cov": "BABEL_ENV=test mocha",
|
|
194
|
+
"test": "c8 pnpm run test-no-cov",
|
|
195
|
+
"test-cov": "TIMING=1 c8 --reporter text pnpm run test-no-cov",
|
|
196
|
+
"test-index": "pnpm run test-no-cov test/rules/index.js"
|
|
197
|
+
},
|
|
198
|
+
"version": "62.8.0-depup.0",
|
|
199
|
+
"depup": {
|
|
200
|
+
"changes": {
|
|
201
|
+
"are-docs-informative": {
|
|
202
|
+
"from": "^0.0.2",
|
|
203
|
+
"to": "^0.1.1"
|
|
204
|
+
},
|
|
205
|
+
"escape-string-regexp": {
|
|
206
|
+
"from": "^4.0.0",
|
|
207
|
+
"to": "^5.0.0"
|
|
208
|
+
},
|
|
209
|
+
"espree": {
|
|
210
|
+
"from": "^11.1.0",
|
|
211
|
+
"to": "^11.2.0"
|
|
212
|
+
}
|
|
213
|
+
},
|
|
214
|
+
"depsUpdated": 3,
|
|
215
|
+
"originalPackage": "eslint-plugin-jsdoc",
|
|
216
|
+
"originalVersion": "62.8.0",
|
|
217
|
+
"processedAt": "2026-03-17T16:36:12.864Z",
|
|
218
|
+
"smokeTest": "passed"
|
|
219
|
+
}
|
|
220
|
+
}
|
package/rollup.config.js
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import {
|
|
2
|
+
nodeResolve,
|
|
3
|
+
} from '@rollup/plugin-node-resolve';
|
|
4
|
+
|
|
5
|
+
export default [
|
|
6
|
+
{
|
|
7
|
+
input: 'node_modules/to-valid-identifier/index.js',
|
|
8
|
+
output: {
|
|
9
|
+
file: 'dist/to-valid-identifier.cjs',
|
|
10
|
+
format: 'cjs',
|
|
11
|
+
},
|
|
12
|
+
plugins: [
|
|
13
|
+
nodeResolve(),
|
|
14
|
+
],
|
|
15
|
+
},
|
|
16
|
+
];
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
const WarnSettings = function () {
|
|
2
|
+
/** @type {WeakMap<object, Set<string>>} */
|
|
3
|
+
const warnedSettings = new WeakMap();
|
|
4
|
+
|
|
5
|
+
return {
|
|
6
|
+
/**
|
|
7
|
+
* Warn only once for each context and setting
|
|
8
|
+
* @param {import('eslint').Rule.RuleContext} context
|
|
9
|
+
* @param {string} setting
|
|
10
|
+
* @returns {boolean}
|
|
11
|
+
*/
|
|
12
|
+
hasBeenWarned (context, setting) {
|
|
13
|
+
return warnedSettings.has(context) && /** @type {Set<string>} */ (
|
|
14
|
+
warnedSettings.get(context)
|
|
15
|
+
).has(setting);
|
|
16
|
+
},
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* @param {import('eslint').Rule.RuleContext} context
|
|
20
|
+
* @param {string} setting
|
|
21
|
+
* @returns {void}
|
|
22
|
+
*/
|
|
23
|
+
markSettingAsWarned (context, setting) {
|
|
24
|
+
// c8 ignore else
|
|
25
|
+
if (!warnedSettings.has(context)) {
|
|
26
|
+
warnedSettings.set(context, new Set());
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
/** @type {Set<string>} */ (warnedSettings.get(context)).add(setting);
|
|
30
|
+
},
|
|
31
|
+
};
|
|
32
|
+
};
|
|
33
|
+
|
|
34
|
+
export default WarnSettings;
|