eslint-plugin-jsdoc 63.3.3 → 64.0.1
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/index.d.ts +14 -0
- package/package.json +23 -48
- package/src/index.js +22 -6
- package/dist/WarnSettings.cjs +0 -38
- package/dist/WarnSettings.cjs.map +0 -1
- package/dist/alignTransform.cjs +0 -402
- package/dist/alignTransform.cjs.map +0 -1
- package/dist/buildForbidRuleDefinition.cjs +0 -101
- package/dist/buildForbidRuleDefinition.cjs.map +0 -1
- package/dist/buildRejectOrPreferRuleDefinition.cjs +0 -352
- package/dist/buildRejectOrPreferRuleDefinition.cjs.map +0 -1
- package/dist/cjs/WarnSettings.d.ts +0 -16
- package/dist/cjs/alignTransform.d.ts +0 -33
- package/dist/cjs/buildForbidRuleDefinition.d.ts +0 -14
- package/dist/cjs/buildRejectOrPreferRuleDefinition.d.ts +0 -8
- package/dist/cjs/defaultTagOrder.d.ts +0 -4
- package/dist/cjs/exportParser.d.ts +0 -40
- package/dist/cjs/getDefaultTagStructureForMode.d.ts +0 -10
- package/dist/cjs/getJsdocProcessorPlugin.d.cts +0 -5
- package/dist/cjs/getJsdocProcessorPlugin.d.ts +0 -66
- package/dist/cjs/index-cjs.d.ts +0 -26
- package/dist/cjs/index.cjs.d.cts +0 -2
- package/dist/cjs/iterateJsdoc.d.cts +0 -7
- package/dist/cjs/iterateJsdoc.d.ts +0 -495
- package/dist/cjs/jsdocUtils.d.ts +0 -500
- package/dist/cjs/rules/checkAccess.d.ts +0 -2
- package/dist/cjs/rules/checkAlignment.d.ts +0 -2
- package/dist/cjs/rules/checkExamples.d.ts +0 -3
- package/dist/cjs/rules/checkIndentation.d.ts +0 -2
- package/dist/cjs/rules/checkLineAlignment.d.ts +0 -9
- package/dist/cjs/rules/checkParamNames.d.ts +0 -2
- package/dist/cjs/rules/checkPropertyNames.d.ts +0 -2
- package/dist/cjs/rules/checkSyntax.d.ts +0 -2
- package/dist/cjs/rules/checkTagNames.d.ts +0 -2
- package/dist/cjs/rules/checkTemplateNames.d.ts +0 -2
- package/dist/cjs/rules/checkTypes.d.ts +0 -7
- package/dist/cjs/rules/checkValues.d.ts +0 -2
- package/dist/cjs/rules/convertToJsdocComments.d.ts +0 -266
- package/dist/cjs/rules/emptyTags.d.ts +0 -2
- package/dist/cjs/rules/escapeInlineTags.d.ts +0 -2
- package/dist/cjs/rules/implementsOnClasses.d.ts +0 -2
- package/dist/cjs/rules/importsAsDependencies.d.ts +0 -2
- package/dist/cjs/rules/informativeDocs.d.ts +0 -2
- package/dist/cjs/rules/linesBeforeBlock.d.ts +0 -2
- package/dist/cjs/rules/matchDescription.d.ts +0 -2
- package/dist/cjs/rules/matchName.d.ts +0 -2
- package/dist/cjs/rules/multilineBlocks.d.ts +0 -2
- package/dist/cjs/rules/noBadBlocks.d.ts +0 -2
- package/dist/cjs/rules/noBlankBlockDescriptions.d.ts +0 -2
- package/dist/cjs/rules/noBlankBlocks.d.ts +0 -2
- package/dist/cjs/rules/noDefaults.d.ts +0 -2
- package/dist/cjs/rules/noMissingSyntax.d.ts +0 -9
- package/dist/cjs/rules/noMultiAsterisks.d.ts +0 -2
- package/dist/cjs/rules/noRestrictedSyntax.d.ts +0 -2
- package/dist/cjs/rules/noTypes.d.ts +0 -2
- package/dist/cjs/rules/noUndefinedTypes.d.ts +0 -2
- package/dist/cjs/rules/normalizeSeeLinks.d.ts +0 -2
- package/dist/cjs/rules/preferImportTag.d.ts +0 -2
- package/dist/cjs/rules/requireAsteriskPrefix.d.ts +0 -2
- package/dist/cjs/rules/requireDescription.d.ts +0 -2
- package/dist/cjs/rules/requireDescriptionCompleteSentence.d.ts +0 -2
- package/dist/cjs/rules/requireExample.d.ts +0 -2
- package/dist/cjs/rules/requireFileOverview.d.ts +0 -2
- package/dist/cjs/rules/requireHyphenBeforeParamDescription.d.ts +0 -2
- package/dist/cjs/rules/requireJsdoc.d.ts +0 -24
- package/dist/cjs/rules/requireParam.d.ts +0 -3
- package/dist/cjs/rules/requireParamDescription.d.ts +0 -2
- package/dist/cjs/rules/requireParamName.d.ts +0 -2
- package/dist/cjs/rules/requireParamType.d.ts +0 -2
- package/dist/cjs/rules/requireProperty.d.ts +0 -2
- package/dist/cjs/rules/requirePropertyDescription.d.ts +0 -2
- package/dist/cjs/rules/requirePropertyName.d.ts +0 -2
- package/dist/cjs/rules/requirePropertyType.d.ts +0 -2
- package/dist/cjs/rules/requireRejects.d.ts +0 -2
- package/dist/cjs/rules/requireReturns.d.ts +0 -2
- package/dist/cjs/rules/requireReturnsCheck.d.ts +0 -2
- package/dist/cjs/rules/requireReturnsDescription.d.ts +0 -2
- package/dist/cjs/rules/requireReturnsType.d.ts +0 -2
- package/dist/cjs/rules/requireTags.d.ts +0 -2
- package/dist/cjs/rules/requireTemplate.d.ts +0 -2
- package/dist/cjs/rules/requireThrows.d.ts +0 -2
- package/dist/cjs/rules/requireYields.d.ts +0 -2
- package/dist/cjs/rules/requireYieldsCheck.d.ts +0 -2
- package/dist/cjs/rules/sortTags.d.ts +0 -2
- package/dist/cjs/rules/tagLines.d.ts +0 -2
- package/dist/cjs/rules/textEscaping.d.ts +0 -2
- package/dist/cjs/rules/tsMethodSignatureStyle.d.ts +0 -2
- package/dist/cjs/rules/tsNoEmptyObjectType.d.ts +0 -2
- package/dist/cjs/rules/tsNoUnnecessaryTemplateExpression.d.ts +0 -2
- package/dist/cjs/rules/tsPreferFunctionType.d.ts +0 -2
- package/dist/cjs/rules/typeFormatting.d.ts +0 -2
- package/dist/cjs/rules/validTypes.d.ts +0 -2
- package/dist/cjs/tagNames.d.ts +0 -15
- package/dist/cjs/utils/hasReturnValue.d.ts +0 -19
- package/dist/defaultTagOrder.cjs +0 -46
- package/dist/defaultTagOrder.cjs.map +0 -1
- package/dist/exportParser.cjs +0 -732
- package/dist/exportParser.cjs.map +0 -1
- package/dist/generateDocs.cjs +0 -342
- package/dist/generateDocs.cjs.map +0 -1
- package/dist/generateOptions.cjs +0 -62
- package/dist/generateOptions.cjs.map +0 -1
- package/dist/generateRule.cjs +0 -248
- package/dist/generateRule.cjs.map +0 -1
- package/dist/generateRuleTypes.cjs +0 -24
- package/dist/generateRuleTypes.cjs.map +0 -1
- package/dist/getDefaultTagStructureForMode.cjs +0 -289
- package/dist/getDefaultTagStructureForMode.cjs.map +0 -1
- package/dist/getJsdocProcessorPlugin.cjs +0 -587
- package/dist/getJsdocProcessorPlugin.cjs.map +0 -1
- package/dist/getJsdocProcessorPlugin.cts +0 -5
- package/dist/index-cjs.cjs +0 -600
- package/dist/index-cjs.cjs.map +0 -1
- package/dist/index-cjs.d.ts +0 -27
- package/dist/index-esm.cjs +0 -162
- package/dist/index-esm.cjs.map +0 -1
- package/dist/index-esm.d.ts +0 -72
- package/dist/index.cjs +0 -748
- package/dist/index.cjs.cts +0 -3
- package/dist/index.cjs.map +0 -1
- package/dist/iterateJsdoc.cjs +0 -2150
- package/dist/iterateJsdoc.cjs.map +0 -1
- package/dist/iterateJsdoc.cts +0 -7
- package/dist/jsdocUtils.cjs +0 -1786
- package/dist/jsdocUtils.cjs.map +0 -1
- package/dist/rules/checkAccess.cjs +0 -40
- package/dist/rules/checkAccess.cjs.map +0 -1
- package/dist/rules/checkAlignment.cjs +0 -78
- package/dist/rules/checkAlignment.cjs.map +0 -1
- package/dist/rules/checkExamples.cjs +0 -521
- package/dist/rules/checkExamples.cjs.map +0 -1
- package/dist/rules/checkIndentation.cjs +0 -170
- package/dist/rules/checkIndentation.cjs.map +0 -1
- package/dist/rules/checkLineAlignment.cjs +0 -398
- package/dist/rules/checkLineAlignment.cjs.map +0 -1
- package/dist/rules/checkParamNames.cjs +0 -407
- package/dist/rules/checkParamNames.cjs.map +0 -1
- package/dist/rules/checkPropertyNames.cjs +0 -135
- package/dist/rules/checkPropertyNames.cjs.map +0 -1
- package/dist/rules/checkSyntax.cjs +0 -38
- package/dist/rules/checkSyntax.cjs.map +0 -1
- package/dist/rules/checkTagNames.cjs +0 -312
- package/dist/rules/checkTagNames.cjs.map +0 -1
- package/dist/rules/checkTemplateNames.cjs +0 -192
- package/dist/rules/checkTemplateNames.cjs.map +0 -1
- package/dist/rules/checkTypes.cjs +0 -111
- package/dist/rules/checkTypes.cjs.map +0 -1
- package/dist/rules/checkValues.cjs +0 -166
- package/dist/rules/checkValues.cjs.map +0 -1
- package/dist/rules/convertToJsdocComments.cjs +0 -356
- package/dist/rules/convertToJsdocComments.cjs.map +0 -1
- package/dist/rules/emptyTags.cjs +0 -98
- package/dist/rules/emptyTags.cjs.map +0 -1
- package/dist/rules/escapeInlineTags.cjs +0 -234
- package/dist/rules/escapeInlineTags.cjs.map +0 -1
- package/dist/rules/implementsOnClasses.cjs +0 -74
- package/dist/rules/implementsOnClasses.cjs.map +0 -1
- package/dist/rules/importsAsDependencies.cjs +0 -104
- package/dist/rules/importsAsDependencies.cjs.map +0 -1
- package/dist/rules/informativeDocs.cjs +0 -187
- package/dist/rules/informativeDocs.cjs.map +0 -1
- package/dist/rules/linesBeforeBlock.cjs +0 -120
- package/dist/rules/linesBeforeBlock.cjs.map +0 -1
- package/dist/rules/matchDescription.cjs +0 -356
- package/dist/rules/matchDescription.cjs.map +0 -1
- package/dist/rules/matchName.cjs +0 -160
- package/dist/rules/matchName.cjs.map +0 -1
- package/dist/rules/multilineBlocks.cjs +0 -431
- package/dist/rules/multilineBlocks.cjs.map +0 -1
- package/dist/rules/noBadBlocks.cjs +0 -100
- package/dist/rules/noBadBlocks.cjs.map +0 -1
- package/dist/rules/noBlankBlockDescriptions.cjs +0 -63
- package/dist/rules/noBlankBlockDescriptions.cjs.map +0 -1
- package/dist/rules/noBlankBlocks.cjs +0 -54
- package/dist/rules/noBlankBlocks.cjs.map +0 -1
- package/dist/rules/noDefaults.cjs +0 -102
- package/dist/rules/noDefaults.cjs.map +0 -1
- package/dist/rules/noMissingSyntax.cjs +0 -196
- package/dist/rules/noMissingSyntax.cjs.map +0 -1
- package/dist/rules/noMultiAsterisks.cjs +0 -126
- package/dist/rules/noMultiAsterisks.cjs.map +0 -1
- package/dist/rules/noRestrictedSyntax.cjs +0 -68
- package/dist/rules/noRestrictedSyntax.cjs.map +0 -1
- package/dist/rules/noTypes.cjs +0 -101
- package/dist/rules/noTypes.cjs.map +0 -1
- package/dist/rules/noUndefinedTypes.cjs +0 -616
- package/dist/rules/noUndefinedTypes.cjs.map +0 -1
- package/dist/rules/normalizeSeeLinks.cjs +0 -271
- package/dist/rules/normalizeSeeLinks.cjs.map +0 -1
- package/dist/rules/preferImportTag.cjs +0 -362
- package/dist/rules/preferImportTag.cjs.map +0 -1
- package/dist/rules/requireAsteriskPrefix.cjs +0 -190
- package/dist/rules/requireAsteriskPrefix.cjs.map +0 -1
- package/dist/rules/requireDescription.cjs +0 -164
- package/dist/rules/requireDescription.cjs.map +0 -1
- package/dist/rules/requireDescriptionCompleteSentence.cjs +0 -321
- package/dist/rules/requireDescriptionCompleteSentence.cjs.map +0 -1
- package/dist/rules/requireExample.cjs +0 -136
- package/dist/rules/requireExample.cjs.map +0 -1
- package/dist/rules/requireFileOverview.cjs +0 -194
- package/dist/rules/requireFileOverview.cjs.map +0 -1
- package/dist/rules/requireHyphenBeforeParamDescription.cjs +0 -166
- package/dist/rules/requireHyphenBeforeParamDescription.cjs.map +0 -1
- package/dist/rules/requireJsdoc.cjs +0 -721
- package/dist/rules/requireJsdoc.cjs.map +0 -1
- package/dist/rules/requireParam.cjs +0 -772
- package/dist/rules/requireParam.cjs.map +0 -1
- package/dist/rules/requireParamDescription.cjs +0 -105
- package/dist/rules/requireParamDescription.cjs.map +0 -1
- package/dist/rules/requireParamName.cjs +0 -68
- package/dist/rules/requireParamName.cjs.map +0 -1
- package/dist/rules/requireParamType.cjs +0 -104
- package/dist/rules/requireParamType.cjs.map +0 -1
- package/dist/rules/requireProperty.cjs +0 -63
- package/dist/rules/requireProperty.cjs.map +0 -1
- package/dist/rules/requirePropertyDescription.cjs +0 -29
- package/dist/rules/requirePropertyDescription.cjs.map +0 -1
- package/dist/rules/requirePropertyName.cjs +0 -29
- package/dist/rules/requirePropertyName.cjs.map +0 -1
- package/dist/rules/requirePropertyType.cjs +0 -29
- package/dist/rules/requirePropertyType.cjs.map +0 -1
- package/dist/rules/requireRejects.cjs +0 -226
- package/dist/rules/requireRejects.cjs.map +0 -1
- package/dist/rules/requireReturns.cjs +0 -262
- package/dist/rules/requireReturns.cjs.map +0 -1
- package/dist/rules/requireReturnsCheck.cjs +0 -225
- package/dist/rules/requireReturnsCheck.cjs.map +0 -1
- package/dist/rules/requireReturnsDescription.cjs +0 -72
- package/dist/rules/requireReturnsDescription.cjs.map +0 -1
- package/dist/rules/requireReturnsType.cjs +0 -68
- package/dist/rules/requireReturnsType.cjs.map +0 -1
- package/dist/rules/requireTags.cjs +0 -74
- package/dist/rules/requireTags.cjs.map +0 -1
- package/dist/rules/requireTemplate.cjs +0 -220
- package/dist/rules/requireTemplate.cjs.map +0 -1
- package/dist/rules/requireThrows.cjs +0 -118
- package/dist/rules/requireThrows.cjs.map +0 -1
- package/dist/rules/requireYields.cjs +0 -224
- package/dist/rules/requireYields.cjs.map +0 -1
- package/dist/rules/requireYieldsCheck.cjs +0 -179
- package/dist/rules/requireYieldsCheck.cjs.map +0 -1
- package/dist/rules/sortTags.cjs +0 -656
- package/dist/rules/sortTags.cjs.map +0 -1
- package/dist/rules/tagLines.cjs +0 -374
- package/dist/rules/tagLines.cjs.map +0 -1
- package/dist/rules/textEscaping.cjs +0 -141
- package/dist/rules/textEscaping.cjs.map +0 -1
- package/dist/rules/tsMethodSignatureStyle.cjs +0 -240
- package/dist/rules/tsMethodSignatureStyle.cjs.map +0 -1
- package/dist/rules/tsNoEmptyObjectType.cjs +0 -62
- package/dist/rules/tsNoEmptyObjectType.cjs.map +0 -1
- package/dist/rules/tsNoUnnecessaryTemplateExpression.cjs +0 -104
- package/dist/rules/tsNoUnnecessaryTemplateExpression.cjs.map +0 -1
- package/dist/rules/tsPreferFunctionType.cjs +0 -110
- package/dist/rules/tsPreferFunctionType.cjs.map +0 -1
- package/dist/rules/typeFormatting.cjs +0 -607
- package/dist/rules/typeFormatting.cjs.map +0 -1
- package/dist/rules/validTypes.cjs +0 -324
- package/dist/rules/validTypes.cjs.map +0 -1
- package/dist/tagNames.cjs +0 -244
- package/dist/tagNames.cjs.map +0 -1
- package/dist/to-valid-identifier.cjs +0 -263
- package/dist/utils/hasReturnValue.cjs +0 -495
- package/dist/utils/hasReturnValue.cjs.map +0 -1
- package/rollup.config.js +0 -16
- package/src/getJsdocProcessorPlugin.cts +0 -5
- package/src/index-cjs.js +0 -760
- package/src/index-esm.js +0 -196
- package/src/index.cjs.cts +0 -3
- package/src/iterateJsdoc.cts +0 -7
|
@@ -1,164 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
|
|
3
|
-
Object.defineProperty(exports, "__esModule", {
|
|
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 }; }
|
|
9
|
-
/**
|
|
10
|
-
* @param {string} description
|
|
11
|
-
* @returns {import('../iterateJsdoc.js').Integer}
|
|
12
|
-
*/
|
|
13
|
-
const checkDescription = description => {
|
|
14
|
-
return description.trim().split('\n').filter(Boolean).length;
|
|
15
|
-
};
|
|
16
|
-
var _default = exports.default = (0, _iterateJsdoc.default)(({
|
|
17
|
-
context,
|
|
18
|
-
jsdoc,
|
|
19
|
-
report,
|
|
20
|
-
utils
|
|
21
|
-
}) => {
|
|
22
|
-
if (utils.avoidDocs()) {
|
|
23
|
-
return;
|
|
24
|
-
}
|
|
25
|
-
const {
|
|
26
|
-
descriptionStyle = 'body'
|
|
27
|
-
} = context.options[0] || {};
|
|
28
|
-
let targetTagName = utils.getPreferredTagName({
|
|
29
|
-
// We skip reporting except when `@description` is essential to the rule,
|
|
30
|
-
// so user can block the tag and still meaningfully use this rule
|
|
31
|
-
// even if the tag is present (and `check-tag-names` is the one to
|
|
32
|
-
// normally report the fact that it is blocked but present)
|
|
33
|
-
skipReportingBlockedTag: descriptionStyle !== 'tag',
|
|
34
|
-
tagName: 'description'
|
|
35
|
-
});
|
|
36
|
-
if (!targetTagName) {
|
|
37
|
-
return;
|
|
38
|
-
}
|
|
39
|
-
const isBlocked = typeof targetTagName === 'object' && 'blocked' in targetTagName && targetTagName.blocked;
|
|
40
|
-
if (isBlocked) {
|
|
41
|
-
targetTagName = /** @type {{blocked: true; tagName: string;}} */targetTagName.tagName;
|
|
42
|
-
}
|
|
43
|
-
if (descriptionStyle !== 'tag') {
|
|
44
|
-
const {
|
|
45
|
-
description
|
|
46
|
-
} = utils.getDescription();
|
|
47
|
-
if (checkDescription(description || '')) {
|
|
48
|
-
return;
|
|
49
|
-
}
|
|
50
|
-
if (descriptionStyle === 'body') {
|
|
51
|
-
const descTags = utils.getPresentTags(['desc', 'description']);
|
|
52
|
-
if (descTags.length) {
|
|
53
|
-
const [{
|
|
54
|
-
tag: tagName
|
|
55
|
-
}] = descTags;
|
|
56
|
-
report(`Remove the @${tagName} tag to leave a plain block description or add additional description text above the @${tagName} line.`);
|
|
57
|
-
} else {
|
|
58
|
-
report('Missing JSDoc block description.');
|
|
59
|
-
}
|
|
60
|
-
return;
|
|
61
|
-
}
|
|
62
|
-
}
|
|
63
|
-
const functionExamples = isBlocked ? [] : jsdoc.tags.filter(({
|
|
64
|
-
tag
|
|
65
|
-
}) => {
|
|
66
|
-
return tag === targetTagName;
|
|
67
|
-
});
|
|
68
|
-
if (!functionExamples.length) {
|
|
69
|
-
report(descriptionStyle === 'any' ? `Missing JSDoc block description or @${targetTagName} declaration.` : `Missing JSDoc @${targetTagName} declaration.`);
|
|
70
|
-
return;
|
|
71
|
-
}
|
|
72
|
-
for (const example of functionExamples) {
|
|
73
|
-
if (!checkDescription(`${example.name} ${utils.getTagDescription(example)}`)) {
|
|
74
|
-
report(`Missing JSDoc @${targetTagName} description.`, null, example);
|
|
75
|
-
}
|
|
76
|
-
}
|
|
77
|
-
}, {
|
|
78
|
-
contextDefaults: true,
|
|
79
|
-
meta: {
|
|
80
|
-
docs: {
|
|
81
|
-
description: 'Requires that all functions (and potentially other contexts) have a description.',
|
|
82
|
-
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-description.md#repos-sticky-header'
|
|
83
|
-
},
|
|
84
|
-
schema: [{
|
|
85
|
-
additionalProperties: false,
|
|
86
|
-
properties: {
|
|
87
|
-
checkConstructors: {
|
|
88
|
-
default: true,
|
|
89
|
-
description: `A value indicating whether \`constructor\`s should be
|
|
90
|
-
checked. Defaults to \`true\`.`,
|
|
91
|
-
type: 'boolean'
|
|
92
|
-
},
|
|
93
|
-
checkGetters: {
|
|
94
|
-
default: true,
|
|
95
|
-
description: `A value indicating whether getters should be checked.
|
|
96
|
-
Defaults to \`true\`.`,
|
|
97
|
-
type: 'boolean'
|
|
98
|
-
},
|
|
99
|
-
checkSetters: {
|
|
100
|
-
default: true,
|
|
101
|
-
description: `A value indicating whether setters should be checked.
|
|
102
|
-
Defaults to \`true\`.`,
|
|
103
|
-
type: 'boolean'
|
|
104
|
-
},
|
|
105
|
-
contexts: {
|
|
106
|
-
description: `Set to an array of strings representing the AST context
|
|
107
|
-
where you wish the rule to be applied (e.g., \`ClassDeclaration\` for ES6
|
|
108
|
-
classes).
|
|
109
|
-
|
|
110
|
-
\`context\` defaults to \`any\` and \`comment\` defaults to no specific comment context.
|
|
111
|
-
|
|
112
|
-
Overrides the default contexts (\`ArrowFunctionExpression\`,
|
|
113
|
-
\`FunctionDeclaration\`, \`FunctionExpression\`). Set to \`"any"\` if you want
|
|
114
|
-
the rule to apply to any JSDoc block throughout your files (as is necessary
|
|
115
|
-
for finding function blocks not attached to a function declaration or
|
|
116
|
-
expression, i.e., \`@callback\` or \`@function\` (or its aliases \`@func\` or
|
|
117
|
-
\`@method\`) (including those associated with an \`@interface\`).
|
|
118
|
-
|
|
119
|
-
See the ["AST and Selectors"](../advanced.md#ast-and-selectors)
|
|
120
|
-
section of our Advanced docs for more on the expected format.`,
|
|
121
|
-
items: {
|
|
122
|
-
anyOf: [{
|
|
123
|
-
type: 'string'
|
|
124
|
-
}, {
|
|
125
|
-
additionalProperties: false,
|
|
126
|
-
properties: {
|
|
127
|
-
comment: {
|
|
128
|
-
type: 'string'
|
|
129
|
-
},
|
|
130
|
-
context: {
|
|
131
|
-
type: 'string'
|
|
132
|
-
}
|
|
133
|
-
},
|
|
134
|
-
type: 'object'
|
|
135
|
-
}]
|
|
136
|
-
},
|
|
137
|
-
type: 'array'
|
|
138
|
-
},
|
|
139
|
-
descriptionStyle: {
|
|
140
|
-
description: `Whether to accept implicit descriptions (\`"body"\`) or
|
|
141
|
-
\`@description\` tags (\`"tag"\`) as satisfying the rule. Set to \`"any"\` to
|
|
142
|
-
accept either style. Defaults to \`"body"\`.`,
|
|
143
|
-
enum: ['body', 'tag', 'any'],
|
|
144
|
-
type: 'string'
|
|
145
|
-
},
|
|
146
|
-
exemptedBy: {
|
|
147
|
-
description: `Array of tags (e.g., \`['type']\`) whose presence on the
|
|
148
|
-
document block avoids the need for a \`@description\`. Defaults to an
|
|
149
|
-
array with \`inheritdoc\`. If you set this array, it will overwrite the
|
|
150
|
-
default, so be sure to add back \`inheritdoc\` if you wish its presence
|
|
151
|
-
to cause exemption of the rule.`,
|
|
152
|
-
items: {
|
|
153
|
-
type: 'string'
|
|
154
|
-
},
|
|
155
|
-
type: 'array'
|
|
156
|
-
}
|
|
157
|
-
},
|
|
158
|
-
type: 'object'
|
|
159
|
-
}],
|
|
160
|
-
type: 'suggestion'
|
|
161
|
-
}
|
|
162
|
-
});
|
|
163
|
-
module.exports = exports.default;
|
|
164
|
-
//# sourceMappingURL=requireDescription.cjs.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"requireDescription.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/requireDescription.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {string} description\n * @returns {import('../iterateJsdoc.js').Integer}\n */\nconst checkDescription = (description) => {\n return description\n .trim()\n .split('\\n')\n .filter(Boolean)\n .length;\n};\n\nexport default iterateJsdoc(({\n context,\n jsdoc,\n report,\n utils,\n}) => {\n if (utils.avoidDocs()) {\n return;\n }\n\n const {\n descriptionStyle = 'body',\n } = context.options[0] || {};\n\n let targetTagName = utils.getPreferredTagName({\n // We skip reporting except when `@description` is essential to the rule,\n // so user can block the tag and still meaningfully use this rule\n // even if the tag is present (and `check-tag-names` is the one to\n // normally report the fact that it is blocked but present)\n skipReportingBlockedTag: descriptionStyle !== 'tag',\n tagName: 'description',\n });\n if (!targetTagName) {\n return;\n }\n\n const isBlocked = typeof targetTagName === 'object' && 'blocked' in targetTagName && targetTagName.blocked;\n if (isBlocked) {\n targetTagName = /** @type {{blocked: true; tagName: string;}} */ (\n targetTagName\n ).tagName;\n }\n\n if (descriptionStyle !== 'tag') {\n const {\n description,\n } = utils.getDescription();\n if (checkDescription(description || '')) {\n return;\n }\n\n if (descriptionStyle === 'body') {\n const descTags = utils.getPresentTags([\n 'desc', 'description',\n ]);\n if (descTags.length) {\n const [\n {\n tag: tagName,\n },\n ] = descTags;\n report(`Remove the @${tagName} tag to leave a plain block description or add additional description text above the @${tagName} line.`);\n } else {\n report('Missing JSDoc block description.');\n }\n\n return;\n }\n }\n\n const functionExamples = isBlocked ?\n [] :\n jsdoc.tags.filter(({\n tag,\n }) => {\n return tag === targetTagName;\n });\n\n if (!functionExamples.length) {\n report(\n descriptionStyle === 'any' ?\n `Missing JSDoc block description or @${targetTagName} declaration.` :\n `Missing JSDoc @${targetTagName} declaration.`,\n );\n\n return;\n }\n\n for (const example of functionExamples) {\n if (!checkDescription(`${example.name} ${utils.getTagDescription(example)}`)) {\n report(`Missing JSDoc @${targetTagName} description.`, null, example);\n }\n }\n}, {\n contextDefaults: true,\n meta: {\n docs: {\n description: 'Requires that all functions (and potentially other contexts) have a description.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-description.md#repos-sticky-header',\n },\n schema: [\n {\n additionalProperties: false,\n properties: {\n checkConstructors: {\n default: true,\n description: `A value indicating whether \\`constructor\\`s should be\nchecked. Defaults to \\`true\\`.`,\n type: 'boolean',\n },\n checkGetters: {\n default: true,\n description: `A value indicating whether getters should be checked.\nDefaults to \\`true\\`.`,\n type: 'boolean',\n },\n checkSetters: {\n default: true,\n description: `A value indicating whether setters should be checked.\nDefaults to \\`true\\`.`,\n type: 'boolean',\n },\n contexts: {\n description: `Set to an array of strings representing the AST context\nwhere you wish the rule to be applied (e.g., \\`ClassDeclaration\\` for ES6\nclasses).\n\n\\`context\\` defaults to \\`any\\` and \\`comment\\` defaults to no specific comment context.\n\nOverrides the default contexts (\\`ArrowFunctionExpression\\`,\n\\`FunctionDeclaration\\`, \\`FunctionExpression\\`). Set to \\`\"any\"\\` if you want\nthe rule to apply to any JSDoc block throughout your files (as is necessary\nfor finding function blocks not attached to a function declaration or\nexpression, i.e., \\`@callback\\` or \\`@function\\` (or its aliases \\`@func\\` or\n\\`@method\\`) (including those associated with an \\`@interface\\`).\n\nSee the [\"AST and Selectors\"](../advanced.md#ast-and-selectors)\nsection of our Advanced docs for more on the expected format.`,\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 descriptionStyle: {\n description: `Whether to accept implicit descriptions (\\`\"body\"\\`) or\n\\`@description\\` tags (\\`\"tag\"\\`) as satisfying the rule. Set to \\`\"any\"\\` to\naccept either style. Defaults to \\`\"body\"\\`.`,\n enum: [\n 'body', 'tag', 'any',\n ],\n type: 'string',\n },\n exemptedBy: {\n description: `Array of tags (e.g., \\`['type']\\`) whose presence on the\ndocument block avoids the need for a \\`@description\\`. Defaults to an\narray with \\`inheritdoc\\`. If you set this array, it will overwrite the\ndefault, so be sure to add back \\`inheritdoc\\` if you wish its presence\nto cause exemption of the rule.`,\n items: {\n type: 'string',\n },\n type: 'array',\n },\n },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n});\n"],"mappings":";;;;;;AAAA;AAA8C;AAE9C;AACA;AACA;AACA;AACA,MAAM,gBAAgB,GAAI,WAAW,IAAK;EACxC,OAAO,WAAW,CACf,IAAI,CAAC,CAAC,CACN,KAAK,CAAC,IAAI,CAAC,CACX,MAAM,CAAC,OAAO,CAAC,CACf,MAAM;AACX,CAAC;AAAC,iCAEa,IAAAA,qBAAY,EAAC,CAAC;EAC3B,OAAO;EACP,KAAK;EACL,MAAM;EACN;AACF,CAAC,KAAK;EACJ,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE;IACrB;EACF;EAEA,MAAM;IACJ,gBAAgB,GAAG;EACrB,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAE5B,IAAI,aAAa,GAAG,KAAK,CAAC,mBAAmB,CAAC;IAC5C;IACA;IACA;IACA;IACA,uBAAuB,EAAE,gBAAgB,KAAK,KAAK;IACnD,OAAO,EAAE;EACX,CAAC,CAAC;EACF,IAAI,CAAC,aAAa,EAAE;IAClB;EACF;EAEA,MAAM,SAAS,GAAG,OAAO,aAAa,KAAK,QAAQ,IAAI,SAAS,IAAI,aAAa,IAAI,aAAa,CAAC,OAAO;EAC1G,IAAI,SAAS,EAAE;IACb,aAAa,GAAG,gDACd,aAAa,CACb,OAAO;EACX;EAEA,IAAI,gBAAgB,KAAK,KAAK,EAAE;IAC9B,MAAM;MACJ;IACF,CAAC,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;IAC1B,IAAI,gBAAgB,CAAC,WAAW,IAAI,EAAE,CAAC,EAAE;MACvC;IACF;IAEA,IAAI,gBAAgB,KAAK,MAAM,EAAE;MAC/B,MAAM,QAAQ,GAAG,KAAK,CAAC,cAAc,CAAC,CACpC,MAAM,EAAE,aAAa,CACtB,CAAC;MACF,IAAI,QAAQ,CAAC,MAAM,EAAE;QACnB,MAAM,CACJ;UACE,GAAG,EAAE;QACP,CAAC,CACF,GAAG,QAAQ;QACZ,MAAM,CAAC,eAAe,OAAO,yFAAyF,OAAO,QAAQ,CAAC;MACxI,CAAC,MAAM;QACL,MAAM,CAAC,kCAAkC,CAAC;MAC5C;MAEA;IACF;EACF;EAEA,MAAM,gBAAgB,GAAG,SAAS,GAChC,EAAE,GACF,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACjB;EACF,CAAC,KAAK;IACJ,OAAO,GAAG,KAAK,aAAa;EAC9B,CAAC,CAAC;EAEJ,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE;IAC5B,MAAM,CACJ,gBAAgB,KAAK,KAAK,GACxB,uCAAuC,aAAa,eAAe,GACnE,kBAAkB,aAAa,eACnC,CAAC;IAED;EACF;EAEA,KAAK,MAAM,OAAO,IAAI,gBAAgB,EAAE;IACtC,IAAI,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAC,IAAI,IAAI,KAAK,CAAC,iBAAiB,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;MAC5E,MAAM,CAAC,kBAAkB,aAAa,eAAe,EAAE,IAAI,EAAE,OAAO,CAAC;IACvE;EACF;AACF,CAAC,EAAE;EACD,eAAe,EAAE,IAAI;EACrB,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EAAE,kFAAkF;MAC/F,GAAG,EAAE;IACP,CAAC;IACD,MAAM,EAAE,CACN;MACE,oBAAoB,EAAE,KAAK;MAC3B,UAAU,EAAE;QACV,iBAAiB,EAAE;UACjB,OAAO,EAAE,IAAI;UACb,WAAW,EAAE;AACzB,+BAA+B;UACnB,IAAI,EAAE;QACR,CAAC;QACD,YAAY,EAAE;UACZ,OAAO,EAAE,IAAI;UACb,WAAW,EAAE;AACzB,sBAAsB;UACV,IAAI,EAAE;QACR,CAAC;QACD,YAAY,EAAE;UACZ,OAAO,EAAE,IAAI;UACb,WAAW,EAAE;AACzB,sBAAsB;UACV,IAAI,EAAE;QACR,CAAC;QACD,QAAQ,EAAE;UACR,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,8DAA8D;UAClD,KAAK,EAAE;YACL,KAAK,EAAE,CACL;cACE,IAAI,EAAE;YACR,CAAC,EACD;cACE,oBAAoB,EAAE,KAAK;cAC3B,UAAU,EAAE;gBACV,OAAO,EAAE;kBACP,IAAI,EAAE;gBACR,CAAC;gBACD,OAAO,EAAE;kBACP,IAAI,EAAE;gBACR;cACF,CAAC;cACD,IAAI,EAAE;YACR,CAAC;UAEL,CAAC;UACD,IAAI,EAAE;QACR,CAAC;QACD,gBAAgB,EAAE;UAChB,WAAW,EAAE;AACzB;AACA,6CAA6C;UACjC,IAAI,EAAE,CACJ,MAAM,EAAE,KAAK,EAAE,KAAK,CACrB;UACD,IAAI,EAAE;QACR,CAAC;QACD,UAAU,EAAE;UACV,WAAW,EAAE;AACzB;AACA;AACA;AACA,gCAAgC;UACpB,KAAK,EAAE;YACL,IAAI,EAAE;UACR,CAAC;UACD,IAAI,EAAE;QACR;MACF,CAAC;MACD,IAAI,EAAE;IACR,CAAC,CACF;IACD,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA","ignoreList":[]}
|
|
@@ -1,321 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
|
|
3
|
-
Object.defineProperty(exports, "__esModule", {
|
|
4
|
-
value: true
|
|
5
|
-
});
|
|
6
|
-
exports.default = void 0;
|
|
7
|
-
var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
|
|
8
|
-
var _escapeStringRegexp = _interopRequireDefault(require("escape-string-regexp"));
|
|
9
|
-
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
|
|
10
|
-
const otherDescriptiveTags = new Set(['classdesc', 'deprecated', 'exception', 'file', 'fileoverview', 'overview',
|
|
11
|
-
// 'copyright' and 'see' might be good addition, but as the former may be
|
|
12
|
-
// sensitive text, and the latter may have just a link, they are not
|
|
13
|
-
// included by default
|
|
14
|
-
'summary', 'throws', 'todo', 'yield', 'yields']);
|
|
15
|
-
|
|
16
|
-
/**
|
|
17
|
-
* @param {string} text
|
|
18
|
-
* @returns {string[]}
|
|
19
|
-
*/
|
|
20
|
-
const extractParagraphs = text => {
|
|
21
|
-
return text.split(/(?<![;:])\n\n+/v);
|
|
22
|
-
};
|
|
23
|
-
|
|
24
|
-
/**
|
|
25
|
-
* @param {string} text
|
|
26
|
-
* @param {string|RegExp} abbreviationsRegex
|
|
27
|
-
* @returns {string[]}
|
|
28
|
-
*/
|
|
29
|
-
const extractSentences = (text, abbreviationsRegex) => {
|
|
30
|
-
const txt = text
|
|
31
|
-
// Remove all {} tags.
|
|
32
|
-
.replaceAll(/(?<!^)\{[\s\S]*?\}\s*/gv, '')
|
|
33
|
-
|
|
34
|
-
// Remove custom abbreviations
|
|
35
|
-
.replace(abbreviationsRegex, '');
|
|
36
|
-
const sentenceEndGrouping = /([.?!])(?:\s+|$)/gv;
|
|
37
|
-
const puncts = [...txt.matchAll(sentenceEndGrouping)].map(sentEnd => {
|
|
38
|
-
return sentEnd[0];
|
|
39
|
-
});
|
|
40
|
-
return txt.split(/[.?!](?:\s+|$)/v)
|
|
41
|
-
|
|
42
|
-
// Re-add the dot.
|
|
43
|
-
.map((sentence, idx) => {
|
|
44
|
-
return !puncts[idx] && /^\s*$/v.test(sentence) ? sentence : `${sentence}${puncts[idx] || ''}`;
|
|
45
|
-
});
|
|
46
|
-
};
|
|
47
|
-
|
|
48
|
-
/**
|
|
49
|
-
* @param {string} text
|
|
50
|
-
* @returns {boolean}
|
|
51
|
-
*/
|
|
52
|
-
const isNewLinePrecededByAPeriod = text => {
|
|
53
|
-
/** @type {boolean} */
|
|
54
|
-
let lastLineEndsSentence;
|
|
55
|
-
const lines = text.split('\n');
|
|
56
|
-
return !lines.some(line => {
|
|
57
|
-
if (lastLineEndsSentence === false && /^[A-Z][a-z]/v.test(line)) {
|
|
58
|
-
return true;
|
|
59
|
-
}
|
|
60
|
-
lastLineEndsSentence = /[.:?!\|]$/v.test(line);
|
|
61
|
-
return false;
|
|
62
|
-
});
|
|
63
|
-
};
|
|
64
|
-
|
|
65
|
-
/**
|
|
66
|
-
* @param {string} str
|
|
67
|
-
* @returns {boolean}
|
|
68
|
-
*/
|
|
69
|
-
const isCapitalized = str => {
|
|
70
|
-
return str[0] === str[0].toUpperCase();
|
|
71
|
-
};
|
|
72
|
-
|
|
73
|
-
/**
|
|
74
|
-
* @param {string} str
|
|
75
|
-
* @returns {boolean}
|
|
76
|
-
*/
|
|
77
|
-
const isTable = str => {
|
|
78
|
-
return str.charAt(0) === '|';
|
|
79
|
-
};
|
|
80
|
-
|
|
81
|
-
/**
|
|
82
|
-
* @param {string} str
|
|
83
|
-
* @returns {string}
|
|
84
|
-
*/
|
|
85
|
-
const capitalize = str => {
|
|
86
|
-
return str.charAt(0).toUpperCase() + str.slice(1);
|
|
87
|
-
};
|
|
88
|
-
|
|
89
|
-
/**
|
|
90
|
-
* @param {string} description
|
|
91
|
-
* @param {import('../iterateJsdoc.js').Report} reportOrig
|
|
92
|
-
* @param {import('eslint').Rule.Node} jsdocNode
|
|
93
|
-
* @param {string|RegExp} abbreviationsRegex
|
|
94
|
-
* @param {import('eslint').SourceCode} sourceCode
|
|
95
|
-
* @param {import('comment-parser').Spec|{
|
|
96
|
-
* line: import('../iterateJsdoc.js').Integer
|
|
97
|
-
* }} tag
|
|
98
|
-
* @param {boolean} newlineBeforeCapsAssumesBadSentenceEnd
|
|
99
|
-
* @returns {boolean}
|
|
100
|
-
*/
|
|
101
|
-
const validateDescription = (description, reportOrig, jsdocNode, abbreviationsRegex, sourceCode, tag, newlineBeforeCapsAssumesBadSentenceEnd) => {
|
|
102
|
-
if (!description || /^\n+$/v.test(description)) {
|
|
103
|
-
return false;
|
|
104
|
-
}
|
|
105
|
-
const descriptionNoHeadings = description.replaceAll(/^\s*#[^\n]*(\n|$)/gmv, '');
|
|
106
|
-
const paragraphs = extractParagraphs(descriptionNoHeadings).filter(Boolean);
|
|
107
|
-
return paragraphs.some((paragraph, parIdx) => {
|
|
108
|
-
const sentences = extractSentences(paragraph, abbreviationsRegex);
|
|
109
|
-
const fix = /** @type {import('eslint').Rule.ReportFixer} */fixer => {
|
|
110
|
-
let text = sourceCode.getText(jsdocNode);
|
|
111
|
-
if (!/[.:?!]$/v.test(paragraph)) {
|
|
112
|
-
const line = paragraph.split('\n').findLast(Boolean);
|
|
113
|
-
text = text.replace(new RegExp(`${(0, _escapeStringRegexp.default)(/** @type {string} */
|
|
114
|
-
line)}$`, 'mv'), `${line}.`);
|
|
115
|
-
}
|
|
116
|
-
for (const sentence of sentences.filter(sentence_ => {
|
|
117
|
-
return !/^\s*$/v.test(sentence_) && !isCapitalized(sentence_) && !isTable(sentence_);
|
|
118
|
-
})) {
|
|
119
|
-
const beginning = sentence.split('\n')[0];
|
|
120
|
-
if ('tag' in tag && tag.tag) {
|
|
121
|
-
const reg = new RegExp(`(@${(0, _escapeStringRegexp.default)(tag.tag)}.*)${(0, _escapeStringRegexp.default)(beginning)}`, 'v');
|
|
122
|
-
text = text.replace(reg, (_$0, $1) => {
|
|
123
|
-
return $1 + capitalize(beginning);
|
|
124
|
-
});
|
|
125
|
-
} else {
|
|
126
|
-
text = text.replace(new RegExp('((?:[.?!]|\\*|\\})\\s*)' + (0, _escapeStringRegexp.default)(beginning), 'v'), '$1' + capitalize(beginning));
|
|
127
|
-
}
|
|
128
|
-
}
|
|
129
|
-
return fixer.replaceText(jsdocNode, text);
|
|
130
|
-
};
|
|
131
|
-
|
|
132
|
-
/**
|
|
133
|
-
* @param {string} msg
|
|
134
|
-
* @param {import('eslint').Rule.ReportFixer | null | undefined} fixer
|
|
135
|
-
* @param {{
|
|
136
|
-
* line?: number | undefined;
|
|
137
|
-
* column?: number | undefined;
|
|
138
|
-
* } | (import('comment-parser').Spec & {
|
|
139
|
-
* line?: number | undefined;
|
|
140
|
-
* column?: number | undefined;
|
|
141
|
-
* })} tagObj
|
|
142
|
-
* @returns {void}
|
|
143
|
-
*/
|
|
144
|
-
const report = (msg, fixer, tagObj) => {
|
|
145
|
-
if ('line' in tagObj) {
|
|
146
|
-
/**
|
|
147
|
-
* @type {{
|
|
148
|
-
* line: number;
|
|
149
|
-
* }}
|
|
150
|
-
*/
|
|
151
|
-
tagObj.line += parIdx * 2;
|
|
152
|
-
} else {
|
|
153
|
-
/** @type {import('comment-parser').Spec} */tagObj.source[0].number += parIdx * 2;
|
|
154
|
-
}
|
|
155
|
-
|
|
156
|
-
// Avoid errors if old column doesn't exist here
|
|
157
|
-
tagObj.column = 0;
|
|
158
|
-
reportOrig(msg, fixer, tagObj);
|
|
159
|
-
};
|
|
160
|
-
if (sentences.some(sentence => {
|
|
161
|
-
return /^[.?!]$/v.test(sentence);
|
|
162
|
-
})) {
|
|
163
|
-
report('Sentences must be more than punctuation.', null, tag);
|
|
164
|
-
}
|
|
165
|
-
if (sentences.some(sentence => {
|
|
166
|
-
return !/^\s*$/v.test(sentence) && !isCapitalized(sentence) && !isTable(sentence);
|
|
167
|
-
})) {
|
|
168
|
-
report('Sentences should start with an uppercase character.', fix, tag);
|
|
169
|
-
}
|
|
170
|
-
const paragraphNoAbbreviations = paragraph.replace(abbreviationsRegex, '');
|
|
171
|
-
if (!/(?:[.?!\|]|```)\s*$/v.test(paragraphNoAbbreviations)) {
|
|
172
|
-
report('Sentences must end with a period.', fix, tag);
|
|
173
|
-
return true;
|
|
174
|
-
}
|
|
175
|
-
if (newlineBeforeCapsAssumesBadSentenceEnd && !isNewLinePrecededByAPeriod(paragraphNoAbbreviations)) {
|
|
176
|
-
report('A line of text is started with an uppercase character, but the preceding line does not end the sentence.', null, tag);
|
|
177
|
-
return true;
|
|
178
|
-
}
|
|
179
|
-
return false;
|
|
180
|
-
});
|
|
181
|
-
};
|
|
182
|
-
var _default = exports.default = (0, _iterateJsdoc.default)(({
|
|
183
|
-
context,
|
|
184
|
-
jsdoc,
|
|
185
|
-
jsdocNode,
|
|
186
|
-
report,
|
|
187
|
-
sourceCode,
|
|
188
|
-
utils
|
|
189
|
-
}) => {
|
|
190
|
-
const /** @type {{abbreviations: string[], newlineBeforeCapsAssumesBadSentenceEnd: boolean}} */{
|
|
191
|
-
abbreviations = [],
|
|
192
|
-
newlineBeforeCapsAssumesBadSentenceEnd = false
|
|
193
|
-
} = context.options[0] || {};
|
|
194
|
-
|
|
195
|
-
// `@inheritDoc` can be used as inline tag with TSDoc/typedoc: https://typedoc.org/documents/Tags.__inheritDoc_.html
|
|
196
|
-
if (utils.getInlineTags().some(({
|
|
197
|
-
tag
|
|
198
|
-
}) => {
|
|
199
|
-
return [
|
|
200
|
-
// Typdoc
|
|
201
|
-
'include', 'includeCode',
|
|
202
|
-
// TSDoc
|
|
203
|
-
'inheritDoc', 'inheritdoc', 'label'].includes(tag);
|
|
204
|
-
})) {
|
|
205
|
-
return;
|
|
206
|
-
}
|
|
207
|
-
const abbreviationsRegex = abbreviations.length ? new RegExp('\\b' + abbreviations.map(abbreviation => {
|
|
208
|
-
return (0, _escapeStringRegexp.default)(abbreviation.replaceAll(/\.$/gv, '') + '.');
|
|
209
|
-
}).join('|') + '(?:$|\\s)', 'gv') : '';
|
|
210
|
-
let {
|
|
211
|
-
description
|
|
212
|
-
} = utils.getDescription();
|
|
213
|
-
const indices = [...description.matchAll(/```[\s\S]*```/gv)].map(match => {
|
|
214
|
-
const {
|
|
215
|
-
index
|
|
216
|
-
} = match;
|
|
217
|
-
const [{
|
|
218
|
-
length
|
|
219
|
-
}] = match;
|
|
220
|
-
return {
|
|
221
|
-
index,
|
|
222
|
-
length
|
|
223
|
-
};
|
|
224
|
-
}).toReversed();
|
|
225
|
-
for (const {
|
|
226
|
-
index,
|
|
227
|
-
length
|
|
228
|
-
} of indices) {
|
|
229
|
-
description = description.slice(0, index) + description.slice(/** @type {import('../iterateJsdoc.js').Integer} */index + length);
|
|
230
|
-
}
|
|
231
|
-
if (validateDescription(description, report, jsdocNode, abbreviationsRegex, sourceCode, {
|
|
232
|
-
line: jsdoc.source[0].number + 1
|
|
233
|
-
}, newlineBeforeCapsAssumesBadSentenceEnd)) {
|
|
234
|
-
return;
|
|
235
|
-
}
|
|
236
|
-
utils.forEachPreferredTag('description', matchingJsdocTag => {
|
|
237
|
-
const desc = `${matchingJsdocTag.name} ${utils.getTagDescription(matchingJsdocTag)}`.trim();
|
|
238
|
-
validateDescription(desc, report, jsdocNode, abbreviationsRegex, sourceCode, matchingJsdocTag, newlineBeforeCapsAssumesBadSentenceEnd);
|
|
239
|
-
}, true);
|
|
240
|
-
const {
|
|
241
|
-
tagsWithNames
|
|
242
|
-
} = utils.getTagsByType(jsdoc.tags);
|
|
243
|
-
const tagsWithoutNames = utils.filterTags(({
|
|
244
|
-
tag: tagName
|
|
245
|
-
}) => {
|
|
246
|
-
return otherDescriptiveTags.has(tagName) || utils.hasOptionTag(tagName) && !tagsWithNames.some(({
|
|
247
|
-
tag
|
|
248
|
-
}) => {
|
|
249
|
-
// If user accidentally adds tags with names (or like `returns`
|
|
250
|
-
// get parsed as having names), do not add to this list
|
|
251
|
-
return tag === tagName;
|
|
252
|
-
});
|
|
253
|
-
});
|
|
254
|
-
tagsWithNames.some(tag => {
|
|
255
|
-
const desc = /** @type {string} */utils.getTagDescription(tag).replace(/^- /v, '').trimEnd();
|
|
256
|
-
return validateDescription(desc, report, jsdocNode, abbreviationsRegex, sourceCode, tag, newlineBeforeCapsAssumesBadSentenceEnd);
|
|
257
|
-
});
|
|
258
|
-
tagsWithoutNames.some(tag => {
|
|
259
|
-
const desc = `${tag.name} ${utils.getTagDescription(tag)}`.trim();
|
|
260
|
-
return validateDescription(desc, report, jsdocNode, abbreviationsRegex, sourceCode, tag, newlineBeforeCapsAssumesBadSentenceEnd);
|
|
261
|
-
});
|
|
262
|
-
}, {
|
|
263
|
-
iterateAllJsdocs: true,
|
|
264
|
-
meta: {
|
|
265
|
-
docs: {
|
|
266
|
-
description: 'Requires that block description, explicit `@description`, and `@param`/`@returns` tag descriptions are written in complete sentences.',
|
|
267
|
-
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-description-complete-sentence.md#repos-sticky-header'
|
|
268
|
-
},
|
|
269
|
-
fixable: 'code',
|
|
270
|
-
schema: [{
|
|
271
|
-
additionalProperties: false,
|
|
272
|
-
properties: {
|
|
273
|
-
abbreviations: {
|
|
274
|
-
description: `You can provide an \`abbreviations\` options array to avoid such strings of text
|
|
275
|
-
being treated as sentence endings when followed by dots. The \`.\` is not
|
|
276
|
-
necessary at the end of the array items.`,
|
|
277
|
-
items: {
|
|
278
|
-
type: 'string'
|
|
279
|
-
},
|
|
280
|
-
type: 'array'
|
|
281
|
-
},
|
|
282
|
-
newlineBeforeCapsAssumesBadSentenceEnd: {
|
|
283
|
-
description: `When \`false\` (the new default), we will not assume capital letters after
|
|
284
|
-
newlines are an incorrect way to end the sentence (they may be proper
|
|
285
|
-
nouns, for example).`,
|
|
286
|
-
type: 'boolean'
|
|
287
|
-
},
|
|
288
|
-
tags: {
|
|
289
|
-
description: `If you want additional tags to be checked for their descriptions, you may
|
|
290
|
-
add them within this option.
|
|
291
|
-
|
|
292
|
-
\`\`\`js
|
|
293
|
-
{
|
|
294
|
-
'jsdoc/require-description-complete-sentence': ['error', {
|
|
295
|
-
tags: ['see', 'copyright']
|
|
296
|
-
}]
|
|
297
|
-
}
|
|
298
|
-
\`\`\`
|
|
299
|
-
|
|
300
|
-
The tags \`@param\`/\`@arg\`/\`@argument\` and \`@property\`/\`@prop\` will be properly
|
|
301
|
-
parsed to ensure that the checked "description" text includes only the text
|
|
302
|
-
after the name.
|
|
303
|
-
|
|
304
|
-
All other tags will treat the text following the tag name, a space, and
|
|
305
|
-
an optional curly-bracketed type expression (and another space) as part of
|
|
306
|
-
its "description" (e.g., for \`@returns {someType} some description\`, the
|
|
307
|
-
description is \`some description\` while for \`@some-tag xyz\`, the description
|
|
308
|
-
is \`xyz\`).`,
|
|
309
|
-
items: {
|
|
310
|
-
type: 'string'
|
|
311
|
-
},
|
|
312
|
-
type: 'array'
|
|
313
|
-
}
|
|
314
|
-
},
|
|
315
|
-
type: 'object'
|
|
316
|
-
}],
|
|
317
|
-
type: 'suggestion'
|
|
318
|
-
}
|
|
319
|
-
});
|
|
320
|
-
module.exports = exports.default;
|
|
321
|
-
//# sourceMappingURL=requireDescriptionCompleteSentence.cjs.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"requireDescriptionCompleteSentence.cjs","names":["escapeStringRegexp","iterateJsdoc"],"sources":["../../src/rules/requireDescriptionCompleteSentence.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport escapeStringRegexp from 'escape-string-regexp';\n\nconst otherDescriptiveTags = new Set([\n 'classdesc', 'deprecated', 'exception', 'file', 'fileoverview', 'overview',\n // 'copyright' and 'see' might be good addition, but as the former may be\n // sensitive text, and the latter may have just a link, they are not\n // included by default\n 'summary', 'throws', 'todo', 'yield', 'yields',\n]);\n\n/**\n * @param {string} text\n * @returns {string[]}\n */\nconst extractParagraphs = (text) => {\n return text.split(/(?<![;:])\\n\\n+/v);\n};\n\n/**\n * @param {string} text\n * @param {string|RegExp} abbreviationsRegex\n * @returns {string[]}\n */\nconst extractSentences = (text, abbreviationsRegex) => {\n const txt = text\n // Remove all {} tags.\n .replaceAll(/(?<!^)\\{[\\s\\S]*?\\}\\s*/gv, '')\n\n // Remove custom abbreviations\n .replace(abbreviationsRegex, '');\n\n const sentenceEndGrouping = /([.?!])(?:\\s+|$)/gv;\n\n const puncts = [\n ...txt.matchAll(sentenceEndGrouping),\n ].map((sentEnd) => {\n return sentEnd[0];\n });\n\n return txt\n .split(/[.?!](?:\\s+|$)/v)\n\n // Re-add the dot.\n .map((sentence, idx) => {\n return !puncts[idx] && /^\\s*$/v.test(sentence) ? sentence : `${sentence}${puncts[idx] || ''}`;\n });\n};\n\n/**\n * @param {string} text\n * @returns {boolean}\n */\nconst isNewLinePrecededByAPeriod = (text) => {\n /** @type {boolean} */\n let lastLineEndsSentence;\n\n const lines = text.split('\\n');\n\n return !lines.some((line) => {\n if (lastLineEndsSentence === false && /^[A-Z][a-z]/v.test(line)) {\n return true;\n }\n\n lastLineEndsSentence = /[.:?!\\|]$/v.test(line);\n\n return false;\n });\n};\n\n/**\n * @param {string} str\n * @returns {boolean}\n */\nconst isCapitalized = (str) => {\n return str[0] === str[0].toUpperCase();\n};\n\n/**\n * @param {string} str\n * @returns {boolean}\n */\nconst isTable = (str) => {\n return str.charAt(0) === '|';\n};\n\n/**\n * @param {string} str\n * @returns {string}\n */\nconst capitalize = (str) => {\n return str.charAt(0).toUpperCase() + str.slice(1);\n};\n\n/**\n * @param {string} description\n * @param {import('../iterateJsdoc.js').Report} reportOrig\n * @param {import('eslint').Rule.Node} jsdocNode\n * @param {string|RegExp} abbreviationsRegex\n * @param {import('eslint').SourceCode} sourceCode\n * @param {import('comment-parser').Spec|{\n * line: import('../iterateJsdoc.js').Integer\n * }} tag\n * @param {boolean} newlineBeforeCapsAssumesBadSentenceEnd\n * @returns {boolean}\n */\nconst validateDescription = (\n description, reportOrig, jsdocNode, abbreviationsRegex,\n sourceCode, tag, newlineBeforeCapsAssumesBadSentenceEnd,\n) => {\n if (!description || (/^\\n+$/v).test(description)) {\n return false;\n }\n\n const descriptionNoHeadings = description.replaceAll(/^\\s*#[^\\n]*(\\n|$)/gmv, '');\n\n const paragraphs = extractParagraphs(descriptionNoHeadings).filter(Boolean);\n\n return paragraphs.some((paragraph, parIdx) => {\n const sentences = extractSentences(paragraph, abbreviationsRegex);\n\n const fix = /** @type {import('eslint').Rule.ReportFixer} */ (fixer) => {\n let text = sourceCode.getText(jsdocNode);\n\n if (!/[.:?!]$/v.test(paragraph)) {\n const line = paragraph.split('\\n').findLast(Boolean);\n text = text.replace(new RegExp(`${escapeStringRegexp(\n /** @type {string} */\n (line),\n )}$`, 'mv'), `${line}.`);\n }\n\n for (const sentence of sentences.filter((sentence_) => {\n return !(/^\\s*$/v).test(sentence_) && !isCapitalized(sentence_) &&\n !isTable(sentence_);\n })) {\n const beginning = sentence.split('\\n')[0];\n\n if ('tag' in tag && tag.tag) {\n const reg = new RegExp(`(@${escapeStringRegexp(tag.tag)}.*)${escapeStringRegexp(beginning)}`, 'v');\n\n text = text.replace(reg, (_$0, $1) => {\n return $1 + capitalize(beginning);\n });\n } else {\n text = text.replace(new RegExp('((?:[.?!]|\\\\*|\\\\})\\\\s*)' + escapeStringRegexp(beginning), 'v'), '$1' + capitalize(beginning));\n }\n }\n\n return fixer.replaceText(jsdocNode, text);\n };\n\n /**\n * @param {string} msg\n * @param {import('eslint').Rule.ReportFixer | null | undefined} fixer\n * @param {{\n * line?: number | undefined;\n * column?: number | undefined;\n * } | (import('comment-parser').Spec & {\n * line?: number | undefined;\n * column?: number | undefined;\n * })} tagObj\n * @returns {void}\n */\n const report = (msg, fixer, tagObj) => {\n if ('line' in tagObj) {\n /**\n * @type {{\n * line: number;\n * }}\n */ (tagObj).line += parIdx * 2;\n } else {\n /** @type {import('comment-parser').Spec} */ (\n tagObj\n ).source[0].number += parIdx * 2;\n }\n\n // Avoid errors if old column doesn't exist here\n tagObj.column = 0;\n reportOrig(msg, fixer, tagObj);\n };\n\n if (sentences.some((sentence) => {\n return (/^[.?!]$/v).test(sentence);\n })) {\n report('Sentences must be more than punctuation.', null, tag);\n }\n\n if (sentences.some((sentence) => {\n return !(/^\\s*$/v).test(sentence) && !isCapitalized(sentence) && !isTable(sentence);\n })) {\n report('Sentences should start with an uppercase character.', fix, tag);\n }\n\n const paragraphNoAbbreviations = paragraph.replace(abbreviationsRegex, '');\n\n if (!/(?:[.?!\\|]|```)\\s*$/v.test(paragraphNoAbbreviations)) {\n report('Sentences must end with a period.', fix, tag);\n return true;\n }\n\n if (newlineBeforeCapsAssumesBadSentenceEnd && !isNewLinePrecededByAPeriod(paragraphNoAbbreviations)) {\n report('A line of text is started with an uppercase character, but the preceding line does not end the sentence.', null, tag);\n\n return true;\n }\n\n return false;\n });\n};\n\nexport default iterateJsdoc(({\n context,\n jsdoc,\n jsdocNode,\n report,\n sourceCode,\n utils,\n}) => {\n const /** @type {{abbreviations: string[], newlineBeforeCapsAssumesBadSentenceEnd: boolean}} */ {\n abbreviations = [],\n newlineBeforeCapsAssumesBadSentenceEnd = false,\n } = context.options[0] || {};\n\n // `@inheritDoc` can be used as inline tag with TSDoc/typedoc: https://typedoc.org/documents/Tags.__inheritDoc_.html\n if (utils.getInlineTags().some(({\n tag,\n }) => {\n return [\n // Typdoc\n 'include', 'includeCode',\n // TSDoc\n 'inheritDoc', 'inheritdoc',\n 'label',\n ].includes(tag);\n })) {\n return;\n }\n\n const abbreviationsRegex = abbreviations.length ?\n new RegExp('\\\\b' + abbreviations.map((abbreviation) => {\n return escapeStringRegexp(abbreviation.replaceAll(/\\.$/gv, '') + '.');\n }).join('|') + '(?:$|\\\\s)', 'gv') :\n '';\n\n let {\n description,\n } = utils.getDescription();\n\n const indices = [\n ...description.matchAll(/```[\\s\\S]*```/gv),\n ].map((match) => {\n const {\n index,\n } = match;\n const [\n {\n length,\n },\n ] = match;\n return {\n index,\n length,\n };\n }).toReversed();\n\n for (const {\n index,\n length,\n } of indices) {\n description = description.slice(0, index) +\n description.slice(/** @type {import('../iterateJsdoc.js').Integer} */ (\n index\n ) + length);\n }\n\n if (validateDescription(description, report, jsdocNode, abbreviationsRegex, sourceCode, {\n line: jsdoc.source[0].number + 1,\n }, newlineBeforeCapsAssumesBadSentenceEnd)) {\n return;\n }\n\n utils.forEachPreferredTag('description', (matchingJsdocTag) => {\n const desc = `${matchingJsdocTag.name} ${utils.getTagDescription(matchingJsdocTag)}`.trim();\n validateDescription(desc, report, jsdocNode, abbreviationsRegex, sourceCode, matchingJsdocTag, newlineBeforeCapsAssumesBadSentenceEnd);\n }, true);\n\n const {\n tagsWithNames,\n } = utils.getTagsByType(jsdoc.tags);\n const tagsWithoutNames = utils.filterTags(({\n tag: tagName,\n }) => {\n return otherDescriptiveTags.has(tagName) ||\n utils.hasOptionTag(tagName) && !tagsWithNames.some(({\n tag,\n }) => {\n // If user accidentally adds tags with names (or like `returns`\n // get parsed as having names), do not add to this list\n return tag === tagName;\n });\n });\n\n tagsWithNames.some((tag) => {\n const desc = /** @type {string} */ (\n utils.getTagDescription(tag)\n ).replace(/^- /v, '').trimEnd();\n\n return validateDescription(desc, report, jsdocNode, abbreviationsRegex, sourceCode, tag, newlineBeforeCapsAssumesBadSentenceEnd);\n });\n\n tagsWithoutNames.some((tag) => {\n const desc = `${tag.name} ${utils.getTagDescription(tag)}`.trim();\n\n return validateDescription(desc, report, jsdocNode, abbreviationsRegex, sourceCode, tag, newlineBeforeCapsAssumesBadSentenceEnd);\n });\n}, {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Requires that block description, explicit `@description`, and `@param`/`@returns` tag descriptions are written in complete sentences.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-description-complete-sentence.md#repos-sticky-header',\n },\n fixable: 'code',\n schema: [\n {\n additionalProperties: false,\n properties: {\n abbreviations: {\n description: `You can provide an \\`abbreviations\\` options array to avoid such strings of text\nbeing treated as sentence endings when followed by dots. The \\`.\\` is not\nnecessary at the end of the array items.`,\n items: {\n type: 'string',\n },\n type: 'array',\n },\n newlineBeforeCapsAssumesBadSentenceEnd: {\n description: `When \\`false\\` (the new default), we will not assume capital letters after\nnewlines are an incorrect way to end the sentence (they may be proper\nnouns, for example).`,\n type: 'boolean',\n },\n tags: {\n description: `If you want additional tags to be checked for their descriptions, you may\nadd them within this option.\n\n\\`\\`\\`js\n{\n 'jsdoc/require-description-complete-sentence': ['error', {\n tags: ['see', 'copyright']\n }]\n}\n\\`\\`\\`\n\nThe tags \\`@param\\`/\\`@arg\\`/\\`@argument\\` and \\`@property\\`/\\`@prop\\` will be properly\nparsed to ensure that the checked \"description\" text includes only the text\nafter the name.\n\nAll other tags will treat the text following the tag name, a space, and\nan optional curly-bracketed type expression (and another space) as part of\nits \"description\" (e.g., for \\`@returns {someType} some description\\`, the\ndescription is \\`some description\\` while for \\`@some-tag xyz\\`, the description\nis \\`xyz\\`).`,\n items: {\n type: 'string',\n },\n type: 'array',\n },\n },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n});\n"],"mappings":";;;;;;AAAA;AACA;AAAsD;AAEtD,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAAC,CACnC,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc,EAAE,UAAU;AAC1E;AACA;AACA;AACA,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAC/C,CAAC;;AAEF;AACA;AACA;AACA;AACA,MAAM,iBAAiB,GAAI,IAAI,IAAK;EAClC,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC;AACtC,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,MAAM,gBAAgB,GAAG,CAAC,IAAI,EAAE,kBAAkB,KAAK;EACrD,MAAM,GAAG,GAAG;EACV;EAAA,CACC,UAAU,CAAC,yBAAyB,EAAE,EAAE;;EAEzC;EAAA,CACC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC;EAElC,MAAM,mBAAmB,GAAG,oBAAoB;EAEhD,MAAM,MAAM,GAAG,CACb,GAAG,GAAG,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CACrC,CAAC,GAAG,CAAE,OAAO,IAAK;IACjB,OAAO,OAAO,CAAC,CAAC,CAAC;EACnB,CAAC,CAAC;EAEF,OAAO,GAAG,CACP,KAAK,CAAC,iBAAiB;;EAExB;EAAA,CACC,GAAG,CAAC,CAAC,QAAQ,EAAE,GAAG,KAAK;IACtB,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,QAAQ,GAAG,GAAG,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE;EAC/F,CAAC,CAAC;AACN,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAM,0BAA0B,GAAI,IAAI,IAAK;EAC3C;EACA,IAAI,oBAAoB;EAExB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;EAE9B,OAAO,CAAC,KAAK,CAAC,IAAI,CAAE,IAAI,IAAK;IAC3B,IAAI,oBAAoB,KAAK,KAAK,IAAI,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;MAC/D,OAAO,IAAI;IACb;IAEA,oBAAoB,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC;IAE9C,OAAO,KAAK;EACd,CAAC,CAAC;AACJ,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAM,aAAa,GAAI,GAAG,IAAK;EAC7B,OAAO,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;AACxC,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAM,OAAO,GAAI,GAAG,IAAK;EACvB,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG;AAC9B,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAM,UAAU,GAAI,GAAG,IAAK;EAC1B,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;AACnD,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,mBAAmB,GAAG,CAC1B,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE,kBAAkB,EACtD,UAAU,EAAE,GAAG,EAAE,sCAAsC,KACpD;EACH,IAAI,CAAC,WAAW,IAAK,QAAQ,CAAE,IAAI,CAAC,WAAW,CAAC,EAAE;IAChD,OAAO,KAAK;EACd;EAEA,MAAM,qBAAqB,GAAG,WAAW,CAAC,UAAU,CAAC,sBAAsB,EAAE,EAAE,CAAC;EAEhF,MAAM,UAAU,GAAG,iBAAiB,CAAC,qBAAqB,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;EAE3E,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,MAAM,KAAK;IAC5C,MAAM,SAAS,GAAG,gBAAgB,CAAC,SAAS,EAAE,kBAAkB,CAAC;IAEjE,MAAM,GAAG,GAAG,gDAAkD,KAAK,IAAK;MACtE,IAAI,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC;MAExC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;QAC/B,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC;QACpD,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,GAAG,IAAAA,2BAAkB,EAClD;QACC,IACH,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,IAAI,GAAG,CAAC;MAC1B;MAEA,KAAK,MAAM,QAAQ,IAAI,SAAS,CAAC,MAAM,CAAE,SAAS,IAAK;QACrD,OAAO,CAAE,QAAQ,CAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,IAC7D,CAAC,OAAO,CAAC,SAAS,CAAC;MACvB,CAAC,CAAC,EAAE;QACF,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAEzC,IAAI,KAAK,IAAI,GAAG,IAAI,GAAG,CAAC,GAAG,EAAE;UAC3B,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,KAAK,IAAAA,2BAAkB,EAAC,GAAG,CAAC,GAAG,CAAC,MAAM,IAAAA,2BAAkB,EAAC,SAAS,CAAC,EAAE,EAAE,GAAG,CAAC;UAElG,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE,KAAK;YACpC,OAAO,EAAE,GAAG,UAAU,CAAC,SAAS,CAAC;UACnC,CAAC,CAAC;QACJ,CAAC,MAAM;UACL,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,yBAAyB,GAAG,IAAAA,2BAAkB,EAAC,SAAS,CAAC,EAAE,GAAG,CAAC,EAAE,IAAI,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;QAC/H;MACF;MAEA,OAAO,KAAK,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,CAAC;IAC3C,CAAC;;IAED;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;IACI,MAAM,MAAM,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,KAAK;MACrC,IAAI,MAAM,IAAI,MAAM,EAAE;QACpB;AACR;AACA;AACA;AACA;QAAa,MAAM,CAAE,IAAI,IAAI,MAAM,GAAG,CAAC;MACjC,CAAC,MAAM;QACL,4CACE,MAAM,CACN,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,MAAM,GAAG,CAAC;MAClC;;MAEA;MACA,MAAM,CAAC,MAAM,GAAG,CAAC;MACjB,UAAU,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC;IAChC,CAAC;IAED,IAAI,SAAS,CAAC,IAAI,CAAE,QAAQ,IAAK;MAC/B,OAAQ,UAAU,CAAE,IAAI,CAAC,QAAQ,CAAC;IACpC,CAAC,CAAC,EAAE;MACF,MAAM,CAAC,0CAA0C,EAAE,IAAI,EAAE,GAAG,CAAC;IAC/D;IAEA,IAAI,SAAS,CAAC,IAAI,CAAE,QAAQ,IAAK;MAC/B,OAAO,CAAE,QAAQ,CAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IACrF,CAAC,CAAC,EAAE;MACF,MAAM,CAAC,qDAAqD,EAAE,GAAG,EAAE,GAAG,CAAC;IACzE;IAEA,MAAM,wBAAwB,GAAG,SAAS,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC;IAE1E,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,wBAAwB,CAAC,EAAE;MAC1D,MAAM,CAAC,mCAAmC,EAAE,GAAG,EAAE,GAAG,CAAC;MACrD,OAAO,IAAI;IACb;IAEA,IAAI,sCAAsC,IAAI,CAAC,0BAA0B,CAAC,wBAAwB,CAAC,EAAE;MACnG,MAAM,CAAC,0GAA0G,EAAE,IAAI,EAAE,GAAG,CAAC;MAE7H,OAAO,IAAI;IACb;IAEA,OAAO,KAAK;EACd,CAAC,CAAC;AACJ,CAAC;AAAC,iCAEa,IAAAC,qBAAY,EAAC,CAAC;EAC3B,OAAO;EACP,KAAK;EACL,SAAS;EACT,MAAM;EACN,UAAU;EACV;AACF,CAAC,KAAK;EACJ,MAAM,yFAA0F;IAC9F,aAAa,GAAG,EAAE;IAClB,sCAAsC,GAAG;EAC3C,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;;EAE5B;EACA,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC9B;EACF,CAAC,KAAK;IACJ,OAAO;IACL;IACA,SAAS,EAAE,aAAa;IACxB;IACA,YAAY,EAAE,YAAY,EAC1B,OAAO,CACR,CAAC,QAAQ,CAAC,GAAG,CAAC;EACjB,CAAC,CAAC,EAAE;IACF;EACF;EAEA,MAAM,kBAAkB,GAAG,aAAa,CAAC,MAAM,GAC7C,IAAI,MAAM,CAAC,KAAK,GAAG,aAAa,CAAC,GAAG,CAAE,YAAY,IAAK;IACrD,OAAO,IAAAD,2BAAkB,EAAC,YAAY,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC;EACvE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,WAAW,EAAE,IAAI,CAAC,GACjC,EAAE;EAEJ,IAAI;IACF;EACF,CAAC,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;EAE1B,MAAM,OAAO,GAAG,CACd,GAAG,WAAW,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAC3C,CAAC,GAAG,CAAE,KAAK,IAAK;IACf,MAAM;MACJ;IACF,CAAC,GAAG,KAAK;IACT,MAAM,CACJ;MACE;IACF,CAAC,CACF,GAAG,KAAK;IACT,OAAO;MACL,KAAK;MACL;IACF,CAAC;EACH,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;EAEf,KAAK,MAAM;IACT,KAAK;IACL;EACF,CAAC,IAAI,OAAO,EAAE;IACZ,WAAW,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,GACvC,WAAW,CAAC,KAAK,CAAC,mDAChB,KAAK,GACH,MAAM,CAAC;EACf;EAEA,IAAI,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,kBAAkB,EAAE,UAAU,EAAE;IACtF,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG;EACjC,CAAC,EAAE,sCAAsC,CAAC,EAAE;IAC1C;EACF;EAEA,KAAK,CAAC,mBAAmB,CAAC,aAAa,EAAG,gBAAgB,IAAK;IAC7D,MAAM,IAAI,GAAG,GAAG,gBAAgB,CAAC,IAAI,IAAI,KAAK,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;IAC3F,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,kBAAkB,EAAE,UAAU,EAAE,gBAAgB,EAAE,sCAAsC,CAAC;EACxI,CAAC,EAAE,IAAI,CAAC;EAER,MAAM;IACJ;EACF,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC;EACnC,MAAM,gBAAgB,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;IACzC,GAAG,EAAE;EACP,CAAC,KAAK;IACJ,OAAO,oBAAoB,CAAC,GAAG,CAAC,OAAO,CAAC,IACtC,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;MAClD;IACF,CAAC,KAAK;MACJ;MACA;MACA,OAAO,GAAG,KAAK,OAAO;IACxB,CAAC,CAAC;EACN,CAAC,CAAC;EAEF,aAAa,CAAC,IAAI,CAAE,GAAG,IAAK;IAC1B,MAAM,IAAI,GAAG,qBACX,KAAK,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAC5B,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;IAE/B,OAAO,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,kBAAkB,EAAE,UAAU,EAAE,GAAG,EAAE,sCAAsC,CAAC;EAClI,CAAC,CAAC;EAEF,gBAAgB,CAAC,IAAI,CAAE,GAAG,IAAK;IAC7B,MAAM,IAAI,GAAG,GAAG,GAAG,CAAC,IAAI,IAAI,KAAK,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;IAEjE,OAAO,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,kBAAkB,EAAE,UAAU,EAAE,GAAG,EAAE,sCAAsC,CAAC;EAClI,CAAC,CAAC;AACJ,CAAC,EAAE;EACD,gBAAgB,EAAE,IAAI;EACtB,IAAI,EAAE;IACJ,IAAI,EAAE;MACJ,WAAW,EAAE,uIAAuI;MACpJ,GAAG,EAAE;IACP,CAAC;IACD,OAAO,EAAE,MAAM;IACf,MAAM,EAAE,CACN;MACE,oBAAoB,EAAE,KAAK;MAC3B,UAAU,EAAE;QACV,aAAa,EAAE;UACb,WAAW,EAAE;AACzB;AACA,yCAAyC;UAC7B,KAAK,EAAE;YACL,IAAI,EAAE;UACR,CAAC;UACD,IAAI,EAAE;QACR,CAAC;QACD,sCAAsC,EAAE;UACtC,WAAW,EAAE;AACzB;AACA,qBAAqB;UACT,IAAI,EAAE;QACR,CAAC;QACD,IAAI,EAAE;UACJ,WAAW,EAAE;AACzB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,aAAa;UACD,KAAK,EAAE;YACL,IAAI,EAAE;UACR,CAAC;UACD,IAAI,EAAE;QACR;MACF,CAAC;MACD,IAAI,EAAE;IACR,CAAC,CACF;IACD,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAA","ignoreList":[]}
|