eslint-plugin-jsdoc 52.0.4 → 53.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/WarnSettings.cjs +18 -35
- package/dist/WarnSettings.cjs.map +1 -1
- package/dist/WarnSettings.js +20 -0
- package/dist/WarnSettings.js.map +1 -0
- package/dist/_virtual/rolldown_runtime.cjs +32 -0
- package/dist/_virtual/rolldown_runtime.js +11 -0
- package/dist/alignTransform.cjs +224 -305
- package/dist/alignTransform.cjs.map +1 -1
- package/dist/alignTransform.js +241 -0
- package/dist/alignTransform.js.map +1 -0
- package/dist/defaultTagOrder.cjs +132 -43
- package/dist/defaultTagOrder.cjs.map +1 -1
- package/dist/defaultTagOrder.js +134 -0
- package/dist/defaultTagOrder.js.map +1 -0
- package/dist/exportParser.cjs +478 -696
- package/dist/exportParser.cjs.map +1 -1
- package/dist/exportParser.js +518 -0
- package/dist/exportParser.js.map +1 -0
- package/dist/getDefaultTagStructureForMode.cjs +184 -288
- package/dist/getDefaultTagStructureForMode.cjs.map +1 -1
- package/dist/getDefaultTagStructureForMode.js +188 -0
- package/dist/getDefaultTagStructureForMode.js.map +1 -0
- package/dist/getJsdocProcessorPlugin.cjs +364 -550
- package/dist/getJsdocProcessorPlugin.cjs.map +1 -1
- package/dist/getJsdocProcessorPlugin.d.cts +70 -0
- package/dist/getJsdocProcessorPlugin.d.cts.map +1 -0
- package/dist/getJsdocProcessorPlugin.d.ts +68 -65
- package/dist/getJsdocProcessorPlugin.d.ts.map +1 -1
- package/dist/getJsdocProcessorPlugin.js +383 -0
- package/dist/getJsdocProcessorPlugin.js.map +1 -0
- package/dist/index.cjs +2 -410
- package/dist/index.d.cts +2 -0
- package/dist/index.d.ts +2 -17
- package/dist/index.js +3 -0
- package/dist/iterateJsdoc.cjs +1539 -1988
- package/dist/iterateJsdoc.cjs.map +1 -1
- package/dist/iterateJsdoc.d.cts +472 -0
- package/dist/iterateJsdoc.d.cts.map +1 -0
- package/dist/iterateJsdoc.d.ts +359 -349
- package/dist/iterateJsdoc.d.ts.map +1 -1
- package/dist/iterateJsdoc.js +1628 -0
- package/dist/iterateJsdoc.js.map +1 -0
- package/dist/jsdocUtils.cjs +1009 -1376
- package/dist/jsdocUtils.cjs.map +1 -1
- package/dist/jsdocUtils.js +1123 -0
- package/dist/jsdocUtils.js.map +1 -0
- package/dist/plugin.cjs +427 -0
- package/dist/plugin.cjs.map +1 -0
- package/dist/plugin.js +427 -0
- package/dist/plugin.js.map +1 -0
- package/dist/rules/checkAccess.cjs +29 -36
- package/dist/rules/checkAccess.cjs.map +1 -1
- package/dist/rules/checkAccess.js +33 -0
- package/dist/rules/checkAccess.js.map +1 -0
- package/dist/rules/checkAlignment.cjs +41 -54
- package/dist/rules/checkAlignment.cjs.map +1 -1
- package/dist/rules/checkAlignment.js +47 -0
- package/dist/rules/checkAlignment.js.map +1 -0
- package/dist/rules/checkExamples.cjs +327 -484
- package/dist/rules/checkExamples.cjs.map +1 -1
- package/dist/rules/checkExamples.js +348 -0
- package/dist/rules/checkExamples.js.map +1 -0
- package/dist/rules/checkIndentation.cjs +50 -65
- package/dist/rules/checkIndentation.cjs.map +1 -1
- package/dist/rules/checkIndentation.js +59 -0
- package/dist/rules/checkIndentation.js.map +1 -0
- package/dist/rules/checkLineAlignment.cjs +220 -311
- package/dist/rules/checkLineAlignment.cjs.map +1 -1
- package/dist/rules/checkLineAlignment.js +229 -0
- package/dist/rules/checkLineAlignment.js.map +1 -0
- package/dist/rules/checkParamNames.cjs +227 -335
- package/dist/rules/checkParamNames.cjs.map +1 -1
- package/dist/rules/checkParamNames.js +237 -0
- package/dist/rules/checkParamNames.js.map +1 -0
- package/dist/rules/checkPropertyNames.cjs +78 -106
- package/dist/rules/checkPropertyNames.cjs.map +1 -1
- package/dist/rules/checkPropertyNames.js +88 -0
- package/dist/rules/checkPropertyNames.js.map +1 -0
- package/dist/rules/checkSyntax.cjs +21 -34
- package/dist/rules/checkSyntax.cjs.map +1 -1
- package/dist/rules/checkSyntax.js +25 -0
- package/dist/rules/checkSyntax.js.map +1 -0
- package/dist/rules/checkTagNames.cjs +188 -210
- package/dist/rules/checkTagNames.cjs.map +1 -1
- package/dist/rules/checkTagNames.js +191 -0
- package/dist/rules/checkTagNames.js.map +1 -0
- package/dist/rules/checkTemplateNames.cjs +121 -178
- package/dist/rules/checkTemplateNames.cjs.map +1 -1
- package/dist/rules/checkTemplateNames.js +124 -0
- package/dist/rules/checkTemplateNames.js.map +1 -0
- package/dist/rules/checkTypes.cjs +291 -385
- package/dist/rules/checkTypes.cjs.map +1 -1
- package/dist/rules/checkTypes.js +299 -0
- package/dist/rules/checkTypes.js.map +1 -0
- package/dist/rules/checkValues.cjs +100 -146
- package/dist/rules/checkValues.cjs.map +1 -1
- package/dist/rules/checkValues.js +103 -0
- package/dist/rules/checkValues.js.map +1 -0
- package/dist/rules/convertToJsdocComments.cjs +228 -306
- package/dist/rules/convertToJsdocComments.cjs.map +1 -1
- package/dist/rules/convertToJsdocComments.js +231 -0
- package/dist/rules/convertToJsdocComments.js.map +1 -0
- package/dist/rules/emptyTags.cjs +62 -72
- package/dist/rules/emptyTags.cjs.map +1 -1
- package/dist/rules/emptyTags.js +67 -0
- package/dist/rules/emptyTags.js.map +1 -0
- package/dist/rules/implementsOnClasses.cjs +36 -56
- package/dist/rules/implementsOnClasses.cjs.map +1 -1
- package/dist/rules/implementsOnClasses.js +40 -0
- package/dist/rules/implementsOnClasses.js.map +1 -0
- package/dist/rules/importsAsDependencies.cjs +62 -99
- package/dist/rules/importsAsDependencies.cjs.map +1 -1
- package/dist/rules/importsAsDependencies.js +68 -0
- package/dist/rules/importsAsDependencies.js.map +1 -0
- package/dist/rules/informativeDocs.cjs +105 -142
- package/dist/rules/informativeDocs.cjs.map +1 -1
- package/dist/rules/informativeDocs.js +110 -0
- package/dist/rules/informativeDocs.js.map +1 -0
- package/dist/rules/linesBeforeBlock.cjs +70 -105
- package/dist/rules/linesBeforeBlock.cjs.map +1 -1
- package/dist/rules/linesBeforeBlock.js +75 -0
- package/dist/rules/linesBeforeBlock.js.map +1 -0
- package/dist/rules/matchDescription.cjs +160 -222
- package/dist/rules/matchDescription.cjs.map +1 -1
- package/dist/rules/matchDescription.js +167 -0
- package/dist/rules/matchDescription.js.map +1 -0
- package/dist/rules/matchName.cjs +73 -128
- package/dist/rules/matchName.cjs.map +1 -1
- package/dist/rules/matchName.js +77 -0
- package/dist/rules/matchName.js.map +1 -0
- package/dist/rules/multilineBlocks.cjs +235 -352
- package/dist/rules/multilineBlocks.cjs.map +1 -1
- package/dist/rules/multilineBlocks.js +245 -0
- package/dist/rules/multilineBlocks.js.map +1 -0
- package/dist/rules/noBadBlocks.cjs +63 -86
- package/dist/rules/noBadBlocks.cjs.map +1 -1
- package/dist/rules/noBadBlocks.js +68 -0
- package/dist/rules/noBadBlocks.js.map +1 -0
- package/dist/rules/noBlankBlockDescriptions.cjs +35 -57
- package/dist/rules/noBlankBlockDescriptions.cjs.map +1 -1
- package/dist/rules/noBlankBlockDescriptions.js +41 -0
- package/dist/rules/noBlankBlockDescriptions.js.map +1 -0
- package/dist/rules/noBlankBlocks.cjs +26 -48
- package/dist/rules/noBlankBlocks.cjs.map +1 -1
- package/dist/rules/noBlankBlocks.js +30 -0
- package/dist/rules/noBlankBlocks.js.map +1 -0
- package/dist/rules/noDefaults.cjs +52 -79
- package/dist/rules/noDefaults.cjs.map +1 -1
- package/dist/rules/noDefaults.js +56 -0
- package/dist/rules/noDefaults.js.map +1 -0
- package/dist/rules/noMissingSyntax.cjs +115 -165
- package/dist/rules/noMissingSyntax.cjs.map +1 -1
- package/dist/rules/noMissingSyntax.js +126 -0
- package/dist/rules/noMissingSyntax.js.map +1 -0
- package/dist/rules/noMultiAsterisks.cjs +48 -89
- package/dist/rules/noMultiAsterisks.cjs.map +1 -1
- package/dist/rules/noMultiAsterisks.js +58 -0
- package/dist/rules/noMultiAsterisks.js.map +1 -0
- package/dist/rules/noRestrictedSyntax.cjs +45 -79
- package/dist/rules/noRestrictedSyntax.cjs.map +1 -1
- package/dist/rules/noRestrictedSyntax.js +49 -0
- package/dist/rules/noRestrictedSyntax.js.map +1 -0
- package/dist/rules/noTypes.cjs +59 -80
- package/dist/rules/noTypes.cjs.map +1 -1
- package/dist/rules/noTypes.js +65 -0
- package/dist/rules/noTypes.js.map +1 -0
- package/dist/rules/noUndefinedTypes.cjs +297 -388
- package/dist/rules/noUndefinedTypes.cjs.map +1 -1
- package/dist/rules/noUndefinedTypes.js +303 -0
- package/dist/rules/noUndefinedTypes.js.map +1 -0
- package/dist/rules/requireAsteriskPrefix.cjs +108 -159
- package/dist/rules/requireAsteriskPrefix.cjs.map +1 -1
- package/dist/rules/requireAsteriskPrefix.js +112 -0
- package/dist/rules/requireAsteriskPrefix.js.map +1 -0
- package/dist/rules/requireDescription.cjs +89 -129
- package/dist/rules/requireDescription.cjs.map +1 -1
- package/dist/rules/requireDescription.js +95 -0
- package/dist/rules/requireDescription.js.map +1 -0
- package/dist/rules/requireDescriptionCompleteSentence.cjs +201 -262
- package/dist/rules/requireDescriptionCompleteSentence.cjs.map +1 -1
- package/dist/rules/requireDescriptionCompleteSentence.js +220 -0
- package/dist/rules/requireDescriptionCompleteSentence.js.map +1 -0
- package/dist/rules/requireExample.cjs +73 -104
- package/dist/rules/requireExample.cjs.map +1 -1
- package/dist/rules/requireExample.js +77 -0
- package/dist/rules/requireExample.js.map +1 -0
- package/dist/rules/requireFileOverview.cjs +75 -129
- package/dist/rules/requireFileOverview.cjs.map +1 -1
- package/dist/rules/requireFileOverview.js +81 -0
- package/dist/rules/requireFileOverview.js.map +1 -0
- package/dist/rules/requireHyphenBeforeParamDescription.cjs +85 -133
- package/dist/rules/requireHyphenBeforeParamDescription.cjs.map +1 -1
- package/dist/rules/requireHyphenBeforeParamDescription.js +89 -0
- package/dist/rules/requireHyphenBeforeParamDescription.js.map +1 -0
- package/dist/rules/requireJsdoc.cjs +384 -557
- package/dist/rules/requireJsdoc.cjs.map +1 -1
- package/dist/rules/requireJsdoc.js +404 -0
- package/dist/rules/requireJsdoc.js.map +1 -0
- package/dist/rules/requireParam.cjs +336 -526
- package/dist/rules/requireParam.cjs.map +1 -1
- package/dist/rules/requireParam.js +344 -0
- package/dist/rules/requireParam.js.map +1 -0
- package/dist/rules/requireParamDescription.cjs +55 -80
- package/dist/rules/requireParamDescription.cjs.map +1 -1
- package/dist/rules/requireParamDescription.js +59 -0
- package/dist/rules/requireParamDescription.js.map +1 -0
- package/dist/rules/requireParamName.cjs +32 -50
- package/dist/rules/requireParamName.cjs.map +1 -1
- package/dist/rules/requireParamName.js +36 -0
- package/dist/rules/requireParamName.js.map +1 -0
- package/dist/rules/requireParamType.cjs +55 -80
- package/dist/rules/requireParamType.cjs.map +1 -1
- package/dist/rules/requireParamType.js +59 -0
- package/dist/rules/requireParamType.js.map +1 -0
- package/dist/rules/requireProperty.cjs +31 -42
- package/dist/rules/requireProperty.cjs.map +1 -1
- package/dist/rules/requireProperty.js +35 -0
- package/dist/rules/requireProperty.js.map +1 -0
- package/dist/rules/requirePropertyDescription.cjs +17 -25
- package/dist/rules/requirePropertyDescription.cjs.map +1 -1
- package/dist/rules/requirePropertyDescription.js +21 -0
- package/dist/rules/requirePropertyDescription.js.map +1 -0
- package/dist/rules/requirePropertyName.cjs +17 -25
- package/dist/rules/requirePropertyName.cjs.map +1 -1
- package/dist/rules/requirePropertyName.js +21 -0
- package/dist/rules/requirePropertyName.js.map +1 -0
- package/dist/rules/requirePropertyType.cjs +17 -25
- package/dist/rules/requirePropertyType.cjs.map +1 -1
- package/dist/rules/requirePropertyType.js +21 -0
- package/dist/rules/requirePropertyType.js.map +1 -0
- package/dist/rules/requireReturns.cjs +125 -203
- package/dist/rules/requireReturns.cjs.map +1 -1
- package/dist/rules/requireReturns.js +131 -0
- package/dist/rules/requireReturns.js.map +1 -0
- package/dist/rules/requireReturnsCheck.cjs +60 -103
- package/dist/rules/requireReturnsCheck.cjs.map +1 -1
- package/dist/rules/requireReturnsCheck.js +66 -0
- package/dist/rules/requireReturnsCheck.js.map +1 -0
- package/dist/rules/requireReturnsDescription.cjs +39 -54
- package/dist/rules/requireReturnsDescription.cjs.map +1 -1
- package/dist/rules/requireReturnsDescription.js +43 -0
- package/dist/rules/requireReturnsDescription.js.map +1 -0
- package/dist/rules/requireReturnsType.cjs +32 -50
- package/dist/rules/requireReturnsType.cjs.map +1 -1
- package/dist/rules/requireReturnsType.js +36 -0
- package/dist/rules/requireReturnsType.js.map +1 -0
- package/dist/rules/requireTemplate.cjs +119 -178
- package/dist/rules/requireTemplate.cjs.map +1 -1
- package/dist/rules/requireTemplate.js +122 -0
- package/dist/rules/requireTemplate.js.map +1 -0
- package/dist/rules/requireThrows.cjs +61 -95
- package/dist/rules/requireThrows.cjs.map +1 -1
- package/dist/rules/requireThrows.js +67 -0
- package/dist/rules/requireThrows.js.map +1 -0
- package/dist/rules/requireYields.cjs +106 -166
- package/dist/rules/requireYields.cjs.map +1 -1
- package/dist/rules/requireYields.js +115 -0
- package/dist/rules/requireYields.js.map +1 -0
- package/dist/rules/requireYieldsCheck.cjs +96 -152
- package/dist/rules/requireYieldsCheck.cjs.map +1 -1
- package/dist/rules/requireYieldsCheck.js +105 -0
- package/dist/rules/requireYieldsCheck.js.map +1 -0
- package/dist/rules/sortTags.cjs +258 -444
- package/dist/rules/sortTags.cjs.map +1 -1
- package/dist/rules/sortTags.js +262 -0
- package/dist/rules/sortTags.js.map +1 -0
- package/dist/rules/tagLines.cjs +179 -266
- package/dist/rules/tagLines.cjs.map +1 -1
- package/dist/rules/tagLines.js +183 -0
- package/dist/rules/tagLines.js.map +1 -0
- package/dist/rules/textEscaping.cjs +92 -127
- package/dist/rules/textEscaping.cjs.map +1 -1
- package/dist/rules/textEscaping.js +102 -0
- package/dist/rules/textEscaping.js.map +1 -0
- package/dist/rules/validTypes.cjs +252 -265
- package/dist/rules/validTypes.cjs.map +1 -1
- package/dist/rules/validTypes.js +259 -0
- package/dist/rules/validTypes.js.map +1 -0
- package/dist/tagNames.cjs +134 -170
- package/dist/tagNames.cjs.map +1 -1
- package/dist/tagNames.js +144 -0
- package/dist/tagNames.js.map +1 -0
- package/dist/utils/hasReturnValue.cjs +246 -474
- package/dist/utils/hasReturnValue.cjs.map +1 -1
- package/dist/utils/hasReturnValue.js +265 -0
- package/dist/utils/hasReturnValue.js.map +1 -0
- package/package.json +40 -24
- package/dist/generateRule.cjs +0 -242
- package/dist/generateRule.cjs.map +0 -1
- package/dist/index.cjs.map +0 -1
- package/dist/index.d.ts.map +0 -1
- package/src/WarnSettings.js +0 -34
- package/src/alignTransform.js +0 -358
- package/src/defaultTagOrder.js +0 -169
- package/src/exportParser.js +0 -978
- package/src/getDefaultTagStructureForMode.js +0 -969
- package/src/getJsdocProcessorPlugin.js +0 -672
- package/src/index.js +0 -530
- package/src/iterateJsdoc.js +0 -2518
- package/src/jsdocUtils.js +0 -1896
- package/src/rules/checkAccess.js +0 -45
- package/src/rules/checkAlignment.js +0 -63
- package/src/rules/checkExamples.js +0 -589
- package/src/rules/checkIndentation.js +0 -75
- package/src/rules/checkLineAlignment.js +0 -372
- package/src/rules/checkParamNames.js +0 -474
- package/src/rules/checkPropertyNames.js +0 -152
- package/src/rules/checkSyntax.js +0 -30
- package/src/rules/checkTagNames.js +0 -314
- package/src/rules/checkTemplateNames.js +0 -204
- package/src/rules/checkTypes.js +0 -535
- package/src/rules/checkValues.js +0 -248
- package/src/rules/convertToJsdocComments.js +0 -398
- package/src/rules/emptyTags.js +0 -98
- package/src/rules/implementsOnClasses.js +0 -64
- package/src/rules/importsAsDependencies.js +0 -133
- package/src/rules/informativeDocs.js +0 -189
- package/src/rules/linesBeforeBlock.js +0 -134
- package/src/rules/matchDescription.js +0 -286
- package/src/rules/matchName.js +0 -151
- package/src/rules/multilineBlocks.js +0 -493
- package/src/rules/noBadBlocks.js +0 -119
- package/src/rules/noBlankBlockDescriptions.js +0 -69
- package/src/rules/noBlankBlocks.js +0 -53
- package/src/rules/noDefaults.js +0 -85
- package/src/rules/noMissingSyntax.js +0 -195
- package/src/rules/noMultiAsterisks.js +0 -134
- package/src/rules/noRestrictedSyntax.js +0 -91
- package/src/rules/noTypes.js +0 -93
- package/src/rules/noUndefinedTypes.js +0 -543
- package/src/rules/requireAsteriskPrefix.js +0 -190
- package/src/rules/requireDescription.js +0 -161
- package/src/rules/requireDescriptionCompleteSentence.js +0 -335
- package/src/rules/requireExample.js +0 -118
- package/src/rules/requireFileOverview.js +0 -154
- package/src/rules/requireHyphenBeforeParamDescription.js +0 -176
- package/src/rules/requireJsdoc.js +0 -743
- package/src/rules/requireParam.js +0 -602
- package/src/rules/requireParamDescription.js +0 -89
- package/src/rules/requireParamName.js +0 -55
- package/src/rules/requireParamType.js +0 -89
- package/src/rules/requireProperty.js +0 -48
- package/src/rules/requirePropertyDescription.js +0 -25
- package/src/rules/requirePropertyName.js +0 -25
- package/src/rules/requirePropertyType.js +0 -25
- package/src/rules/requireReturns.js +0 -238
- package/src/rules/requireReturnsCheck.js +0 -145
- package/src/rules/requireReturnsDescription.js +0 -59
- package/src/rules/requireReturnsType.js +0 -51
- package/src/rules/requireTemplate.js +0 -201
- package/src/rules/requireThrows.js +0 -111
- package/src/rules/requireYields.js +0 -216
- package/src/rules/requireYieldsCheck.js +0 -208
- package/src/rules/sortTags.js +0 -558
- package/src/rules/tagLines.js +0 -359
- package/src/rules/textEscaping.js +0 -154
- package/src/rules/validTypes.js +0 -401
- package/src/tagNames.js +0 -238
- package/src/utils/hasReturnValue.js +0 -572
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"checkTypes.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","_jsdoccomment","e","__esModule","default","strictNativeTypes","adjustNames","type","preferred","isGenericMatch","typeNodeName","node","parentNode","ret","parentMeta","meta","brackets","dot","dotBracketEnd","match","slice","length","bracketEnd","endsWith","value","replace","getMessage","upperCase","_default","exports","iterateJsdoc","context","jsdocNode","report","settings","sourceCode","utils","jsdocTagsWithPossibleType","filterTags","tag","Boolean","tagMightHaveTypePosition","mode","preferredTypes","preferredTypesOriginal","structuredTags","injectObjectPreferredTypes","info","message","replacement","infoUC","typeToInject","Object","exemptTagContexts","noDefaults","unifyParentAndChildTypeChecks","options","getPreferredTypeInfo","_type","property","hasMatchingPreferredType","typeName","isNameOfGeneric","undefined","checkPostFixes","some","checkPostFix","directNameMatch","values","includes","unifiedSyntaxParentMatch","checkNativeTypes","invalidTypes","changedPreferred","strictNativeType","elements","left","toLowerCase","push","getInvalidTypes","tagName","nameInTag","idx","types","preferredSetting","nextItem","skipRootChecking","name","startsWith","reportSettings","entries","typs","Array","isArray","jsdocTag","typeAst","tryParse","parse","traverse","fixedType","stringify","fix","fixer","replaceText","getText","badType","preferredType","msg","tagValue","JSON","iterateAllJsdocs","docs","description","url","fixable","schema","additionalProperties","properties","items","oneOf","module"],"sources":["../../src/rules/checkTypes.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n parse,\n stringify,\n traverse,\n tryParse,\n} from '@es-joy/jsdoccomment';\n\nconst strictNativeTypes = [\n 'undefined',\n 'null',\n 'boolean',\n 'number',\n 'bigint',\n 'string',\n 'symbol',\n 'object',\n 'Array',\n 'Function',\n 'Date',\n 'RegExp',\n];\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\nexport default iterateJsdoc(({\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 } = settings;\n\n const injectObjectPreferredTypes = !('Object' in preferredTypesOriginal ||\n 'object' in preferredTypesOriginal ||\n 'object.<>' in preferredTypesOriginal ||\n 'Object.<>' in preferredTypesOriginal ||\n 'object<>' in preferredTypesOriginal);\n\n /**\n * @type {{\n * message: string,\n * replacement: false\n * }}\n */\n const info = {\n message: getMessage(),\n replacement: false,\n };\n\n /**\n * @type {{\n * message: string,\n * replacement: false\n * }}\n */\n const infoUC = {\n message: getMessage(true),\n replacement: false,\n };\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 typeName = typeNodeName;\n\n const isNameOfGeneric = parentNode !== undefined && parentNode.type === 'JsdocTypeGeneric' && property === 'left';\n if (unifyParentAndChildTypeChecks || isNameOfGeneric) {\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 if (preferredTypes?.[typeNodeName + checkPostFix] !== undefined) {\n typeName += 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 if (preferredTypes?.[checkPostFix] !== undefined) {\n typeName = checkPostFix;\n\n return true;\n }\n\n return false;\n });\n }\n }\n\n const directNameMatch = preferredTypes?.[typeNodeName] !== undefined &&\n !Object.values(preferredTypes).includes(typeNodeName);\n const unifiedSyntaxParentMatch = property && directNameMatch && unifyParentAndChildTypeChecks;\n isGenericMatch = isGenericMatch || Boolean(unifiedSyntaxParentMatch);\n\n hasMatchingPreferredType = isGenericMatch ||\n directNameMatch && !property;\n\n return [\n hasMatchingPreferredType, typeName, isGenericMatch,\n ];\n };\n\n /**\n * Iterates strict types to see if any should be added to `invalidTypes` (and\n * the the relevant strict type returned as the new preferred type).\n * @param {string} typeNodeName\n * @param {string|undefined} preferred\n * @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode\n * @param {(string|false|undefined)[][]} invalidTypes\n * @returns {string|undefined} The `preferred` type string, optionally changed\n */\n const checkNativeTypes = (typeNodeName, preferred, parentNode, invalidTypes) => {\n let changedPreferred = preferred;\n for (const strictNativeType of strictNativeTypes) {\n if (\n strictNativeType === 'object' &&\n (\n // This is not set to remap with exact type match (e.g.,\n // `object: 'Object'`), so can ignore (including if circular)\n !preferredTypes?.[typeNodeName] ||\n // Although present on `preferredTypes` for remapping, this is a\n // parent object without a parent match (and not\n // `unifyParentAndChildTypeChecks`) and we don't want\n // `object<>` given TypeScript issue https://github.com/microsoft/TypeScript/issues/20555\n /**\n * @type {import('jsdoc-type-pratt-parser').GenericResult}\n */\n (\n parentNode\n )?.elements?.length && (\n /**\n * @type {import('jsdoc-type-pratt-parser').GenericResult}\n */\n (\n parentNode\n )?.left?.type === 'JsdocTypeName' &&\n /**\n * @type {import('jsdoc-type-pratt-parser').GenericResult}\n */\n (parentNode)?.left?.value === 'Object'\n )\n )\n ) {\n continue;\n }\n\n if (strictNativeType !== typeNodeName &&\n strictNativeType.toLowerCase() === typeNodeName.toLowerCase() &&\n\n // Don't report if user has own map for a strict native type\n (!preferredTypes || preferredTypes?.[strictNativeType] === undefined)\n ) {\n changedPreferred = strictNativeType;\n invalidTypes.push([\n typeNodeName, changedPreferred,\n ]);\n break;\n }\n }\n\n return changedPreferred;\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 typeName,\n isGenericMatch,\n ] = getPreferredTypeInfo(type, typeNodeName, parentNode, property);\n\n let preferred;\n let types;\n if (hasMatchingPreferredType) {\n const preferredSetting = preferredTypes[typeName];\n typeNodeName = typeName === '[]' ? typeName : 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 (!noDefaults && type === 'JsdocTypeName') {\n preferred = checkNativeTypes(typeNodeName, preferred, parentNode, invalidTypes);\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 iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Reports invalid types.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-types.md#repos-sticky-header',\n },\n fixable: 'code',\n schema: [\n {\n additionalProperties: false,\n properties: {\n exemptTagContexts: {\n items: {\n additionalProperties: false,\n properties: {\n tag: {\n type: 'string',\n },\n types: {\n oneOf: [\n {\n type: 'boolean',\n },\n {\n items: {\n type: 'string',\n },\n type: 'array',\n },\n ],\n },\n },\n type: 'object',\n },\n type: 'array',\n },\n noDefaults: {\n type: 'boolean',\n },\n unifyParentAndChildTypeChecks: {\n type: 'boolean',\n },\n },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AAK8B,SAAAD,uBAAAG,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE9B,MAAMG,iBAAiB,GAAG,CACxB,WAAW,EACX,MAAM,EACN,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,OAAO,EACP,UAAU,EACV,MAAM,EACN,QAAQ,CACT;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,WAAW,GAAGA,CAACC,IAAI,EAAEC,SAAS,EAAEC,cAAc,EAAEC,YAAY,EAAEC,IAAI,EAAEC,UAAU,KAAK;EACvF,IAAIC,GAAG,GAAGL,SAAS;EACnB,IAAIC,cAAc,EAAE;IAClB,MAAMK,UAAU,GAAG,8DACjBF,UAAU,CACVG,IAAI;IACN,IAAIP,SAAS,KAAK,IAAI,EAAE;MACtBM,UAAU,CAACE,QAAQ,GAAG,QAAQ;MAC9BF,UAAU,CAACG,GAAG,GAAG,KAAK;MACtBJ,GAAG,GAAG,OAAO;IACf,CAAC,MAAM;MACL,MAAMK,aAAa,GAAGV,SAAS,CAACW,KAAK,CAAC,aAAa,CAAC;MACpD,IAAID,aAAa,EAAE;QACjBJ,UAAU,CAACE,QAAQ,GAAG,OAAO;QAC7BF,UAAU,CAACG,GAAG,GAAG,IAAI;QACrBJ,GAAG,GAAGL,SAAS,CAACY,KAAK,CAAC,CAAC,EAAE,CAACF,aAAa,CAAC,CAAC,CAAC,CAACG,MAAM,CAAC;MACpD,CAAC,MAAM;QACL,MAAMC,UAAU,GAAGd,SAAS,CAACe,QAAQ,CAAC,IAAI,CAAC;QAC3C,IAAID,UAAU,EAAE;UACdR,UAAU,CAACE,QAAQ,GAAG,OAAO;UAC7BF,UAAU,CAACG,GAAG,GAAG,KAAK;UACtBJ,GAAG,GAAGL,SAAS,CAACY,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC9B,CAAC,MAAM,IACLN,UAAU,EAAEE,QAAQ,KAAK,QAAQ,KAChCN,YAAY,KAAK,IAAI,IAAIA,YAAY,KAAK,OAAO,CAAC,EACnD;UACAI,UAAU,CAACE,QAAQ,GAAG,OAAO;UAC7BF,UAAU,CAACG,GAAG,GAAG,KAAK;QACxB;MACF;IACF;EACF,CAAC,MAAM,IAAIV,IAAI,KAAK,cAAc,EAAE;IAClCI,IAAI,CAACJ,IAAI,GAAG,eAAe;EAC7B;;EAEA;EACEI,IAAI,CACJa,KAAK,GAAGX,GAAG,CAACY,OAAO,CAAC,uBAAuB,EAAE,EAAE,CAAC;;EAElD;EACA,IAAI,CAACZ,GAAG,EAAE;IACR,2DACEF,IAAI,CACJa,KAAK,GAAGd,YAAY;EACxB;AACF,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAMgB,UAAU,GAAIC,SAAS,IAAK;EAChC,OAAO,sDAAsD,GAC7D,GAAG,IAAIA,SAAS,GAAG,GAAG,GAAG,GAAG,CAAC,GAAG,yCAAyC;AAC3E,CAAC;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAzB,OAAA,GAEa,IAAA0B,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPC,SAAS;EACTC,MAAM;EACNC,QAAQ;EACRC,UAAU;EACVC;AACF,CAAC,KAAK;EACJ,MAAMC,yBAAyB,GAAGD,KAAK,CAACE,UAAU,CAAEC,GAAG,IAAK;IAC1D,OAAOC,OAAO,CAACJ,KAAK,CAACK,wBAAwB,CAACF,GAAG,CAACA,GAAG,CAAC,CAAC;EACzD,CAAC,CAAC;EAEF;EACE;AACJ;AACA;AACA;AACA;AACA;AACA;EACI;IACEG,IAAI;IACJC,cAAc,EAAEC,sBAAsB;IACtCC;EACF,CAAC,GAAGX,QAAQ;EAEd,MAAMY,0BAA0B,GAAG,EAAE,QAAQ,IAAIF,sBAAsB,IACrE,QAAQ,IAAIA,sBAAsB,IAClC,WAAW,IAAIA,sBAAsB,IACrC,WAAW,IAAIA,sBAAsB,IACrC,UAAU,IAAIA,sBAAsB,CAAC;;EAEvC;AACF;AACA;AACA;AACA;AACA;EACE,MAAMG,IAAI,GAAG;IACXC,OAAO,EAAEtB,UAAU,CAAC,CAAC;IACrBuB,WAAW,EAAE;EACf,CAAC;;EAED;AACF;AACA;AACA;AACA;AACA;EACE,MAAMC,MAAM,GAAG;IACbF,OAAO,EAAEtB,UAAU,CAAC,IAAI,CAAC;IACzBuB,WAAW,EAAE;EACf,CAAC;;EAED;EACA,MAAME,YAAY,GAAGT,IAAI,KAAK,YAAY,GACxC;IACEU,MAAM,EAAE,QAAQ;IAChB,WAAW,EAAEL,IAAI;IACjB,WAAW,EAAEG,MAAM;IACnB,UAAU,EAAEH,IAAI;IAChB,UAAU,EAAEG;EACd,CAAC,GACD;IACEE,MAAM,EAAE,QAAQ;IAChB,WAAW,EAAE,UAAU;IACvB,WAAW,EAAE,UAAU;IACvB,UAAU,EAAE;EACd,CAAC;;EAEH;EACA,MAAMT,cAAc,GAAG;IACrB,IAAGG,0BAA0B,GAC3BK,YAAY,GACZ,CAAC,CAAC;IACJ,GAAGP;EACL,CAAC;EAED;EACE;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EAAQ;IACFS,iBAAiB,GAAG,EAAE;IACtBC,UAAU;IACVC;EACF,CAAC,GAAGxB,OAAO,CAACyB,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;;EAE9B;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMC,oBAAoB,GAAGA,CAACC,KAAK,EAAEhD,YAAY,EAAEE,UAAU,EAAE+C,QAAQ,KAAK;IAC1E,IAAIC,wBAAwB,GAAG,KAAK;IACpC,IAAInD,cAAc,GAAG,KAAK;IAC1B,IAAIoD,QAAQ,GAAGnD,YAAY;IAE3B,MAAMoD,eAAe,GAAGlD,UAAU,KAAKmD,SAAS,IAAInD,UAAU,CAACL,IAAI,KAAK,kBAAkB,IAAIoD,QAAQ,KAAK,MAAM;IACjH,IAAIJ,6BAA6B,IAAIO,eAAe,EAAE;MACpD,MAAM9C,QAAQ,GAAG,8DACfJ,UAAU,EACTG,IAAI,EAAEC,QAAQ;MACjB,MAAMC,GAAG,GAAG,8DACVL,UAAU,EACTG,IAAI,EAAEE,GAAG;MAEZ,IAAID,QAAQ,KAAK,OAAO,EAAE;QACxB,MAAMgD,cAAc,GAAG/C,GAAG,GAAG,CAC3B,GAAG,EAAE,KAAK,CACX,GAAG,CACF,IAAI,CACL;QACDR,cAAc,GAAGuD,cAAc,CAACC,IAAI,CAAEC,YAAY,IAAK;UACrD,IAAIvB,cAAc,GAAGjC,YAAY,GAAGwD,YAAY,CAAC,KAAKH,SAAS,EAAE;YAC/DF,QAAQ,IAAIK,YAAY;YAExB,OAAO,IAAI;UACb;UAEA,OAAO,KAAK;QACd,CAAC,CAAC;MACJ;MAEA,IACE,CAACzD,cAAc,IAAIkD,QAAQ,IAC3B,8DACE/C,UAAU,CACVL,IAAI,KAAK,kBAAkB,EAC7B;QACA,MAAMyD,cAAc,GAAG/C,GAAG,GAAG,CAC3B,GAAG,EAAE,KAAK,CACX,GAAG,CACFD,QAAQ,KAAK,OAAO,GAAG,IAAI,GAAG,IAAI,CACnC;QAEDP,cAAc,GAAGuD,cAAc,CAACC,IAAI,CAAEC,YAAY,IAAK;UACrD,IAAIvB,cAAc,GAAGuB,YAAY,CAAC,KAAKH,SAAS,EAAE;YAChDF,QAAQ,GAAGK,YAAY;YAEvB,OAAO,IAAI;UACb;UAEA,OAAO,KAAK;QACd,CAAC,CAAC;MACJ;IACF;IAEA,MAAMC,eAAe,GAAGxB,cAAc,GAAGjC,YAAY,CAAC,KAAKqD,SAAS,IAClE,CAACX,MAAM,CAACgB,MAAM,CAACzB,cAAc,CAAC,CAAC0B,QAAQ,CAAC3D,YAAY,CAAC;IACvD,MAAM4D,wBAAwB,GAAGX,QAAQ,IAAIQ,eAAe,IAAIZ,6BAA6B;IAC7F9C,cAAc,GAAGA,cAAc,IAAI+B,OAAO,CAAC8B,wBAAwB,CAAC;IAEpEV,wBAAwB,GAAGnD,cAAc,IACvC0D,eAAe,IAAI,CAACR,QAAQ;IAE9B,OAAO,CACLC,wBAAwB,EAAEC,QAAQ,EAAEpD,cAAc,CACnD;EACH,CAAC;;EAED;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAM8D,gBAAgB,GAAGA,CAAC7D,YAAY,EAAEF,SAAS,EAAEI,UAAU,EAAE4D,YAAY,KAAK;IAC9E,IAAIC,gBAAgB,GAAGjE,SAAS;IAChC,KAAK,MAAMkE,gBAAgB,IAAIrE,iBAAiB,EAAE;MAChD,IACEqE,gBAAgB,KAAK,QAAQ;MAE3B;MACA;MACA,CAAC/B,cAAc,GAAGjC,YAAY,CAAC;MAC/B;MACA;MACA;MACA;MACA;AACV;AACA;MAEYE,UAAU,EACT+D,QAAQ,EAAEtD,MAAM;MACnB;AACV;AACA;MAEcT,UAAU,EACTgE,IAAI,EAAErE,IAAI,KAAK,eAAe;MACjC;AACZ;AACA;MACaK,UAAU,EAAGgE,IAAI,EAAEpD,KAAK,KAAK,QAAQ,CACvC,CACF,EACD;QACA;MACF;MAEA,IAAIkD,gBAAgB,KAAKhE,YAAY,IACnCgE,gBAAgB,CAACG,WAAW,CAAC,CAAC,KAAKnE,YAAY,CAACmE,WAAW,CAAC,CAAC;MAE7D;MACC,CAAClC,cAAc,IAAIA,cAAc,GAAG+B,gBAAgB,CAAC,KAAKX,SAAS,CAAC,EACrE;QACAU,gBAAgB,GAAGC,gBAAgB;QACnCF,YAAY,CAACM,IAAI,CAAC,CAChBpE,YAAY,EAAE+D,gBAAgB,CAC/B,CAAC;QACF;MACF;IACF;IAEA,OAAOA,gBAAgB;EACzB,CAAC;;EAED;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMM,eAAe,GAAGA,CAACxE,IAAI,EAAEiB,KAAK,EAAEwD,OAAO,EAAEC,SAAS,EAAEC,GAAG,EAAEvB,QAAQ,EAAEhD,IAAI,EAAEC,UAAU,EAAE4D,YAAY,KAAK;IAC1G,IAAI9D,YAAY,GAAGH,IAAI,KAAK,cAAc,GAAG,GAAG,GAAGiB,KAAK;IAExD,MAAM,CACJoC,wBAAwB,EACxBC,QAAQ,EACRpD,cAAc,CACf,GAAGgD,oBAAoB,CAAClD,IAAI,EAAEG,YAAY,EAAEE,UAAU,EAAE+C,QAAQ,CAAC;IAElE,IAAInD,SAAS;IACb,IAAI2E,KAAK;IACT,IAAIvB,wBAAwB,EAAE;MAC5B,MAAMwB,gBAAgB,GAAGzC,cAAc,CAACkB,QAAQ,CAAC;MACjDnD,YAAY,GAAGmD,QAAQ,KAAK,IAAI,GAAGA,QAAQ,GAAGnD,YAAY;MAE1D,IAAI,CAAC0E,gBAAgB,EAAE;QACrBZ,YAAY,CAACM,IAAI,CAAC,CAChBpE,YAAY,CACb,CAAC;MACJ,CAAC,MAAM,IAAI,OAAO0E,gBAAgB,KAAK,QAAQ,EAAE;QAC/C5E,SAAS,GAAG4E,gBAAgB;QAC5BZ,YAAY,CAACM,IAAI,CAAC,CAChBpE,YAAY,EAAEF,SAAS,CACxB,CAAC;MACJ,CAAC,MAAM,IAAI4E,gBAAgB,IAAI,OAAOA,gBAAgB,KAAK,QAAQ,EAAE;QACnE,MAAMC,QAAQ,GAAGD,gBAAgB,CAACE,gBAAgB,IAAIjD,yBAAyB,CAAC6C,GAAG,GAAG,CAAC,CAAC;QAExF,IAAI,CAACG,QAAQ,IAAI,CAACA,QAAQ,CAACE,IAAI,CAACC,UAAU,CAAC,GAAGP,SAAS,GAAG,CAAC,EAAE;UAC3DzE,SAAS,GAAG4E,gBAAgB,CAACnC,WAAW;UACxCuB,YAAY,CAACM,IAAI,CAAC,CAChBpE,YAAY,EACZF,SAAS,EACT4E,gBAAgB,CAACpC,OAAO,CACzB,CAAC;QACJ;MACF,CAAC,MAAM;QACLZ,KAAK,CAACqD,cAAc,CAClB,wFACF,CAAC;QAED;MACF;IACF,CAAC,MAAM,IAAIrC,MAAM,CAACsC,OAAO,CAAC7C,cAAc,CAAC,CAACoB,IAAI,CAAC,CAAC,CAC9C1B,GAAG,EACH;MACEhC,IAAI,EAAEoF;IACR,CAAC,CACF,KAAK;MACJR,KAAK,GAAGQ,IAAI;MAEZ,OAAOpD,GAAG,KAAKyC,OAAO,IACpBY,KAAK,CAACC,OAAO,CAACV,KAAK,CAAC,IACpB,CAACA,KAAK,CAACd,QAAQ,CAAC3D,YAAY,CAAC;IACjC,CAAC,CAAC,EAAE;MACF8D,YAAY,CAACM,IAAI,CAAC,CAChBpE,YAAY,EAAEyE,KAAK,CACpB,CAAC;IACJ,CAAC,MAAM,IAAI,CAAC7B,UAAU,IAAI/C,IAAI,KAAK,eAAe,EAAE;MAClDC,SAAS,GAAG+D,gBAAgB,CAAC7D,YAAY,EAAEF,SAAS,EAAEI,UAAU,EAAE4D,YAAY,CAAC;IACjF;;IAEA;IACA,IAAIhE,SAAS,EAAE;MACbF,WAAW,CAACC,IAAI,EAAEC,SAAS,EAAEC,cAAc,EAAEC,YAAY,EAAEC,IAAI,EAAEC,UAAU,CAAC;IAC9E;EACF,CAAC;EAED,KAAK,MAAM,CACTsE,GAAG,EACHY,QAAQ,CACT,IAAIzD,yBAAyB,CAACqD,OAAO,CAAC,CAAC,EAAE;IACxC;IACA,MAAMlB,YAAY,GAAG,EAAE;IACvB,IAAIuB,OAAO;IAEX,IAAI;MACFA,OAAO,GAAGrD,IAAI,KAAK,YAAY,GAAG,IAAAsD,sBAAQ,EAACF,QAAQ,CAACvF,IAAI,CAAC,GAAG,IAAA0F,mBAAK,EAACH,QAAQ,CAACvF,IAAI,EAAEmC,IAAI,CAAC;IACxF,CAAC,CAAC,MAAM;MACN;IACF;IAEA,MAAM;MACJ6C,IAAI,EAAEN,SAAS;MACf1C,GAAG,EAAEyC;IACP,CAAC,GAAGc,QAAQ;IAEZ,IAAAI,sBAAQ,EAACH,OAAO,EAAE,CAACpF,IAAI,EAAEC,UAAU,EAAE+C,QAAQ,KAAK;MAChD,MAAM;QACJpD,IAAI;QACJiB;MACF,CAAC;MACC;AACR;AACA;MAAab,IAAK;MACZ,IAAI,CAAC,CACH,cAAc,EAAE,eAAe,CAChC,CAAC0D,QAAQ,CAAC9D,IAAI,CAAC,EAAE;QAChB;MACF;MAEAwE,eAAe,CAACxE,IAAI,EAAEiB,KAAK,EAAEwD,OAAO,EAAEC,SAAS,EAAEC,GAAG,EAAEvB,QAAQ,EAAEhD,IAAI,EAAEC,UAAU,EAAE4D,YAAY,CAAC;IACjG,CAAC,CAAC;IAEF,IAAIA,YAAY,CAACnD,MAAM,EAAE;MACvB,MAAM8E,SAAS,GAAG,IAAAC,uBAAS,EAACL,OAAO,CAAC;;MAEpC;AACN;AACA;MACM,MAAMM,GAAG,GAAIC,KAAK,IAAK;QACrB,OAAOA,KAAK,CAACC,WAAW,CACtBvE,SAAS,EACTG,UAAU,CAACqE,OAAO,CAACxE,SAAS,CAAC,CAACP,OAAO,CACnC,IAAIqE,QAAQ,CAACvF,IAAI,GAAG,EACpB,IAAI4F,SAAS,GACf,CACF,CAAC;MACH,CAAC;MAED,KAAK,MAAM,CACTM,OAAO,EACPC,aAAa,GAAG,EAAE,EAClBC,GAAG,CACJ,IAAInC,YAAY,EAAE;QACjB,MAAMoC,QAAQ,GAAGd,QAAQ,CAACP,IAAI,GAAG,KAAKO,QAAQ,CAACP,IAAI,GAAG,GAAG,EAAE;QAC3D,IAAIlC,iBAAiB,CAACY,IAAI,CAAC,CAAC;UAC1B1B,GAAG;UACH4C;QACF,CAAC,KAAK;UACJ,OAAO5C,GAAG,KAAKyC,OAAO,KACnBG,KAAK,KAAK,IAAI,IAAIA,KAAK,CAACd,QAAQ,CAACyB,QAAQ,CAACvF,IAAI,CAAC,CAAC;QACrD,CAAC,CAAC,EAAE;UACF;QACF;QAEA0B,MAAM,CACJ0E,GAAG,IACD,kBAAkB3B,OAAO,GAAG4B,QAAQ,UAAUH,OAAO,GAAG,IACvDC,aAAa,GAAG,IAAI,GAAG,GAAG,CAAC,IAC3BA,aAAa,GAAG,WAAWG,IAAI,CAACT,SAAS,CAACM,aAAa,CAAC,GAAG,GAAG,EAAE,CAAC,EACpEA,aAAa,GAAGL,GAAG,GAAG,IAAI,EAC1BP,QAAQ,EACRa,GAAG,GAAG;UACJ3B,OAAO;UACP4B;QACF,CAAC,GAAG7C,SACN,CAAC;MACH;IACF;EACF;AACF,CAAC,EAAE;EACD+C,gBAAgB,EAAE,IAAI;EACtB/F,IAAI,EAAE;IACJgG,IAAI,EAAE;MACJC,WAAW,EAAE,wBAAwB;MACrCC,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVhE,iBAAiB,EAAE;UACjBiE,KAAK,EAAE;YACLF,oBAAoB,EAAE,KAAK;YAC3BC,UAAU,EAAE;cACV9E,GAAG,EAAE;gBACHhC,IAAI,EAAE;cACR,CAAC;cACD4E,KAAK,EAAE;gBACLoC,KAAK,EAAE,CACL;kBACEhH,IAAI,EAAE;gBACR,CAAC,EACD;kBACE+G,KAAK,EAAE;oBACL/G,IAAI,EAAE;kBACR,CAAC;kBACDA,IAAI,EAAE;gBACR,CAAC;cAEL;YACF,CAAC;YACDA,IAAI,EAAE;UACR,CAAC;UACDA,IAAI,EAAE;QACR,CAAC;QACD+C,UAAU,EAAE;UACV/C,IAAI,EAAE;QACR,CAAC;QACDgD,6BAA6B,EAAE;UAC7BhD,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAiH,MAAA,CAAA3F,OAAA,GAAAA,OAAA,CAAAzB,OAAA","ignoreList":[]}
|
|
1
|
+
{"version":3,"file":"checkTypes.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/checkTypes.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n parse,\n stringify,\n traverse,\n tryParse,\n} from '@es-joy/jsdoccomment';\n\nconst strictNativeTypes = [\n 'undefined',\n 'null',\n 'boolean',\n 'number',\n 'bigint',\n 'string',\n 'symbol',\n 'object',\n 'Array',\n 'Function',\n 'Date',\n 'RegExp',\n];\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\nexport default iterateJsdoc(({\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 } = settings;\n\n const injectObjectPreferredTypes = !('Object' in preferredTypesOriginal ||\n 'object' in preferredTypesOriginal ||\n 'object.<>' in preferredTypesOriginal ||\n 'Object.<>' in preferredTypesOriginal ||\n 'object<>' in preferredTypesOriginal);\n\n /**\n * @type {{\n * message: string,\n * replacement: false\n * }}\n */\n const info = {\n message: getMessage(),\n replacement: false,\n };\n\n /**\n * @type {{\n * message: string,\n * replacement: false\n * }}\n */\n const infoUC = {\n message: getMessage(true),\n replacement: false,\n };\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 typeName = typeNodeName;\n\n const isNameOfGeneric = parentNode !== undefined && parentNode.type === 'JsdocTypeGeneric' && property === 'left';\n if (unifyParentAndChildTypeChecks || isNameOfGeneric) {\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 if (preferredTypes?.[typeNodeName + checkPostFix] !== undefined) {\n typeName += 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 if (preferredTypes?.[checkPostFix] !== undefined) {\n typeName = checkPostFix;\n\n return true;\n }\n\n return false;\n });\n }\n }\n\n const directNameMatch = preferredTypes?.[typeNodeName] !== undefined &&\n !Object.values(preferredTypes).includes(typeNodeName);\n const unifiedSyntaxParentMatch = property && directNameMatch && unifyParentAndChildTypeChecks;\n isGenericMatch = isGenericMatch || Boolean(unifiedSyntaxParentMatch);\n\n hasMatchingPreferredType = isGenericMatch ||\n directNameMatch && !property;\n\n return [\n hasMatchingPreferredType, typeName, isGenericMatch,\n ];\n };\n\n /**\n * Iterates strict types to see if any should be added to `invalidTypes` (and\n * the the relevant strict type returned as the new preferred type).\n * @param {string} typeNodeName\n * @param {string|undefined} preferred\n * @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode\n * @param {(string|false|undefined)[][]} invalidTypes\n * @returns {string|undefined} The `preferred` type string, optionally changed\n */\n const checkNativeTypes = (typeNodeName, preferred, parentNode, invalidTypes) => {\n let changedPreferred = preferred;\n for (const strictNativeType of strictNativeTypes) {\n if (\n strictNativeType === 'object' &&\n (\n // This is not set to remap with exact type match (e.g.,\n // `object: 'Object'`), so can ignore (including if circular)\n !preferredTypes?.[typeNodeName] ||\n // Although present on `preferredTypes` for remapping, this is a\n // parent object without a parent match (and not\n // `unifyParentAndChildTypeChecks`) and we don't want\n // `object<>` given TypeScript issue https://github.com/microsoft/TypeScript/issues/20555\n /**\n * @type {import('jsdoc-type-pratt-parser').GenericResult}\n */\n (\n parentNode\n )?.elements?.length && (\n /**\n * @type {import('jsdoc-type-pratt-parser').GenericResult}\n */\n (\n parentNode\n )?.left?.type === 'JsdocTypeName' &&\n /**\n * @type {import('jsdoc-type-pratt-parser').GenericResult}\n */\n (parentNode)?.left?.value === 'Object'\n )\n )\n ) {\n continue;\n }\n\n if (strictNativeType !== typeNodeName &&\n strictNativeType.toLowerCase() === typeNodeName.toLowerCase() &&\n\n // Don't report if user has own map for a strict native type\n (!preferredTypes || preferredTypes?.[strictNativeType] === undefined)\n ) {\n changedPreferred = strictNativeType;\n invalidTypes.push([\n typeNodeName, changedPreferred,\n ]);\n break;\n }\n }\n\n return changedPreferred;\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 typeName,\n isGenericMatch,\n ] = getPreferredTypeInfo(type, typeNodeName, parentNode, property);\n\n let preferred;\n let types;\n if (hasMatchingPreferredType) {\n const preferredSetting = preferredTypes[typeName];\n typeNodeName = typeName === '[]' ? typeName : 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 (!noDefaults && type === 'JsdocTypeName') {\n preferred = checkNativeTypes(typeNodeName, preferred, parentNode, invalidTypes);\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 iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Reports invalid types.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-types.md#repos-sticky-header',\n },\n fixable: 'code',\n schema: [\n {\n additionalProperties: false,\n properties: {\n exemptTagContexts: {\n items: {\n additionalProperties: false,\n properties: {\n tag: {\n type: 'string',\n },\n types: {\n oneOf: [\n {\n type: 'boolean',\n },\n {\n items: {\n type: 'string',\n },\n type: 'array',\n },\n ],\n },\n },\n type: 'object',\n },\n type: 'array',\n },\n noDefaults: {\n type: 'boolean',\n },\n unifyParentAndChildTypeChecks: {\n type: 'boolean',\n },\n },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n});\n"],"mappings":";;;;;AAQA,MAAM,oBAAoB;CACxB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD;;;;;;;;;;;;AAaD,MAAM,cAAc,CAAC,MAAM,WAAW,gBAAgB,cAAc,MAAM,eAAe;CACvF,IAAI,MAAM;AACV,KAAI,gBAAgB;EAClB,MAAM,aACJ,WACA;AACF,MAAI,cAAc,MAAM;GACtB,WAAW,WAAW;GACtB,WAAW,MAAM;GACjB,MAAM;EACP,OAAM;GACL,MAAM,gBAAgB,UAAU,MAAM,cAAc;AACpD,OAAI,eAAe;IACjB,WAAW,WAAW;IACtB,WAAW,MAAM;IACjB,MAAM,UAAU,MAAM,GAAG,CAAC,cAAc,GAAG,OAAO;GACnD,OAAM;IACL,MAAM,aAAa,UAAU,SAAS,KAAK;AAC3C,QAAI,YAAY;KACd,WAAW,WAAW;KACtB,WAAW,MAAM;KACjB,MAAM,UAAU,MAAM,GAAG,GAAG;IAC7B,WACC,YAAY,aAAa,aACxB,iBAAiB,QAAQ,iBAAiB,UAC3C;KACA,WAAW,WAAW;KACtB,WAAW,MAAM;IAClB;GACF;EACF;CACF,WAAU,SAAS,gBAClB,KAAK,OAAO;6DAIZ,KACA,QAAQ,IAAI,QAAQ,yBAAyB,GAAG;AAGlD,KAAI,CAAC;6DAED,KACA,QAAQ;AAEb;;;;;AAMD,MAAM,aAAa,CAAC,cAAc;AAChC,QAAO,2DACA,YAAY,MAAM,OAAO;AACjC;AAED,yBAAeA,6BAAa,CAAC,EAC3B,SACA,WACA,QACA,UACA,YACA,OACD,KAAK;CACJ,MAAM,4BAA4B,MAAM,WAAW,CAAC,QAAQ;AAC1D,SAAO,QAAQ,MAAM,yBAAyB,IAAI,IAAI,CAAC;CACxD,EAAC;CAEF,MAQE,EACE,MACA,gBAAgB,wBAChB,gBACD,GAAG;CAEN,MAAM,6BAA6B,EAAE,YAAY,0BAC/C,YAAY,0BACZ,eAAe,0BACf,eAAe,0BACf,cAAc;;;;;;;CAQhB,MAAM,OAAO;EACX,SAAS,YAAY;EACrB,aAAa;CACd;;;;;;;CAQD,MAAM,SAAS;EACb,SAAS,WAAW,KAAK;EACzB,aAAa;CACd;;CAGD,MAAM,eAAe,SAAS,eAC5B;EACE,QAAQ;EACR,aAAa;EACb,aAAa;EACb,YAAY;EACZ,YAAY;CACb,IACD;EACE,QAAQ;EACR,aAAa;EACb,aAAa;EACb,YAAY;CACb;;CAGH,MAAM,iBAAiB;EACrB,GAAG,6BACD,eACA,CAAE;EACJ,GAAG;CACJ;CAED,MAUM,EACF,oBAAoB,CAAE,GACtB,YACA,+BACD,GAAG,QAAQ,QAAQ,MAAM,CAAE;;;;;;;;;;CAW9B,MAAM,uBAAuB,CAAC,OAAO,cAAc,YAAY,aAAa;EAC1E,IAAI,2BAA2B;EAC/B,IAAI,iBAAiB;EACrB,IAAI,WAAW;EAEf,MAAM,kBAAkB,eAAe,UAAa,WAAW,SAAS,sBAAsB,aAAa;AAC3G,MAAI,iCAAiC,iBAAiB;GACpD,MAAM,WACJ,YACC,MAAM;GACT,MAAM,MACJ,YACC,MAAM;AAET,OAAI,aAAa,SAAS;IACxB,MAAM,iBAAiB,MAAM,CAC3B,KAAK,KACN,IAAG,CACF,IACD;IACD,iBAAiB,eAAe,KAAK,CAAC,iBAAiB;AACrD,SAAI,iBAAiB,eAAe,kBAAkB,QAAW;MAC/D,YAAY;AAEZ,aAAO;KACR;AAED,YAAO;IACR,EAAC;GACH;AAED,OACE,CAAC,kBAAkB,YAEjB,WACA,SAAS,oBACX;IACA,MAAM,iBAAiB,MAAM,CAC3B,KAAK,KACN,IAAG,CACF,aAAa,UAAU,OAAO,IAC/B;IAED,iBAAiB,eAAe,KAAK,CAAC,iBAAiB;AACrD,SAAI,iBAAiB,kBAAkB,QAAW;MAChD,WAAW;AAEX,aAAO;KACR;AAED,YAAO;IACR,EAAC;GACH;EACF;EAED,MAAM,kBAAkB,iBAAiB,kBAAkB,UACzD,CAAC,OAAO,OAAO,eAAe,CAAC,SAAS,aAAa;EACvD,MAAM,2BAA2B,YAAY,mBAAmB;EAChE,iBAAiB,kBAAkB,QAAQ,yBAAyB;EAEpE,2BAA2B,kBACzB,mBAAmB,CAAC;AAEtB,SAAO;GACL;GAA0B;GAAU;EACrC;CACF;;;;;;;;;;CAWD,MAAM,mBAAmB,CAAC,cAAc,WAAW,YAAY,iBAAiB;EAC9E,IAAI,mBAAmB;AACvB,OAAK,MAAM,oBAAoB,mBAAmB;AAChD,OACE,qBAAqB,aAInB,CAAC,iBAAiB,iBAShB,YACC,UAAU,UAKT,YACC,MAAM,SAAS,mBAIjB,YAAa,MAAM,UAAU,UAIlC;AAGF,OAAI,qBAAqB,gBACvB,iBAAiB,aAAa,KAAK,aAAa,aAAa,KAG5D,CAAC,kBAAkB,iBAAiB,sBAAsB,SAC3D;IACA,mBAAmB;IACnB,aAAa,KAAK,CAChB,cAAc,gBACf,EAAC;AACF;GACD;EACF;AAED,SAAO;CACR;;;;;;;;;;;;;;CAeD,MAAM,kBAAkB,CAAC,MAAM,OAAO,SAAS,WAAW,KAAK,UAAU,MAAM,YAAY,iBAAiB;EAC1G,IAAI,eAAe,SAAS,iBAAiB,MAAM;EAEnD,MAAM,CACJ,0BACA,UACA,eACD,GAAG,qBAAqB,MAAM,cAAc,YAAY,SAAS;EAElE,IAAI;EACJ,IAAI;AACJ,MAAI,0BAA0B;GAC5B,MAAM,mBAAmB,eAAe;GACxC,eAAe,aAAa,OAAO,WAAW;AAE9C,OAAI,CAAC,kBACH,aAAa,KAAK,CAChB,YACD,EAAC;YACO,OAAO,qBAAqB,UAAU;IAC/C,YAAY;IACZ,aAAa,KAAK,CAChB,cAAc,SACf,EAAC;GACH,WAAU,oBAAoB,OAAO,qBAAqB,UAAU;IACnE,MAAM,WAAW,iBAAiB,oBAAoB,0BAA0B,MAAM;AAEtF,QAAI,CAAC,YAAY,CAAC,SAAS,KAAK,WAAW,GAAG,UAAU,CAAC,CAAC,CAAC,EAAE;KAC3D,YAAY,iBAAiB;KAC7B,aAAa,KAAK;MAChB;MACA;MACA,iBAAiB;KAClB,EAAC;IACH;GACF,OAAM;IACL,MAAM,eACJ,yFACD;AAED;GACD;EACF,WAAU,OAAO,QAAQ,eAAe,CAAC,KAAK,CAAC,CAC9C,KACA,EACE,MAAM,MACP,CACF,KAAK;GACJ,QAAQ;AAER,UAAO,QAAQ,WACb,MAAM,QAAQ,MAAM,IACpB,CAAC,MAAM,SAAS,aAAa;EAChC,EAAC,EACA,aAAa,KAAK,CAChB,cAAc,KACf,EAAC;WACO,CAAC,cAAc,SAAS,iBACjC,YAAY,iBAAiB,cAAc,WAAW,YAAY,aAAa;AAIjF,MAAI,WACF,YAAY,MAAM,WAAW,gBAAgB,cAAc,MAAM,WAAW;CAE/E;AAED,MAAK,MAAM,CACT,KACA,SACD,IAAI,0BAA0B,SAAS,EAAE;;EAExC,MAAM,eAAe,CAAE;EACvB,IAAI;AAEJ,MAAI;GACF,UAAU,SAAS,mDAAwB,SAAS,KAAK,oCAAS,SAAS,MAAM,KAAK;EACvF,QAAO;AACN;EACD;EAED,MAAM,EACJ,MAAM,WACN,KAAK,SACN,GAAG;sCAEK,SAAS,CAAC,MAAM,YAAY,aAAa;GAChD,MAAM,EACJ,MACA,OACD,GAGM;AACP,OAAI,CAAC,CACH,gBAAgB,eACjB,EAAC,SAAS,KAAK,CACd;GAGF,gBAAgB,MAAM,OAAO,SAAS,WAAW,KAAK,UAAU,MAAM,YAAY,aAAa;EAChG,EAAC;AAEF,MAAI,aAAa,QAAQ;GACvB,MAAM,iDAAsB,QAAQ;;;;GAKpC,MAAM,MAAM,CAAC,UAAU;AACrB,WAAO,MAAM,YACX,WACA,WAAW,QAAQ,UAAU,CAAC,QAC5B,CAAC,CAAC,EAAE,SAAS,KAAK,CAAC,CAAC,EACpB,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CACjB,CACF;GACF;AAED,QAAK,MAAM,CACT,SACA,gBAAgB,IAChB,IACD,IAAI,cAAc;IACjB,MAAM,WAAW,SAAS,OAAO,CAAC,EAAE,EAAE,SAAS,KAAK,CAAC,CAAC,GAAG;AACzD,QAAI,kBAAkB,KAAK,CAAC,EAC1B,KACA,OACD,KAAK;AACJ,YAAO,QAAQ,YACZ,UAAU,QAAQ,MAAM,SAAS,SAAS,KAAK;IACnD,EAAC,CACA;IAGF,OACE,OACE,CAAC,eAAe,EAAE,UAAU,SAAS,OAAO,EAAE,QAAQ,CAAC,CAAC,IACvD,gBAAgB,OAAO,QACvB,gBAAgB,CAAC,QAAQ,EAAE,KAAK,UAAU,cAAc,CAAC,CAAC,CAAC,GAAG,KACjE,gBAAgB,MAAM,MACtB,UACA,MAAM;KACJ;KACA;IACD,IAAG,OACL;GACF;EACF;CACF;AACF,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,mBAAmB;KACjB,OAAO;MACL,sBAAsB;MACtB,YAAY;OACV,KAAK,EACH,MAAM,SACP;OACD,OAAO,EACL,OAAO,CACL,EACE,MAAM,UACP,GACD;QACE,OAAO,EACL,MAAM,SACP;QACD,MAAM;OACP,CACF,EACF;MACF;MACD,MAAM;KACP;KACD,MAAM;IACP;IACD,YAAY,EACV,MAAM,UACP;IACD,+BAA+B,EAC7B,MAAM,UACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}
|
|
@@ -0,0 +1,299 @@
|
|
|
1
|
+
import iterateJsdoc from "../iterateJsdoc.js";
|
|
2
|
+
import { parse, stringify, traverse, tryParse } from "@es-joy/jsdoccomment";
|
|
3
|
+
|
|
4
|
+
//#region src/rules/checkTypes.js
|
|
5
|
+
const strictNativeTypes = [
|
|
6
|
+
"undefined",
|
|
7
|
+
"null",
|
|
8
|
+
"boolean",
|
|
9
|
+
"number",
|
|
10
|
+
"bigint",
|
|
11
|
+
"string",
|
|
12
|
+
"symbol",
|
|
13
|
+
"object",
|
|
14
|
+
"Array",
|
|
15
|
+
"Function",
|
|
16
|
+
"Date",
|
|
17
|
+
"RegExp"
|
|
18
|
+
];
|
|
19
|
+
/**
|
|
20
|
+
* Adjusts the parent type node `meta` for generic matches (or type node
|
|
21
|
+
* `type` for `JsdocTypeAny`) and sets the type node `value`.
|
|
22
|
+
* @param {string} type The actual type
|
|
23
|
+
* @param {string} preferred The preferred type
|
|
24
|
+
* @param {boolean} isGenericMatch
|
|
25
|
+
* @param {string} typeNodeName
|
|
26
|
+
* @param {import('jsdoc-type-pratt-parser').NonRootResult} node
|
|
27
|
+
* @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode
|
|
28
|
+
* @returns {void}
|
|
29
|
+
*/
|
|
30
|
+
const adjustNames = (type, preferred, isGenericMatch, typeNodeName, node, parentNode) => {
|
|
31
|
+
let ret = preferred;
|
|
32
|
+
if (isGenericMatch) {
|
|
33
|
+
const parentMeta = parentNode.meta;
|
|
34
|
+
if (preferred === "[]") {
|
|
35
|
+
parentMeta.brackets = "square";
|
|
36
|
+
parentMeta.dot = false;
|
|
37
|
+
ret = "Array";
|
|
38
|
+
} else {
|
|
39
|
+
const dotBracketEnd = preferred.match(/\.(?:<>)?$/v);
|
|
40
|
+
if (dotBracketEnd) {
|
|
41
|
+
parentMeta.brackets = "angle";
|
|
42
|
+
parentMeta.dot = true;
|
|
43
|
+
ret = preferred.slice(0, -dotBracketEnd[0].length);
|
|
44
|
+
} else {
|
|
45
|
+
const bracketEnd = preferred.endsWith("<>");
|
|
46
|
+
if (bracketEnd) {
|
|
47
|
+
parentMeta.brackets = "angle";
|
|
48
|
+
parentMeta.dot = false;
|
|
49
|
+
ret = preferred.slice(0, -2);
|
|
50
|
+
} else if (parentMeta?.brackets === "square" && (typeNodeName === "[]" || typeNodeName === "Array")) {
|
|
51
|
+
parentMeta.brackets = "angle";
|
|
52
|
+
parentMeta.dot = false;
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
} else if (type === "JsdocTypeAny") node.type = "JsdocTypeName";
|
|
57
|
+
/** @type {import('jsdoc-type-pratt-parser').NameResult} */ node.value = ret.replace(/(?:\.|<>|\.<>|\[\])$/v, "");
|
|
58
|
+
if (!ret)
|
|
59
|
+
/** @type {import('jsdoc-type-pratt-parser').NameResult} */ node.value = typeNodeName;
|
|
60
|
+
};
|
|
61
|
+
/**
|
|
62
|
+
* @param {boolean} [upperCase]
|
|
63
|
+
* @returns {string}
|
|
64
|
+
*/
|
|
65
|
+
const getMessage = (upperCase) => {
|
|
66
|
+
return "Use object shorthand or index signatures instead of `" + (upperCase ? "O" : "o") + "bject`, e.g., `{[key: string]: string}`";
|
|
67
|
+
};
|
|
68
|
+
var checkTypes_default = iterateJsdoc(({ context, jsdocNode, report, settings, sourceCode, utils }) => {
|
|
69
|
+
const jsdocTagsWithPossibleType = utils.filterTags((tag) => {
|
|
70
|
+
return Boolean(utils.tagMightHaveTypePosition(tag.tag));
|
|
71
|
+
});
|
|
72
|
+
const { mode, preferredTypes: preferredTypesOriginal, structuredTags } = settings;
|
|
73
|
+
const injectObjectPreferredTypes = !("Object" in preferredTypesOriginal || "object" in preferredTypesOriginal || "object.<>" in preferredTypesOriginal || "Object.<>" in preferredTypesOriginal || "object<>" in preferredTypesOriginal);
|
|
74
|
+
/**
|
|
75
|
+
* @type {{
|
|
76
|
+
* message: string,
|
|
77
|
+
* replacement: false
|
|
78
|
+
* }}
|
|
79
|
+
*/
|
|
80
|
+
const info = {
|
|
81
|
+
message: getMessage(),
|
|
82
|
+
replacement: false
|
|
83
|
+
};
|
|
84
|
+
/**
|
|
85
|
+
* @type {{
|
|
86
|
+
* message: string,
|
|
87
|
+
* replacement: false
|
|
88
|
+
* }}
|
|
89
|
+
*/
|
|
90
|
+
const infoUC = {
|
|
91
|
+
message: getMessage(true),
|
|
92
|
+
replacement: false
|
|
93
|
+
};
|
|
94
|
+
/** @type {import('../iterateJsdoc.js').PreferredTypes} */
|
|
95
|
+
const typeToInject = mode === "typescript" ? {
|
|
96
|
+
Object: "object",
|
|
97
|
+
"object.<>": info,
|
|
98
|
+
"Object.<>": infoUC,
|
|
99
|
+
"object<>": info,
|
|
100
|
+
"Object<>": infoUC
|
|
101
|
+
} : {
|
|
102
|
+
Object: "object",
|
|
103
|
+
"object.<>": "Object<>",
|
|
104
|
+
"Object.<>": "Object<>",
|
|
105
|
+
"object<>": "Object<>"
|
|
106
|
+
};
|
|
107
|
+
/** @type {import('../iterateJsdoc.js').PreferredTypes} */
|
|
108
|
+
const preferredTypes = {
|
|
109
|
+
...injectObjectPreferredTypes ? typeToInject : {},
|
|
110
|
+
...preferredTypesOriginal
|
|
111
|
+
};
|
|
112
|
+
const { exemptTagContexts = [], noDefaults, unifyParentAndChildTypeChecks } = context.options[0] || {};
|
|
113
|
+
/**
|
|
114
|
+
* Gets information about the preferred type: whether there is a matching
|
|
115
|
+
* preferred type, what the type is, and whether it is a match to a generic.
|
|
116
|
+
* @param {string} _type Not currently in use
|
|
117
|
+
* @param {string} typeNodeName
|
|
118
|
+
* @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode
|
|
119
|
+
* @param {string|undefined} property
|
|
120
|
+
* @returns {[hasMatchingPreferredType: boolean, typeName: string, isGenericMatch: boolean]}
|
|
121
|
+
*/
|
|
122
|
+
const getPreferredTypeInfo = (_type, typeNodeName, parentNode, property) => {
|
|
123
|
+
let hasMatchingPreferredType = false;
|
|
124
|
+
let isGenericMatch = false;
|
|
125
|
+
let typeName = typeNodeName;
|
|
126
|
+
const isNameOfGeneric = parentNode !== void 0 && parentNode.type === "JsdocTypeGeneric" && property === "left";
|
|
127
|
+
if (unifyParentAndChildTypeChecks || isNameOfGeneric) {
|
|
128
|
+
const brackets = parentNode?.meta?.brackets;
|
|
129
|
+
const dot = parentNode?.meta?.dot;
|
|
130
|
+
if (brackets === "angle") {
|
|
131
|
+
const checkPostFixes = dot ? [".", ".<>"] : ["<>"];
|
|
132
|
+
isGenericMatch = checkPostFixes.some((checkPostFix) => {
|
|
133
|
+
if (preferredTypes?.[typeNodeName + checkPostFix] !== void 0) {
|
|
134
|
+
typeName += checkPostFix;
|
|
135
|
+
return true;
|
|
136
|
+
}
|
|
137
|
+
return false;
|
|
138
|
+
});
|
|
139
|
+
}
|
|
140
|
+
if (!isGenericMatch && property && parentNode.type === "JsdocTypeGeneric") {
|
|
141
|
+
const checkPostFixes = dot ? [".", ".<>"] : [brackets === "angle" ? "<>" : "[]"];
|
|
142
|
+
isGenericMatch = checkPostFixes.some((checkPostFix) => {
|
|
143
|
+
if (preferredTypes?.[checkPostFix] !== void 0) {
|
|
144
|
+
typeName = checkPostFix;
|
|
145
|
+
return true;
|
|
146
|
+
}
|
|
147
|
+
return false;
|
|
148
|
+
});
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
const directNameMatch = preferredTypes?.[typeNodeName] !== void 0 && !Object.values(preferredTypes).includes(typeNodeName);
|
|
152
|
+
const unifiedSyntaxParentMatch = property && directNameMatch && unifyParentAndChildTypeChecks;
|
|
153
|
+
isGenericMatch = isGenericMatch || Boolean(unifiedSyntaxParentMatch);
|
|
154
|
+
hasMatchingPreferredType = isGenericMatch || directNameMatch && !property;
|
|
155
|
+
return [
|
|
156
|
+
hasMatchingPreferredType,
|
|
157
|
+
typeName,
|
|
158
|
+
isGenericMatch
|
|
159
|
+
];
|
|
160
|
+
};
|
|
161
|
+
/**
|
|
162
|
+
* Iterates strict types to see if any should be added to `invalidTypes` (and
|
|
163
|
+
* the the relevant strict type returned as the new preferred type).
|
|
164
|
+
* @param {string} typeNodeName
|
|
165
|
+
* @param {string|undefined} preferred
|
|
166
|
+
* @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode
|
|
167
|
+
* @param {(string|false|undefined)[][]} invalidTypes
|
|
168
|
+
* @returns {string|undefined} The `preferred` type string, optionally changed
|
|
169
|
+
*/
|
|
170
|
+
const checkNativeTypes = (typeNodeName, preferred, parentNode, invalidTypes) => {
|
|
171
|
+
let changedPreferred = preferred;
|
|
172
|
+
for (const strictNativeType of strictNativeTypes) {
|
|
173
|
+
if (strictNativeType === "object" && (!preferredTypes?.[typeNodeName] || parentNode?.elements?.length && parentNode?.left?.type === "JsdocTypeName" && parentNode?.left?.value === "Object")) continue;
|
|
174
|
+
if (strictNativeType !== typeNodeName && strictNativeType.toLowerCase() === typeNodeName.toLowerCase() && (!preferredTypes || preferredTypes?.[strictNativeType] === void 0)) {
|
|
175
|
+
changedPreferred = strictNativeType;
|
|
176
|
+
invalidTypes.push([typeNodeName, changedPreferred]);
|
|
177
|
+
break;
|
|
178
|
+
}
|
|
179
|
+
}
|
|
180
|
+
return changedPreferred;
|
|
181
|
+
};
|
|
182
|
+
/**
|
|
183
|
+
* Collect invalid type info.
|
|
184
|
+
* @param {string} type
|
|
185
|
+
* @param {string} value
|
|
186
|
+
* @param {string} tagName
|
|
187
|
+
* @param {string} nameInTag
|
|
188
|
+
* @param {number} idx
|
|
189
|
+
* @param {string|undefined} property
|
|
190
|
+
* @param {import('jsdoc-type-pratt-parser').NonRootResult} node
|
|
191
|
+
* @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode
|
|
192
|
+
* @param {(string|false|undefined)[][]} invalidTypes
|
|
193
|
+
* @returns {void}
|
|
194
|
+
*/
|
|
195
|
+
const getInvalidTypes = (type, value, tagName, nameInTag, idx, property, node, parentNode, invalidTypes) => {
|
|
196
|
+
let typeNodeName = type === "JsdocTypeAny" ? "*" : value;
|
|
197
|
+
const [hasMatchingPreferredType, typeName, isGenericMatch] = getPreferredTypeInfo(type, typeNodeName, parentNode, property);
|
|
198
|
+
let preferred;
|
|
199
|
+
let types;
|
|
200
|
+
if (hasMatchingPreferredType) {
|
|
201
|
+
const preferredSetting = preferredTypes[typeName];
|
|
202
|
+
typeNodeName = typeName === "[]" ? typeName : typeNodeName;
|
|
203
|
+
if (!preferredSetting) invalidTypes.push([typeNodeName]);
|
|
204
|
+
else if (typeof preferredSetting === "string") {
|
|
205
|
+
preferred = preferredSetting;
|
|
206
|
+
invalidTypes.push([typeNodeName, preferred]);
|
|
207
|
+
} else if (preferredSetting && typeof preferredSetting === "object") {
|
|
208
|
+
const nextItem = preferredSetting.skipRootChecking && jsdocTagsWithPossibleType[idx + 1];
|
|
209
|
+
if (!nextItem || !nextItem.name.startsWith(`${nameInTag}.`)) {
|
|
210
|
+
preferred = preferredSetting.replacement;
|
|
211
|
+
invalidTypes.push([
|
|
212
|
+
typeNodeName,
|
|
213
|
+
preferred,
|
|
214
|
+
preferredSetting.message
|
|
215
|
+
]);
|
|
216
|
+
}
|
|
217
|
+
} else {
|
|
218
|
+
utils.reportSettings("Invalid `settings.jsdoc.preferredTypes`. Values must be falsy, a string, or an object.");
|
|
219
|
+
return;
|
|
220
|
+
}
|
|
221
|
+
} else if (Object.entries(structuredTags).some(([tag, { type: typs }]) => {
|
|
222
|
+
types = typs;
|
|
223
|
+
return tag === tagName && Array.isArray(types) && !types.includes(typeNodeName);
|
|
224
|
+
})) invalidTypes.push([typeNodeName, types]);
|
|
225
|
+
else if (!noDefaults && type === "JsdocTypeName") preferred = checkNativeTypes(typeNodeName, preferred, parentNode, invalidTypes);
|
|
226
|
+
if (preferred) adjustNames(type, preferred, isGenericMatch, typeNodeName, node, parentNode);
|
|
227
|
+
};
|
|
228
|
+
for (const [idx, jsdocTag] of jsdocTagsWithPossibleType.entries()) {
|
|
229
|
+
/** @type {(string|false|undefined)[][]} */
|
|
230
|
+
const invalidTypes = [];
|
|
231
|
+
let typeAst;
|
|
232
|
+
try {
|
|
233
|
+
typeAst = mode === "permissive" ? tryParse(jsdocTag.type) : parse(jsdocTag.type, mode);
|
|
234
|
+
} catch {
|
|
235
|
+
continue;
|
|
236
|
+
}
|
|
237
|
+
const { name: nameInTag, tag: tagName } = jsdocTag;
|
|
238
|
+
traverse(typeAst, (node, parentNode, property) => {
|
|
239
|
+
const { type, value } = node;
|
|
240
|
+
if (!["JsdocTypeAny", "JsdocTypeName"].includes(type)) return;
|
|
241
|
+
getInvalidTypes(type, value, tagName, nameInTag, idx, property, node, parentNode, invalidTypes);
|
|
242
|
+
});
|
|
243
|
+
if (invalidTypes.length) {
|
|
244
|
+
const fixedType = stringify(typeAst);
|
|
245
|
+
/**
|
|
246
|
+
* @type {import('eslint').Rule.ReportFixer}
|
|
247
|
+
*/
|
|
248
|
+
const fix = (fixer) => {
|
|
249
|
+
return fixer.replaceText(jsdocNode, sourceCode.getText(jsdocNode).replace(`{${jsdocTag.type}}`, `{${fixedType}}`));
|
|
250
|
+
};
|
|
251
|
+
for (const [badType, preferredType = "", msg] of invalidTypes) {
|
|
252
|
+
const tagValue = jsdocTag.name ? ` "${jsdocTag.name}"` : "";
|
|
253
|
+
if (exemptTagContexts.some(({ tag, types }) => {
|
|
254
|
+
return tag === tagName && (types === true || types.includes(jsdocTag.type));
|
|
255
|
+
})) continue;
|
|
256
|
+
report(msg || `Invalid JSDoc @${tagName}${tagValue} type "${badType}"` + (preferredType ? "; " : ".") + (preferredType ? `prefer: ${JSON.stringify(preferredType)}.` : ""), preferredType ? fix : null, jsdocTag, msg ? {
|
|
257
|
+
tagName,
|
|
258
|
+
tagValue
|
|
259
|
+
} : void 0);
|
|
260
|
+
}
|
|
261
|
+
}
|
|
262
|
+
}
|
|
263
|
+
}, {
|
|
264
|
+
iterateAllJsdocs: true,
|
|
265
|
+
meta: {
|
|
266
|
+
docs: {
|
|
267
|
+
description: "Reports invalid types.",
|
|
268
|
+
url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-types.md#repos-sticky-header"
|
|
269
|
+
},
|
|
270
|
+
fixable: "code",
|
|
271
|
+
schema: [{
|
|
272
|
+
additionalProperties: false,
|
|
273
|
+
properties: {
|
|
274
|
+
exemptTagContexts: {
|
|
275
|
+
items: {
|
|
276
|
+
additionalProperties: false,
|
|
277
|
+
properties: {
|
|
278
|
+
tag: { type: "string" },
|
|
279
|
+
types: { oneOf: [{ type: "boolean" }, {
|
|
280
|
+
items: { type: "string" },
|
|
281
|
+
type: "array"
|
|
282
|
+
}] }
|
|
283
|
+
},
|
|
284
|
+
type: "object"
|
|
285
|
+
},
|
|
286
|
+
type: "array"
|
|
287
|
+
},
|
|
288
|
+
noDefaults: { type: "boolean" },
|
|
289
|
+
unifyParentAndChildTypeChecks: { type: "boolean" }
|
|
290
|
+
},
|
|
291
|
+
type: "object"
|
|
292
|
+
}],
|
|
293
|
+
type: "suggestion"
|
|
294
|
+
}
|
|
295
|
+
});
|
|
296
|
+
|
|
297
|
+
//#endregion
|
|
298
|
+
export { checkTypes_default as default };
|
|
299
|
+
//# sourceMappingURL=checkTypes.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"checkTypes.js","names":[],"sources":["../../src/rules/checkTypes.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n parse,\n stringify,\n traverse,\n tryParse,\n} from '@es-joy/jsdoccomment';\n\nconst strictNativeTypes = [\n 'undefined',\n 'null',\n 'boolean',\n 'number',\n 'bigint',\n 'string',\n 'symbol',\n 'object',\n 'Array',\n 'Function',\n 'Date',\n 'RegExp',\n];\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\nexport default iterateJsdoc(({\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 } = settings;\n\n const injectObjectPreferredTypes = !('Object' in preferredTypesOriginal ||\n 'object' in preferredTypesOriginal ||\n 'object.<>' in preferredTypesOriginal ||\n 'Object.<>' in preferredTypesOriginal ||\n 'object<>' in preferredTypesOriginal);\n\n /**\n * @type {{\n * message: string,\n * replacement: false\n * }}\n */\n const info = {\n message: getMessage(),\n replacement: false,\n };\n\n /**\n * @type {{\n * message: string,\n * replacement: false\n * }}\n */\n const infoUC = {\n message: getMessage(true),\n replacement: false,\n };\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 typeName = typeNodeName;\n\n const isNameOfGeneric = parentNode !== undefined && parentNode.type === 'JsdocTypeGeneric' && property === 'left';\n if (unifyParentAndChildTypeChecks || isNameOfGeneric) {\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 if (preferredTypes?.[typeNodeName + checkPostFix] !== undefined) {\n typeName += 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 if (preferredTypes?.[checkPostFix] !== undefined) {\n typeName = checkPostFix;\n\n return true;\n }\n\n return false;\n });\n }\n }\n\n const directNameMatch = preferredTypes?.[typeNodeName] !== undefined &&\n !Object.values(preferredTypes).includes(typeNodeName);\n const unifiedSyntaxParentMatch = property && directNameMatch && unifyParentAndChildTypeChecks;\n isGenericMatch = isGenericMatch || Boolean(unifiedSyntaxParentMatch);\n\n hasMatchingPreferredType = isGenericMatch ||\n directNameMatch && !property;\n\n return [\n hasMatchingPreferredType, typeName, isGenericMatch,\n ];\n };\n\n /**\n * Iterates strict types to see if any should be added to `invalidTypes` (and\n * the the relevant strict type returned as the new preferred type).\n * @param {string} typeNodeName\n * @param {string|undefined} preferred\n * @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode\n * @param {(string|false|undefined)[][]} invalidTypes\n * @returns {string|undefined} The `preferred` type string, optionally changed\n */\n const checkNativeTypes = (typeNodeName, preferred, parentNode, invalidTypes) => {\n let changedPreferred = preferred;\n for (const strictNativeType of strictNativeTypes) {\n if (\n strictNativeType === 'object' &&\n (\n // This is not set to remap with exact type match (e.g.,\n // `object: 'Object'`), so can ignore (including if circular)\n !preferredTypes?.[typeNodeName] ||\n // Although present on `preferredTypes` for remapping, this is a\n // parent object without a parent match (and not\n // `unifyParentAndChildTypeChecks`) and we don't want\n // `object<>` given TypeScript issue https://github.com/microsoft/TypeScript/issues/20555\n /**\n * @type {import('jsdoc-type-pratt-parser').GenericResult}\n */\n (\n parentNode\n )?.elements?.length && (\n /**\n * @type {import('jsdoc-type-pratt-parser').GenericResult}\n */\n (\n parentNode\n )?.left?.type === 'JsdocTypeName' &&\n /**\n * @type {import('jsdoc-type-pratt-parser').GenericResult}\n */\n (parentNode)?.left?.value === 'Object'\n )\n )\n ) {\n continue;\n }\n\n if (strictNativeType !== typeNodeName &&\n strictNativeType.toLowerCase() === typeNodeName.toLowerCase() &&\n\n // Don't report if user has own map for a strict native type\n (!preferredTypes || preferredTypes?.[strictNativeType] === undefined)\n ) {\n changedPreferred = strictNativeType;\n invalidTypes.push([\n typeNodeName, changedPreferred,\n ]);\n break;\n }\n }\n\n return changedPreferred;\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 typeName,\n isGenericMatch,\n ] = getPreferredTypeInfo(type, typeNodeName, parentNode, property);\n\n let preferred;\n let types;\n if (hasMatchingPreferredType) {\n const preferredSetting = preferredTypes[typeName];\n typeNodeName = typeName === '[]' ? typeName : 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 (!noDefaults && type === 'JsdocTypeName') {\n preferred = checkNativeTypes(typeNodeName, preferred, parentNode, invalidTypes);\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 iterateAllJsdocs: true,\n meta: {\n docs: {\n description: 'Reports invalid types.',\n url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-types.md#repos-sticky-header',\n },\n fixable: 'code',\n schema: [\n {\n additionalProperties: false,\n properties: {\n exemptTagContexts: {\n items: {\n additionalProperties: false,\n properties: {\n tag: {\n type: 'string',\n },\n types: {\n oneOf: [\n {\n type: 'boolean',\n },\n {\n items: {\n type: 'string',\n },\n type: 'array',\n },\n ],\n },\n },\n type: 'object',\n },\n type: 'array',\n },\n noDefaults: {\n type: 'boolean',\n },\n unifyParentAndChildTypeChecks: {\n type: 'boolean',\n },\n },\n type: 'object',\n },\n ],\n type: 'suggestion',\n },\n});\n"],"mappings":";;;;AAQA,MAAM,oBAAoB;CACxB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD;;;;;;;;;;;;AAaD,MAAM,cAAc,CAAC,MAAM,WAAW,gBAAgB,cAAc,MAAM,eAAe;CACvF,IAAI,MAAM;AACV,KAAI,gBAAgB;EAClB,MAAM,aACJ,WACA;AACF,MAAI,cAAc,MAAM;GACtB,WAAW,WAAW;GACtB,WAAW,MAAM;GACjB,MAAM;EACP,OAAM;GACL,MAAM,gBAAgB,UAAU,MAAM,cAAc;AACpD,OAAI,eAAe;IACjB,WAAW,WAAW;IACtB,WAAW,MAAM;IACjB,MAAM,UAAU,MAAM,GAAG,CAAC,cAAc,GAAG,OAAO;GACnD,OAAM;IACL,MAAM,aAAa,UAAU,SAAS,KAAK;AAC3C,QAAI,YAAY;KACd,WAAW,WAAW;KACtB,WAAW,MAAM;KACjB,MAAM,UAAU,MAAM,GAAG,GAAG;IAC7B,WACC,YAAY,aAAa,aACxB,iBAAiB,QAAQ,iBAAiB,UAC3C;KACA,WAAW,WAAW;KACtB,WAAW,MAAM;IAClB;GACF;EACF;CACF,WAAU,SAAS,gBAClB,KAAK,OAAO;6DAIZ,KACA,QAAQ,IAAI,QAAQ,yBAAyB,GAAG;AAGlD,KAAI,CAAC;6DAED,KACA,QAAQ;AAEb;;;;;AAMD,MAAM,aAAa,CAAC,cAAc;AAChC,QAAO,2DACA,YAAY,MAAM,OAAO;AACjC;AAED,yBAAe,aAAa,CAAC,EAC3B,SACA,WACA,QACA,UACA,YACA,OACD,KAAK;CACJ,MAAM,4BAA4B,MAAM,WAAW,CAAC,QAAQ;AAC1D,SAAO,QAAQ,MAAM,yBAAyB,IAAI,IAAI,CAAC;CACxD,EAAC;CAEF,MAQE,EACE,MACA,gBAAgB,wBAChB,gBACD,GAAG;CAEN,MAAM,6BAA6B,EAAE,YAAY,0BAC/C,YAAY,0BACZ,eAAe,0BACf,eAAe,0BACf,cAAc;;;;;;;CAQhB,MAAM,OAAO;EACX,SAAS,YAAY;EACrB,aAAa;CACd;;;;;;;CAQD,MAAM,SAAS;EACb,SAAS,WAAW,KAAK;EACzB,aAAa;CACd;;CAGD,MAAM,eAAe,SAAS,eAC5B;EACE,QAAQ;EACR,aAAa;EACb,aAAa;EACb,YAAY;EACZ,YAAY;CACb,IACD;EACE,QAAQ;EACR,aAAa;EACb,aAAa;EACb,YAAY;CACb;;CAGH,MAAM,iBAAiB;EACrB,GAAG,6BACD,eACA,CAAE;EACJ,GAAG;CACJ;CAED,MAUM,EACF,oBAAoB,CAAE,GACtB,YACA,+BACD,GAAG,QAAQ,QAAQ,MAAM,CAAE;;;;;;;;;;CAW9B,MAAM,uBAAuB,CAAC,OAAO,cAAc,YAAY,aAAa;EAC1E,IAAI,2BAA2B;EAC/B,IAAI,iBAAiB;EACrB,IAAI,WAAW;EAEf,MAAM,kBAAkB,eAAe,UAAa,WAAW,SAAS,sBAAsB,aAAa;AAC3G,MAAI,iCAAiC,iBAAiB;GACpD,MAAM,WACJ,YACC,MAAM;GACT,MAAM,MACJ,YACC,MAAM;AAET,OAAI,aAAa,SAAS;IACxB,MAAM,iBAAiB,MAAM,CAC3B,KAAK,KACN,IAAG,CACF,IACD;IACD,iBAAiB,eAAe,KAAK,CAAC,iBAAiB;AACrD,SAAI,iBAAiB,eAAe,kBAAkB,QAAW;MAC/D,YAAY;AAEZ,aAAO;KACR;AAED,YAAO;IACR,EAAC;GACH;AAED,OACE,CAAC,kBAAkB,YAEjB,WACA,SAAS,oBACX;IACA,MAAM,iBAAiB,MAAM,CAC3B,KAAK,KACN,IAAG,CACF,aAAa,UAAU,OAAO,IAC/B;IAED,iBAAiB,eAAe,KAAK,CAAC,iBAAiB;AACrD,SAAI,iBAAiB,kBAAkB,QAAW;MAChD,WAAW;AAEX,aAAO;KACR;AAED,YAAO;IACR,EAAC;GACH;EACF;EAED,MAAM,kBAAkB,iBAAiB,kBAAkB,UACzD,CAAC,OAAO,OAAO,eAAe,CAAC,SAAS,aAAa;EACvD,MAAM,2BAA2B,YAAY,mBAAmB;EAChE,iBAAiB,kBAAkB,QAAQ,yBAAyB;EAEpE,2BAA2B,kBACzB,mBAAmB,CAAC;AAEtB,SAAO;GACL;GAA0B;GAAU;EACrC;CACF;;;;;;;;;;CAWD,MAAM,mBAAmB,CAAC,cAAc,WAAW,YAAY,iBAAiB;EAC9E,IAAI,mBAAmB;AACvB,OAAK,MAAM,oBAAoB,mBAAmB;AAChD,OACE,qBAAqB,aAInB,CAAC,iBAAiB,iBAShB,YACC,UAAU,UAKT,YACC,MAAM,SAAS,mBAIjB,YAAa,MAAM,UAAU,UAIlC;AAGF,OAAI,qBAAqB,gBACvB,iBAAiB,aAAa,KAAK,aAAa,aAAa,KAG5D,CAAC,kBAAkB,iBAAiB,sBAAsB,SAC3D;IACA,mBAAmB;IACnB,aAAa,KAAK,CAChB,cAAc,gBACf,EAAC;AACF;GACD;EACF;AAED,SAAO;CACR;;;;;;;;;;;;;;CAeD,MAAM,kBAAkB,CAAC,MAAM,OAAO,SAAS,WAAW,KAAK,UAAU,MAAM,YAAY,iBAAiB;EAC1G,IAAI,eAAe,SAAS,iBAAiB,MAAM;EAEnD,MAAM,CACJ,0BACA,UACA,eACD,GAAG,qBAAqB,MAAM,cAAc,YAAY,SAAS;EAElE,IAAI;EACJ,IAAI;AACJ,MAAI,0BAA0B;GAC5B,MAAM,mBAAmB,eAAe;GACxC,eAAe,aAAa,OAAO,WAAW;AAE9C,OAAI,CAAC,kBACH,aAAa,KAAK,CAChB,YACD,EAAC;YACO,OAAO,qBAAqB,UAAU;IAC/C,YAAY;IACZ,aAAa,KAAK,CAChB,cAAc,SACf,EAAC;GACH,WAAU,oBAAoB,OAAO,qBAAqB,UAAU;IACnE,MAAM,WAAW,iBAAiB,oBAAoB,0BAA0B,MAAM;AAEtF,QAAI,CAAC,YAAY,CAAC,SAAS,KAAK,WAAW,GAAG,UAAU,CAAC,CAAC,CAAC,EAAE;KAC3D,YAAY,iBAAiB;KAC7B,aAAa,KAAK;MAChB;MACA;MACA,iBAAiB;KAClB,EAAC;IACH;GACF,OAAM;IACL,MAAM,eACJ,yFACD;AAED;GACD;EACF,WAAU,OAAO,QAAQ,eAAe,CAAC,KAAK,CAAC,CAC9C,KACA,EACE,MAAM,MACP,CACF,KAAK;GACJ,QAAQ;AAER,UAAO,QAAQ,WACb,MAAM,QAAQ,MAAM,IACpB,CAAC,MAAM,SAAS,aAAa;EAChC,EAAC,EACA,aAAa,KAAK,CAChB,cAAc,KACf,EAAC;WACO,CAAC,cAAc,SAAS,iBACjC,YAAY,iBAAiB,cAAc,WAAW,YAAY,aAAa;AAIjF,MAAI,WACF,YAAY,MAAM,WAAW,gBAAgB,cAAc,MAAM,WAAW;CAE/E;AAED,MAAK,MAAM,CACT,KACA,SACD,IAAI,0BAA0B,SAAS,EAAE;;EAExC,MAAM,eAAe,CAAE;EACvB,IAAI;AAEJ,MAAI;GACF,UAAU,SAAS,eAAe,SAAS,SAAS,KAAK,GAAG,MAAM,SAAS,MAAM,KAAK;EACvF,QAAO;AACN;EACD;EAED,MAAM,EACJ,MAAM,WACN,KAAK,SACN,GAAG;EAEJ,SAAS,SAAS,CAAC,MAAM,YAAY,aAAa;GAChD,MAAM,EACJ,MACA,OACD,GAGM;AACP,OAAI,CAAC,CACH,gBAAgB,eACjB,EAAC,SAAS,KAAK,CACd;GAGF,gBAAgB,MAAM,OAAO,SAAS,WAAW,KAAK,UAAU,MAAM,YAAY,aAAa;EAChG,EAAC;AAEF,MAAI,aAAa,QAAQ;GACvB,MAAM,YAAY,UAAU,QAAQ;;;;GAKpC,MAAM,MAAM,CAAC,UAAU;AACrB,WAAO,MAAM,YACX,WACA,WAAW,QAAQ,UAAU,CAAC,QAC5B,CAAC,CAAC,EAAE,SAAS,KAAK,CAAC,CAAC,EACpB,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CACjB,CACF;GACF;AAED,QAAK,MAAM,CACT,SACA,gBAAgB,IAChB,IACD,IAAI,cAAc;IACjB,MAAM,WAAW,SAAS,OAAO,CAAC,EAAE,EAAE,SAAS,KAAK,CAAC,CAAC,GAAG;AACzD,QAAI,kBAAkB,KAAK,CAAC,EAC1B,KACA,OACD,KAAK;AACJ,YAAO,QAAQ,YACZ,UAAU,QAAQ,MAAM,SAAS,SAAS,KAAK;IACnD,EAAC,CACA;IAGF,OACE,OACE,CAAC,eAAe,EAAE,UAAU,SAAS,OAAO,EAAE,QAAQ,CAAC,CAAC,IACvD,gBAAgB,OAAO,QACvB,gBAAgB,CAAC,QAAQ,EAAE,KAAK,UAAU,cAAc,CAAC,CAAC,CAAC,GAAG,KACjE,gBAAgB,MAAM,MACtB,UACA,MAAM;KACJ;KACA;IACD,IAAG,OACL;GACF;EACF;CACF;AACF,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,mBAAmB;KACjB,OAAO;MACL,sBAAsB;MACtB,YAAY;OACV,KAAK,EACH,MAAM,SACP;OACD,OAAO,EACL,OAAO,CACL,EACE,MAAM,UACP,GACD;QACE,OAAO,EACL,MAAM,SACP;QACD,MAAM;OACP,CACF,EACF;MACF;MACD,MAAM;KACP;KACD,MAAM;IACP;IACD,YAAY,EACV,MAAM,UACP;IACD,+BAA+B,EAC7B,MAAM,UACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}
|