eslint-plugin-jsdoc 52.0.4 → 53.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/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 +364 -550
- 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 -65
- 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 +2 -410
- package/dist/index.d.cts +2 -0
- package/dist/index.d.ts +2 -17
- package/dist/index.js +3 -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/plugin.cjs +427 -0
- package/dist/plugin.cjs.map +1 -0
- package/dist/plugin.js +427 -0
- package/dist/plugin.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 +40 -24
- package/dist/generateRule.cjs +0 -242
- package/dist/generateRule.cjs.map +0 -1
- package/dist/index.cjs.map +0 -1
- package/dist/index.d.ts.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 -672
- 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
|
@@ -1,176 +1,126 @@
|
|
|
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/noMissingSyntax.js
|
|
9
4
|
/**
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
5
|
+
* @typedef {{
|
|
6
|
+
* comment: string,
|
|
7
|
+
* context: string,
|
|
8
|
+
* message: string,
|
|
9
|
+
* minimum: import('../iterateJsdoc.js').Integer
|
|
10
|
+
* }} ContextObject
|
|
11
|
+
*/
|
|
18
12
|
/**
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
13
|
+
* @typedef {string|ContextObject} Context
|
|
14
|
+
*/
|
|
22
15
|
/**
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
const setDefaults = state => {
|
|
27
|
-
|
|
28
|
-
state.selectorMap = {};
|
|
29
|
-
}
|
|
16
|
+
* @param {import('../iterateJsdoc.js').StateObject} state
|
|
17
|
+
* @returns {void}
|
|
18
|
+
*/
|
|
19
|
+
const setDefaults = (state) => {
|
|
20
|
+
if (!state.selectorMap) state.selectorMap = {};
|
|
30
21
|
};
|
|
31
|
-
|
|
32
22
|
/**
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
23
|
+
* @param {import('../iterateJsdoc.js').StateObject} state
|
|
24
|
+
* @param {string} selector
|
|
25
|
+
* @param {string} comment
|
|
26
|
+
* @returns {void}
|
|
27
|
+
*/
|
|
38
28
|
const incrementSelector = (state, selector, comment) => {
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
if (!state.selectorMap[selector][comment]) {
|
|
43
|
-
state.selectorMap[selector][comment] = 0;
|
|
44
|
-
}
|
|
45
|
-
state.selectorMap[selector][comment]++;
|
|
29
|
+
if (!state.selectorMap[selector]) state.selectorMap[selector] = {};
|
|
30
|
+
if (!state.selectorMap[selector][comment]) state.selectorMap[selector][comment] = 0;
|
|
31
|
+
state.selectorMap[selector][comment]++;
|
|
46
32
|
};
|
|
47
|
-
var
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
// Handle error later
|
|
57
|
-
return;
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
/**
|
|
61
|
-
* @type {Context[]}
|
|
62
|
-
*/
|
|
63
|
-
const contexts = context.options[0].contexts;
|
|
64
|
-
const {
|
|
65
|
-
contextStr
|
|
66
|
-
} = utils.findContext(contexts, comment);
|
|
67
|
-
setDefaults(state);
|
|
68
|
-
incrementSelector(state, contextStr, String(comment));
|
|
33
|
+
var noMissingSyntax_default = require_iterateJsdoc.default(({ context, info: { comment }, state, utils }) => {
|
|
34
|
+
if (!context.options[0]) return;
|
|
35
|
+
/**
|
|
36
|
+
* @type {Context[]}
|
|
37
|
+
*/
|
|
38
|
+
const contexts = context.options[0].contexts;
|
|
39
|
+
const { contextStr } = utils.findContext(contexts, comment);
|
|
40
|
+
setDefaults(state);
|
|
41
|
+
incrementSelector(state, contextStr, String(comment));
|
|
69
42
|
}, {
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
additionalProperties: false,
|
|
150
|
-
properties: {
|
|
151
|
-
comment: {
|
|
152
|
-
type: 'string'
|
|
153
|
-
},
|
|
154
|
-
context: {
|
|
155
|
-
type: 'string'
|
|
156
|
-
},
|
|
157
|
-
message: {
|
|
158
|
-
type: 'string'
|
|
159
|
-
},
|
|
160
|
-
minimum: {
|
|
161
|
-
type: 'integer'
|
|
162
|
-
}
|
|
163
|
-
},
|
|
164
|
-
type: 'object'
|
|
165
|
-
}]
|
|
166
|
-
},
|
|
167
|
-
type: 'array'
|
|
168
|
-
}
|
|
169
|
-
},
|
|
170
|
-
type: 'object'
|
|
171
|
-
}],
|
|
172
|
-
type: 'suggestion'
|
|
173
|
-
}
|
|
43
|
+
contextSelected: true,
|
|
44
|
+
exit({ context, settings, state }) {
|
|
45
|
+
if (!context.options.length && !settings.contexts) {
|
|
46
|
+
context.report({
|
|
47
|
+
loc: {
|
|
48
|
+
end: {
|
|
49
|
+
column: 1,
|
|
50
|
+
line: 1
|
|
51
|
+
},
|
|
52
|
+
start: {
|
|
53
|
+
column: 1,
|
|
54
|
+
line: 1
|
|
55
|
+
}
|
|
56
|
+
},
|
|
57
|
+
message: "Rule `no-missing-syntax` is missing a `contexts` option."
|
|
58
|
+
});
|
|
59
|
+
return;
|
|
60
|
+
}
|
|
61
|
+
setDefaults(state);
|
|
62
|
+
/**
|
|
63
|
+
* @type {Context[]}
|
|
64
|
+
*/
|
|
65
|
+
const contexts = (context.options[0] ?? {}).contexts ?? settings?.contexts;
|
|
66
|
+
contexts.some((cntxt) => {
|
|
67
|
+
const contextStr = typeof cntxt === "object" ? cntxt.context ?? "any" : cntxt;
|
|
68
|
+
const comment = typeof cntxt === "string" ? "" : cntxt?.comment;
|
|
69
|
+
const contextKey = contextStr === "any" ? "undefined" : contextStr;
|
|
70
|
+
if ((!state.selectorMap[contextKey] || !state.selectorMap[contextKey][comment] || state.selectorMap[contextKey][comment] < (cntxt?.minimum ?? 1)) && (contextStr !== "any" || Object.values(state.selectorMap).every((cmmnt) => {
|
|
71
|
+
return !cmmnt[comment] || cmmnt[comment] < (cntxt?.minimum ?? 1);
|
|
72
|
+
}))) {
|
|
73
|
+
const message = typeof cntxt === "string" ? "Syntax is required: {{context}}" : cntxt?.message ?? "Syntax is required: {{context}}" + (comment ? " with {{comment}}" : "");
|
|
74
|
+
context.report({
|
|
75
|
+
data: {
|
|
76
|
+
comment,
|
|
77
|
+
context: contextStr
|
|
78
|
+
},
|
|
79
|
+
loc: {
|
|
80
|
+
end: {
|
|
81
|
+
column: 1,
|
|
82
|
+
line: 1
|
|
83
|
+
},
|
|
84
|
+
start: {
|
|
85
|
+
column: 1,
|
|
86
|
+
line: 1
|
|
87
|
+
}
|
|
88
|
+
},
|
|
89
|
+
message
|
|
90
|
+
});
|
|
91
|
+
return true;
|
|
92
|
+
}
|
|
93
|
+
return false;
|
|
94
|
+
});
|
|
95
|
+
},
|
|
96
|
+
matchContext: true,
|
|
97
|
+
meta: {
|
|
98
|
+
docs: {
|
|
99
|
+
description: "Reports when certain comment structures are always expected.",
|
|
100
|
+
url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-missing-syntax.md#repos-sticky-header"
|
|
101
|
+
},
|
|
102
|
+
fixable: "code",
|
|
103
|
+
schema: [{
|
|
104
|
+
additionalProperties: false,
|
|
105
|
+
properties: { contexts: {
|
|
106
|
+
items: { anyOf: [{ type: "string" }, {
|
|
107
|
+
additionalProperties: false,
|
|
108
|
+
properties: {
|
|
109
|
+
comment: { type: "string" },
|
|
110
|
+
context: { type: "string" },
|
|
111
|
+
message: { type: "string" },
|
|
112
|
+
minimum: { type: "integer" }
|
|
113
|
+
},
|
|
114
|
+
type: "object"
|
|
115
|
+
}] },
|
|
116
|
+
type: "array"
|
|
117
|
+
} },
|
|
118
|
+
type: "object"
|
|
119
|
+
}],
|
|
120
|
+
type: "suggestion"
|
|
121
|
+
}
|
|
174
122
|
});
|
|
175
|
-
|
|
123
|
+
|
|
124
|
+
//#endregion
|
|
125
|
+
exports.default = noMissingSyntax_default;
|
|
176
126
|
//# sourceMappingURL=noMissingSyntax.cjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"noMissingSyntax.cjs","names":["
|
|
1
|
+
{"version":3,"file":"noMissingSyntax.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/noMissingSyntax.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @typedef {{\n * comment: string,\n * context: string,\n * message: string,\n * minimum: import('../iterateJsdoc.js').Integer\n * }} ContextObject\n */\n\n/**\n * @typedef {string|ContextObject} Context\n */\n\n/**\n * @param {import('../iterateJsdoc.js').StateObject} state\n * @returns {void}\n */\nconst setDefaults = (state) => {\n if (!state.selectorMap) {\n state.selectorMap = {};\n }\n};\n\n/**\n * @param {import('../iterateJsdoc.js').StateObject} state\n * @param {string} selector\n * @param {string} comment\n * @returns {void}\n */\nconst incrementSelector = (state, selector, comment) => {\n if (!state.selectorMap[selector]) {\n state.selectorMap[selector] = {};\n }\n\n if (!state.selectorMap[selector][comment]) {\n state.selectorMap[selector][comment] = 0;\n }\n\n state.selectorMap[selector][comment]++;\n};\n\nexport default iterateJsdoc(({\n context,\n info: {\n comment,\n },\n state,\n utils,\n}) => {\n if (!context.options[0]) {\n // Handle error later\n return;\n }\n\n /**\n * @type {Context[]}\n */\n const contexts = context.options[0].contexts;\n\n const {\n contextStr,\n } = utils.findContext(contexts, comment);\n\n setDefaults(state);\n\n incrementSelector(state, contextStr, String(comment));\n}, {\n contextSelected: true,\n exit ({\n context,\n settings,\n state,\n }) {\n if (!context.options.length && !settings.contexts) {\n context.report({\n loc: {\n end: {\n column: 1,\n line: 1,\n },\n start: {\n column: 1,\n line: 1,\n },\n },\n message: 'Rule `no-missing-syntax` is missing a `contexts` option.',\n });\n\n return;\n }\n\n setDefaults(state);\n\n /**\n * @type {Context[]}\n */\n const contexts = (context.options[0] ?? {}).contexts ?? settings?.contexts;\n\n // Report when MISSING\n contexts.some((cntxt) => {\n const contextStr = typeof cntxt === 'object' ? cntxt.context ?? 'any' : cntxt;\n const comment = typeof cntxt === 'string' ? '' : cntxt?.comment;\n\n const contextKey = contextStr === 'any' ? 'undefined' : contextStr;\n\n if (\n (!state.selectorMap[contextKey] ||\n !state.selectorMap[contextKey][comment] ||\n state.selectorMap[contextKey][comment] < (\n // @ts-expect-error comment would need an object, not string\n cntxt?.minimum ?? 1\n )) &&\n (contextStr !== 'any' || Object.values(state.selectorMap).every((cmmnt) => {\n return !cmmnt[comment] || cmmnt[comment] < (\n // @ts-expect-error comment would need an object, not string\n cntxt?.minimum ?? 1\n );\n }))\n ) {\n const message = typeof cntxt === 'string' ?\n 'Syntax is required: {{context}}' :\n cntxt?.message ?? ('Syntax is required: {{context}}' +\n (comment ? ' with {{comment}}' : ''));\n context.report({\n data: {\n comment,\n context: contextStr,\n },\n loc: {\n end: {\n column: 1,\n line: 1,\n },\n start: {\n column: 1,\n line: 1,\n },\n },\n message,\n });\n\n return true;\n }\n\n return false;\n });\n },\n matchContext: true,\n meta: {\n docs: {\n description: 'Reports when certain comment structures are always expected.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-missing-syntax.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 message: {\n type: 'string',\n },\n minimum: {\n type: 'integer',\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":";;;;;;;;;;;;;;;;;;AAmBA,MAAM,cAAc,CAAC,UAAU;AAC7B,KAAI,CAAC,MAAM,aACT,MAAM,cAAc,CAAE;AAEzB;;;;;;;AAQD,MAAM,oBAAoB,CAAC,OAAO,UAAU,YAAY;AACtD,KAAI,CAAC,MAAM,YAAY,WACrB,MAAM,YAAY,YAAY,CAAE;AAGlC,KAAI,CAAC,MAAM,YAAY,UAAU,UAC/B,MAAM,YAAY,UAAU,WAAW;CAGzC,MAAM,YAAY,UAAU;AAC7B;AAED,8BAAeA,6BAAa,CAAC,EAC3B,SACA,MAAM,EACJ,SACD,EACD,OACA,OACD,KAAK;AACJ,KAAI,CAAC,QAAQ,QAAQ,GAEnB;;;;CAMF,MAAM,WAAW,QAAQ,QAAQ,GAAG;CAEpC,MAAM,EACJ,YACD,GAAG,MAAM,YAAY,UAAU,QAAQ;CAExC,YAAY,MAAM;CAElB,kBAAkB,OAAO,YAAY,OAAO,QAAQ,CAAC;AACtD,GAAE;CACD,iBAAiB;CACjB,KAAM,EACJ,SACA,UACA,OACD,EAAE;AACD,MAAI,CAAC,QAAQ,QAAQ,UAAU,CAAC,SAAS,UAAU;GACjD,QAAQ,OAAO;IACb,KAAK;KACH,KAAK;MACH,QAAQ;MACR,MAAM;KACP;KACD,OAAO;MACL,QAAQ;MACR,MAAM;KACP;IACF;IACD,SAAS;GACV,EAAC;AAEF;EACD;EAED,YAAY,MAAM;;;;EAKlB,MAAM,YAAY,QAAQ,QAAQ,MAAM,CAAE,GAAE,YAAY,UAAU;EAGlE,SAAS,KAAK,CAAC,UAAU;GACvB,MAAM,aAAa,OAAO,UAAU,WAAW,MAAM,WAAW,QAAQ;GACxE,MAAM,UAAU,OAAO,UAAU,WAAW,KAAK,OAAO;GAExD,MAAM,aAAa,eAAe,QAAQ,cAAc;AAExD,QACG,CAAC,MAAM,YAAY,eACpB,CAAC,MAAM,YAAY,YAAY,YAC/B,MAAM,YAAY,YAAY,YAE5B,OAAO,WAAW,QAEnB,eAAe,SAAS,OAAO,OAAO,MAAM,YAAY,CAAC,MAAM,CAAC,UAAU;AACzE,WAAO,CAAC,MAAM,YAAY,MAAM,YAE9B,OAAO,WAAW;GAErB,EAAC,GACF;IACA,MAAM,UAAU,OAAO,UAAU,WAC/B,oCACA,OAAO,WAAY,qCAChB,UAAU,sBAAsB;IACrC,QAAQ,OAAO;KACb,MAAM;MACJ;MACA,SAAS;KACV;KACD,KAAK;MACH,KAAK;OACH,QAAQ;OACR,MAAM;MACP;MACD,OAAO;OACL,QAAQ;OACR,MAAM;MACP;KACF;KACD;IACD,EAAC;AAEF,WAAO;GACR;AAED,UAAO;EACR,EAAC;CACH;CACD,cAAc;CACd,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,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;MACD,SAAS,EACP,MAAM,SACP;MACD,SAAS,EACP,MAAM,UACP;KACF;KACD,MAAM;IACP,CACF,EACF;IACD,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
import iterateJsdoc from "../iterateJsdoc.js";
|
|
2
|
+
|
|
3
|
+
//#region src/rules/noMissingSyntax.js
|
|
4
|
+
/**
|
|
5
|
+
* @typedef {{
|
|
6
|
+
* comment: string,
|
|
7
|
+
* context: string,
|
|
8
|
+
* message: string,
|
|
9
|
+
* minimum: import('../iterateJsdoc.js').Integer
|
|
10
|
+
* }} ContextObject
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* @typedef {string|ContextObject} Context
|
|
14
|
+
*/
|
|
15
|
+
/**
|
|
16
|
+
* @param {import('../iterateJsdoc.js').StateObject} state
|
|
17
|
+
* @returns {void}
|
|
18
|
+
*/
|
|
19
|
+
const setDefaults = (state) => {
|
|
20
|
+
if (!state.selectorMap) state.selectorMap = {};
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* @param {import('../iterateJsdoc.js').StateObject} state
|
|
24
|
+
* @param {string} selector
|
|
25
|
+
* @param {string} comment
|
|
26
|
+
* @returns {void}
|
|
27
|
+
*/
|
|
28
|
+
const incrementSelector = (state, selector, comment) => {
|
|
29
|
+
if (!state.selectorMap[selector]) state.selectorMap[selector] = {};
|
|
30
|
+
if (!state.selectorMap[selector][comment]) state.selectorMap[selector][comment] = 0;
|
|
31
|
+
state.selectorMap[selector][comment]++;
|
|
32
|
+
};
|
|
33
|
+
var noMissingSyntax_default = iterateJsdoc(({ context, info: { comment }, state, utils }) => {
|
|
34
|
+
if (!context.options[0]) return;
|
|
35
|
+
/**
|
|
36
|
+
* @type {Context[]}
|
|
37
|
+
*/
|
|
38
|
+
const contexts = context.options[0].contexts;
|
|
39
|
+
const { contextStr } = utils.findContext(contexts, comment);
|
|
40
|
+
setDefaults(state);
|
|
41
|
+
incrementSelector(state, contextStr, String(comment));
|
|
42
|
+
}, {
|
|
43
|
+
contextSelected: true,
|
|
44
|
+
exit({ context, settings, state }) {
|
|
45
|
+
if (!context.options.length && !settings.contexts) {
|
|
46
|
+
context.report({
|
|
47
|
+
loc: {
|
|
48
|
+
end: {
|
|
49
|
+
column: 1,
|
|
50
|
+
line: 1
|
|
51
|
+
},
|
|
52
|
+
start: {
|
|
53
|
+
column: 1,
|
|
54
|
+
line: 1
|
|
55
|
+
}
|
|
56
|
+
},
|
|
57
|
+
message: "Rule `no-missing-syntax` is missing a `contexts` option."
|
|
58
|
+
});
|
|
59
|
+
return;
|
|
60
|
+
}
|
|
61
|
+
setDefaults(state);
|
|
62
|
+
/**
|
|
63
|
+
* @type {Context[]}
|
|
64
|
+
*/
|
|
65
|
+
const contexts = (context.options[0] ?? {}).contexts ?? settings?.contexts;
|
|
66
|
+
contexts.some((cntxt) => {
|
|
67
|
+
const contextStr = typeof cntxt === "object" ? cntxt.context ?? "any" : cntxt;
|
|
68
|
+
const comment = typeof cntxt === "string" ? "" : cntxt?.comment;
|
|
69
|
+
const contextKey = contextStr === "any" ? "undefined" : contextStr;
|
|
70
|
+
if ((!state.selectorMap[contextKey] || !state.selectorMap[contextKey][comment] || state.selectorMap[contextKey][comment] < (cntxt?.minimum ?? 1)) && (contextStr !== "any" || Object.values(state.selectorMap).every((cmmnt) => {
|
|
71
|
+
return !cmmnt[comment] || cmmnt[comment] < (cntxt?.minimum ?? 1);
|
|
72
|
+
}))) {
|
|
73
|
+
const message = typeof cntxt === "string" ? "Syntax is required: {{context}}" : cntxt?.message ?? "Syntax is required: {{context}}" + (comment ? " with {{comment}}" : "");
|
|
74
|
+
context.report({
|
|
75
|
+
data: {
|
|
76
|
+
comment,
|
|
77
|
+
context: contextStr
|
|
78
|
+
},
|
|
79
|
+
loc: {
|
|
80
|
+
end: {
|
|
81
|
+
column: 1,
|
|
82
|
+
line: 1
|
|
83
|
+
},
|
|
84
|
+
start: {
|
|
85
|
+
column: 1,
|
|
86
|
+
line: 1
|
|
87
|
+
}
|
|
88
|
+
},
|
|
89
|
+
message
|
|
90
|
+
});
|
|
91
|
+
return true;
|
|
92
|
+
}
|
|
93
|
+
return false;
|
|
94
|
+
});
|
|
95
|
+
},
|
|
96
|
+
matchContext: true,
|
|
97
|
+
meta: {
|
|
98
|
+
docs: {
|
|
99
|
+
description: "Reports when certain comment structures are always expected.",
|
|
100
|
+
url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-missing-syntax.md#repos-sticky-header"
|
|
101
|
+
},
|
|
102
|
+
fixable: "code",
|
|
103
|
+
schema: [{
|
|
104
|
+
additionalProperties: false,
|
|
105
|
+
properties: { contexts: {
|
|
106
|
+
items: { anyOf: [{ type: "string" }, {
|
|
107
|
+
additionalProperties: false,
|
|
108
|
+
properties: {
|
|
109
|
+
comment: { type: "string" },
|
|
110
|
+
context: { type: "string" },
|
|
111
|
+
message: { type: "string" },
|
|
112
|
+
minimum: { type: "integer" }
|
|
113
|
+
},
|
|
114
|
+
type: "object"
|
|
115
|
+
}] },
|
|
116
|
+
type: "array"
|
|
117
|
+
} },
|
|
118
|
+
type: "object"
|
|
119
|
+
}],
|
|
120
|
+
type: "suggestion"
|
|
121
|
+
}
|
|
122
|
+
});
|
|
123
|
+
|
|
124
|
+
//#endregion
|
|
125
|
+
export { noMissingSyntax_default as default };
|
|
126
|
+
//# sourceMappingURL=noMissingSyntax.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"noMissingSyntax.js","names":[],"sources":["../../src/rules/noMissingSyntax.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @typedef {{\n * comment: string,\n * context: string,\n * message: string,\n * minimum: import('../iterateJsdoc.js').Integer\n * }} ContextObject\n */\n\n/**\n * @typedef {string|ContextObject} Context\n */\n\n/**\n * @param {import('../iterateJsdoc.js').StateObject} state\n * @returns {void}\n */\nconst setDefaults = (state) => {\n if (!state.selectorMap) {\n state.selectorMap = {};\n }\n};\n\n/**\n * @param {import('../iterateJsdoc.js').StateObject} state\n * @param {string} selector\n * @param {string} comment\n * @returns {void}\n */\nconst incrementSelector = (state, selector, comment) => {\n if (!state.selectorMap[selector]) {\n state.selectorMap[selector] = {};\n }\n\n if (!state.selectorMap[selector][comment]) {\n state.selectorMap[selector][comment] = 0;\n }\n\n state.selectorMap[selector][comment]++;\n};\n\nexport default iterateJsdoc(({\n context,\n info: {\n comment,\n },\n state,\n utils,\n}) => {\n if (!context.options[0]) {\n // Handle error later\n return;\n }\n\n /**\n * @type {Context[]}\n */\n const contexts = context.options[0].contexts;\n\n const {\n contextStr,\n } = utils.findContext(contexts, comment);\n\n setDefaults(state);\n\n incrementSelector(state, contextStr, String(comment));\n}, {\n contextSelected: true,\n exit ({\n context,\n settings,\n state,\n }) {\n if (!context.options.length && !settings.contexts) {\n context.report({\n loc: {\n end: {\n column: 1,\n line: 1,\n },\n start: {\n column: 1,\n line: 1,\n },\n },\n message: 'Rule `no-missing-syntax` is missing a `contexts` option.',\n });\n\n return;\n }\n\n setDefaults(state);\n\n /**\n * @type {Context[]}\n */\n const contexts = (context.options[0] ?? {}).contexts ?? settings?.contexts;\n\n // Report when MISSING\n contexts.some((cntxt) => {\n const contextStr = typeof cntxt === 'object' ? cntxt.context ?? 'any' : cntxt;\n const comment = typeof cntxt === 'string' ? '' : cntxt?.comment;\n\n const contextKey = contextStr === 'any' ? 'undefined' : contextStr;\n\n if (\n (!state.selectorMap[contextKey] ||\n !state.selectorMap[contextKey][comment] ||\n state.selectorMap[contextKey][comment] < (\n // @ts-expect-error comment would need an object, not string\n cntxt?.minimum ?? 1\n )) &&\n (contextStr !== 'any' || Object.values(state.selectorMap).every((cmmnt) => {\n return !cmmnt[comment] || cmmnt[comment] < (\n // @ts-expect-error comment would need an object, not string\n cntxt?.minimum ?? 1\n );\n }))\n ) {\n const message = typeof cntxt === 'string' ?\n 'Syntax is required: {{context}}' :\n cntxt?.message ?? ('Syntax is required: {{context}}' +\n (comment ? ' with {{comment}}' : ''));\n context.report({\n data: {\n comment,\n context: contextStr,\n },\n loc: {\n end: {\n column: 1,\n line: 1,\n },\n start: {\n column: 1,\n line: 1,\n },\n },\n message,\n });\n\n return true;\n }\n\n return false;\n });\n },\n matchContext: true,\n meta: {\n docs: {\n description: 'Reports when certain comment structures are always expected.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-missing-syntax.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 message: {\n type: 'string',\n },\n minimum: {\n type: 'integer',\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":";;;;;;;;;;;;;;;;;;AAmBA,MAAM,cAAc,CAAC,UAAU;AAC7B,KAAI,CAAC,MAAM,aACT,MAAM,cAAc,CAAE;AAEzB;;;;;;;AAQD,MAAM,oBAAoB,CAAC,OAAO,UAAU,YAAY;AACtD,KAAI,CAAC,MAAM,YAAY,WACrB,MAAM,YAAY,YAAY,CAAE;AAGlC,KAAI,CAAC,MAAM,YAAY,UAAU,UAC/B,MAAM,YAAY,UAAU,WAAW;CAGzC,MAAM,YAAY,UAAU;AAC7B;AAED,8BAAe,aAAa,CAAC,EAC3B,SACA,MAAM,EACJ,SACD,EACD,OACA,OACD,KAAK;AACJ,KAAI,CAAC,QAAQ,QAAQ,GAEnB;;;;CAMF,MAAM,WAAW,QAAQ,QAAQ,GAAG;CAEpC,MAAM,EACJ,YACD,GAAG,MAAM,YAAY,UAAU,QAAQ;CAExC,YAAY,MAAM;CAElB,kBAAkB,OAAO,YAAY,OAAO,QAAQ,CAAC;AACtD,GAAE;CACD,iBAAiB;CACjB,KAAM,EACJ,SACA,UACA,OACD,EAAE;AACD,MAAI,CAAC,QAAQ,QAAQ,UAAU,CAAC,SAAS,UAAU;GACjD,QAAQ,OAAO;IACb,KAAK;KACH,KAAK;MACH,QAAQ;MACR,MAAM;KACP;KACD,OAAO;MACL,QAAQ;MACR,MAAM;KACP;IACF;IACD,SAAS;GACV,EAAC;AAEF;EACD;EAED,YAAY,MAAM;;;;EAKlB,MAAM,YAAY,QAAQ,QAAQ,MAAM,CAAE,GAAE,YAAY,UAAU;EAGlE,SAAS,KAAK,CAAC,UAAU;GACvB,MAAM,aAAa,OAAO,UAAU,WAAW,MAAM,WAAW,QAAQ;GACxE,MAAM,UAAU,OAAO,UAAU,WAAW,KAAK,OAAO;GAExD,MAAM,aAAa,eAAe,QAAQ,cAAc;AAExD,QACG,CAAC,MAAM,YAAY,eACpB,CAAC,MAAM,YAAY,YAAY,YAC/B,MAAM,YAAY,YAAY,YAE5B,OAAO,WAAW,QAEnB,eAAe,SAAS,OAAO,OAAO,MAAM,YAAY,CAAC,MAAM,CAAC,UAAU;AACzE,WAAO,CAAC,MAAM,YAAY,MAAM,YAE9B,OAAO,WAAW;GAErB,EAAC,GACF;IACA,MAAM,UAAU,OAAO,UAAU,WAC/B,oCACA,OAAO,WAAY,qCAChB,UAAU,sBAAsB;IACrC,QAAQ,OAAO;KACb,MAAM;MACJ;MACA,SAAS;KACV;KACD,KAAK;MACH,KAAK;OACH,QAAQ;OACR,MAAM;MACP;MACD,OAAO;OACL,QAAQ;OACR,MAAM;MACP;KACF;KACD;IACD,EAAC;AAEF,WAAO;GACR;AAED,UAAO;EACR,EAAC;CACH;CACD,cAAc;CACd,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,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;MACD,SAAS,EACP,MAAM,SACP;MACD,SAAS,EACP,MAAM,UACP;KACF;KACD,MAAM;IACP,CACF,EACF;IACD,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}
|
|
@@ -1,99 +1,58 @@
|
|
|
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/noMultiAsterisks.js
|
|
9
4
|
const middleAsterisksBlockWS = /^([\t ]|\*(?!\*))+/v;
|
|
10
5
|
const middleAsterisksNoBlockWS = /^\*+/v;
|
|
11
6
|
const endAsterisksSingleLineBlockWS = /\*((?:\*|(?: |\t))*)\*$/v;
|
|
12
7
|
const endAsterisksMultipleLineBlockWS = /((?:\*|(?: |\t))*)\*$/v;
|
|
13
8
|
const endAsterisksSingleLineNoBlockWS = /\*(\**)\*$/v;
|
|
14
9
|
const endAsterisksMultipleLineNoBlockWS = /(\**)\*$/v;
|
|
15
|
-
var
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
}
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
} = tokens;
|
|
41
|
-
if (preventAtMiddleLines && !end && !tag && !type && !name && (!allowWhitespace && middleAsterisks.test(description) || allowWhitespace && middleAsterisks.test(postDelimiter + description))) {
|
|
42
|
-
// console.log('description', JSON.stringify(description));
|
|
43
|
-
const fix = () => {
|
|
44
|
-
tokens.description = description.replace(middleAsterisks, '');
|
|
45
|
-
};
|
|
46
|
-
utils.reportJSDoc('Should be no multiple asterisks on middle lines.', {
|
|
47
|
-
line: number
|
|
48
|
-
}, fix, true);
|
|
49
|
-
return true;
|
|
50
|
-
}
|
|
51
|
-
if (!preventAtEnd || !end) {
|
|
52
|
-
return false;
|
|
53
|
-
}
|
|
54
|
-
const isSingleLineBlock = delimiter === '/**';
|
|
55
|
-
const delim = isSingleLineBlock ? '*' : delimiter;
|
|
56
|
-
const endAsterisks = allowWhitespace ? isSingleLineBlock ? endAsterisksSingleLineNoBlockWS : endAsterisksMultipleLineNoBlockWS : isSingleLineBlock ? endAsterisksSingleLineBlockWS : endAsterisksMultipleLineBlockWS;
|
|
57
|
-
const endingAsterisksAndSpaces = (allowWhitespace ? postDelimiter + description + delim : description + delim).match(endAsterisks);
|
|
58
|
-
if (!endingAsterisksAndSpaces || !isSingleLineBlock && endingAsterisksAndSpaces[1] && !endingAsterisksAndSpaces[1].trim()) {
|
|
59
|
-
return false;
|
|
60
|
-
}
|
|
61
|
-
const endFix = () => {
|
|
62
|
-
if (!isSingleLineBlock) {
|
|
63
|
-
tokens.delimiter = '';
|
|
64
|
-
}
|
|
65
|
-
tokens.description = (description + delim).replace(endAsterisks, '');
|
|
66
|
-
};
|
|
67
|
-
utils.reportJSDoc('Should be no multiple asterisks on end lines.', {
|
|
68
|
-
line: number
|
|
69
|
-
}, endFix, true);
|
|
70
|
-
return true;
|
|
71
|
-
});
|
|
10
|
+
var noMultiAsterisks_default = require_iterateJsdoc.default(({ context, jsdoc, utils }) => {
|
|
11
|
+
const { allowWhitespace = false, preventAtEnd = true, preventAtMiddleLines = true } = context.options[0] || {};
|
|
12
|
+
const middleAsterisks = allowWhitespace ? middleAsterisksNoBlockWS : middleAsterisksBlockWS;
|
|
13
|
+
jsdoc.source.some(({ number, tokens }) => {
|
|
14
|
+
const { delimiter, description, end, name, postDelimiter, tag, type } = tokens;
|
|
15
|
+
if (preventAtMiddleLines && !end && !tag && !type && !name && (!allowWhitespace && middleAsterisks.test(description) || allowWhitespace && middleAsterisks.test(postDelimiter + description))) {
|
|
16
|
+
const fix = () => {
|
|
17
|
+
tokens.description = description.replace(middleAsterisks, "");
|
|
18
|
+
};
|
|
19
|
+
utils.reportJSDoc("Should be no multiple asterisks on middle lines.", { line: number }, fix, true);
|
|
20
|
+
return true;
|
|
21
|
+
}
|
|
22
|
+
if (!preventAtEnd || !end) return false;
|
|
23
|
+
const isSingleLineBlock = delimiter === "/**";
|
|
24
|
+
const delim = isSingleLineBlock ? "*" : delimiter;
|
|
25
|
+
const endAsterisks = allowWhitespace ? isSingleLineBlock ? endAsterisksSingleLineNoBlockWS : endAsterisksMultipleLineNoBlockWS : isSingleLineBlock ? endAsterisksSingleLineBlockWS : endAsterisksMultipleLineBlockWS;
|
|
26
|
+
const endingAsterisksAndSpaces = (allowWhitespace ? postDelimiter + description + delim : description + delim).match(endAsterisks);
|
|
27
|
+
if (!endingAsterisksAndSpaces || !isSingleLineBlock && endingAsterisksAndSpaces[1] && !endingAsterisksAndSpaces[1].trim()) return false;
|
|
28
|
+
const endFix = () => {
|
|
29
|
+
if (!isSingleLineBlock) tokens.delimiter = "";
|
|
30
|
+
tokens.description = (description + delim).replace(endAsterisks, "");
|
|
31
|
+
};
|
|
32
|
+
utils.reportJSDoc("Should be no multiple asterisks on end lines.", { line: number }, endFix, true);
|
|
33
|
+
return true;
|
|
34
|
+
});
|
|
72
35
|
}, {
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
}
|
|
92
|
-
},
|
|
93
|
-
type: 'object'
|
|
94
|
-
}],
|
|
95
|
-
type: 'suggestion'
|
|
96
|
-
}
|
|
36
|
+
iterateAllJsdocs: true,
|
|
37
|
+
meta: {
|
|
38
|
+
docs: {
|
|
39
|
+
description: "Prevents use of multiple asterisks at the beginning of lines.",
|
|
40
|
+
url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-multi-asterisks.md#repos-sticky-header"
|
|
41
|
+
},
|
|
42
|
+
fixable: "code",
|
|
43
|
+
schema: [{
|
|
44
|
+
additionalProperties: false,
|
|
45
|
+
properties: {
|
|
46
|
+
allowWhitespace: { type: "boolean" },
|
|
47
|
+
preventAtEnd: { type: "boolean" },
|
|
48
|
+
preventAtMiddleLines: { type: "boolean" }
|
|
49
|
+
},
|
|
50
|
+
type: "object"
|
|
51
|
+
}],
|
|
52
|
+
type: "suggestion"
|
|
53
|
+
}
|
|
97
54
|
});
|
|
98
|
-
|
|
55
|
+
|
|
56
|
+
//#endregion
|
|
57
|
+
exports.default = noMultiAsterisks_default;
|
|
99
58
|
//# sourceMappingURL=noMultiAsterisks.cjs.map
|