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
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"noBadBlocks.js","names":["commentParser"],"sources":["../../src/rules/noBadBlocks.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n parse as commentParser,\n} from 'comment-parser';\n\n// Neither a single nor 3+ asterisks are valid jsdoc per\n// https://jsdoc.app/about-getting-started.html#adding-documentation-comments-to-your-code\nconst commentRegexp = /^\\/\\*(?!\\*)/v;\nconst extraAsteriskCommentRegexp = /^\\/\\*{3,}/v;\n\nexport default iterateJsdoc(({\n allComments,\n context,\n makeReport,\n sourceCode,\n}) => {\n const [\n {\n ignore = [\n 'ts-check',\n 'ts-expect-error',\n 'ts-ignore',\n 'ts-nocheck',\n ],\n preventAllMultiAsteriskBlocks = false,\n } = {},\n ] = context.options;\n\n let extraAsterisks = false;\n const nonJsdocNodes = /** @type {import('estree').Node[]} */ (\n allComments\n ).filter((comment) => {\n const commentText = sourceCode.getText(comment);\n\n const initialText = commentText.replace(commentRegexp, '').trimStart();\n if ([\n 'eslint',\n ].some((directive) => {\n return initialText.startsWith(directive);\n })) {\n return false;\n }\n\n let sliceIndex = 2;\n if (!commentRegexp.test(commentText)) {\n const multiline = extraAsteriskCommentRegexp.exec(commentText)?.[0];\n if (!multiline) {\n return false;\n }\n\n sliceIndex = multiline.length;\n extraAsterisks = true;\n if (preventAllMultiAsteriskBlocks) {\n return true;\n }\n }\n\n const tags = (commentParser(\n `${commentText.slice(0, 2)}*${commentText.slice(sliceIndex)}`,\n )[0] || {}).tags ?? [];\n\n return tags.length && !tags.some(({\n tag,\n }) => {\n return ignore.includes(tag);\n });\n });\n\n if (!nonJsdocNodes.length) {\n return;\n }\n\n for (const node of nonJsdocNodes) {\n const report = /** @type {import('../iterateJsdoc.js').MakeReport} */ (\n makeReport\n )(context, node);\n\n // eslint-disable-next-line no-loop-func\n const fix = /** @type {import('eslint').Rule.ReportFixer} */ (fixer) => {\n const text = sourceCode.getText(node);\n\n return fixer.replaceText(\n node,\n extraAsterisks ?\n text.replace(extraAsteriskCommentRegexp, '/**') :\n text.replace('/*', '/**'),\n );\n };\n\n report('Expected JSDoc-like comment to begin with two asterisks.', fix);\n }\n}, {\n checkFile: true,\n meta: {\n docs: {\n description: 'This rule checks for multi-line-style comments which fail to meet the criteria of a jsdoc block.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-bad-blocks.md#repos-sticky-header',\n },\n fixable: 'code',\n schema: [\n {\n additionalProperties: false,\n properties: {\n ignore: {\n items: {\n type: 'string',\n },\n type: 'array',\n },\n preventAllMultiAsteriskBlocks: {\n type: 'boolean',\n },\n },\n type: 'object',\n },\n ],\n type: 'layout',\n },\n});\n"],"mappings":";;;;AAOA,MAAM,gBAAgB;AACtB,MAAM,6BAA6B;AAEnC,0BAAe,aAAa,CAAC,EAC3B,aACA,SACA,YACA,YACD,KAAK;CACJ,MAAM,CACJ,EACE,SAAS;EACP;EACA;EACA;EACA;CACD,GACD,gCAAgC,OACjC,GAAG,CAAE,EACP,GAAG,QAAQ;CAEZ,IAAI,iBAAiB;CACrB,MAAM,gBACJ,YACA,OAAO,CAAC,YAAY;EACpB,MAAM,cAAc,WAAW,QAAQ,QAAQ;EAE/C,MAAM,cAAc,YAAY,QAAQ,eAAe,GAAG,CAAC,WAAW;AACtE,MAAI,CACF,QACD,EAAC,KAAK,CAAC,cAAc;AACpB,UAAO,YAAY,WAAW,UAAU;EACzC,EAAC,CACA,QAAO;EAGT,IAAI,aAAa;AACjB,MAAI,CAAC,cAAc,KAAK,YAAY,EAAE;GACpC,MAAM,YAAY,2BAA2B,KAAK,YAAY,GAAG;AACjE,OAAI,CAAC,UACH,QAAO;GAGT,aAAa,UAAU;GACvB,iBAAiB;AACjB,OAAI,8BACF,QAAO;EAEV;EAED,MAAM,QAAQA,MACZ,GAAG,YAAY,MAAM,GAAG,EAAE,CAAC,CAAC,EAAE,YAAY,MAAM,WAAW,EAAE,CAC9D,CAAC,MAAM,CAAE,GAAE,QAAQ,CAAE;AAEtB,SAAO,KAAK,UAAU,CAAC,KAAK,KAAK,CAAC,EAChC,KACD,KAAK;AACJ,UAAO,OAAO,SAAS,IAAI;EAC5B,EAAC;CACH,EAAC;AAEF,KAAI,CAAC,cAAc,OACjB;AAGF,MAAK,MAAM,QAAQ,eAAe;EAChC,MAAM,SACJ,WACA,SAAS,KAAK;EAGhB,MAAM,MAAuD,CAAC,UAAU;GACtE,MAAM,OAAO,WAAW,QAAQ,KAAK;AAErC,UAAO,MAAM,YACX,MACA,iBACE,KAAK,QAAQ,4BAA4B,MAAM,GAC/C,KAAK,QAAQ,MAAM,MAAM,CAC5B;EACF;EAED,OAAO,4DAA4D,IAAI;CACxE;AACF,GAAE;CACD,WAAW;CACX,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,QAAQ;KACN,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;IACD,+BAA+B,EAC7B,MAAM,UACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}
|
|
@@ -1,63 +1,41 @@
|
|
|
1
|
-
|
|
1
|
+
const require_iterateJsdoc = require('../iterateJsdoc.cjs');
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
value: true
|
|
5
|
-
});
|
|
6
|
-
exports.default = void 0;
|
|
7
|
-
var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
|
|
8
|
-
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
|
|
3
|
+
//#region src/rules/noBlankBlockDescriptions.js
|
|
9
4
|
const anyWhitespaceLines = /^\s*$/v;
|
|
10
5
|
const atLeastTwoLinesWhitespace = /^[ \t]*\n[ \t]*\n\s*$/v;
|
|
11
|
-
var
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
}) => {
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
} else {
|
|
32
|
-
utils.reportJSDoc('There should be no extra blank lines in block descriptions not followed by tags.', {
|
|
33
|
-
line: lastDescriptionLine
|
|
34
|
-
}, () => {
|
|
35
|
-
utils.setBlockDescription((info, seedTokens) => {
|
|
36
|
-
return [
|
|
37
|
-
// Keep the starting line
|
|
38
|
-
{
|
|
39
|
-
number: 0,
|
|
40
|
-
source: '',
|
|
41
|
-
tokens: seedTokens({
|
|
42
|
-
...info,
|
|
43
|
-
description: ''
|
|
44
|
-
})
|
|
45
|
-
}];
|
|
46
|
-
});
|
|
47
|
-
});
|
|
48
|
-
}
|
|
49
|
-
}
|
|
6
|
+
var noBlankBlockDescriptions_default = require_iterateJsdoc.default(({ jsdoc, utils }) => {
|
|
7
|
+
const { description, descriptions, lastDescriptionLine } = utils.getDescription();
|
|
8
|
+
const regex = jsdoc.tags.length ? anyWhitespaceLines : atLeastTwoLinesWhitespace;
|
|
9
|
+
if (descriptions.length && regex.test(description)) if (jsdoc.tags.length) utils.reportJSDoc("There should be no blank lines in block descriptions followed by tags.", { line: lastDescriptionLine }, () => {
|
|
10
|
+
utils.setBlockDescription(() => {
|
|
11
|
+
return [];
|
|
12
|
+
});
|
|
13
|
+
});
|
|
14
|
+
else utils.reportJSDoc("There should be no extra blank lines in block descriptions not followed by tags.", { line: lastDescriptionLine }, () => {
|
|
15
|
+
utils.setBlockDescription((info, seedTokens) => {
|
|
16
|
+
return [{
|
|
17
|
+
number: 0,
|
|
18
|
+
source: "",
|
|
19
|
+
tokens: seedTokens({
|
|
20
|
+
...info,
|
|
21
|
+
description: ""
|
|
22
|
+
})
|
|
23
|
+
}];
|
|
24
|
+
});
|
|
25
|
+
});
|
|
50
26
|
}, {
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
27
|
+
iterateAllJsdocs: true,
|
|
28
|
+
meta: {
|
|
29
|
+
docs: {
|
|
30
|
+
description: "Detects and removes extra lines of a blank block description",
|
|
31
|
+
url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-blank-block-descriptions.md#repos-sticky-header"
|
|
32
|
+
},
|
|
33
|
+
fixable: "whitespace",
|
|
34
|
+
schema: [],
|
|
35
|
+
type: "layout"
|
|
36
|
+
}
|
|
61
37
|
});
|
|
62
|
-
|
|
38
|
+
|
|
39
|
+
//#endregion
|
|
40
|
+
exports.default = noBlankBlockDescriptions_default;
|
|
63
41
|
//# sourceMappingURL=noBlankBlockDescriptions.cjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"noBlankBlockDescriptions.cjs","names":["
|
|
1
|
+
{"version":3,"file":"noBlankBlockDescriptions.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/noBlankBlockDescriptions.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nconst anyWhitespaceLines = /^\\s*$/v;\nconst atLeastTwoLinesWhitespace = /^[ \\t]*\\n[ \\t]*\\n\\s*$/v;\n\nexport default iterateJsdoc(({\n jsdoc,\n utils,\n}) => {\n const {\n description,\n descriptions,\n lastDescriptionLine,\n } = utils.getDescription();\n\n const regex = jsdoc.tags.length ?\n anyWhitespaceLines :\n atLeastTwoLinesWhitespace;\n\n if (descriptions.length && regex.test(description)) {\n if (jsdoc.tags.length) {\n utils.reportJSDoc(\n 'There should be no blank lines in block descriptions followed by tags.',\n {\n line: lastDescriptionLine,\n },\n () => {\n utils.setBlockDescription(() => {\n // Remove all lines\n return [];\n });\n },\n );\n } else {\n utils.reportJSDoc(\n 'There should be no extra blank lines in block descriptions not followed by tags.',\n {\n line: lastDescriptionLine,\n },\n () => {\n utils.setBlockDescription((info, seedTokens) => {\n return [\n // Keep the starting line\n {\n number: 0,\n source: '',\n tokens: seedTokens({\n ...info,\n description: '',\n }),\n },\n ];\n });\n },\n );\n }\n }\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Detects and removes extra lines of a blank block description',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-blank-block-descriptions.md#repos-sticky-header',\n },\n fixable: 'whitespace',\n schema: [],\n type: 'layout',\n },\n});\n"],"mappings":";;;AAEA,MAAM,qBAAqB;AAC3B,MAAM,4BAA4B;AAElC,uCAAeA,6BAAa,CAAC,EAC3B,OACA,OACD,KAAK;CACJ,MAAM,EACJ,aACA,cACA,qBACD,GAAG,MAAM,gBAAgB;CAE1B,MAAM,QAAQ,MAAM,KAAK,SACvB,qBACA;AAEF,KAAI,aAAa,UAAU,MAAM,KAAK,YAAY,CAChD,KAAI,MAAM,KAAK,QACb,MAAM,YACJ,0EACA,EACE,MAAM,oBACP,GACD,MAAM;EACJ,MAAM,oBAAoB,MAAM;AAE9B,UAAO,CAAE;EACV,EAAC;CACH,EACF;MAED,MAAM,YACJ,oFACA,EACE,MAAM,oBACP,GACD,MAAM;EACJ,MAAM,oBAAoB,CAAC,MAAM,eAAe;AAC9C,UAAO,CAEL;IACE,QAAQ;IACR,QAAQ;IACR,QAAQ,WAAW;KACjB,GAAG;KACH,aAAa;IACd,EAAC;GACH,CACF;EACF,EAAC;CACH,EACF;AAGN,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CAAE;EACV,MAAM;CACP;AACF,EAAC"}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import iterateJsdoc from "../iterateJsdoc.js";
|
|
2
|
+
|
|
3
|
+
//#region src/rules/noBlankBlockDescriptions.js
|
|
4
|
+
const anyWhitespaceLines = /^\s*$/v;
|
|
5
|
+
const atLeastTwoLinesWhitespace = /^[ \t]*\n[ \t]*\n\s*$/v;
|
|
6
|
+
var noBlankBlockDescriptions_default = iterateJsdoc(({ jsdoc, utils }) => {
|
|
7
|
+
const { description, descriptions, lastDescriptionLine } = utils.getDescription();
|
|
8
|
+
const regex = jsdoc.tags.length ? anyWhitespaceLines : atLeastTwoLinesWhitespace;
|
|
9
|
+
if (descriptions.length && regex.test(description)) if (jsdoc.tags.length) utils.reportJSDoc("There should be no blank lines in block descriptions followed by tags.", { line: lastDescriptionLine }, () => {
|
|
10
|
+
utils.setBlockDescription(() => {
|
|
11
|
+
return [];
|
|
12
|
+
});
|
|
13
|
+
});
|
|
14
|
+
else utils.reportJSDoc("There should be no extra blank lines in block descriptions not followed by tags.", { line: lastDescriptionLine }, () => {
|
|
15
|
+
utils.setBlockDescription((info, seedTokens) => {
|
|
16
|
+
return [{
|
|
17
|
+
number: 0,
|
|
18
|
+
source: "",
|
|
19
|
+
tokens: seedTokens({
|
|
20
|
+
...info,
|
|
21
|
+
description: ""
|
|
22
|
+
})
|
|
23
|
+
}];
|
|
24
|
+
});
|
|
25
|
+
});
|
|
26
|
+
}, {
|
|
27
|
+
iterateAllJsdocs: true,
|
|
28
|
+
meta: {
|
|
29
|
+
docs: {
|
|
30
|
+
description: "Detects and removes extra lines of a blank block description",
|
|
31
|
+
url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-blank-block-descriptions.md#repos-sticky-header"
|
|
32
|
+
},
|
|
33
|
+
fixable: "whitespace",
|
|
34
|
+
schema: [],
|
|
35
|
+
type: "layout"
|
|
36
|
+
}
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
//#endregion
|
|
40
|
+
export { noBlankBlockDescriptions_default as default };
|
|
41
|
+
//# sourceMappingURL=noBlankBlockDescriptions.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"noBlankBlockDescriptions.js","names":[],"sources":["../../src/rules/noBlankBlockDescriptions.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nconst anyWhitespaceLines = /^\\s*$/v;\nconst atLeastTwoLinesWhitespace = /^[ \\t]*\\n[ \\t]*\\n\\s*$/v;\n\nexport default iterateJsdoc(({\n jsdoc,\n utils,\n}) => {\n const {\n description,\n descriptions,\n lastDescriptionLine,\n } = utils.getDescription();\n\n const regex = jsdoc.tags.length ?\n anyWhitespaceLines :\n atLeastTwoLinesWhitespace;\n\n if (descriptions.length && regex.test(description)) {\n if (jsdoc.tags.length) {\n utils.reportJSDoc(\n 'There should be no blank lines in block descriptions followed by tags.',\n {\n line: lastDescriptionLine,\n },\n () => {\n utils.setBlockDescription(() => {\n // Remove all lines\n return [];\n });\n },\n );\n } else {\n utils.reportJSDoc(\n 'There should be no extra blank lines in block descriptions not followed by tags.',\n {\n line: lastDescriptionLine,\n },\n () => {\n utils.setBlockDescription((info, seedTokens) => {\n return [\n // Keep the starting line\n {\n number: 0,\n source: '',\n tokens: seedTokens({\n ...info,\n description: '',\n }),\n },\n ];\n });\n },\n );\n }\n }\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Detects and removes extra lines of a blank block description',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-blank-block-descriptions.md#repos-sticky-header',\n },\n fixable: 'whitespace',\n schema: [],\n type: 'layout',\n },\n});\n"],"mappings":";;;AAEA,MAAM,qBAAqB;AAC3B,MAAM,4BAA4B;AAElC,uCAAe,aAAa,CAAC,EAC3B,OACA,OACD,KAAK;CACJ,MAAM,EACJ,aACA,cACA,qBACD,GAAG,MAAM,gBAAgB;CAE1B,MAAM,QAAQ,MAAM,KAAK,SACvB,qBACA;AAEF,KAAI,aAAa,UAAU,MAAM,KAAK,YAAY,CAChD,KAAI,MAAM,KAAK,QACb,MAAM,YACJ,0EACA,EACE,MAAM,oBACP,GACD,MAAM;EACJ,MAAM,oBAAoB,MAAM;AAE9B,UAAO,CAAE;EACV,EAAC;CACH,EACF;MAED,MAAM,YACJ,oFACA,EACE,MAAM,oBACP,GACD,MAAM;EACJ,MAAM,oBAAoB,CAAC,MAAM,eAAe;AAC9C,UAAO,CAEL;IACE,QAAQ;IACR,QAAQ;IACR,QAAQ,WAAW;KACjB,GAAG;KACH,aAAa;IACd,EAAC;GACH,CACF;EACF,EAAC;CACH,EACF;AAGN,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CAAE;EACV,MAAM;CACP;AACF,EAAC"}
|
|
@@ -1,52 +1,30 @@
|
|
|
1
|
-
|
|
1
|
+
const require_iterateJsdoc = require('../iterateJsdoc.cjs');
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
utils
|
|
13
|
-
}) => {
|
|
14
|
-
if (jsdoc.tags.length) {
|
|
15
|
-
return;
|
|
16
|
-
}
|
|
17
|
-
const {
|
|
18
|
-
description,
|
|
19
|
-
lastDescriptionLine
|
|
20
|
-
} = utils.getDescription();
|
|
21
|
-
if (description.trim()) {
|
|
22
|
-
return;
|
|
23
|
-
}
|
|
24
|
-
const {
|
|
25
|
-
enableFixer
|
|
26
|
-
} = context.options[0] || {};
|
|
27
|
-
utils.reportJSDoc('No empty blocks', {
|
|
28
|
-
line: lastDescriptionLine
|
|
29
|
-
}, enableFixer ? () => {
|
|
30
|
-
jsdoc.source.splice(0, jsdoc.source.length);
|
|
31
|
-
} : null);
|
|
3
|
+
//#region src/rules/noBlankBlocks.js
|
|
4
|
+
var noBlankBlocks_default = require_iterateJsdoc.default(({ context, jsdoc, utils }) => {
|
|
5
|
+
if (jsdoc.tags.length) return;
|
|
6
|
+
const { description, lastDescriptionLine } = utils.getDescription();
|
|
7
|
+
if (description.trim()) return;
|
|
8
|
+
const { enableFixer } = context.options[0] || {};
|
|
9
|
+
utils.reportJSDoc("No empty blocks", { line: lastDescriptionLine }, enableFixer ? () => {
|
|
10
|
+
jsdoc.source.splice(0, jsdoc.source.length);
|
|
11
|
+
} : null);
|
|
32
12
|
}, {
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
}
|
|
47
|
-
}],
|
|
48
|
-
type: 'suggestion'
|
|
49
|
-
}
|
|
13
|
+
iterateAllJsdocs: true,
|
|
14
|
+
meta: {
|
|
15
|
+
docs: {
|
|
16
|
+
description: "Removes empty blocks with nothing but possibly line breaks",
|
|
17
|
+
url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-blank-blocks.md#repos-sticky-header"
|
|
18
|
+
},
|
|
19
|
+
fixable: "code",
|
|
20
|
+
schema: [{
|
|
21
|
+
additionalProperties: false,
|
|
22
|
+
properties: { enableFixer: { type: "boolean" } }
|
|
23
|
+
}],
|
|
24
|
+
type: "suggestion"
|
|
25
|
+
}
|
|
50
26
|
});
|
|
51
|
-
|
|
27
|
+
|
|
28
|
+
//#endregion
|
|
29
|
+
exports.default = noBlankBlocks_default;
|
|
52
30
|
//# sourceMappingURL=noBlankBlocks.cjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"noBlankBlocks.cjs","names":["
|
|
1
|
+
{"version":3,"file":"noBlankBlocks.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/noBlankBlocks.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n context,\n jsdoc,\n utils,\n}) => {\n if (jsdoc.tags.length) {\n return;\n }\n\n const {\n description,\n lastDescriptionLine,\n } = utils.getDescription();\n if (description.trim()) {\n return;\n }\n\n const {\n enableFixer,\n } = context.options[0] || {};\n\n utils.reportJSDoc(\n 'No empty blocks',\n {\n line: lastDescriptionLine,\n },\n enableFixer ? () => {\n jsdoc.source.splice(0, jsdoc.source.length);\n } : null,\n );\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Removes empty blocks with nothing but possibly line breaks',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-blank-blocks.md#repos-sticky-header',\n },\n fixable: 'code',\n schema: [\n {\n additionalProperties: false,\n properties: {\n enableFixer: {\n type: 'boolean',\n },\n },\n },\n ],\n type: 'suggestion',\n },\n});\n"],"mappings":";;;AAEA,4BAAeA,6BAAa,CAAC,EAC3B,SACA,OACA,OACD,KAAK;AACJ,KAAI,MAAM,KAAK,OACb;CAGF,MAAM,EACJ,aACA,qBACD,GAAG,MAAM,gBAAgB;AAC1B,KAAI,YAAY,MAAM,CACpB;CAGF,MAAM,EACJ,aACD,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAE5B,MAAM,YACJ,mBACA,EACE,MAAM,oBACP,GACD,cAAc,MAAM;EAClB,MAAM,OAAO,OAAO,GAAG,MAAM,OAAO,OAAO;CAC5C,IAAG,KACL;AACF,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,aAAa,EACX,MAAM,UACP,EACF;EACF,CACF;EACD,MAAM;CACP;AACF,EAAC"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import iterateJsdoc from "../iterateJsdoc.js";
|
|
2
|
+
|
|
3
|
+
//#region src/rules/noBlankBlocks.js
|
|
4
|
+
var noBlankBlocks_default = iterateJsdoc(({ context, jsdoc, utils }) => {
|
|
5
|
+
if (jsdoc.tags.length) return;
|
|
6
|
+
const { description, lastDescriptionLine } = utils.getDescription();
|
|
7
|
+
if (description.trim()) return;
|
|
8
|
+
const { enableFixer } = context.options[0] || {};
|
|
9
|
+
utils.reportJSDoc("No empty blocks", { line: lastDescriptionLine }, enableFixer ? () => {
|
|
10
|
+
jsdoc.source.splice(0, jsdoc.source.length);
|
|
11
|
+
} : null);
|
|
12
|
+
}, {
|
|
13
|
+
iterateAllJsdocs: true,
|
|
14
|
+
meta: {
|
|
15
|
+
docs: {
|
|
16
|
+
description: "Removes empty blocks with nothing but possibly line breaks",
|
|
17
|
+
url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-blank-blocks.md#repos-sticky-header"
|
|
18
|
+
},
|
|
19
|
+
fixable: "code",
|
|
20
|
+
schema: [{
|
|
21
|
+
additionalProperties: false,
|
|
22
|
+
properties: { enableFixer: { type: "boolean" } }
|
|
23
|
+
}],
|
|
24
|
+
type: "suggestion"
|
|
25
|
+
}
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
//#endregion
|
|
29
|
+
export { noBlankBlocks_default as default };
|
|
30
|
+
//# sourceMappingURL=noBlankBlocks.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"noBlankBlocks.js","names":[],"sources":["../../src/rules/noBlankBlocks.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n context,\n jsdoc,\n utils,\n}) => {\n if (jsdoc.tags.length) {\n return;\n }\n\n const {\n description,\n lastDescriptionLine,\n } = utils.getDescription();\n if (description.trim()) {\n return;\n }\n\n const {\n enableFixer,\n } = context.options[0] || {};\n\n utils.reportJSDoc(\n 'No empty blocks',\n {\n line: lastDescriptionLine,\n },\n enableFixer ? () => {\n jsdoc.source.splice(0, jsdoc.source.length);\n } : null,\n );\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Removes empty blocks with nothing but possibly line breaks',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-blank-blocks.md#repos-sticky-header',\n },\n fixable: 'code',\n schema: [\n {\n additionalProperties: false,\n properties: {\n enableFixer: {\n type: 'boolean',\n },\n },\n },\n ],\n type: 'suggestion',\n },\n});\n"],"mappings":";;;AAEA,4BAAe,aAAa,CAAC,EAC3B,SACA,OACA,OACD,KAAK;AACJ,KAAI,MAAM,KAAK,OACb;CAGF,MAAM,EACJ,aACA,qBACD,GAAG,MAAM,gBAAgB;AAC1B,KAAI,YAAY,MAAM,CACpB;CAGF,MAAM,EACJ,aACD,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAE5B,MAAM,YACJ,mBACA,EACE,MAAM,oBACP,GACD,cAAc,MAAM;EAClB,MAAM,OAAO,OAAO,GAAG,MAAM,OAAO,OAAO;CAC5C,IAAG,KACL;AACF,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,aAAa,EACX,MAAM,UACP,EACF;EACF,CACF;EACD,MAAM;CACP;AACF,EAAC"}
|
|
@@ -1,83 +1,56 @@
|
|
|
1
|
-
|
|
1
|
+
const require_iterateJsdoc = require('../iterateJsdoc.cjs');
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
}
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
} else if (tag.default) {
|
|
25
|
-
utils.reportJSDoc(`Defaults are not permitted on @${tag.tag}.`, tag, () => {
|
|
26
|
-
utils.changeTag(tag, {
|
|
27
|
-
name: tag.name.replace(/([^=]*)(=.+)?/v, '[$1]')
|
|
28
|
-
});
|
|
29
|
-
});
|
|
30
|
-
}
|
|
31
|
-
}
|
|
32
|
-
const defaultTags = utils.getPresentTags(['default', 'defaultvalue']);
|
|
33
|
-
for (const tag of defaultTags) {
|
|
34
|
-
if (tag.description.trim()) {
|
|
35
|
-
utils.reportJSDoc(`Default values are not permitted on @${tag.tag}.`, tag, () => {
|
|
36
|
-
utils.changeTag(tag, {
|
|
37
|
-
description: '',
|
|
38
|
-
postTag: ''
|
|
39
|
-
});
|
|
40
|
-
});
|
|
41
|
-
}
|
|
42
|
-
}
|
|
3
|
+
//#region src/rules/noDefaults.js
|
|
4
|
+
var noDefaults_default = require_iterateJsdoc.default(({ context, utils }) => {
|
|
5
|
+
const { noOptionalParamNames } = context.options[0] || {};
|
|
6
|
+
const paramTags = utils.getPresentTags([
|
|
7
|
+
"param",
|
|
8
|
+
"arg",
|
|
9
|
+
"argument"
|
|
10
|
+
]);
|
|
11
|
+
for (const tag of paramTags) if (noOptionalParamNames && tag.optional) utils.reportJSDoc(`Optional param names are not permitted on @${tag.tag}.`, tag, () => {
|
|
12
|
+
utils.changeTag(tag, { name: tag.name.replace(/([^=]*)(=.+)?/v, "$1") });
|
|
13
|
+
});
|
|
14
|
+
else if (tag.default) utils.reportJSDoc(`Defaults are not permitted on @${tag.tag}.`, tag, () => {
|
|
15
|
+
utils.changeTag(tag, { name: tag.name.replace(/([^=]*)(=.+)?/v, "[$1]") });
|
|
16
|
+
});
|
|
17
|
+
const defaultTags = utils.getPresentTags(["default", "defaultvalue"]);
|
|
18
|
+
for (const tag of defaultTags) if (tag.description.trim()) utils.reportJSDoc(`Default values are not permitted on @${tag.tag}.`, tag, () => {
|
|
19
|
+
utils.changeTag(tag, {
|
|
20
|
+
description: "",
|
|
21
|
+
postTag: ""
|
|
22
|
+
});
|
|
23
|
+
});
|
|
43
24
|
}, {
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
type: 'array'
|
|
72
|
-
},
|
|
73
|
-
noOptionalParamNames: {
|
|
74
|
-
type: 'boolean'
|
|
75
|
-
}
|
|
76
|
-
},
|
|
77
|
-
type: 'object'
|
|
78
|
-
}],
|
|
79
|
-
type: 'suggestion'
|
|
80
|
-
}
|
|
25
|
+
contextDefaults: true,
|
|
26
|
+
meta: {
|
|
27
|
+
docs: {
|
|
28
|
+
description: "This rule reports defaults being used on the relevant portion of `@param` or `@default`.",
|
|
29
|
+
url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-defaults.md#repos-sticky-header"
|
|
30
|
+
},
|
|
31
|
+
fixable: "code",
|
|
32
|
+
schema: [{
|
|
33
|
+
additionalProperties: false,
|
|
34
|
+
properties: {
|
|
35
|
+
contexts: {
|
|
36
|
+
items: { anyOf: [{ type: "string" }, {
|
|
37
|
+
additionalProperties: false,
|
|
38
|
+
properties: {
|
|
39
|
+
comment: { type: "string" },
|
|
40
|
+
context: { type: "string" }
|
|
41
|
+
},
|
|
42
|
+
type: "object"
|
|
43
|
+
}] },
|
|
44
|
+
type: "array"
|
|
45
|
+
},
|
|
46
|
+
noOptionalParamNames: { type: "boolean" }
|
|
47
|
+
},
|
|
48
|
+
type: "object"
|
|
49
|
+
}],
|
|
50
|
+
type: "suggestion"
|
|
51
|
+
}
|
|
81
52
|
});
|
|
82
|
-
|
|
53
|
+
|
|
54
|
+
//#endregion
|
|
55
|
+
exports.default = noDefaults_default;
|
|
83
56
|
//# sourceMappingURL=noDefaults.cjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"noDefaults.cjs","names":["
|
|
1
|
+
{"version":3,"file":"noDefaults.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/noDefaults.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n context,\n utils,\n}) => {\n const {\n noOptionalParamNames,\n } = context.options[0] || {};\n const paramTags = utils.getPresentTags([\n 'param', 'arg', 'argument',\n ]);\n for (const tag of paramTags) {\n if (noOptionalParamNames && tag.optional) {\n utils.reportJSDoc(`Optional param names are not permitted on @${tag.tag}.`, tag, () => {\n utils.changeTag(tag, {\n name: tag.name.replace(/([^=]*)(=.+)?/v, '$1'),\n });\n });\n } else if (tag.default) {\n utils.reportJSDoc(`Defaults are not permitted on @${tag.tag}.`, tag, () => {\n utils.changeTag(tag, {\n name: tag.name.replace(/([^=]*)(=.+)?/v, '[$1]'),\n });\n });\n }\n }\n\n const defaultTags = utils.getPresentTags([\n 'default', 'defaultvalue',\n ]);\n for (const tag of defaultTags) {\n if (tag.description.trim()) {\n utils.reportJSDoc(`Default values are not permitted on @${tag.tag}.`, tag, () => {\n utils.changeTag(tag, {\n description: '',\n postTag: '',\n });\n });\n }\n }\n}, {\n contextDefaults: true,\n meta: {\n docs: {\n description: 'This rule reports defaults being used on the relevant portion of `@param` or `@default`.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-defaults.md#repos-sticky-header',\n },\n fixable: 'code',\n schema: [\n {\n additionalProperties: false,\n properties: {\n contexts: {\n items: {\n anyOf: [\n {\n type: 'string',\n },\n {\n additionalProperties: false,\n properties: {\n comment: {\n type: 'string',\n },\n context: {\n type: 'string',\n },\n },\n type: 'object',\n },\n ],\n },\n type: 'array',\n },\n noOptionalParamNames: {\n type: 'boolean',\n },\n },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n});\n"],"mappings":";;;AAEA,yBAAeA,6BAAa,CAAC,EAC3B,SACA,OACD,KAAK;CACJ,MAAM,EACJ,sBACD,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAC5B,MAAM,YAAY,MAAM,eAAe;EACrC;EAAS;EAAO;CACjB,EAAC;AACF,MAAK,MAAM,OAAO,UAChB,KAAI,wBAAwB,IAAI,UAC9B,MAAM,YAAY,CAAC,2CAA2C,EAAE,IAAI,IAAI,CAAC,CAAC,EAAE,KAAK,MAAM;EACrF,MAAM,UAAU,KAAK,EACnB,MAAM,IAAI,KAAK,QAAQ,kBAAkB,KAAK,CAC/C,EAAC;CACH,EAAC;UACO,IAAI,SACb,MAAM,YAAY,CAAC,+BAA+B,EAAE,IAAI,IAAI,CAAC,CAAC,EAAE,KAAK,MAAM;EACzE,MAAM,UAAU,KAAK,EACnB,MAAM,IAAI,KAAK,QAAQ,kBAAkB,OAAO,CACjD,EAAC;CACH,EAAC;CAIN,MAAM,cAAc,MAAM,eAAe,CACvC,WAAW,cACZ,EAAC;AACF,MAAK,MAAM,OAAO,YAChB,KAAI,IAAI,YAAY,MAAM,EACxB,MAAM,YAAY,CAAC,qCAAqC,EAAE,IAAI,IAAI,CAAC,CAAC,EAAE,KAAK,MAAM;EAC/E,MAAM,UAAU,KAAK;GACnB,aAAa;GACb,SAAS;EACV,EAAC;CACH,EAAC;AAGP,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,UAAU;KACR,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;MACE,sBAAsB;MACtB,YAAY;OACV,SAAS,EACP,MAAM,SACP;OACD,SAAS,EACP,MAAM,SACP;MACF;MACD,MAAM;KACP,CACF,EACF;KACD,MAAM;IACP;IACD,sBAAsB,EACpB,MAAM,UACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import iterateJsdoc from "../iterateJsdoc.js";
|
|
2
|
+
|
|
3
|
+
//#region src/rules/noDefaults.js
|
|
4
|
+
var noDefaults_default = iterateJsdoc(({ context, utils }) => {
|
|
5
|
+
const { noOptionalParamNames } = context.options[0] || {};
|
|
6
|
+
const paramTags = utils.getPresentTags([
|
|
7
|
+
"param",
|
|
8
|
+
"arg",
|
|
9
|
+
"argument"
|
|
10
|
+
]);
|
|
11
|
+
for (const tag of paramTags) if (noOptionalParamNames && tag.optional) utils.reportJSDoc(`Optional param names are not permitted on @${tag.tag}.`, tag, () => {
|
|
12
|
+
utils.changeTag(tag, { name: tag.name.replace(/([^=]*)(=.+)?/v, "$1") });
|
|
13
|
+
});
|
|
14
|
+
else if (tag.default) utils.reportJSDoc(`Defaults are not permitted on @${tag.tag}.`, tag, () => {
|
|
15
|
+
utils.changeTag(tag, { name: tag.name.replace(/([^=]*)(=.+)?/v, "[$1]") });
|
|
16
|
+
});
|
|
17
|
+
const defaultTags = utils.getPresentTags(["default", "defaultvalue"]);
|
|
18
|
+
for (const tag of defaultTags) if (tag.description.trim()) utils.reportJSDoc(`Default values are not permitted on @${tag.tag}.`, tag, () => {
|
|
19
|
+
utils.changeTag(tag, {
|
|
20
|
+
description: "",
|
|
21
|
+
postTag: ""
|
|
22
|
+
});
|
|
23
|
+
});
|
|
24
|
+
}, {
|
|
25
|
+
contextDefaults: true,
|
|
26
|
+
meta: {
|
|
27
|
+
docs: {
|
|
28
|
+
description: "This rule reports defaults being used on the relevant portion of `@param` or `@default`.",
|
|
29
|
+
url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-defaults.md#repos-sticky-header"
|
|
30
|
+
},
|
|
31
|
+
fixable: "code",
|
|
32
|
+
schema: [{
|
|
33
|
+
additionalProperties: false,
|
|
34
|
+
properties: {
|
|
35
|
+
contexts: {
|
|
36
|
+
items: { anyOf: [{ type: "string" }, {
|
|
37
|
+
additionalProperties: false,
|
|
38
|
+
properties: {
|
|
39
|
+
comment: { type: "string" },
|
|
40
|
+
context: { type: "string" }
|
|
41
|
+
},
|
|
42
|
+
type: "object"
|
|
43
|
+
}] },
|
|
44
|
+
type: "array"
|
|
45
|
+
},
|
|
46
|
+
noOptionalParamNames: { type: "boolean" }
|
|
47
|
+
},
|
|
48
|
+
type: "object"
|
|
49
|
+
}],
|
|
50
|
+
type: "suggestion"
|
|
51
|
+
}
|
|
52
|
+
});
|
|
53
|
+
|
|
54
|
+
//#endregion
|
|
55
|
+
export { noDefaults_default as default };
|
|
56
|
+
//# sourceMappingURL=noDefaults.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"noDefaults.js","names":[],"sources":["../../src/rules/noDefaults.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n context,\n utils,\n}) => {\n const {\n noOptionalParamNames,\n } = context.options[0] || {};\n const paramTags = utils.getPresentTags([\n 'param', 'arg', 'argument',\n ]);\n for (const tag of paramTags) {\n if (noOptionalParamNames && tag.optional) {\n utils.reportJSDoc(`Optional param names are not permitted on @${tag.tag}.`, tag, () => {\n utils.changeTag(tag, {\n name: tag.name.replace(/([^=]*)(=.+)?/v, '$1'),\n });\n });\n } else if (tag.default) {\n utils.reportJSDoc(`Defaults are not permitted on @${tag.tag}.`, tag, () => {\n utils.changeTag(tag, {\n name: tag.name.replace(/([^=]*)(=.+)?/v, '[$1]'),\n });\n });\n }\n }\n\n const defaultTags = utils.getPresentTags([\n 'default', 'defaultvalue',\n ]);\n for (const tag of defaultTags) {\n if (tag.description.trim()) {\n utils.reportJSDoc(`Default values are not permitted on @${tag.tag}.`, tag, () => {\n utils.changeTag(tag, {\n description: '',\n postTag: '',\n });\n });\n }\n }\n}, {\n contextDefaults: true,\n meta: {\n docs: {\n description: 'This rule reports defaults being used on the relevant portion of `@param` or `@default`.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-defaults.md#repos-sticky-header',\n },\n fixable: 'code',\n schema: [\n {\n additionalProperties: false,\n properties: {\n contexts: {\n items: {\n anyOf: [\n {\n type: 'string',\n },\n {\n additionalProperties: false,\n properties: {\n comment: {\n type: 'string',\n },\n context: {\n type: 'string',\n },\n },\n type: 'object',\n },\n ],\n },\n type: 'array',\n },\n noOptionalParamNames: {\n type: 'boolean',\n },\n },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n});\n"],"mappings":";;;AAEA,yBAAe,aAAa,CAAC,EAC3B,SACA,OACD,KAAK;CACJ,MAAM,EACJ,sBACD,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAC5B,MAAM,YAAY,MAAM,eAAe;EACrC;EAAS;EAAO;CACjB,EAAC;AACF,MAAK,MAAM,OAAO,UAChB,KAAI,wBAAwB,IAAI,UAC9B,MAAM,YAAY,CAAC,2CAA2C,EAAE,IAAI,IAAI,CAAC,CAAC,EAAE,KAAK,MAAM;EACrF,MAAM,UAAU,KAAK,EACnB,MAAM,IAAI,KAAK,QAAQ,kBAAkB,KAAK,CAC/C,EAAC;CACH,EAAC;UACO,IAAI,SACb,MAAM,YAAY,CAAC,+BAA+B,EAAE,IAAI,IAAI,CAAC,CAAC,EAAE,KAAK,MAAM;EACzE,MAAM,UAAU,KAAK,EACnB,MAAM,IAAI,KAAK,QAAQ,kBAAkB,OAAO,CACjD,EAAC;CACH,EAAC;CAIN,MAAM,cAAc,MAAM,eAAe,CACvC,WAAW,cACZ,EAAC;AACF,MAAK,MAAM,OAAO,YAChB,KAAI,IAAI,YAAY,MAAM,EACxB,MAAM,YAAY,CAAC,qCAAqC,EAAE,IAAI,IAAI,CAAC,CAAC,EAAE,KAAK,MAAM;EAC/E,MAAM,UAAU,KAAK;GACnB,aAAa;GACb,SAAS;EACV,EAAC;CACH,EAAC;AAGP,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,UAAU;KACR,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;MACE,sBAAsB;MACtB,YAAY;OACV,SAAS,EACP,MAAM,SACP;OACD,SAAS,EACP,MAAM,SACP;MACF;MACD,MAAM;KACP,CACF,EACF;KACD,MAAM;IACP;IACD,sBAAsB,EACpB,MAAM,UACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}
|