eslint-plugin-jsdoc 63.3.2 → 64.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/index.d.ts +7 -4
- package/package.json +27 -52
- package/src/index.js +7 -8
- 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 -23
- 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 -598
- package/dist/index-cjs.cjs.map +0 -1
- package/dist/index-cjs.d.ts +0 -24
- 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 -746
- 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 -758
- package/src/index-esm.js +0 -196
- package/src/index.cjs.cts +0 -3
- package/src/iterateJsdoc.cts +0 -7
|
@@ -1,352 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
|
|
3
|
-
Object.defineProperty(exports, "__esModule", {
|
|
4
|
-
value: true
|
|
5
|
-
});
|
|
6
|
-
exports.buildRejectOrPreferRuleDefinition = void 0;
|
|
7
|
-
var _iterateJsdoc = _interopRequireDefault(require("./iterateJsdoc.cjs"));
|
|
8
|
-
var _jsdoccomment = require("@es-joy/jsdoccomment");
|
|
9
|
-
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
|
|
10
|
-
/**
|
|
11
|
-
* Adjusts the parent type node `meta` for generic matches (or type node
|
|
12
|
-
* `type` for `JsdocTypeAny`) and sets the type node `value`.
|
|
13
|
-
* @param {string} type The actual type
|
|
14
|
-
* @param {string} preferred The preferred type
|
|
15
|
-
* @param {boolean} isGenericMatch
|
|
16
|
-
* @param {string} typeNodeName
|
|
17
|
-
* @param {import('jsdoc-type-pratt-parser').NonRootResult} node
|
|
18
|
-
* @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode
|
|
19
|
-
* @returns {void}
|
|
20
|
-
*/
|
|
21
|
-
const adjustNames = (type, preferred, isGenericMatch, typeNodeName, node, parentNode) => {
|
|
22
|
-
let ret = preferred;
|
|
23
|
-
if (isGenericMatch) {
|
|
24
|
-
const parentMeta = /** @type {import('jsdoc-type-pratt-parser').GenericResult} */parentNode.meta;
|
|
25
|
-
if (preferred === '[]') {
|
|
26
|
-
parentMeta.brackets = 'square';
|
|
27
|
-
parentMeta.dot = false;
|
|
28
|
-
ret = 'Array';
|
|
29
|
-
} else {
|
|
30
|
-
const dotBracketEnd = preferred.match(/\.(?:<>)?$/v);
|
|
31
|
-
if (dotBracketEnd) {
|
|
32
|
-
parentMeta.brackets = 'angle';
|
|
33
|
-
parentMeta.dot = true;
|
|
34
|
-
ret = preferred.slice(0, -dotBracketEnd[0].length);
|
|
35
|
-
} else {
|
|
36
|
-
const bracketEnd = preferred.endsWith('<>');
|
|
37
|
-
if (bracketEnd) {
|
|
38
|
-
parentMeta.brackets = 'angle';
|
|
39
|
-
parentMeta.dot = false;
|
|
40
|
-
ret = preferred.slice(0, -2);
|
|
41
|
-
} else if (parentMeta?.brackets === 'square' && (typeNodeName === '[]' || typeNodeName === 'Array')) {
|
|
42
|
-
parentMeta.brackets = 'angle';
|
|
43
|
-
parentMeta.dot = false;
|
|
44
|
-
}
|
|
45
|
-
}
|
|
46
|
-
}
|
|
47
|
-
} else if (type === 'JsdocTypeAny') {
|
|
48
|
-
node.type = 'JsdocTypeName';
|
|
49
|
-
}
|
|
50
|
-
|
|
51
|
-
/** @type {import('jsdoc-type-pratt-parser').NameResult} */
|
|
52
|
-
node.value = ret.replace(/(?:\.|<>|\.<>|\[\])$/v, '');
|
|
53
|
-
|
|
54
|
-
// For bare pseudo-types like `<>`
|
|
55
|
-
if (!ret) {
|
|
56
|
-
/** @type {import('jsdoc-type-pratt-parser').NameResult} */node.value = typeNodeName;
|
|
57
|
-
}
|
|
58
|
-
};
|
|
59
|
-
|
|
60
|
-
/**
|
|
61
|
-
* @param {boolean} [upperCase]
|
|
62
|
-
* @returns {string}
|
|
63
|
-
*/
|
|
64
|
-
const getMessage = upperCase => {
|
|
65
|
-
return 'Use object shorthand or index signatures instead of ' + '`' + (upperCase ? 'O' : 'o') + 'bject`, e.g., `{[key: string]: string}`';
|
|
66
|
-
};
|
|
67
|
-
|
|
68
|
-
/**
|
|
69
|
-
* @type {{
|
|
70
|
-
* message: string,
|
|
71
|
-
* replacement: false
|
|
72
|
-
* }}
|
|
73
|
-
*/
|
|
74
|
-
const info = {
|
|
75
|
-
message: getMessage(),
|
|
76
|
-
replacement: false
|
|
77
|
-
};
|
|
78
|
-
|
|
79
|
-
/**
|
|
80
|
-
* @type {{
|
|
81
|
-
* message: string,
|
|
82
|
-
* replacement: false
|
|
83
|
-
* }}
|
|
84
|
-
*/
|
|
85
|
-
const infoUC = {
|
|
86
|
-
message: getMessage(true),
|
|
87
|
-
replacement: false
|
|
88
|
-
};
|
|
89
|
-
|
|
90
|
-
/**
|
|
91
|
-
* @param {{
|
|
92
|
-
* checkNativeTypes?: import('./rules/checkTypes.js').CheckNativeTypes|null
|
|
93
|
-
* overrideSettings?: import('./iterateJsdoc.js').Settings['preferredTypes']|null,
|
|
94
|
-
* description?: string,
|
|
95
|
-
* schema?: import('eslint').Rule.RuleMetaData['schema'],
|
|
96
|
-
* typeName?: string,
|
|
97
|
-
* url?: string,
|
|
98
|
-
* }} cfg
|
|
99
|
-
* @returns {import('eslint').Rule.RuleModule}
|
|
100
|
-
*/
|
|
101
|
-
const buildRejectOrPreferRuleDefinition = ({
|
|
102
|
-
checkNativeTypes = null,
|
|
103
|
-
typeName,
|
|
104
|
-
description = typeName ?? 'Reports types deemed invalid (customizable and with defaults, for preventing and/or recommending replacements).',
|
|
105
|
-
overrideSettings = null,
|
|
106
|
-
schema = [],
|
|
107
|
-
url = 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-types.md#repos-sticky-header'
|
|
108
|
-
}) => {
|
|
109
|
-
return (0, _iterateJsdoc.default)(({
|
|
110
|
-
context,
|
|
111
|
-
jsdocNode,
|
|
112
|
-
report,
|
|
113
|
-
settings,
|
|
114
|
-
sourceCode,
|
|
115
|
-
utils
|
|
116
|
-
}) => {
|
|
117
|
-
const jsdocTagsWithPossibleType = utils.filterTags(tag => {
|
|
118
|
-
return Boolean(utils.tagMightHaveTypePosition(tag.tag));
|
|
119
|
-
});
|
|
120
|
-
const
|
|
121
|
-
/**
|
|
122
|
-
* @type {{
|
|
123
|
-
* preferredTypes: import('./iterateJsdoc.js').PreferredTypes,
|
|
124
|
-
* structuredTags: import('./iterateJsdoc.js').StructuredTags,
|
|
125
|
-
* mode: import('./jsdocUtils.js').ParserMode
|
|
126
|
-
* }}
|
|
127
|
-
*/
|
|
128
|
-
{
|
|
129
|
-
mode,
|
|
130
|
-
preferredTypes: preferredTypesOriginal,
|
|
131
|
-
structuredTags
|
|
132
|
-
} = overrideSettings ? {
|
|
133
|
-
mode: settings.mode,
|
|
134
|
-
preferredTypes: overrideSettings,
|
|
135
|
-
structuredTags: {}
|
|
136
|
-
} : settings;
|
|
137
|
-
const injectObjectPreferredTypes = !overrideSettings && !('Object' in preferredTypesOriginal || 'object' in preferredTypesOriginal || 'object.<>' in preferredTypesOriginal || 'Object.<>' in preferredTypesOriginal || 'object<>' in preferredTypesOriginal);
|
|
138
|
-
|
|
139
|
-
/** @type {import('./iterateJsdoc.js').PreferredTypes} */
|
|
140
|
-
const typeToInject = mode === 'typescript' ? {
|
|
141
|
-
Object: 'object',
|
|
142
|
-
'object.<>': info,
|
|
143
|
-
'Object.<>': infoUC,
|
|
144
|
-
'object<>': info,
|
|
145
|
-
'Object<>': infoUC
|
|
146
|
-
} : {
|
|
147
|
-
Object: 'object',
|
|
148
|
-
'object.<>': 'Object<>',
|
|
149
|
-
'Object.<>': 'Object<>',
|
|
150
|
-
'object<>': 'Object<>'
|
|
151
|
-
};
|
|
152
|
-
|
|
153
|
-
/** @type {import('./iterateJsdoc.js').PreferredTypes} */
|
|
154
|
-
const preferredTypes = {
|
|
155
|
-
...(injectObjectPreferredTypes ? typeToInject : {}),
|
|
156
|
-
...preferredTypesOriginal
|
|
157
|
-
};
|
|
158
|
-
const
|
|
159
|
-
/**
|
|
160
|
-
* @type {{
|
|
161
|
-
* noDefaults: boolean,
|
|
162
|
-
* unifyParentAndChildTypeChecks: boolean,
|
|
163
|
-
* exemptTagContexts: ({
|
|
164
|
-
* tag: string,
|
|
165
|
-
* types: true|string[]
|
|
166
|
-
* })[]
|
|
167
|
-
* }}
|
|
168
|
-
*/
|
|
169
|
-
{
|
|
170
|
-
exemptTagContexts = [],
|
|
171
|
-
noDefaults,
|
|
172
|
-
unifyParentAndChildTypeChecks
|
|
173
|
-
} = context.options[0] || {};
|
|
174
|
-
|
|
175
|
-
/**
|
|
176
|
-
* Gets information about the preferred type: whether there is a matching
|
|
177
|
-
* preferred type, what the type is, and whether it is a match to a generic.
|
|
178
|
-
* @param {string} _type Not currently in use
|
|
179
|
-
* @param {string} typeNodeName
|
|
180
|
-
* @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode
|
|
181
|
-
* @param {string|undefined} property
|
|
182
|
-
* @returns {[hasMatchingPreferredType: boolean, typeName: string, isGenericMatch: boolean]}
|
|
183
|
-
*/
|
|
184
|
-
const getPreferredTypeInfo = (_type, typeNodeName, parentNode, property) => {
|
|
185
|
-
let hasMatchingPreferredType = false;
|
|
186
|
-
let isGenericMatch = false;
|
|
187
|
-
let typName = typeNodeName;
|
|
188
|
-
const isNameOfGeneric = parentNode !== undefined && parentNode.type === 'JsdocTypeGeneric' && property === 'left';
|
|
189
|
-
const brackets = /** @type {import('jsdoc-type-pratt-parser').GenericResult} */parentNode?.meta?.brackets;
|
|
190
|
-
const dot = /** @type {import('jsdoc-type-pratt-parser').GenericResult} */parentNode?.meta?.dot;
|
|
191
|
-
if (brackets === 'angle') {
|
|
192
|
-
const checkPostFixes = dot ? ['.', '.<>'] : ['<>'];
|
|
193
|
-
isGenericMatch = checkPostFixes.some(checkPostFix => {
|
|
194
|
-
const preferredType = preferredTypes?.[typeNodeName + checkPostFix];
|
|
195
|
-
|
|
196
|
-
// Does `unifyParentAndChildTypeChecks` need to be checked here?
|
|
197
|
-
if ((unifyParentAndChildTypeChecks || isNameOfGeneric || (/* c8 ignore next 2 -- If checking `unifyParentAndChildTypeChecks` */
|
|
198
|
-
typeof preferredType === 'object' && preferredType?.unifyParentAndChildTypeChecks)) && preferredType !== undefined) {
|
|
199
|
-
typName += checkPostFix;
|
|
200
|
-
return true;
|
|
201
|
-
}
|
|
202
|
-
return false;
|
|
203
|
-
});
|
|
204
|
-
}
|
|
205
|
-
if (!isGenericMatch && property && /** @type {import('jsdoc-type-pratt-parser').NonRootResult} */parentNode.type === 'JsdocTypeGeneric') {
|
|
206
|
-
const checkPostFixes = dot ? ['.', '.<>'] : [brackets === 'angle' ? '<>' : '[]'];
|
|
207
|
-
isGenericMatch = checkPostFixes.some(checkPostFix => {
|
|
208
|
-
const preferredType = preferredTypes?.[checkPostFix];
|
|
209
|
-
if (
|
|
210
|
-
// Does `unifyParentAndChildTypeChecks` need to be checked here?
|
|
211
|
-
(unifyParentAndChildTypeChecks || isNameOfGeneric || (/* c8 ignore next 2 -- If checking `unifyParentAndChildTypeChecks` */
|
|
212
|
-
typeof preferredType === 'object' && preferredType?.unifyParentAndChildTypeChecks)) && preferredType !== undefined) {
|
|
213
|
-
typName = checkPostFix;
|
|
214
|
-
return true;
|
|
215
|
-
}
|
|
216
|
-
return false;
|
|
217
|
-
});
|
|
218
|
-
}
|
|
219
|
-
const prefType = preferredTypes?.[typeNodeName];
|
|
220
|
-
const directNameMatch = prefType !== undefined && !Object.values(preferredTypes).includes(typeNodeName);
|
|
221
|
-
const specificUnify = typeof prefType === 'object' && prefType?.unifyParentAndChildTypeChecks;
|
|
222
|
-
const unifiedSyntaxParentMatch = property && directNameMatch && (unifyParentAndChildTypeChecks || specificUnify);
|
|
223
|
-
isGenericMatch = isGenericMatch || Boolean(unifiedSyntaxParentMatch);
|
|
224
|
-
hasMatchingPreferredType = isGenericMatch || directNameMatch && !property;
|
|
225
|
-
return [hasMatchingPreferredType, typName, isGenericMatch];
|
|
226
|
-
};
|
|
227
|
-
|
|
228
|
-
/**
|
|
229
|
-
* Collect invalid type info.
|
|
230
|
-
* @param {string} type
|
|
231
|
-
* @param {string} value
|
|
232
|
-
* @param {string} tagName
|
|
233
|
-
* @param {string} nameInTag
|
|
234
|
-
* @param {number} idx
|
|
235
|
-
* @param {string|undefined} property
|
|
236
|
-
* @param {import('jsdoc-type-pratt-parser').NonRootResult} node
|
|
237
|
-
* @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode
|
|
238
|
-
* @param {(string|false|undefined)[][]} invalidTypes
|
|
239
|
-
* @returns {void}
|
|
240
|
-
*/
|
|
241
|
-
const getInvalidTypes = (type, value, tagName, nameInTag, idx, property, node, parentNode, invalidTypes) => {
|
|
242
|
-
let typeNodeName = type === 'JsdocTypeAny' ? '*' : value;
|
|
243
|
-
const [hasMatchingPreferredType, typName, isGenericMatch] = getPreferredTypeInfo(type, typeNodeName, parentNode, property);
|
|
244
|
-
let preferred;
|
|
245
|
-
let types;
|
|
246
|
-
if (hasMatchingPreferredType) {
|
|
247
|
-
const preferredSetting = preferredTypes[typName];
|
|
248
|
-
typeNodeName = typName === '[]' ? typName : typeNodeName;
|
|
249
|
-
if (!preferredSetting) {
|
|
250
|
-
invalidTypes.push([typeNodeName]);
|
|
251
|
-
} else if (typeof preferredSetting === 'string') {
|
|
252
|
-
preferred = preferredSetting;
|
|
253
|
-
invalidTypes.push([typeNodeName, preferred]);
|
|
254
|
-
} else if (preferredSetting && typeof preferredSetting === 'object') {
|
|
255
|
-
const nextItem = preferredSetting.skipRootChecking && jsdocTagsWithPossibleType[idx + 1];
|
|
256
|
-
if (!nextItem || !nextItem.name.startsWith(`${nameInTag}.`)) {
|
|
257
|
-
preferred = preferredSetting.replacement;
|
|
258
|
-
invalidTypes.push([typeNodeName, preferred, preferredSetting.message]);
|
|
259
|
-
}
|
|
260
|
-
} else {
|
|
261
|
-
utils.reportSettings('Invalid `settings.jsdoc.preferredTypes`. Values must be falsy, a string, or an object.');
|
|
262
|
-
return;
|
|
263
|
-
}
|
|
264
|
-
} else if (Object.entries(structuredTags).some(([tag, {
|
|
265
|
-
type: typs
|
|
266
|
-
}]) => {
|
|
267
|
-
types = typs;
|
|
268
|
-
return tag === tagName && Array.isArray(types) && !types.includes(typeNodeName);
|
|
269
|
-
})) {
|
|
270
|
-
invalidTypes.push([typeNodeName, types]);
|
|
271
|
-
} else if (checkNativeTypes && !noDefaults && type === 'JsdocTypeName') {
|
|
272
|
-
preferred = checkNativeTypes(preferredTypes, typeNodeName, preferred, parentNode, invalidTypes);
|
|
273
|
-
}
|
|
274
|
-
|
|
275
|
-
// For fixer
|
|
276
|
-
if (preferred) {
|
|
277
|
-
adjustNames(type, preferred, isGenericMatch, typeNodeName, node, parentNode);
|
|
278
|
-
}
|
|
279
|
-
};
|
|
280
|
-
for (const [idx, jsdocTag] of jsdocTagsWithPossibleType.entries()) {
|
|
281
|
-
/** @type {(string|false|undefined)[][]} */
|
|
282
|
-
const invalidTypes = [];
|
|
283
|
-
let typeAst;
|
|
284
|
-
try {
|
|
285
|
-
typeAst = mode === 'permissive' ? (0, _jsdoccomment.tryParse)(jsdocTag.type) : (0, _jsdoccomment.parse)(jsdocTag.type, mode);
|
|
286
|
-
} catch {
|
|
287
|
-
continue;
|
|
288
|
-
}
|
|
289
|
-
const {
|
|
290
|
-
name: nameInTag,
|
|
291
|
-
tag: tagName
|
|
292
|
-
} = jsdocTag;
|
|
293
|
-
(0, _jsdoccomment.traverse)(typeAst, (node, parentNode, property) => {
|
|
294
|
-
const {
|
|
295
|
-
type,
|
|
296
|
-
value
|
|
297
|
-
} =
|
|
298
|
-
/**
|
|
299
|
-
* @type {import('jsdoc-type-pratt-parser').NameResult}
|
|
300
|
-
*/
|
|
301
|
-
node;
|
|
302
|
-
if (!['JsdocTypeAny', 'JsdocTypeName'].includes(type)) {
|
|
303
|
-
return;
|
|
304
|
-
}
|
|
305
|
-
getInvalidTypes(type, value, tagName, nameInTag, idx, property, node, parentNode, invalidTypes);
|
|
306
|
-
});
|
|
307
|
-
if (invalidTypes.length) {
|
|
308
|
-
const fixedType = (0, _jsdoccomment.stringify)(typeAst);
|
|
309
|
-
|
|
310
|
-
/**
|
|
311
|
-
* @type {import('eslint').Rule.ReportFixer}
|
|
312
|
-
*/
|
|
313
|
-
const fix = fixer => {
|
|
314
|
-
return fixer.replaceText(jsdocNode, sourceCode.getText(jsdocNode).replace(`{${jsdocTag.type}}`, `{${fixedType}}`));
|
|
315
|
-
};
|
|
316
|
-
for (const [badType, preferredType = '', msg] of invalidTypes) {
|
|
317
|
-
const tagValue = jsdocTag.name ? ` "${jsdocTag.name}"` : '';
|
|
318
|
-
if (exemptTagContexts.some(({
|
|
319
|
-
tag,
|
|
320
|
-
types
|
|
321
|
-
}) => {
|
|
322
|
-
return tag === tagName && (types === true || types.includes(jsdocTag.type));
|
|
323
|
-
})) {
|
|
324
|
-
continue;
|
|
325
|
-
}
|
|
326
|
-
report(msg || `Invalid JSDoc @${tagName}${tagValue} type "${badType}"` + (preferredType ? '; ' : '.') + (preferredType ? `prefer: ${JSON.stringify(preferredType)}.` : ''), preferredType ? fix : null, jsdocTag, msg ? {
|
|
327
|
-
tagName,
|
|
328
|
-
tagValue
|
|
329
|
-
} : undefined);
|
|
330
|
-
}
|
|
331
|
-
}
|
|
332
|
-
}
|
|
333
|
-
}, {
|
|
334
|
-
iterateAllJsdocs: true,
|
|
335
|
-
meta: {
|
|
336
|
-
docs: {
|
|
337
|
-
description,
|
|
338
|
-
url
|
|
339
|
-
},
|
|
340
|
-
...(!overrideSettings || Object.values(overrideSettings).some(os => {
|
|
341
|
-
return os && typeof os === 'object' ? /* c8 ignore next -- Ok */
|
|
342
|
-
os.replacement : typeof os === 'string';
|
|
343
|
-
}) ? {
|
|
344
|
-
fixable: 'code'
|
|
345
|
-
} : {}),
|
|
346
|
-
schema,
|
|
347
|
-
type: 'suggestion'
|
|
348
|
-
}
|
|
349
|
-
});
|
|
350
|
-
};
|
|
351
|
-
exports.buildRejectOrPreferRuleDefinition = buildRejectOrPreferRuleDefinition;
|
|
352
|
-
//# sourceMappingURL=buildRejectOrPreferRuleDefinition.cjs.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"buildRejectOrPreferRuleDefinition.cjs","names":["iterateJsdoc","tryParse","parse","traverse","stringify"],"sources":["../src/buildRejectOrPreferRuleDefinition.js"],"sourcesContent":["import iterateJsdoc from './iterateJsdoc.js';\nimport {\n parse,\n stringify,\n traverse,\n tryParse,\n} from '@es-joy/jsdoccomment';\n\n/**\n * Adjusts the parent type node `meta` for generic matches (or type node\n * `type` for `JsdocTypeAny`) and sets the type node `value`.\n * @param {string} type The actual type\n * @param {string} preferred The preferred type\n * @param {boolean} isGenericMatch\n * @param {string} typeNodeName\n * @param {import('jsdoc-type-pratt-parser').NonRootResult} node\n * @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode\n * @returns {void}\n */\nconst adjustNames = (type, preferred, isGenericMatch, typeNodeName, node, parentNode) => {\n let ret = preferred;\n if (isGenericMatch) {\n const parentMeta = /** @type {import('jsdoc-type-pratt-parser').GenericResult} */ (\n parentNode\n ).meta;\n if (preferred === '[]') {\n parentMeta.brackets = 'square';\n parentMeta.dot = false;\n ret = 'Array';\n } else {\n const dotBracketEnd = preferred.match(/\\.(?:<>)?$/v);\n if (dotBracketEnd) {\n parentMeta.brackets = 'angle';\n parentMeta.dot = true;\n ret = preferred.slice(0, -dotBracketEnd[0].length);\n } else {\n const bracketEnd = preferred.endsWith('<>');\n if (bracketEnd) {\n parentMeta.brackets = 'angle';\n parentMeta.dot = false;\n ret = preferred.slice(0, -2);\n } else if (\n parentMeta?.brackets === 'square' &&\n (typeNodeName === '[]' || typeNodeName === 'Array')\n ) {\n parentMeta.brackets = 'angle';\n parentMeta.dot = false;\n }\n }\n }\n } else if (type === 'JsdocTypeAny') {\n node.type = 'JsdocTypeName';\n }\n\n /** @type {import('jsdoc-type-pratt-parser').NameResult} */ (\n node\n ).value = ret.replace(/(?:\\.|<>|\\.<>|\\[\\])$/v, '');\n\n // For bare pseudo-types like `<>`\n if (!ret) {\n /** @type {import('jsdoc-type-pratt-parser').NameResult} */ (\n node\n ).value = typeNodeName;\n }\n};\n\n/**\n * @param {boolean} [upperCase]\n * @returns {string}\n */\nconst getMessage = (upperCase) => {\n return 'Use object shorthand or index signatures instead of ' +\n '`' + (upperCase ? 'O' : 'o') + 'bject`, e.g., `{[key: string]: string}`';\n};\n\n/**\n * @type {{\n * message: string,\n * replacement: false\n * }}\n */\nconst info = {\n message: getMessage(),\n replacement: false,\n};\n\n/**\n * @type {{\n * message: string,\n * replacement: false\n * }}\n */\nconst infoUC = {\n message: getMessage(true),\n replacement: false,\n};\n\n/**\n * @param {{\n * checkNativeTypes?: import('./rules/checkTypes.js').CheckNativeTypes|null\n * overrideSettings?: import('./iterateJsdoc.js').Settings['preferredTypes']|null,\n * description?: string,\n * schema?: import('eslint').Rule.RuleMetaData['schema'],\n * typeName?: string,\n * url?: string,\n * }} cfg\n * @returns {import('eslint').Rule.RuleModule}\n */\nexport const buildRejectOrPreferRuleDefinition = ({\n checkNativeTypes = null,\n typeName,\n description = typeName ?? 'Reports types deemed invalid (customizable and with defaults, for preventing and/or recommending replacements).',\n overrideSettings = null,\n schema = [],\n url = 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-types.md#repos-sticky-header',\n}) => {\n return iterateJsdoc(\n ({\n context,\n jsdocNode,\n report,\n settings,\n sourceCode,\n utils,\n }) => {\n const jsdocTagsWithPossibleType = utils.filterTags((tag) => {\n return Boolean(utils.tagMightHaveTypePosition(tag.tag));\n });\n\n const\n /**\n * @type {{\n * preferredTypes: import('./iterateJsdoc.js').PreferredTypes,\n * structuredTags: import('./iterateJsdoc.js').StructuredTags,\n * mode: import('./jsdocUtils.js').ParserMode\n * }}\n */\n {\n mode,\n preferredTypes: preferredTypesOriginal,\n structuredTags,\n } = overrideSettings ? {\n mode: settings.mode,\n preferredTypes: overrideSettings,\n structuredTags: {},\n } : settings;\n\n const injectObjectPreferredTypes = !overrideSettings &&\n !('Object' in preferredTypesOriginal ||\n 'object' in preferredTypesOriginal ||\n 'object.<>' in preferredTypesOriginal ||\n 'Object.<>' in preferredTypesOriginal ||\n 'object<>' in preferredTypesOriginal);\n\n /** @type {import('./iterateJsdoc.js').PreferredTypes} */\n const typeToInject = mode === 'typescript' ?\n {\n Object: 'object',\n 'object.<>': info,\n 'Object.<>': infoUC,\n 'object<>': info,\n 'Object<>': infoUC,\n } :\n {\n Object: 'object',\n 'object.<>': 'Object<>',\n 'Object.<>': 'Object<>',\n 'object<>': 'Object<>',\n };\n\n /** @type {import('./iterateJsdoc.js').PreferredTypes} */\n const preferredTypes = {\n ...injectObjectPreferredTypes ?\n typeToInject :\n {},\n ...preferredTypesOriginal,\n };\n\n const\n /**\n * @type {{\n * noDefaults: boolean,\n * unifyParentAndChildTypeChecks: boolean,\n * exemptTagContexts: ({\n * tag: string,\n * types: true|string[]\n * })[]\n * }}\n */ {\n exemptTagContexts = [],\n noDefaults,\n unifyParentAndChildTypeChecks,\n } = context.options[0] || {};\n\n /**\n * Gets information about the preferred type: whether there is a matching\n * preferred type, what the type is, and whether it is a match to a generic.\n * @param {string} _type Not currently in use\n * @param {string} typeNodeName\n * @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode\n * @param {string|undefined} property\n * @returns {[hasMatchingPreferredType: boolean, typeName: string, isGenericMatch: boolean]}\n */\n const getPreferredTypeInfo = (_type, typeNodeName, parentNode, property) => {\n let hasMatchingPreferredType = false;\n let isGenericMatch = false;\n let typName = typeNodeName;\n\n const isNameOfGeneric = parentNode !== undefined && parentNode.type === 'JsdocTypeGeneric' && property === 'left';\n\n const brackets = /** @type {import('jsdoc-type-pratt-parser').GenericResult} */ (\n parentNode\n )?.meta?.brackets;\n const dot = /** @type {import('jsdoc-type-pratt-parser').GenericResult} */ (\n parentNode\n )?.meta?.dot;\n\n if (brackets === 'angle') {\n const checkPostFixes = dot ? [\n '.', '.<>',\n ] : [\n '<>',\n ];\n isGenericMatch = checkPostFixes.some((checkPostFix) => {\n const preferredType = preferredTypes?.[typeNodeName + checkPostFix];\n\n // Does `unifyParentAndChildTypeChecks` need to be checked here?\n if (\n (unifyParentAndChildTypeChecks || isNameOfGeneric ||\n /* c8 ignore next 2 -- If checking `unifyParentAndChildTypeChecks` */\n (typeof preferredType === 'object' &&\n preferredType?.unifyParentAndChildTypeChecks)\n ) &&\n preferredType !== undefined\n ) {\n typName += checkPostFix;\n\n return true;\n }\n\n return false;\n });\n }\n\n if (\n !isGenericMatch && property &&\n /** @type {import('jsdoc-type-pratt-parser').NonRootResult} */ (\n parentNode\n ).type === 'JsdocTypeGeneric'\n ) {\n const checkPostFixes = dot ? [\n '.', '.<>',\n ] : [\n brackets === 'angle' ? '<>' : '[]',\n ];\n\n isGenericMatch = checkPostFixes.some((checkPostFix) => {\n const preferredType = preferredTypes?.[checkPostFix];\n if (\n // Does `unifyParentAndChildTypeChecks` need to be checked here?\n (unifyParentAndChildTypeChecks || isNameOfGeneric ||\n /* c8 ignore next 2 -- If checking `unifyParentAndChildTypeChecks` */\n (typeof preferredType === 'object' &&\n preferredType?.unifyParentAndChildTypeChecks)) &&\n preferredType !== undefined\n ) {\n typName = checkPostFix;\n\n return true;\n }\n\n return false;\n });\n }\n\n const prefType = preferredTypes?.[typeNodeName];\n const directNameMatch = prefType !== undefined &&\n !Object.values(preferredTypes).includes(typeNodeName);\n const specificUnify = typeof prefType === 'object' &&\n prefType?.unifyParentAndChildTypeChecks;\n const unifiedSyntaxParentMatch = property && directNameMatch && (unifyParentAndChildTypeChecks || specificUnify);\n isGenericMatch = isGenericMatch || Boolean(unifiedSyntaxParentMatch);\n\n hasMatchingPreferredType = isGenericMatch ||\n directNameMatch && !property;\n\n return [\n hasMatchingPreferredType, typName, isGenericMatch,\n ];\n };\n\n /**\n * Collect invalid type info.\n * @param {string} type\n * @param {string} value\n * @param {string} tagName\n * @param {string} nameInTag\n * @param {number} idx\n * @param {string|undefined} property\n * @param {import('jsdoc-type-pratt-parser').NonRootResult} node\n * @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode\n * @param {(string|false|undefined)[][]} invalidTypes\n * @returns {void}\n */\n const getInvalidTypes = (type, value, tagName, nameInTag, idx, property, node, parentNode, invalidTypes) => {\n let typeNodeName = type === 'JsdocTypeAny' ? '*' : value;\n\n const [\n hasMatchingPreferredType,\n typName,\n isGenericMatch,\n ] = getPreferredTypeInfo(type, typeNodeName, parentNode, property);\n\n let preferred;\n let types;\n if (hasMatchingPreferredType) {\n const preferredSetting = preferredTypes[typName];\n typeNodeName = typName === '[]' ? typName : typeNodeName;\n\n if (!preferredSetting) {\n invalidTypes.push([\n typeNodeName,\n ]);\n } else if (typeof preferredSetting === 'string') {\n preferred = preferredSetting;\n invalidTypes.push([\n typeNodeName, preferred,\n ]);\n } else if (preferredSetting && typeof preferredSetting === 'object') {\n const nextItem = preferredSetting.skipRootChecking && jsdocTagsWithPossibleType[idx + 1];\n\n if (!nextItem || !nextItem.name.startsWith(`${nameInTag}.`)) {\n preferred = preferredSetting.replacement;\n invalidTypes.push([\n typeNodeName,\n preferred,\n preferredSetting.message,\n ]);\n }\n } else {\n utils.reportSettings(\n 'Invalid `settings.jsdoc.preferredTypes`. Values must be falsy, a string, or an object.',\n );\n\n return;\n }\n } else if (Object.entries(structuredTags).some(([\n tag,\n {\n type: typs,\n },\n ]) => {\n types = typs;\n\n return tag === tagName &&\n Array.isArray(types) &&\n !types.includes(typeNodeName);\n })) {\n invalidTypes.push([\n typeNodeName, types,\n ]);\n } else if (checkNativeTypes && !noDefaults && type === 'JsdocTypeName') {\n preferred = checkNativeTypes(\n preferredTypes, typeNodeName, preferred, parentNode, invalidTypes,\n );\n }\n\n // For fixer\n if (preferred) {\n adjustNames(type, preferred, isGenericMatch, typeNodeName, node, parentNode);\n }\n };\n\n for (const [\n idx,\n jsdocTag,\n ] of jsdocTagsWithPossibleType.entries()) {\n /** @type {(string|false|undefined)[][]} */\n const invalidTypes = [];\n let typeAst;\n\n try {\n typeAst = mode === 'permissive' ? tryParse(jsdocTag.type) : parse(jsdocTag.type, mode);\n } catch {\n continue;\n }\n\n const {\n name: nameInTag,\n tag: tagName,\n } = jsdocTag;\n\n traverse(typeAst, (node, parentNode, property) => {\n const {\n type,\n value,\n } =\n /**\n * @type {import('jsdoc-type-pratt-parser').NameResult}\n */ (node);\n if (![\n 'JsdocTypeAny', 'JsdocTypeName',\n ].includes(type)) {\n return;\n }\n\n getInvalidTypes(type, value, tagName, nameInTag, idx, property, node, parentNode, invalidTypes);\n });\n\n if (invalidTypes.length) {\n const fixedType = stringify(typeAst);\n\n /**\n * @type {import('eslint').Rule.ReportFixer}\n */\n const fix = (fixer) => {\n return fixer.replaceText(\n jsdocNode,\n sourceCode.getText(jsdocNode).replace(\n `{${jsdocTag.type}}`,\n `{${fixedType}}`,\n ),\n );\n };\n\n for (const [\n badType,\n preferredType = '',\n msg,\n ] of invalidTypes) {\n const tagValue = jsdocTag.name ? ` \"${jsdocTag.name}\"` : '';\n if (exemptTagContexts.some(({\n tag,\n types,\n }) => {\n return tag === tagName &&\n (types === true || types.includes(jsdocTag.type));\n })) {\n continue;\n }\n\n report(\n msg ||\n `Invalid JSDoc @${tagName}${tagValue} type \"${badType}\"` +\n (preferredType ? '; ' : '.') +\n (preferredType ? `prefer: ${JSON.stringify(preferredType)}.` : ''),\n preferredType ? fix : null,\n jsdocTag,\n msg ? {\n tagName,\n tagValue,\n } : undefined,\n );\n }\n }\n }\n },\n {\n iterateAllJsdocs: true,\n meta: {\n docs: {\n description,\n url,\n },\n ...(!overrideSettings || (Object.values(overrideSettings).some((os) => {\n return os && typeof os === 'object' ?\n /* c8 ignore next -- Ok */\n os.replacement :\n typeof os === 'string';\n })) ?\n {\n fixable: 'code',\n } :\n {}\n ),\n schema,\n type: 'suggestion',\n },\n },\n );\n};\n"],"mappings":";;;;;;AAAA;AACA;AAK8B;AAE9B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,WAAW,GAAG,CAAC,IAAI,EAAE,SAAS,EAAE,cAAc,EAAE,YAAY,EAAE,IAAI,EAAE,UAAU,KAAK;EACvF,IAAI,GAAG,GAAG,SAAS;EACnB,IAAI,cAAc,EAAE;IAClB,MAAM,UAAU,GAAG,8DACjB,UAAU,CACV,IAAI;IACN,IAAI,SAAS,KAAK,IAAI,EAAE;MACtB,UAAU,CAAC,QAAQ,GAAG,QAAQ;MAC9B,UAAU,CAAC,GAAG,GAAG,KAAK;MACtB,GAAG,GAAG,OAAO;IACf,CAAC,MAAM;MACL,MAAM,aAAa,GAAG,SAAS,CAAC,KAAK,CAAC,aAAa,CAAC;MACpD,IAAI,aAAa,EAAE;QACjB,UAAU,CAAC,QAAQ,GAAG,OAAO;QAC7B,UAAU,CAAC,GAAG,GAAG,IAAI;QACrB,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;MACpD,CAAC,MAAM;QACL,MAAM,UAAU,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC3C,IAAI,UAAU,EAAE;UACd,UAAU,CAAC,QAAQ,GAAG,OAAO;UAC7B,UAAU,CAAC,GAAG,GAAG,KAAK;UACtB,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC9B,CAAC,MAAM,IACL,UAAU,EAAE,QAAQ,KAAK,QAAQ,KAChC,YAAY,KAAK,IAAI,IAAI,YAAY,KAAK,OAAO,CAAC,EACnD;UACA,UAAU,CAAC,QAAQ,GAAG,OAAO;UAC7B,UAAU,CAAC,GAAG,GAAG,KAAK;QACxB;MACF;IACF;EACF,CAAC,MAAM,IAAI,IAAI,KAAK,cAAc,EAAE;IAClC,IAAI,CAAC,IAAI,GAAG,eAAe;EAC7B;;EAEA;EACE,IAAI,CACJ,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,uBAAuB,EAAE,EAAE,CAAC;;EAElD;EACA,IAAI,CAAC,GAAG,EAAE;IACR,2DACE,IAAI,CACJ,KAAK,GAAG,YAAY;EACxB;AACF,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAM,UAAU,GAAI,SAAS,IAAK;EAChC,OAAO,sDAAsD,GAC7D,GAAG,IAAI,SAAS,GAAG,GAAG,GAAG,GAAG,CAAC,GAAG,yCAAyC;AAC3E,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,IAAI,GAAG;EACX,OAAO,EAAE,UAAU,CAAC,CAAC;EACrB,WAAW,EAAE;AACf,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,MAAM,GAAG;EACb,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC;EACzB,WAAW,EAAE;AACf,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAM,iCAAiC,GAAG,CAAC;EAChD,gBAAgB,GAAG,IAAI;EACvB,QAAQ;EACR,WAAW,GAAG,QAAQ,IAAI,iHAAiH;EAC3I,gBAAgB,GAAG,IAAI;EACvB,MAAM,GAAG,EAAE;EACX,GAAG,GAAG;AACR,CAAC,KAAK;EACJ,OAAO,IAAAA,qBAAY,EACjB,CAAC;IACC,OAAO;IACP,SAAS;IACT,MAAM;IACN,QAAQ;IACR,UAAU;IACV;EACF,CAAC,KAAK;IACJ,MAAM,yBAAyB,GAAG,KAAK,CAAC,UAAU,CAAE,GAAG,IAAK;MAC1D,OAAO,OAAO,CAAC,KAAK,CAAC,wBAAwB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACzD,CAAC,CAAC;IAEF;IACE;AACR;AACA;AACA;AACA;AACA;AACA;IACQ;MACE,IAAI;MACJ,cAAc,EAAE,sBAAsB;MACtC;IACF,CAAC,GAAG,gBAAgB,GAAG;MACrB,IAAI,EAAE,QAAQ,CAAC,IAAI;MACnB,cAAc,EAAE,gBAAgB;MAChC,cAAc,EAAE,CAAC;IACnB,CAAC,GAAG,QAAQ;IAEd,MAAM,0BAA0B,GAAG,CAAC,gBAAgB,IAClD,EAAE,QAAQ,IAAI,sBAAsB,IACpC,QAAQ,IAAI,sBAAsB,IAClC,WAAW,IAAI,sBAAsB,IACrC,WAAW,IAAI,sBAAsB,IACrC,UAAU,IAAI,sBAAsB,CAAC;;IAEvC;IACA,MAAM,YAAY,GAAG,IAAI,KAAK,YAAY,GACxC;MACE,MAAM,EAAE,QAAQ;MAChB,WAAW,EAAE,IAAI;MACjB,WAAW,EAAE,MAAM;MACnB,UAAU,EAAE,IAAI;MAChB,UAAU,EAAE;IACd,CAAC,GACD;MACE,MAAM,EAAE,QAAQ;MAChB,WAAW,EAAE,UAAU;MACvB,WAAW,EAAE,UAAU;MACvB,UAAU,EAAE;IACd,CAAC;;IAEH;IACA,MAAM,cAAc,GAAG;MACrB,IAAG,0BAA0B,GAC3B,YAAY,GACZ,CAAC,CAAC;MACJ,GAAG;IACL,CAAC;IAED;IACE;AACR;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;IAAY;MACF,iBAAiB,GAAG,EAAE;MACtB,UAAU;MACV;IACF,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;;IAE9B;AACN;AACA;AACA;AACA;AACA;AACA;AACA;AACA;IACM,MAAM,oBAAoB,GAAG,CAAC,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,QAAQ,KAAK;MAC1E,IAAI,wBAAwB,GAAG,KAAK;MACpC,IAAI,cAAc,GAAG,KAAK;MAC1B,IAAI,OAAO,GAAG,YAAY;MAE1B,MAAM,eAAe,GAAG,UAAU,KAAK,SAAS,IAAI,UAAU,CAAC,IAAI,KAAK,kBAAkB,IAAI,QAAQ,KAAK,MAAM;MAEjH,MAAM,QAAQ,GAAG,8DACf,UAAU,EACT,IAAI,EAAE,QAAQ;MACjB,MAAM,GAAG,GAAG,8DACV,UAAU,EACT,IAAI,EAAE,GAAG;MAEZ,IAAI,QAAQ,KAAK,OAAO,EAAE;QACxB,MAAM,cAAc,GAAG,GAAG,GAAG,CAC3B,GAAG,EAAE,KAAK,CACX,GAAG,CACF,IAAI,CACL;QACD,cAAc,GAAG,cAAc,CAAC,IAAI,CAAE,YAAY,IAAK;UACrD,MAAM,aAAa,GAAG,cAAc,GAAG,YAAY,GAAG,YAAY,CAAC;;UAEnE;UACA,IACE,CAAC,6BAA6B,IAAI,eAAe,KAC/C;UACC,OAAO,aAAa,KAAK,QAAQ,IAChC,aAAa,EAAE,6BAA6B,CAAC,KAEjD,aAAa,KAAK,SAAS,EAC3B;YACA,OAAO,IAAI,YAAY;YAEvB,OAAO,IAAI;UACb;UAEA,OAAO,KAAK;QACd,CAAC,CAAC;MACJ;MAEA,IACE,CAAC,cAAc,IAAI,QAAQ,IAC3B,8DACE,UAAU,CACV,IAAI,KAAK,kBAAkB,EAC7B;QACA,MAAM,cAAc,GAAG,GAAG,GAAG,CAC3B,GAAG,EAAE,KAAK,CACX,GAAG,CACF,QAAQ,KAAK,OAAO,GAAG,IAAI,GAAG,IAAI,CACnC;QAED,cAAc,GAAG,cAAc,CAAC,IAAI,CAAE,YAAY,IAAK;UACrD,MAAM,aAAa,GAAG,cAAc,GAAG,YAAY,CAAC;UACpD;UACE;UACA,CAAC,6BAA6B,IAAI,eAAe,KAC/C;UACC,OAAO,aAAa,KAAK,QAAQ,IAClC,aAAa,EAAE,6BAA6B,CAAC,KAC7C,aAAa,KAAK,SAAS,EAC7B;YACA,OAAO,GAAG,YAAY;YAEtB,OAAO,IAAI;UACb;UAEA,OAAO,KAAK;QACd,CAAC,CAAC;MACJ;MAEA,MAAM,QAAQ,GAAG,cAAc,GAAG,YAAY,CAAC;MAC/C,MAAM,eAAe,GAAG,QAAQ,KAAK,SAAS,IAC5C,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC;MACvD,MAAM,aAAa,GAAG,OAAO,QAAQ,KAAK,QAAQ,IAChD,QAAQ,EAAE,6BAA6B;MACzC,MAAM,wBAAwB,GAAG,QAAQ,IAAI,eAAe,KAAK,6BAA6B,IAAI,aAAa,CAAC;MAChH,cAAc,GAAG,cAAc,IAAI,OAAO,CAAC,wBAAwB,CAAC;MAEpE,wBAAwB,GAAG,cAAc,IACvC,eAAe,IAAI,CAAC,QAAQ;MAE9B,OAAO,CACL,wBAAwB,EAAE,OAAO,EAAE,cAAc,CAClD;IACH,CAAC;;IAED;AACN;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;IACM,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,YAAY,KAAK;MAC1G,IAAI,YAAY,GAAG,IAAI,KAAK,cAAc,GAAG,GAAG,GAAG,KAAK;MAExD,MAAM,CACJ,wBAAwB,EACxB,OAAO,EACP,cAAc,CACf,GAAG,oBAAoB,CAAC,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,QAAQ,CAAC;MAElE,IAAI,SAAS;MACb,IAAI,KAAK;MACT,IAAI,wBAAwB,EAAE;QAC5B,MAAM,gBAAgB,GAAG,cAAc,CAAC,OAAO,CAAC;QAChD,YAAY,GAAG,OAAO,KAAK,IAAI,GAAG,OAAO,GAAG,YAAY;QAExD,IAAI,CAAC,gBAAgB,EAAE;UACrB,YAAY,CAAC,IAAI,CAAC,CAChB,YAAY,CACb,CAAC;QACJ,CAAC,MAAM,IAAI,OAAO,gBAAgB,KAAK,QAAQ,EAAE;UAC/C,SAAS,GAAG,gBAAgB;UAC5B,YAAY,CAAC,IAAI,CAAC,CAChB,YAAY,EAAE,SAAS,CACxB,CAAC;QACJ,CAAC,MAAM,IAAI,gBAAgB,IAAI,OAAO,gBAAgB,KAAK,QAAQ,EAAE;UACnE,MAAM,QAAQ,GAAG,gBAAgB,CAAC,gBAAgB,IAAI,yBAAyB,CAAC,GAAG,GAAG,CAAC,CAAC;UAExF,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,SAAS,GAAG,CAAC,EAAE;YAC3D,SAAS,GAAG,gBAAgB,CAAC,WAAW;YACxC,YAAY,CAAC,IAAI,CAAC,CAChB,YAAY,EACZ,SAAS,EACT,gBAAgB,CAAC,OAAO,CACzB,CAAC;UACJ;QACF,CAAC,MAAM;UACL,KAAK,CAAC,cAAc,CAClB,wFACF,CAAC;UAED;QACF;MACF,CAAC,MAAM,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,CAC9C,GAAG,EACH;QACE,IAAI,EAAE;MACR,CAAC,CACF,KAAK;QACJ,KAAK,GAAG,IAAI;QAEZ,OAAO,GAAG,KAAK,OAAO,IACpB,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IACpB,CAAC,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC;MACjC,CAAC,CAAC,EAAE;QACF,YAAY,CAAC,IAAI,CAAC,CAChB,YAAY,EAAE,KAAK,CACpB,CAAC;MACJ,CAAC,MAAM,IAAI,gBAAgB,IAAI,CAAC,UAAU,IAAI,IAAI,KAAK,eAAe,EAAE;QACtE,SAAS,GAAG,gBAAgB,CAC1B,cAAc,EAAE,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,YACvD,CAAC;MACH;;MAEA;MACA,IAAI,SAAS,EAAE;QACb,WAAW,CAAC,IAAI,EAAE,SAAS,EAAE,cAAc,EAAE,YAAY,EAAE,IAAI,EAAE,UAAU,CAAC;MAC9E;IACF,CAAC;IAED,KAAK,MAAM,CACT,GAAG,EACH,QAAQ,CACT,IAAI,yBAAyB,CAAC,OAAO,CAAC,CAAC,EAAE;MACxC;MACA,MAAM,YAAY,GAAG,EAAE;MACvB,IAAI,OAAO;MAEX,IAAI;QACF,OAAO,GAAG,IAAI,KAAK,YAAY,GAAG,IAAAC,cAAA,QAAQ,EAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAAC,cAAA,KAAK,EAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;MACxF,CAAC,CAAC,MAAM;QACN;MACF;MAEA,MAAM;QACJ,IAAI,EAAE,SAAS;QACf,GAAG,EAAE;MACP,CAAC,GAAG,QAAQ;MAEZ,IAAAC,cAAA,QAAQ,EAAC,OAAO,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,KAAK;QAChD,MAAM;UACJ,IAAI;UACJ;QACF,CAAC;QACC;AACZ;AACA;QAAiB,IAAK;QACZ,IAAI,CAAC,CACH,cAAc,EAAE,eAAe,CAChC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;UAChB;QACF;QAEA,eAAe,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,YAAY,CAAC;MACjG,CAAC,CAAC;MAEF,IAAI,YAAY,CAAC,MAAM,EAAE;QACvB,MAAM,SAAS,GAAG,IAAAC,cAAA,SAAS,EAAC,OAAO,CAAC;;QAEpC;AACV;AACA;QACU,MAAM,GAAG,GAAI,KAAK,IAAK;UACrB,OAAO,KAAK,CAAC,WAAW,CACtB,SAAS,EACT,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,CACnC,IAAI,QAAQ,CAAC,IAAI,GAAG,EACpB,IAAI,SAAS,GACf,CACF,CAAC;QACH,CAAC;QAED,KAAK,MAAM,CACT,OAAO,EACP,aAAa,GAAG,EAAE,EAClB,GAAG,CACJ,IAAI,YAAY,EAAE;UACjB,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,GAAG,KAAK,QAAQ,CAAC,IAAI,GAAG,GAAG,EAAE;UAC3D,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC;YAC1B,GAAG;YACH;UACF,CAAC,KAAK;YACJ,OAAO,GAAG,KAAK,OAAO,KACnB,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;UACrD,CAAC,CAAC,EAAE;YACF;UACF;UAEA,MAAM,CACJ,GAAG,IACD,kBAAkB,OAAO,GAAG,QAAQ,UAAU,OAAO,GAAG,IACvD,aAAa,GAAG,IAAI,GAAG,GAAG,CAAC,IAC3B,aAAa,GAAG,WAAW,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,GAAG,EAAE,CAAC,EACpE,aAAa,GAAG,GAAG,GAAG,IAAI,EAC1B,QAAQ,EACR,GAAG,GAAG;YACJ,OAAO;YACP;UACF,CAAC,GAAG,SACN,CAAC;QACH;MACF;IACF;EACF,CAAC,EACD;IACE,gBAAgB,EAAE,IAAI;IACtB,IAAI,EAAE;MACJ,IAAI,EAAE;QACJ,WAAW;QACX;MACF,CAAC;MACD,IAAI,CAAC,gBAAgB,IAAK,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAE,EAAE,IAAK;QACrE,OAAO,EAAE,IAAI,OAAO,EAAE,KAAK,QAAQ,GACjC;QACA,EAAE,CAAC,WAAW,GACd,OAAO,EAAE,KAAK,QAAQ;MAC1B,CAAC,CAAE,GACD;QACE,OAAO,EAAE;MACX,CAAC,GACD,CAAC,CAAC,CACH;MACD,MAAM;MACN,IAAI,EAAE;IACR;EACF,CACF,CAAC;AACH,CAAC;AAAC","ignoreList":[]}
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
export default WarnSettings;
|
|
2
|
-
declare function WarnSettings(): {
|
|
3
|
-
/**
|
|
4
|
-
* Warn only once for each context and setting
|
|
5
|
-
* @param {import('eslint').Rule.RuleContext} context
|
|
6
|
-
* @param {string} setting
|
|
7
|
-
* @returns {boolean}
|
|
8
|
-
*/
|
|
9
|
-
hasBeenWarned(context: import("eslint").Rule.RuleContext, setting: string): boolean;
|
|
10
|
-
/**
|
|
11
|
-
* @param {import('eslint').Rule.RuleContext} context
|
|
12
|
-
* @param {string} setting
|
|
13
|
-
* @returns {void}
|
|
14
|
-
*/
|
|
15
|
-
markSettingAsWarned(context: import("eslint").Rule.RuleContext, setting: string): void;
|
|
16
|
-
};
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
export default alignTransform;
|
|
2
|
-
export type TypelessInfo = {
|
|
3
|
-
hasNoTypes: boolean;
|
|
4
|
-
maxNamedTagLength: import("./iterateJsdoc.js").Integer;
|
|
5
|
-
maxUnnamedTagLength: import("./iterateJsdoc.js").Integer;
|
|
6
|
-
};
|
|
7
|
-
export type Width = {
|
|
8
|
-
name: import("./iterateJsdoc.js").Integer;
|
|
9
|
-
start: import("./iterateJsdoc.js").Integer;
|
|
10
|
-
tag: import("./iterateJsdoc.js").Integer;
|
|
11
|
-
type: import("./iterateJsdoc.js").Integer;
|
|
12
|
-
};
|
|
13
|
-
/**
|
|
14
|
-
* @param {{
|
|
15
|
-
* customSpacings: import('../src/rules/checkLineAlignment.js').CustomSpacings,
|
|
16
|
-
* tags: string[],
|
|
17
|
-
* indent: string,
|
|
18
|
-
* preserveMainDescriptionPostDelimiter: boolean,
|
|
19
|
-
* wrapIndent: string,
|
|
20
|
-
* disableWrapIndent: boolean,
|
|
21
|
-
* }} cfg
|
|
22
|
-
* @returns {(
|
|
23
|
-
* block: import('comment-parser').Block
|
|
24
|
-
* ) => import('comment-parser').Block}
|
|
25
|
-
*/
|
|
26
|
-
declare function alignTransform({ customSpacings, disableWrapIndent, indent, preserveMainDescriptionPostDelimiter, tags, wrapIndent, }: {
|
|
27
|
-
customSpacings: import("../src/rules/checkLineAlignment.js").CustomSpacings;
|
|
28
|
-
tags: string[];
|
|
29
|
-
indent: string;
|
|
30
|
-
preserveMainDescriptionPostDelimiter: boolean;
|
|
31
|
-
wrapIndent: string;
|
|
32
|
-
disableWrapIndent: boolean;
|
|
33
|
-
}): (block: import("comment-parser").Block) => import("comment-parser").Block;
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
export function buildForbidRuleDefinition({ contextName, contexts: cntxts, description, getContexts, modifyContext, schema, url, }: {
|
|
2
|
-
contexts?: Contexts;
|
|
3
|
-
description?: string;
|
|
4
|
-
getContexts?: (ctxt: import("eslint").Rule.RuleContext, report: import("./iterateJsdoc.js").Report) => Contexts | false;
|
|
5
|
-
contextName?: string;
|
|
6
|
-
modifyContext?: (context: import("eslint").Rule.RuleContext) => import("eslint").Rule.RuleContext;
|
|
7
|
-
schema?: import("eslint").Rule.RuleMetaData["schema"];
|
|
8
|
-
url?: string;
|
|
9
|
-
}): import("eslint").Rule.RuleModule;
|
|
10
|
-
export type Contexts = (string | {
|
|
11
|
-
comment: string;
|
|
12
|
-
context: string;
|
|
13
|
-
message?: string;
|
|
14
|
-
})[];
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
export function buildRejectOrPreferRuleDefinition({ checkNativeTypes, typeName, description, overrideSettings, schema, url, }: {
|
|
2
|
-
checkNativeTypes?: import("./rules/checkTypes.js").CheckNativeTypes | null;
|
|
3
|
-
overrideSettings?: import("./iterateJsdoc.js").Settings["preferredTypes"] | null;
|
|
4
|
-
description?: string;
|
|
5
|
-
schema?: import("eslint").Rule.RuleMetaData["schema"];
|
|
6
|
-
typeName?: string;
|
|
7
|
-
url?: string;
|
|
8
|
-
}): import("eslint").Rule.RuleModule;
|
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
declare namespace _default {
|
|
2
|
-
export { isUncommentedExport };
|
|
3
|
-
export { parse };
|
|
4
|
-
}
|
|
5
|
-
export default _default;
|
|
6
|
-
export type ValueObject = {
|
|
7
|
-
value: string;
|
|
8
|
-
};
|
|
9
|
-
export type CreatedNode = {
|
|
10
|
-
type?: string;
|
|
11
|
-
value?: ValueObject | import("eslint").Rule.Node | import("@typescript-eslint/types").TSESTree.Node;
|
|
12
|
-
props: {
|
|
13
|
-
[key: string]: CreatedNode | null;
|
|
14
|
-
};
|
|
15
|
-
special?: true;
|
|
16
|
-
globalVars?: CreatedNode;
|
|
17
|
-
exported?: boolean;
|
|
18
|
-
ANONYMOUS_DEFAULT?: import("eslint").Rule.Node;
|
|
19
|
-
};
|
|
20
|
-
export type CreateSymbol = (node: import("eslint").Rule.Node | null, globals: CreatedNode, value: import("eslint").Rule.Node | import("@typescript-eslint/types").TSESTree.Node | null, scope?: CreatedNode | undefined, isGlobal?: boolean | SymbolOptions | undefined) => CreatedNode | null;
|
|
21
|
-
export type SymbolOptions = {
|
|
22
|
-
simpleIdentifier?: boolean;
|
|
23
|
-
};
|
|
24
|
-
/**
|
|
25
|
-
*
|
|
26
|
-
* @param {import('eslint').Rule.Node} node
|
|
27
|
-
* @param {import('eslint').SourceCode} sourceCode
|
|
28
|
-
* @param {import('./rules/requireJsdoc.js').RequireJsdocOpts} opt
|
|
29
|
-
* @param {import('./iterateJsdoc.js').Settings} settings
|
|
30
|
-
* @returns {boolean}
|
|
31
|
-
*/
|
|
32
|
-
declare function isUncommentedExport(node: import("eslint").Rule.Node, sourceCode: import("eslint").SourceCode, opt: import("./rules/requireJsdoc.js").RequireJsdocOpts, settings: import("./iterateJsdoc.js").Settings): boolean;
|
|
33
|
-
/**
|
|
34
|
-
*
|
|
35
|
-
* @param {import('eslint').Rule.Node} ast
|
|
36
|
-
* @param {import('eslint').Rule.Node} node
|
|
37
|
-
* @param {import('./rules/requireJsdoc.js').RequireJsdocOpts} opt
|
|
38
|
-
* @returns {CreatedNode}
|
|
39
|
-
*/
|
|
40
|
-
declare function parse(ast: import("eslint").Rule.Node, node: import("eslint").Rule.Node, opt: import("./rules/requireJsdoc.js").RequireJsdocOpts): CreatedNode;
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
export default getDefaultTagStructureForMode;
|
|
2
|
-
export type TagStructure = Map<string, Map<string, (string | boolean)>>;
|
|
3
|
-
/**
|
|
4
|
-
* @typedef {Map<string, Map<string, (string|boolean)>>} TagStructure
|
|
5
|
-
*/
|
|
6
|
-
/**
|
|
7
|
-
* @param {import('./jsdocUtils.js').ParserMode} mode
|
|
8
|
-
* @returns {TagStructure}
|
|
9
|
-
*/
|
|
10
|
-
declare function getDefaultTagStructureForMode(mode: import("./jsdocUtils.js").ParserMode): TagStructure;
|
|
@@ -1,66 +0,0 @@
|
|
|
1
|
-
export function getJsdocProcessorPlugin(options?: JsdocProcessorOptions): ESLint.Plugin;
|
|
2
|
-
export type Integer = number;
|
|
3
|
-
export type JsdocProcessorOptions = {
|
|
4
|
-
/**
|
|
5
|
-
* Require captions for example tags
|
|
6
|
-
*/
|
|
7
|
-
captionRequired?: boolean | undefined;
|
|
8
|
-
/**
|
|
9
|
-
* See docs
|
|
10
|
-
*/
|
|
11
|
-
paddedIndent?: number | undefined;
|
|
12
|
-
/**
|
|
13
|
-
* See docs
|
|
14
|
-
*/
|
|
15
|
-
checkDefaults?: boolean | undefined;
|
|
16
|
-
/**
|
|
17
|
-
* See docs
|
|
18
|
-
*/
|
|
19
|
-
checkParams?: boolean | undefined;
|
|
20
|
-
/**
|
|
21
|
-
* See docs
|
|
22
|
-
*/
|
|
23
|
-
checkExamples?: boolean | undefined;
|
|
24
|
-
/**
|
|
25
|
-
* See docs
|
|
26
|
-
*/
|
|
27
|
-
checkProperties?: boolean | undefined;
|
|
28
|
-
/**
|
|
29
|
-
* See docs
|
|
30
|
-
*/
|
|
31
|
-
matchingFileName?: string | undefined;
|
|
32
|
-
/**
|
|
33
|
-
* See docs
|
|
34
|
-
*/
|
|
35
|
-
matchingFileNameDefaults?: string | undefined;
|
|
36
|
-
/**
|
|
37
|
-
* See docs
|
|
38
|
-
*/
|
|
39
|
-
matchingFileNameParams?: string | undefined;
|
|
40
|
-
/**
|
|
41
|
-
* See docs
|
|
42
|
-
*/
|
|
43
|
-
matchingFileNameProperties?: string | undefined;
|
|
44
|
-
/**
|
|
45
|
-
* See docs
|
|
46
|
-
*/
|
|
47
|
-
exampleCodeRegex?: string | RegExp | undefined;
|
|
48
|
-
/**
|
|
49
|
-
* See docs
|
|
50
|
-
*/
|
|
51
|
-
rejectExampleCodeRegex?: string | RegExp | undefined;
|
|
52
|
-
/**
|
|
53
|
-
* See docs
|
|
54
|
-
*/
|
|
55
|
-
allowedLanguagesToProcess?: string[] | undefined;
|
|
56
|
-
/**
|
|
57
|
-
* See docs
|
|
58
|
-
*/
|
|
59
|
-
sourceType?: "module" | "script" | undefined;
|
|
60
|
-
/**
|
|
61
|
-
* See docs
|
|
62
|
-
*/
|
|
63
|
-
parser?: Linter.ESTreeParser | Linter.NonESTreeParser | undefined;
|
|
64
|
-
};
|
|
65
|
-
import type { ESLint } from 'eslint';
|
|
66
|
-
import type { Linter } from 'eslint';
|
package/dist/cjs/index-cjs.d.ts
DELETED
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
export default index;
|
|
2
|
-
export type ConfigGroups = "recommended" | "stylistic" | "contents" | "logical" | "requirements";
|
|
3
|
-
export type ConfigVariants = "" | "-typescript" | "-typescript-flavor";
|
|
4
|
-
export type ErrorLevelVariants = "" | "-error";
|
|
5
|
-
/**
|
|
6
|
-
* @typedef {"recommended" | "stylistic" | "contents" | "logical" | "requirements"} ConfigGroups
|
|
7
|
-
* @typedef {"" | "-typescript" | "-typescript-flavor"} ConfigVariants
|
|
8
|
-
* @typedef {"" | "-error"} ErrorLevelVariants
|
|
9
|
-
* @type {import('eslint').ESLint.Plugin & {
|
|
10
|
-
* configs: Record<
|
|
11
|
-
* `flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}`,
|
|
12
|
-
* import('eslint').Linter.Config
|
|
13
|
-
* > &
|
|
14
|
-
* Record<
|
|
15
|
-
* "examples"|"default-expressions"|"examples-and-default-expressions",
|
|
16
|
-
* import('eslint').Linter.Config[]
|
|
17
|
-
* > &
|
|
18
|
-
* Record<"flat/recommended-mixed", import('eslint').Linter.Config[]>
|
|
19
|
-
* }}
|
|
20
|
-
*/
|
|
21
|
-
declare const index: import("eslint").ESLint.Plugin & {
|
|
22
|
-
configs: Record<`flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}`, import("eslint").Linter.Config> & Record<"examples" | "default-expressions" | "examples-and-default-expressions", import("eslint").Linter.Config[]> & Record<"flat/recommended-mixed", import("eslint").Linter.Config[]>;
|
|
23
|
-
};
|
package/dist/cjs/index.cjs.d.cts
DELETED