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,231 @@
|
|
|
1
|
+
import { enforcedContexts, getContextObject, getIndent } from "../jsdocUtils.js";
|
|
2
|
+
import { getSettings } from "../iterateJsdoc.js";
|
|
3
|
+
import { getDecorator, getFollowingComment, getNonJsdocComment, getReducedASTNode } from "@es-joy/jsdoccomment";
|
|
4
|
+
|
|
5
|
+
//#region src/rules/convertToJsdocComments.js
|
|
6
|
+
/** @type {import('eslint').Rule.RuleModule} */
|
|
7
|
+
var convertToJsdocComments_default = {
|
|
8
|
+
create(context) {
|
|
9
|
+
/**
|
|
10
|
+
* @typedef {import('eslint').AST.Token | import('estree').Comment | {
|
|
11
|
+
* type: import('eslint').AST.TokenType|"Line"|"Block"|"Shebang",
|
|
12
|
+
* range: [number, number],
|
|
13
|
+
* value: string
|
|
14
|
+
* }} Token
|
|
15
|
+
*/
|
|
16
|
+
/**
|
|
17
|
+
* @callback AddComment
|
|
18
|
+
* @param {boolean|undefined} inlineCommentBlock
|
|
19
|
+
* @param {Token} comment
|
|
20
|
+
* @param {string} indent
|
|
21
|
+
* @param {number} lines
|
|
22
|
+
* @param {import('eslint').Rule.RuleFixer} fixer
|
|
23
|
+
*/
|
|
24
|
+
/* c8 ignore next -- Fallback to deprecated method */
|
|
25
|
+
const { sourceCode = context.getSourceCode() } = context;
|
|
26
|
+
const settings = getSettings(context);
|
|
27
|
+
if (!settings) return {};
|
|
28
|
+
const { allowedPrefixes = [
|
|
29
|
+
"@ts-",
|
|
30
|
+
"istanbul ",
|
|
31
|
+
"c8 ",
|
|
32
|
+
"v8 ",
|
|
33
|
+
"eslint",
|
|
34
|
+
"prettier-"
|
|
35
|
+
], contexts = settings.contexts || [], contextsAfter = [], contextsBeforeAndAfter = [
|
|
36
|
+
"VariableDeclarator",
|
|
37
|
+
"TSPropertySignature",
|
|
38
|
+
"PropertyDefinition"
|
|
39
|
+
], enableFixer = true, enforceJsdocLineStyle = "multi", lineOrBlockStyle = "both" } = context.options[0] ?? {};
|
|
40
|
+
let reportingNonJsdoc = false;
|
|
41
|
+
/**
|
|
42
|
+
* @param {string} messageId
|
|
43
|
+
* @param {import('estree').Comment|Token} comment
|
|
44
|
+
* @param {import('eslint').Rule.Node} node
|
|
45
|
+
* @param {import('eslint').Rule.ReportFixer} fixer
|
|
46
|
+
*/
|
|
47
|
+
const report = (messageId, comment, node, fixer) => {
|
|
48
|
+
const loc = {
|
|
49
|
+
end: {
|
|
50
|
+
column: 0,
|
|
51
|
+
line: comment.loc?.start?.line ?? 1
|
|
52
|
+
},
|
|
53
|
+
start: {
|
|
54
|
+
column: 0,
|
|
55
|
+
line: comment.loc?.start?.line ?? 1
|
|
56
|
+
}
|
|
57
|
+
};
|
|
58
|
+
context.report({
|
|
59
|
+
fix: enableFixer ? fixer : null,
|
|
60
|
+
loc,
|
|
61
|
+
messageId,
|
|
62
|
+
node
|
|
63
|
+
});
|
|
64
|
+
};
|
|
65
|
+
/**
|
|
66
|
+
* @param {import('eslint').Rule.Node} node
|
|
67
|
+
* @param {import('eslint').AST.Token | import('estree').Comment | {
|
|
68
|
+
* type: import('eslint').AST.TokenType|"Line"|"Block"|"Shebang",
|
|
69
|
+
* range: [number, number],
|
|
70
|
+
* value: string
|
|
71
|
+
* }} comment
|
|
72
|
+
* @param {AddComment} addComment
|
|
73
|
+
* @param {import('../iterateJsdoc.js').Context[]} ctxts
|
|
74
|
+
*/
|
|
75
|
+
const getFixer = (node, comment, addComment, ctxts) => {
|
|
76
|
+
return (fixer) => {
|
|
77
|
+
const lines = settings.minLines === 0 && settings.maxLines >= 1 ? 1 : settings.minLines;
|
|
78
|
+
let baseNode = getReducedASTNode(node, sourceCode);
|
|
79
|
+
const decorator = getDecorator(baseNode);
|
|
80
|
+
if (decorator) baseNode = decorator;
|
|
81
|
+
const indent = getIndent({ text: sourceCode.getText(
|
|
82
|
+
baseNode,
|
|
83
|
+
/** @type {import('eslint').AST.SourceLocation} */
|
|
84
|
+
baseNode.loc.start.column
|
|
85
|
+
) });
|
|
86
|
+
const { inlineCommentBlock } = ctxts.find((contxt) => {
|
|
87
|
+
if (typeof contxt === "string") return false;
|
|
88
|
+
const { context: ctxt } = contxt;
|
|
89
|
+
return ctxt === node.type;
|
|
90
|
+
}) || {};
|
|
91
|
+
return addComment(inlineCommentBlock, comment, indent, lines, fixer);
|
|
92
|
+
};
|
|
93
|
+
};
|
|
94
|
+
/**
|
|
95
|
+
* @param {import('eslint').AST.Token | import('estree').Comment | {
|
|
96
|
+
* type: import('eslint').AST.TokenType|"Line"|"Block"|"Shebang",
|
|
97
|
+
* range: [number, number],
|
|
98
|
+
* value: string
|
|
99
|
+
* }} comment
|
|
100
|
+
* @param {import('eslint').Rule.Node} node
|
|
101
|
+
* @param {AddComment} addComment
|
|
102
|
+
* @param {import('../iterateJsdoc.js').Context[]} ctxts
|
|
103
|
+
*/
|
|
104
|
+
const reportings = (comment, node, addComment, ctxts) => {
|
|
105
|
+
const fixer = getFixer(node, comment, addComment, ctxts);
|
|
106
|
+
if (comment.type === "Block") {
|
|
107
|
+
if (lineOrBlockStyle === "line") return;
|
|
108
|
+
report("blockCommentsJsdocStyle", comment, node, fixer);
|
|
109
|
+
return;
|
|
110
|
+
}
|
|
111
|
+
if (comment.type === "Line") {
|
|
112
|
+
if (lineOrBlockStyle === "block") return;
|
|
113
|
+
report("lineCommentsJsdocStyle", comment, node, fixer);
|
|
114
|
+
}
|
|
115
|
+
};
|
|
116
|
+
/**
|
|
117
|
+
* @type {import('../iterateJsdoc.js').CheckJsdoc}
|
|
118
|
+
*/
|
|
119
|
+
const checkNonJsdoc = (_info, _handler, node) => {
|
|
120
|
+
const comment = getNonJsdocComment(sourceCode, node, settings);
|
|
121
|
+
if (!comment || allowedPrefixes.some((prefix) => {
|
|
122
|
+
return comment.value.trimStart().startsWith(prefix);
|
|
123
|
+
})) return;
|
|
124
|
+
reportingNonJsdoc = true;
|
|
125
|
+
/** @type {AddComment} */
|
|
126
|
+
const addComment = (inlineCommentBlock, commentToAdd, indent, lines, fixer) => {
|
|
127
|
+
const insertion = (inlineCommentBlock || enforceJsdocLineStyle === "single" ? `/** ${commentToAdd.value.trim()} ` : `/**\n${indent}*${commentToAdd.value.trimEnd()}\n${indent}`) + `*/${"\n".repeat((lines || 1) - 1)}`;
|
|
128
|
+
return fixer.replaceText(commentToAdd, insertion);
|
|
129
|
+
};
|
|
130
|
+
reportings(comment, node, addComment, contexts);
|
|
131
|
+
};
|
|
132
|
+
/**
|
|
133
|
+
* @param {import('eslint').Rule.Node} node
|
|
134
|
+
* @param {import('../iterateJsdoc.js').Context[]} ctxts
|
|
135
|
+
*/
|
|
136
|
+
const checkNonJsdocAfter = (node, ctxts) => {
|
|
137
|
+
const comment = getFollowingComment(sourceCode, node);
|
|
138
|
+
if (!comment || comment.value.startsWith("*") || allowedPrefixes.some((prefix) => {
|
|
139
|
+
return comment.value.trimStart().startsWith(prefix);
|
|
140
|
+
})) return;
|
|
141
|
+
/** @type {AddComment} */
|
|
142
|
+
const addComment = (inlineCommentBlock, commentToAdd, indent, lines, fixer) => {
|
|
143
|
+
const insertion = (inlineCommentBlock || enforceJsdocLineStyle === "single" ? `/** ${commentToAdd.value.trim()} ` : `/**\n${indent}*${commentToAdd.value.trimEnd()}\n${indent}`) + `*/${"\n".repeat((lines || 1) - 1)}${lines ? `\n${indent.slice(1)}` : " "}`;
|
|
144
|
+
return [fixer.remove(commentToAdd), fixer.insertTextBefore(node.type === "VariableDeclarator" ? node.parent : node, insertion)];
|
|
145
|
+
};
|
|
146
|
+
reportings(comment, node, addComment, ctxts);
|
|
147
|
+
};
|
|
148
|
+
return {
|
|
149
|
+
...getContextObject(enforcedContexts(context, true, settings), checkNonJsdoc),
|
|
150
|
+
...getContextObject(contextsAfter, (_info, _handler, node) => {
|
|
151
|
+
checkNonJsdocAfter(node, contextsAfter);
|
|
152
|
+
}),
|
|
153
|
+
...getContextObject(contextsBeforeAndAfter, (_info, _handler, node) => {
|
|
154
|
+
checkNonJsdoc({}, null, node);
|
|
155
|
+
if (!reportingNonJsdoc) checkNonJsdocAfter(node, contextsBeforeAndAfter);
|
|
156
|
+
})
|
|
157
|
+
};
|
|
158
|
+
},
|
|
159
|
+
meta: {
|
|
160
|
+
docs: {
|
|
161
|
+
description: "Converts non-JSDoc comments preceding or following nodes into JSDoc ones",
|
|
162
|
+
url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/convert-to-jsdoc-comments.md#repos-sticky-header"
|
|
163
|
+
},
|
|
164
|
+
fixable: "code",
|
|
165
|
+
messages: {
|
|
166
|
+
blockCommentsJsdocStyle: "Block comments should be JSDoc-style.",
|
|
167
|
+
lineCommentsJsdocStyle: "Line comments should be JSDoc-style."
|
|
168
|
+
},
|
|
169
|
+
schema: [{
|
|
170
|
+
additionalProperties: false,
|
|
171
|
+
properties: {
|
|
172
|
+
allowedPrefixes: {
|
|
173
|
+
items: { type: "string" },
|
|
174
|
+
type: "array"
|
|
175
|
+
},
|
|
176
|
+
contexts: {
|
|
177
|
+
items: { anyOf: [{ type: "string" }, {
|
|
178
|
+
additionalProperties: false,
|
|
179
|
+
properties: {
|
|
180
|
+
context: { type: "string" },
|
|
181
|
+
inlineCommentBlock: { type: "boolean" }
|
|
182
|
+
},
|
|
183
|
+
type: "object"
|
|
184
|
+
}] },
|
|
185
|
+
type: "array"
|
|
186
|
+
},
|
|
187
|
+
contextsAfter: {
|
|
188
|
+
items: { anyOf: [{ type: "string" }, {
|
|
189
|
+
additionalProperties: false,
|
|
190
|
+
properties: {
|
|
191
|
+
context: { type: "string" },
|
|
192
|
+
inlineCommentBlock: { type: "boolean" }
|
|
193
|
+
},
|
|
194
|
+
type: "object"
|
|
195
|
+
}] },
|
|
196
|
+
type: "array"
|
|
197
|
+
},
|
|
198
|
+
contextsBeforeAndAfter: {
|
|
199
|
+
items: { anyOf: [{ type: "string" }, {
|
|
200
|
+
additionalProperties: false,
|
|
201
|
+
properties: {
|
|
202
|
+
context: { type: "string" },
|
|
203
|
+
inlineCommentBlock: { type: "boolean" }
|
|
204
|
+
},
|
|
205
|
+
type: "object"
|
|
206
|
+
}] },
|
|
207
|
+
type: "array"
|
|
208
|
+
},
|
|
209
|
+
enableFixer: { type: "boolean" },
|
|
210
|
+
enforceJsdocLineStyle: {
|
|
211
|
+
enum: ["multi", "single"],
|
|
212
|
+
type: "string"
|
|
213
|
+
},
|
|
214
|
+
lineOrBlockStyle: {
|
|
215
|
+
enum: [
|
|
216
|
+
"block",
|
|
217
|
+
"line",
|
|
218
|
+
"both"
|
|
219
|
+
],
|
|
220
|
+
type: "string"
|
|
221
|
+
}
|
|
222
|
+
},
|
|
223
|
+
type: "object"
|
|
224
|
+
}],
|
|
225
|
+
type: "suggestion"
|
|
226
|
+
}
|
|
227
|
+
};
|
|
228
|
+
|
|
229
|
+
//#endregion
|
|
230
|
+
export { convertToJsdocComments_default as default };
|
|
231
|
+
//# sourceMappingURL=convertToJsdocComments.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"convertToJsdocComments.js","names":[],"sources":["../../src/rules/convertToJsdocComments.js"],"sourcesContent":["import {\n getSettings,\n} from '../iterateJsdoc.js';\nimport {\n enforcedContexts,\n getContextObject,\n getIndent,\n} from '../jsdocUtils.js';\nimport {\n getDecorator,\n getFollowingComment,\n getNonJsdocComment,\n getReducedASTNode,\n} from '@es-joy/jsdoccomment';\n\n/** @type {import('eslint').Rule.RuleModule} */\nexport default {\n create (context) {\n /**\n * @typedef {import('eslint').AST.Token | import('estree').Comment | {\n * type: import('eslint').AST.TokenType|\"Line\"|\"Block\"|\"Shebang\",\n * range: [number, number],\n * value: string\n * }} Token\n */\n\n /**\n * @callback AddComment\n * @param {boolean|undefined} inlineCommentBlock\n * @param {Token} comment\n * @param {string} indent\n * @param {number} lines\n * @param {import('eslint').Rule.RuleFixer} fixer\n */\n\n /* c8 ignore next -- Fallback to deprecated method */\n const {\n sourceCode = context.getSourceCode(),\n } = context;\n const settings = getSettings(context);\n if (!settings) {\n return {};\n }\n\n const {\n allowedPrefixes = [\n '@ts-', 'istanbul ', 'c8 ', 'v8 ', 'eslint', 'prettier-',\n ],\n contexts = settings.contexts || [],\n contextsAfter = /** @type {string[]} */ ([]),\n contextsBeforeAndAfter = [\n 'VariableDeclarator', 'TSPropertySignature', 'PropertyDefinition',\n ],\n enableFixer = true,\n enforceJsdocLineStyle = 'multi',\n lineOrBlockStyle = 'both',\n } = context.options[0] ?? {};\n\n let reportingNonJsdoc = false;\n\n /**\n * @param {string} messageId\n * @param {import('estree').Comment|Token} comment\n * @param {import('eslint').Rule.Node} node\n * @param {import('eslint').Rule.ReportFixer} fixer\n */\n const report = (messageId, comment, node, fixer) => {\n const loc = {\n end: {\n column: 0,\n /* c8 ignore next 2 -- Guard */\n // @ts-expect-error Ok\n line: (comment.loc?.start?.line ?? 1),\n },\n start: {\n column: 0,\n /* c8 ignore next 2 -- Guard */\n // @ts-expect-error Ok\n line: (comment.loc?.start?.line ?? 1),\n },\n };\n\n context.report({\n fix: enableFixer ? fixer : null,\n loc,\n messageId,\n node,\n });\n };\n\n /**\n * @param {import('eslint').Rule.Node} node\n * @param {import('eslint').AST.Token | import('estree').Comment | {\n * type: import('eslint').AST.TokenType|\"Line\"|\"Block\"|\"Shebang\",\n * range: [number, number],\n * value: string\n * }} comment\n * @param {AddComment} addComment\n * @param {import('../iterateJsdoc.js').Context[]} ctxts\n */\n const getFixer = (node, comment, addComment, ctxts) => {\n return /** @type {import('eslint').Rule.ReportFixer} */ (fixer) => {\n // Default to one line break if the `minLines`/`maxLines` settings allow\n const lines = settings.minLines === 0 && settings.maxLines >= 1 ? 1 : settings.minLines;\n let baseNode =\n /**\n * @type {import('@typescript-eslint/types').TSESTree.Node|import('eslint').Rule.Node}\n */ (\n getReducedASTNode(node, sourceCode)\n );\n\n const decorator = getDecorator(\n /** @type {import('eslint').Rule.Node} */\n (baseNode),\n );\n if (decorator) {\n baseNode = /** @type {import('@typescript-eslint/types').TSESTree.Decorator} */ (\n decorator\n );\n }\n\n const indent = getIndent({\n text: sourceCode.getText(\n /** @type {import('eslint').Rule.Node} */ (baseNode),\n /** @type {import('eslint').AST.SourceLocation} */\n (\n /** @type {import('eslint').Rule.Node} */ (baseNode).loc\n ).start.column,\n ),\n });\n\n const {\n inlineCommentBlock,\n } =\n /**\n * @type {{\n * context: string,\n * inlineCommentBlock: boolean,\n * minLineCount: import('../iterateJsdoc.js').Integer\n * }[]}\n */ (ctxts).find((contxt) => {\n if (typeof contxt === 'string') {\n return false;\n }\n\n const {\n context: ctxt,\n } = contxt;\n return ctxt === node.type;\n }) || {};\n\n return addComment(inlineCommentBlock, comment, indent, lines, fixer);\n };\n };\n\n /**\n * @param {import('eslint').AST.Token | import('estree').Comment | {\n * type: import('eslint').AST.TokenType|\"Line\"|\"Block\"|\"Shebang\",\n * range: [number, number],\n * value: string\n * }} comment\n * @param {import('eslint').Rule.Node} node\n * @param {AddComment} addComment\n * @param {import('../iterateJsdoc.js').Context[]} ctxts\n */\n const reportings = (comment, node, addComment, ctxts) => {\n const fixer = getFixer(node, comment, addComment, ctxts);\n\n if (comment.type === 'Block') {\n if (lineOrBlockStyle === 'line') {\n return;\n }\n\n report('blockCommentsJsdocStyle', comment, node, fixer);\n return;\n }\n\n if (comment.type === 'Line') {\n if (lineOrBlockStyle === 'block') {\n return;\n }\n\n report('lineCommentsJsdocStyle', comment, node, fixer);\n }\n };\n\n /**\n * @type {import('../iterateJsdoc.js').CheckJsdoc}\n */\n const checkNonJsdoc = (_info, _handler, node) => {\n const comment = getNonJsdocComment(sourceCode, node, settings);\n\n if (\n !comment ||\n /** @type {string[]} */\n (allowedPrefixes).some((prefix) => {\n return comment.value.trimStart().startsWith(prefix);\n })\n ) {\n return;\n }\n\n reportingNonJsdoc = true;\n\n /** @type {AddComment} */\n // eslint-disable-next-line unicorn/consistent-function-scoping -- Avoid conflicts\n const addComment = (inlineCommentBlock, commentToAdd, indent, lines, fixer) => {\n const insertion = (\n inlineCommentBlock || enforceJsdocLineStyle === 'single' ?\n `/** ${commentToAdd.value.trim()} ` :\n `/**\\n${indent}*${commentToAdd.value.trimEnd()}\\n${indent}`\n ) +\n `*/${'\\n'.repeat((lines || 1) - 1)}`;\n\n return fixer.replaceText(\n /** @type {import('eslint').AST.Token} */\n (commentToAdd),\n insertion,\n );\n };\n\n reportings(comment, node, addComment, contexts);\n };\n\n /**\n * @param {import('eslint').Rule.Node} node\n * @param {import('../iterateJsdoc.js').Context[]} ctxts\n */\n const checkNonJsdocAfter = (node, ctxts) => {\n const comment = getFollowingComment(sourceCode, node);\n\n if (\n !comment ||\n comment.value.startsWith('*') ||\n /** @type {string[]} */\n (allowedPrefixes).some((prefix) => {\n return comment.value.trimStart().startsWith(prefix);\n })\n ) {\n return;\n }\n\n /** @type {AddComment} */\n const addComment = (inlineCommentBlock, commentToAdd, indent, lines, fixer) => {\n const insertion = (\n inlineCommentBlock || enforceJsdocLineStyle === 'single' ?\n `/** ${commentToAdd.value.trim()} ` :\n `/**\\n${indent}*${commentToAdd.value.trimEnd()}\\n${indent}`\n ) +\n `*/${'\\n'.repeat((lines || 1) - 1)}${lines ? `\\n${indent.slice(1)}` : ' '}`;\n\n return [\n fixer.remove(\n /** @type {import('eslint').AST.Token} */\n (commentToAdd),\n ), fixer.insertTextBefore(\n node.type === 'VariableDeclarator' ? node.parent : node,\n insertion,\n ),\n ];\n };\n\n reportings(comment, node, addComment, ctxts);\n };\n\n // Todo: add contexts to check after (and handle if want both before and after)\n return {\n ...getContextObject(\n enforcedContexts(context, true, settings),\n checkNonJsdoc,\n ),\n ...getContextObject(\n contextsAfter,\n (_info, _handler, node) => {\n checkNonJsdocAfter(node, contextsAfter);\n },\n ),\n ...getContextObject(\n contextsBeforeAndAfter,\n (_info, _handler, node) => {\n checkNonJsdoc({}, null, node);\n if (!reportingNonJsdoc) {\n checkNonJsdocAfter(node, contextsBeforeAndAfter);\n }\n },\n ),\n };\n },\n meta: {\n docs: {\n description: 'Converts non-JSDoc comments preceding or following nodes into JSDoc ones',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/convert-to-jsdoc-comments.md#repos-sticky-header',\n },\n\n fixable: 'code',\n\n messages: {\n blockCommentsJsdocStyle: 'Block comments should be JSDoc-style.',\n lineCommentsJsdocStyle: 'Line comments should be JSDoc-style.',\n },\n schema: [\n {\n additionalProperties: false,\n properties: {\n allowedPrefixes: {\n items: {\n type: 'string',\n },\n type: 'array',\n },\n contexts: {\n items: {\n anyOf: [\n {\n type: 'string',\n },\n {\n additionalProperties: false,\n properties: {\n context: {\n type: 'string',\n },\n inlineCommentBlock: {\n type: 'boolean',\n },\n },\n type: 'object',\n },\n ],\n },\n type: 'array',\n },\n contextsAfter: {\n items: {\n anyOf: [\n {\n type: 'string',\n },\n {\n additionalProperties: false,\n properties: {\n context: {\n type: 'string',\n },\n inlineCommentBlock: {\n type: 'boolean',\n },\n },\n type: 'object',\n },\n ],\n },\n type: 'array',\n },\n contextsBeforeAndAfter: {\n items: {\n anyOf: [\n {\n type: 'string',\n },\n {\n additionalProperties: false,\n properties: {\n context: {\n type: 'string',\n },\n inlineCommentBlock: {\n type: 'boolean',\n },\n },\n type: 'object',\n },\n ],\n },\n type: 'array',\n },\n enableFixer: {\n type: 'boolean',\n },\n enforceJsdocLineStyle: {\n enum: [\n 'multi', 'single',\n ],\n type: 'string',\n },\n lineOrBlockStyle: {\n enum: [\n 'block', 'line', 'both',\n ],\n type: 'string',\n },\n },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n};\n"],"mappings":";;;;;;AAgBA,qCAAe;CACb,OAAQ,SAAS;;;;;;;;;;;;;;;;;EAmBf,MAAM,EACJ,aAAa,QAAQ,eAAe,EACrC,GAAG;EACJ,MAAM,WAAW,YAAY,QAAQ;AACrC,MAAI,CAAC,SACH,QAAO,CAAE;EAGX,MAAM,EACJ,kBAAkB;GAChB;GAAQ;GAAa;GAAO;GAAO;GAAU;EAC9C,GACD,WAAW,SAAS,YAAY,CAAE,GAClC,gBAAyC,CAAE,GAC3C,yBAAyB;GACvB;GAAsB;GAAuB;EAC9C,GACD,cAAc,MACd,wBAAwB,SACxB,mBAAmB,QACpB,GAAG,QAAQ,QAAQ,MAAM,CAAE;EAE5B,IAAI,oBAAoB;;;;;;;EAQxB,MAAM,SAAS,CAAC,WAAW,SAAS,MAAM,UAAU;GAClD,MAAM,MAAM;IACV,KAAK;KACH,QAAQ;KAGR,MAAO,QAAQ,KAAK,OAAO,QAAQ;IACpC;IACD,OAAO;KACL,QAAQ;KAGR,MAAO,QAAQ,KAAK,OAAO,QAAQ;IACpC;GACF;GAED,QAAQ,OAAO;IACb,KAAK,cAAc,QAAQ;IAC3B;IACA;IACA;GACD,EAAC;EACH;;;;;;;;;;;EAYD,MAAM,WAAW,CAAC,MAAM,SAAS,YAAY,UAAU;AACrD,UAAwD,CAAC,UAAU;IAEjE,MAAM,QAAQ,SAAS,aAAa,KAAK,SAAS,YAAY,IAAI,IAAI,SAAS;IAC/E,IAAI,WAIA,kBAAkB,MAAM,WAAW;IAGvC,MAAM,YAAY,aAEf,SACF;AACD,QAAI,WACF,WACE;IAIJ,MAAM,SAAS,UAAU,EACvB,MAAM,WAAW;KAC4B;;KAGE,SAAU,IACrD,MAAM;KACT,CACF,EAAC;IAEF,MAAM,EACJ,oBACD,GAOM,MAAO,KAAK,CAAC,WAAW;AAC3B,SAAI,OAAO,WAAW,SACpB,QAAO;KAGT,MAAM,EACJ,SAAS,MACV,GAAG;AACJ,YAAO,SAAS,KAAK;IACtB,EAAC,IAAI,CAAE;AAEV,WAAO,WAAW,oBAAoB,SAAS,QAAQ,OAAO,MAAM;GACrE;EACF;;;;;;;;;;;EAYD,MAAM,aAAa,CAAC,SAAS,MAAM,YAAY,UAAU;GACvD,MAAM,QAAQ,SAAS,MAAM,SAAS,YAAY,MAAM;AAExD,OAAI,QAAQ,SAAS,SAAS;AAC5B,QAAI,qBAAqB,OACvB;IAGF,OAAO,2BAA2B,SAAS,MAAM,MAAM;AACvD;GACD;AAED,OAAI,QAAQ,SAAS,QAAQ;AAC3B,QAAI,qBAAqB,QACvB;IAGF,OAAO,0BAA0B,SAAS,MAAM,MAAM;GACvD;EACF;;;;EAKD,MAAM,gBAAgB,CAAC,OAAO,UAAU,SAAS;GAC/C,MAAM,UAAU,mBAAmB,YAAY,MAAM,SAAS;AAE9D,OACE,CAAC,WAEA,gBAAiB,KAAK,CAAC,WAAW;AACjC,WAAO,QAAQ,MAAM,WAAW,CAAC,WAAW,OAAO;GACpD,EAAC,CAEF;GAGF,oBAAoB;;GAIpB,MAAM,aAAa,CAAC,oBAAoB,cAAc,QAAQ,OAAO,UAAU;IAC7E,MAAM,aACJ,sBAAsB,0BAA0B,WAC9C,CAAC,IAAI,EAAE,aAAa,MAAM,MAAM,CAAC,CAAC,CAAC,GACnC,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,aAAa,MAAM,SAAS,CAAC,EAAE,EAAE,QAAQ,IAE3D,CAAC,EAAE,EAAE,KAAK,QAAQ,SAAS,KAAK,EAAE,EAAE;AAExC,WAAO,MAAM,YAEV,cACD,UACD;GACF;GAED,WAAW,SAAS,MAAM,YAAY,SAAS;EAChD;;;;;EAMD,MAAM,qBAAqB,CAAC,MAAM,UAAU;GAC1C,MAAM,UAAU,oBAAoB,YAAY,KAAK;AAErD,OACE,CAAC,WACD,QAAQ,MAAM,WAAW,IAAI,IAE5B,gBAAiB,KAAK,CAAC,WAAW;AACjC,WAAO,QAAQ,MAAM,WAAW,CAAC,WAAW,OAAO;GACpD,EAAC,CAEF;;GAIF,MAAM,aAAa,CAAC,oBAAoB,cAAc,QAAQ,OAAO,UAAU;IAC7E,MAAM,aACJ,sBAAsB,0BAA0B,WAC9C,CAAC,IAAI,EAAE,aAAa,MAAM,MAAM,CAAC,CAAC,CAAC,GACnC,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,aAAa,MAAM,SAAS,CAAC,EAAE,EAAE,QAAQ,IAE3D,CAAC,EAAE,EAAE,KAAK,QAAQ,SAAS,KAAK,EAAE,GAAG,QAAQ,CAAC,EAAE,EAAE,OAAO,MAAM,EAAE,EAAE,GAAG,KAAK;AAE/E,WAAO,CACL,MAAM,OAEH,aACF,EAAE,MAAM,iBACP,KAAK,SAAS,uBAAuB,KAAK,SAAS,MACnD,UACD,AACF;GACF;GAED,WAAW,SAAS,MAAM,YAAY,MAAM;EAC7C;AAGD,SAAO;GACL,GAAG,iBACD,iBAAiB,SAAS,MAAM,SAAS,EACzC,cACD;GACD,GAAG,iBACD,eACA,CAAC,OAAO,UAAU,SAAS;IACzB,mBAAmB,MAAM,cAAc;GACxC,EACF;GACD,GAAG,iBACD,wBACA,CAAC,OAAO,UAAU,SAAS;IACzB,cAAc,CAAE,GAAE,MAAM,KAAK;AAC7B,QAAI,CAAC,mBACH,mBAAmB,MAAM,uBAAuB;GAEnD,EACF;EACF;CACF;CACD,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EAED,SAAS;EAET,UAAU;GACR,yBAAyB;GACzB,wBAAwB;EACzB;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,iBAAiB;KACf,OAAO,EACL,MAAM,SACP;KACD,MAAM;IACP;IACD,UAAU;KACR,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;MACE,sBAAsB;MACtB,YAAY;OACV,SAAS,EACP,MAAM,SACP;OACD,oBAAoB,EAClB,MAAM,UACP;MACF;MACD,MAAM;KACP,CACF,EACF;KACD,MAAM;IACP;IACD,eAAe;KACb,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;MACE,sBAAsB;MACtB,YAAY;OACV,SAAS,EACP,MAAM,SACP;OACD,oBAAoB,EAClB,MAAM,UACP;MACF;MACD,MAAM;KACP,CACF,EACF;KACD,MAAM;IACP;IACD,wBAAwB;KACtB,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;MACE,sBAAsB;MACtB,YAAY;OACV,SAAS,EACP,MAAM,SACP;OACD,oBAAoB,EAClB,MAAM,UACP;MACF;MACD,MAAM;KACP,CACF,EACF;KACD,MAAM;IACP;IACD,aAAa,EACX,MAAM,UACP;IACD,uBAAuB;KACrB,MAAM,CACJ,SAAS,QACV;KACD,MAAM;IACP;IACD,kBAAkB;KAChB,MAAM;MACJ;MAAS;MAAQ;KAClB;KACD,MAAM;IACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF"}
|
package/dist/rules/emptyTags.cjs
CHANGED
|
@@ -1,77 +1,67 @@
|
|
|
1
|
-
|
|
1
|
+
const require_iterateJsdoc = require('../iterateJsdoc.cjs');
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
3
|
+
//#region src/rules/emptyTags.js
|
|
4
|
+
const defaultEmptyTags = new Set([
|
|
5
|
+
"abstract",
|
|
6
|
+
"async",
|
|
7
|
+
"generator",
|
|
8
|
+
"global",
|
|
9
|
+
"hideconstructor",
|
|
10
|
+
"ignore",
|
|
11
|
+
"inheritDoc",
|
|
12
|
+
"inner",
|
|
13
|
+
"instance",
|
|
14
|
+
"internal",
|
|
15
|
+
"overload",
|
|
16
|
+
"override",
|
|
17
|
+
"readonly"
|
|
18
|
+
]);
|
|
15
19
|
const emptyIfNotClosure = new Set([
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
// By time of call in fixer, `tag` will have `line` added
|
|
40
|
-
utils.setTag(
|
|
41
|
-
/**
|
|
42
|
-
* @type {import('comment-parser').Spec & {
|
|
43
|
-
* line: import('../iterateJsdoc.js').Integer
|
|
44
|
-
* }}
|
|
45
|
-
*/
|
|
46
|
-
tag);
|
|
47
|
-
};
|
|
48
|
-
utils.reportJSDoc(`@${tag.tag} should be empty.`, tag, fix, true);
|
|
49
|
-
}
|
|
50
|
-
}
|
|
20
|
+
"inheritdoc",
|
|
21
|
+
"package",
|
|
22
|
+
"private",
|
|
23
|
+
"protected",
|
|
24
|
+
"public",
|
|
25
|
+
"static"
|
|
26
|
+
]);
|
|
27
|
+
const emptyIfClosure = new Set(["interface"]);
|
|
28
|
+
var emptyTags_default = require_iterateJsdoc.default(({ jsdoc, settings, utils }) => {
|
|
29
|
+
const emptyTags = utils.filterTags(({ tag: tagName }) => {
|
|
30
|
+
return defaultEmptyTags.has(tagName) || utils.hasOptionTag(tagName) && jsdoc.tags.some(({ tag }) => {
|
|
31
|
+
return tag === tagName;
|
|
32
|
+
}) || settings.mode === "closure" && emptyIfClosure.has(tagName) || settings.mode !== "closure" && emptyIfNotClosure.has(tagName);
|
|
33
|
+
});
|
|
34
|
+
for (const [key, tag] of emptyTags.entries()) {
|
|
35
|
+
const content = tag.name || tag.description || tag.type;
|
|
36
|
+
if (content.trim() && (key !== emptyTags.length - 1 || !/^\s*\*+$/v.test(content))) {
|
|
37
|
+
const fix = () => {
|
|
38
|
+
utils.setTag(tag);
|
|
39
|
+
};
|
|
40
|
+
utils.reportJSDoc(`@${tag.tag} should be empty.`, tag, fix, true);
|
|
41
|
+
}
|
|
42
|
+
}
|
|
51
43
|
}, {
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
type: 'object'
|
|
72
|
-
}],
|
|
73
|
-
type: 'suggestion'
|
|
74
|
-
}
|
|
44
|
+
checkInternal: true,
|
|
45
|
+
checkPrivate: true,
|
|
46
|
+
iterateAllJsdocs: true,
|
|
47
|
+
meta: {
|
|
48
|
+
docs: {
|
|
49
|
+
description: "Expects specific tags to be empty of any content.",
|
|
50
|
+
url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/empty-tags.md#repos-sticky-header"
|
|
51
|
+
},
|
|
52
|
+
fixable: "code",
|
|
53
|
+
schema: [{
|
|
54
|
+
additionalProperties: false,
|
|
55
|
+
properties: { tags: {
|
|
56
|
+
items: { type: "string" },
|
|
57
|
+
type: "array"
|
|
58
|
+
} },
|
|
59
|
+
type: "object"
|
|
60
|
+
}],
|
|
61
|
+
type: "suggestion"
|
|
62
|
+
}
|
|
75
63
|
});
|
|
76
|
-
|
|
64
|
+
|
|
65
|
+
//#endregion
|
|
66
|
+
exports.default = emptyTags_default;
|
|
77
67
|
//# sourceMappingURL=emptyTags.cjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"emptyTags.cjs","names":["
|
|
1
|
+
{"version":3,"file":"emptyTags.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/emptyTags.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nconst defaultEmptyTags = new Set([\n 'abstract', 'async', 'generator', 'global', 'hideconstructor',\n\n // jsdoc doesn't use this form in its docs, but allow for compatibility with\n // TypeScript which allows and Closure which requires\n 'ignore',\n\n // jsdoc doesn't use but allow for TypeScript\n 'inheritDoc', 'inner', 'instance',\n 'internal',\n\n 'overload',\n\n 'override',\n 'readonly',\n]);\n\nconst emptyIfNotClosure = new Set([\n // Closure doesn't allow with this casing\n 'inheritdoc', 'package', 'private', 'protected', 'public',\n\n 'static',\n]);\n\nconst emptyIfClosure = new Set([\n 'interface',\n]);\n\nexport default iterateJsdoc(({\n jsdoc,\n settings,\n utils,\n}) => {\n const emptyTags = utils.filterTags(({\n tag: tagName,\n }) => {\n return defaultEmptyTags.has(tagName) ||\n utils.hasOptionTag(tagName) && jsdoc.tags.some(({\n tag,\n }) => {\n return tag === tagName;\n }) ||\n settings.mode === 'closure' && emptyIfClosure.has(tagName) ||\n settings.mode !== 'closure' && emptyIfNotClosure.has(tagName);\n });\n\n for (const [\n key,\n tag,\n ] of emptyTags.entries()) {\n const content = tag.name || tag.description || tag.type;\n if (content.trim() && (\n // Allow for JSDoc-block final asterisks\n key !== emptyTags.length - 1 || !(/^\\s*\\*+$/v).test(content)\n )) {\n const fix = () => {\n // By time of call in fixer, `tag` will have `line` added\n utils.setTag(\n /**\n * @type {import('comment-parser').Spec & {\n * line: import('../iterateJsdoc.js').Integer\n * }}\n */ (tag),\n );\n };\n\n utils.reportJSDoc(`@${tag.tag} should be empty.`, tag, fix, true);\n }\n }\n}, {\n checkInternal: true,\n checkPrivate: true,\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Expects specific tags to be empty of any content.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/empty-tags.md#repos-sticky-header',\n },\n fixable: 'code',\n schema: [\n {\n additionalProperties: false,\n properties: {\n tags: {\n items: {\n type: 'string',\n },\n type: 'array',\n },\n },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n});\n"],"mappings":";;;AAEA,MAAM,mBAAmB,IAAI,IAAI;CAC/B;CAAY;CAAS;CAAa;CAAU;CAI5C;CAGA;CAAc;CAAS;CACvB;CAEA;CAEA;CACA;AACD;AAED,MAAM,oBAAoB,IAAI,IAAI;CAEhC;CAAc;CAAW;CAAW;CAAa;CAEjD;AACD;AAED,MAAM,iBAAiB,IAAI,IAAI,CAC7B,WACD;AAED,wBAAeA,6BAAa,CAAC,EAC3B,OACA,UACA,OACD,KAAK;CACJ,MAAM,YAAY,MAAM,WAAW,CAAC,EAClC,KAAK,SACN,KAAK;AACJ,SAAO,iBAAiB,IAAI,QAAQ,IAClC,MAAM,aAAa,QAAQ,IAAI,MAAM,KAAK,KAAK,CAAC,EAC9C,KACD,KAAK;AACJ,UAAO,QAAQ;EAChB,EAAC,IACF,SAAS,SAAS,aAAa,eAAe,IAAI,QAAQ,IAC1D,SAAS,SAAS,aAAa,kBAAkB,IAAI,QAAQ;CAChE,EAAC;AAEF,MAAK,MAAM,CACT,KACA,IACD,IAAI,UAAU,SAAS,EAAE;EACxB,MAAM,UAAU,IAAI,QAAQ,IAAI,eAAe,IAAI;AACnD,MAAI,QAAQ,MAAM,KAEhB,QAAQ,UAAU,SAAS,KAAK,CAAE,YAAa,KAAK,QAAQ,GAC3D;GACD,MAAM,MAAM,MAAM;IAEhB,MAAM,OAKC,IACN;GACF;GAED,MAAM,YAAY,CAAC,CAAC,EAAE,IAAI,IAAI,iBAAiB,CAAC,EAAE,KAAK,KAAK,KAAK;EAClE;CACF;AACF,GAAE;CACD,eAAe;CACf,cAAc;CACd,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,MAAM;IACJ,OAAO,EACL,MAAM,SACP;IACD,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
import iterateJsdoc from "../iterateJsdoc.js";
|
|
2
|
+
|
|
3
|
+
//#region src/rules/emptyTags.js
|
|
4
|
+
const defaultEmptyTags = new Set([
|
|
5
|
+
"abstract",
|
|
6
|
+
"async",
|
|
7
|
+
"generator",
|
|
8
|
+
"global",
|
|
9
|
+
"hideconstructor",
|
|
10
|
+
"ignore",
|
|
11
|
+
"inheritDoc",
|
|
12
|
+
"inner",
|
|
13
|
+
"instance",
|
|
14
|
+
"internal",
|
|
15
|
+
"overload",
|
|
16
|
+
"override",
|
|
17
|
+
"readonly"
|
|
18
|
+
]);
|
|
19
|
+
const emptyIfNotClosure = new Set([
|
|
20
|
+
"inheritdoc",
|
|
21
|
+
"package",
|
|
22
|
+
"private",
|
|
23
|
+
"protected",
|
|
24
|
+
"public",
|
|
25
|
+
"static"
|
|
26
|
+
]);
|
|
27
|
+
const emptyIfClosure = new Set(["interface"]);
|
|
28
|
+
var emptyTags_default = iterateJsdoc(({ jsdoc, settings, utils }) => {
|
|
29
|
+
const emptyTags = utils.filterTags(({ tag: tagName }) => {
|
|
30
|
+
return defaultEmptyTags.has(tagName) || utils.hasOptionTag(tagName) && jsdoc.tags.some(({ tag }) => {
|
|
31
|
+
return tag === tagName;
|
|
32
|
+
}) || settings.mode === "closure" && emptyIfClosure.has(tagName) || settings.mode !== "closure" && emptyIfNotClosure.has(tagName);
|
|
33
|
+
});
|
|
34
|
+
for (const [key, tag] of emptyTags.entries()) {
|
|
35
|
+
const content = tag.name || tag.description || tag.type;
|
|
36
|
+
if (content.trim() && (key !== emptyTags.length - 1 || !/^\s*\*+$/v.test(content))) {
|
|
37
|
+
const fix = () => {
|
|
38
|
+
utils.setTag(tag);
|
|
39
|
+
};
|
|
40
|
+
utils.reportJSDoc(`@${tag.tag} should be empty.`, tag, fix, true);
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
}, {
|
|
44
|
+
checkInternal: true,
|
|
45
|
+
checkPrivate: true,
|
|
46
|
+
iterateAllJsdocs: true,
|
|
47
|
+
meta: {
|
|
48
|
+
docs: {
|
|
49
|
+
description: "Expects specific tags to be empty of any content.",
|
|
50
|
+
url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/empty-tags.md#repos-sticky-header"
|
|
51
|
+
},
|
|
52
|
+
fixable: "code",
|
|
53
|
+
schema: [{
|
|
54
|
+
additionalProperties: false,
|
|
55
|
+
properties: { tags: {
|
|
56
|
+
items: { type: "string" },
|
|
57
|
+
type: "array"
|
|
58
|
+
} },
|
|
59
|
+
type: "object"
|
|
60
|
+
}],
|
|
61
|
+
type: "suggestion"
|
|
62
|
+
}
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
//#endregion
|
|
66
|
+
export { emptyTags_default as default };
|
|
67
|
+
//# sourceMappingURL=emptyTags.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"emptyTags.js","names":[],"sources":["../../src/rules/emptyTags.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nconst defaultEmptyTags = new Set([\n 'abstract', 'async', 'generator', 'global', 'hideconstructor',\n\n // jsdoc doesn't use this form in its docs, but allow for compatibility with\n // TypeScript which allows and Closure which requires\n 'ignore',\n\n // jsdoc doesn't use but allow for TypeScript\n 'inheritDoc', 'inner', 'instance',\n 'internal',\n\n 'overload',\n\n 'override',\n 'readonly',\n]);\n\nconst emptyIfNotClosure = new Set([\n // Closure doesn't allow with this casing\n 'inheritdoc', 'package', 'private', 'protected', 'public',\n\n 'static',\n]);\n\nconst emptyIfClosure = new Set([\n 'interface',\n]);\n\nexport default iterateJsdoc(({\n jsdoc,\n settings,\n utils,\n}) => {\n const emptyTags = utils.filterTags(({\n tag: tagName,\n }) => {\n return defaultEmptyTags.has(tagName) ||\n utils.hasOptionTag(tagName) && jsdoc.tags.some(({\n tag,\n }) => {\n return tag === tagName;\n }) ||\n settings.mode === 'closure' && emptyIfClosure.has(tagName) ||\n settings.mode !== 'closure' && emptyIfNotClosure.has(tagName);\n });\n\n for (const [\n key,\n tag,\n ] of emptyTags.entries()) {\n const content = tag.name || tag.description || tag.type;\n if (content.trim() && (\n // Allow for JSDoc-block final asterisks\n key !== emptyTags.length - 1 || !(/^\\s*\\*+$/v).test(content)\n )) {\n const fix = () => {\n // By time of call in fixer, `tag` will have `line` added\n utils.setTag(\n /**\n * @type {import('comment-parser').Spec & {\n * line: import('../iterateJsdoc.js').Integer\n * }}\n */ (tag),\n );\n };\n\n utils.reportJSDoc(`@${tag.tag} should be empty.`, tag, fix, true);\n }\n }\n}, {\n checkInternal: true,\n checkPrivate: true,\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Expects specific tags to be empty of any content.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/empty-tags.md#repos-sticky-header',\n },\n fixable: 'code',\n schema: [\n {\n additionalProperties: false,\n properties: {\n tags: {\n items: {\n type: 'string',\n },\n type: 'array',\n },\n },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n});\n"],"mappings":";;;AAEA,MAAM,mBAAmB,IAAI,IAAI;CAC/B;CAAY;CAAS;CAAa;CAAU;CAI5C;CAGA;CAAc;CAAS;CACvB;CAEA;CAEA;CACA;AACD;AAED,MAAM,oBAAoB,IAAI,IAAI;CAEhC;CAAc;CAAW;CAAW;CAAa;CAEjD;AACD;AAED,MAAM,iBAAiB,IAAI,IAAI,CAC7B,WACD;AAED,wBAAe,aAAa,CAAC,EAC3B,OACA,UACA,OACD,KAAK;CACJ,MAAM,YAAY,MAAM,WAAW,CAAC,EAClC,KAAK,SACN,KAAK;AACJ,SAAO,iBAAiB,IAAI,QAAQ,IAClC,MAAM,aAAa,QAAQ,IAAI,MAAM,KAAK,KAAK,CAAC,EAC9C,KACD,KAAK;AACJ,UAAO,QAAQ;EAChB,EAAC,IACF,SAAS,SAAS,aAAa,eAAe,IAAI,QAAQ,IAC1D,SAAS,SAAS,aAAa,kBAAkB,IAAI,QAAQ;CAChE,EAAC;AAEF,MAAK,MAAM,CACT,KACA,IACD,IAAI,UAAU,SAAS,EAAE;EACxB,MAAM,UAAU,IAAI,QAAQ,IAAI,eAAe,IAAI;AACnD,MAAI,QAAQ,MAAM,KAEhB,QAAQ,UAAU,SAAS,KAAK,CAAE,YAAa,KAAK,QAAQ,GAC3D;GACD,MAAM,MAAM,MAAM;IAEhB,MAAM,OAKC,IACN;GACF;GAED,MAAM,YAAY,CAAC,CAAC,EAAE,IAAI,IAAI,iBAAiB,CAAC,EAAE,KAAK,KAAK,KAAK;EAClE;CACF;AACF,GAAE;CACD,eAAe;CACf,cAAc;CACd,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,MAAM;IACJ,OAAO,EACL,MAAM,SACP;IACD,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}
|
|
@@ -1,60 +1,40 @@
|
|
|
1
|
-
|
|
1
|
+
const require_iterateJsdoc = require('../iterateJsdoc.cjs');
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
}) => {
|
|
13
|
-
const iteratingFunction = utils.isIteratingFunction();
|
|
14
|
-
if (iteratingFunction) {
|
|
15
|
-
if (utils.hasATag(['class', 'constructor']) || utils.isConstructor()) {
|
|
16
|
-
return;
|
|
17
|
-
}
|
|
18
|
-
} else if (!utils.isVirtualFunction()) {
|
|
19
|
-
return;
|
|
20
|
-
}
|
|
21
|
-
utils.forEachPreferredTag('implements', tag => {
|
|
22
|
-
report('@implements used on a non-constructor function', null, tag);
|
|
23
|
-
});
|
|
3
|
+
//#region src/rules/implementsOnClasses.js
|
|
4
|
+
var implementsOnClasses_default = require_iterateJsdoc.default(({ report, utils }) => {
|
|
5
|
+
const iteratingFunction = utils.isIteratingFunction();
|
|
6
|
+
if (iteratingFunction) {
|
|
7
|
+
if (utils.hasATag(["class", "constructor"]) || utils.isConstructor()) return;
|
|
8
|
+
} else if (!utils.isVirtualFunction()) return;
|
|
9
|
+
utils.forEachPreferredTag("implements", (tag) => {
|
|
10
|
+
report("@implements used on a non-constructor function", null, tag);
|
|
11
|
+
});
|
|
24
12
|
}, {
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
type: 'object'
|
|
49
|
-
}]
|
|
50
|
-
},
|
|
51
|
-
type: 'array'
|
|
52
|
-
}
|
|
53
|
-
},
|
|
54
|
-
type: 'object'
|
|
55
|
-
}],
|
|
56
|
-
type: 'suggestion'
|
|
57
|
-
}
|
|
13
|
+
contextDefaults: true,
|
|
14
|
+
meta: {
|
|
15
|
+
docs: {
|
|
16
|
+
description: "Reports an issue with any non-constructor function using `@implements`.",
|
|
17
|
+
url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/implements-on-classes.md#repos-sticky-header"
|
|
18
|
+
},
|
|
19
|
+
schema: [{
|
|
20
|
+
additionalProperties: false,
|
|
21
|
+
properties: { contexts: {
|
|
22
|
+
items: { anyOf: [{ type: "string" }, {
|
|
23
|
+
additionalProperties: false,
|
|
24
|
+
properties: {
|
|
25
|
+
comment: { type: "string" },
|
|
26
|
+
context: { type: "string" }
|
|
27
|
+
},
|
|
28
|
+
type: "object"
|
|
29
|
+
}] },
|
|
30
|
+
type: "array"
|
|
31
|
+
} },
|
|
32
|
+
type: "object"
|
|
33
|
+
}],
|
|
34
|
+
type: "suggestion"
|
|
35
|
+
}
|
|
58
36
|
});
|
|
59
|
-
|
|
37
|
+
|
|
38
|
+
//#endregion
|
|
39
|
+
exports.default = implementsOnClasses_default;
|
|
60
40
|
//# sourceMappingURL=implementsOnClasses.cjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"implementsOnClasses.cjs","names":["
|
|
1
|
+
{"version":3,"file":"implementsOnClasses.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/implementsOnClasses.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n report,\n utils,\n}) => {\n const iteratingFunction = utils.isIteratingFunction();\n\n if (iteratingFunction) {\n if (utils.hasATag([\n 'class',\n 'constructor',\n ]) ||\n utils.isConstructor()\n ) {\n return;\n }\n } else if (!utils.isVirtualFunction()) {\n return;\n }\n\n utils.forEachPreferredTag('implements', (tag) => {\n report('@implements used on a non-constructor function', null, tag);\n });\n}, {\n contextDefaults: true,\n meta: {\n docs: {\n description: 'Reports an issue with any non-constructor function using `@implements`.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/implements-on-classes.md#repos-sticky-header',\n },\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 },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n});\n"],"mappings":";;;AAEA,kCAAeA,6BAAa,CAAC,EAC3B,QACA,OACD,KAAK;CACJ,MAAM,oBAAoB,MAAM,qBAAqB;AAErD,KAAI,mBACF;MAAI,MAAM,QAAQ,CAChB,SACA,aACD,EAAC,IACA,MAAM,eAAe,CAErB;CACD,WACQ,CAAC,MAAM,mBAAmB,CACnC;CAGF,MAAM,oBAAoB,cAAc,CAAC,QAAQ;EAC/C,OAAO,kDAAkD,MAAM,IAAI;CACpE,EAAC;AACH,GAAE;CACD,iBAAiB;CACjB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,UAAU;IACR,OAAO,EACL,OAAO,CACL,EACE,MAAM,SACP,GACD;KACE,sBAAsB;KACtB,YAAY;MACV,SAAS,EACP,MAAM,SACP;MACD,SAAS,EACP,MAAM,SACP;KACF;KACD,MAAM;IACP,CACF,EACF;IACD,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}
|