eslint-plugin-jsdoc 47.0.1 → 48.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{WarnSettings.js → WarnSettings.cjs} +2 -2
- package/dist/WarnSettings.cjs.map +1 -0
- package/dist/{alignTransform.js → alignTransform.cjs} +2 -2
- package/dist/alignTransform.cjs.map +1 -0
- package/dist/{defaultTagOrder.js → defaultTagOrder.cjs} +1 -1
- package/dist/defaultTagOrder.cjs.map +1 -0
- package/dist/{exportParser.js → exportParser.cjs} +32 -36
- package/dist/exportParser.cjs.map +1 -0
- package/dist/{generateRule.js → generateRule.cjs} +7 -4
- package/dist/generateRule.cjs.map +1 -0
- package/dist/{getDefaultTagStructureForMode.js → getDefaultTagStructureForMode.cjs} +1 -1
- package/dist/getDefaultTagStructureForMode.cjs.map +1 -0
- package/dist/{index.js → index.cjs} +60 -59
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/{iterateJsdoc.js → iterateJsdoc.cjs} +16 -21
- package/dist/iterateJsdoc.cjs.map +1 -0
- package/dist/{jsdocUtils.js → jsdocUtils.cjs} +17 -17
- package/dist/jsdocUtils.cjs.map +1 -0
- package/dist/rules/{checkAccess.js → checkAccess.cjs} +2 -2
- package/dist/rules/checkAccess.cjs.map +1 -0
- package/dist/rules/{checkAlignment.js → checkAlignment.cjs} +2 -2
- package/dist/rules/checkAlignment.cjs.map +1 -0
- package/dist/rules/{checkExamples.js → checkExamples.cjs} +2 -2
- package/dist/rules/checkExamples.cjs.map +1 -0
- package/dist/rules/{checkIndentation.js → checkIndentation.cjs} +2 -2
- package/dist/rules/checkIndentation.cjs.map +1 -0
- package/dist/rules/{checkLineAlignment.js → checkLineAlignment.cjs} +3 -3
- package/dist/rules/checkLineAlignment.cjs.map +1 -0
- package/dist/rules/{checkParamNames.js → checkParamNames.cjs} +2 -2
- package/dist/rules/checkParamNames.cjs.map +1 -0
- package/dist/rules/{checkPropertyNames.js → checkPropertyNames.cjs} +2 -2
- package/dist/rules/checkPropertyNames.cjs.map +1 -0
- package/dist/rules/{checkSyntax.js → checkSyntax.cjs} +2 -2
- package/dist/rules/checkSyntax.cjs.map +1 -0
- package/dist/rules/{checkTagNames.js → checkTagNames.cjs} +2 -2
- package/dist/rules/checkTagNames.cjs.map +1 -0
- package/dist/rules/{checkTypes.js → checkTypes.cjs} +2 -2
- package/dist/rules/checkTypes.cjs.map +1 -0
- package/dist/rules/{checkValues.js → checkValues.cjs} +2 -2
- package/dist/rules/checkValues.cjs.map +1 -0
- package/dist/rules/{emptyTags.js → emptyTags.cjs} +2 -2
- package/dist/rules/emptyTags.cjs.map +1 -0
- package/dist/rules/{implementsOnClasses.js → implementsOnClasses.cjs} +2 -2
- package/dist/rules/implementsOnClasses.cjs.map +1 -0
- package/dist/rules/{importsAsDependencies.js → importsAsDependencies.cjs} +10 -12
- package/dist/rules/importsAsDependencies.cjs.map +1 -0
- package/dist/rules/{informativeDocs.js → informativeDocs.cjs} +2 -2
- package/dist/rules/informativeDocs.cjs.map +1 -0
- package/dist/rules/{matchDescription.js → matchDescription.cjs} +2 -2
- package/dist/rules/matchDescription.cjs.map +1 -0
- package/dist/rules/{matchName.js → matchName.cjs} +2 -2
- package/dist/rules/matchName.cjs.map +1 -0
- package/dist/rules/{multilineBlocks.js → multilineBlocks.cjs} +2 -2
- package/dist/rules/multilineBlocks.cjs.map +1 -0
- package/dist/rules/{noBadBlocks.js → noBadBlocks.cjs} +2 -2
- package/dist/rules/noBadBlocks.cjs.map +1 -0
- package/dist/rules/{noBlankBlockDescriptions.js → noBlankBlockDescriptions.cjs} +2 -2
- package/dist/rules/noBlankBlockDescriptions.cjs.map +1 -0
- package/dist/rules/{noBlankBlocks.js → noBlankBlocks.cjs} +2 -2
- package/dist/rules/noBlankBlocks.cjs.map +1 -0
- package/dist/rules/{noDefaults.js → noDefaults.cjs} +2 -2
- package/dist/rules/noDefaults.cjs.map +1 -0
- package/dist/rules/{noMissingSyntax.js → noMissingSyntax.cjs} +2 -2
- package/dist/rules/noMissingSyntax.cjs.map +1 -0
- package/dist/rules/{noMultiAsterisks.js → noMultiAsterisks.cjs} +2 -2
- package/dist/rules/noMultiAsterisks.cjs.map +1 -0
- package/dist/rules/{noRestrictedSyntax.js → noRestrictedSyntax.cjs} +2 -2
- package/dist/rules/noRestrictedSyntax.cjs.map +1 -0
- package/dist/rules/{noTypes.js → noTypes.cjs} +2 -2
- package/dist/rules/noTypes.cjs.map +1 -0
- package/dist/rules/{noUndefinedTypes.js → noUndefinedTypes.cjs} +5 -5
- package/dist/rules/noUndefinedTypes.cjs.map +1 -0
- package/dist/rules/{requireAsteriskPrefix.js → requireAsteriskPrefix.cjs} +2 -2
- package/dist/rules/requireAsteriskPrefix.cjs.map +1 -0
- package/dist/rules/{requireDescription.js → requireDescription.cjs} +2 -2
- package/dist/rules/requireDescription.cjs.map +1 -0
- package/dist/rules/{requireDescriptionCompleteSentence.js → requireDescriptionCompleteSentence.cjs} +2 -2
- package/dist/rules/requireDescriptionCompleteSentence.cjs.map +1 -0
- package/dist/rules/{requireExample.js → requireExample.cjs} +2 -2
- package/dist/rules/requireExample.cjs.map +1 -0
- package/dist/rules/{requireFileOverview.js → requireFileOverview.cjs} +2 -2
- package/dist/rules/requireFileOverview.cjs.map +1 -0
- package/dist/rules/{requireHyphenBeforeParamDescription.js → requireHyphenBeforeParamDescription.cjs} +2 -2
- package/dist/rules/requireHyphenBeforeParamDescription.cjs.map +1 -0
- package/dist/rules/{requireJsdoc.js → requireJsdoc.cjs} +5 -5
- package/dist/rules/requireJsdoc.cjs.map +1 -0
- package/dist/rules/{requireParam.js → requireParam.cjs} +2 -2
- package/dist/rules/requireParam.cjs.map +1 -0
- package/dist/rules/{requireParamDescription.js → requireParamDescription.cjs} +2 -2
- package/dist/rules/requireParamDescription.cjs.map +1 -0
- package/dist/rules/{requireParamName.js → requireParamName.cjs} +2 -2
- package/dist/rules/requireParamName.cjs.map +1 -0
- package/dist/rules/{requireParamType.js → requireParamType.cjs} +2 -2
- package/dist/rules/requireParamType.cjs.map +1 -0
- package/dist/rules/{requireProperty.js → requireProperty.cjs} +2 -2
- package/dist/rules/requireProperty.cjs.map +1 -0
- package/dist/rules/{requirePropertyDescription.js → requirePropertyDescription.cjs} +2 -2
- package/dist/rules/requirePropertyDescription.cjs.map +1 -0
- package/dist/rules/{requirePropertyName.js → requirePropertyName.cjs} +2 -2
- package/dist/rules/requirePropertyName.cjs.map +1 -0
- package/dist/rules/{requirePropertyType.js → requirePropertyType.cjs} +2 -2
- package/dist/rules/requirePropertyType.cjs.map +1 -0
- package/dist/rules/{requireReturns.js → requireReturns.cjs} +4 -4
- package/dist/rules/requireReturns.cjs.map +1 -0
- package/dist/rules/{requireReturnsCheck.js → requireReturnsCheck.cjs} +2 -2
- package/dist/rules/requireReturnsCheck.cjs.map +1 -0
- package/dist/rules/{requireReturnsDescription.js → requireReturnsDescription.cjs} +2 -2
- package/dist/rules/requireReturnsDescription.cjs.map +1 -0
- package/dist/rules/{requireReturnsType.js → requireReturnsType.cjs} +2 -2
- package/dist/rules/requireReturnsType.cjs.map +1 -0
- package/dist/rules/{requireThrows.js → requireThrows.cjs} +2 -2
- package/dist/rules/requireThrows.cjs.map +1 -0
- package/dist/rules/{requireYields.js → requireYields.cjs} +2 -2
- package/dist/rules/requireYields.cjs.map +1 -0
- package/dist/rules/{requireYieldsCheck.js → requireYieldsCheck.cjs} +2 -2
- package/dist/rules/requireYieldsCheck.cjs.map +1 -0
- package/dist/rules/{sortTags.js → sortTags.cjs} +4 -4
- package/dist/rules/sortTags.cjs.map +1 -0
- package/dist/rules/{tagLines.js → tagLines.cjs} +2 -2
- package/dist/rules/tagLines.cjs.map +1 -0
- package/dist/rules/{textEscaping.js → textEscaping.cjs} +2 -2
- package/dist/rules/textEscaping.cjs.map +1 -0
- package/dist/rules/{validTypes.js → validTypes.cjs} +2 -2
- package/dist/rules/validTypes.cjs.map +1 -0
- package/dist/{tagNames.js → tagNames.cjs} +1 -1
- package/dist/tagNames.cjs.map +1 -0
- package/dist/utils/{hasReturnValue.js → hasReturnValue.cjs} +14 -17
- package/dist/utils/hasReturnValue.cjs.map +1 -0
- package/{eslint.config.mjs → eslint.config.js} +37 -28
- package/package.json +16 -16
- package/dist/WarnSettings.js.map +0 -1
- package/dist/alignTransform.js.map +0 -1
- package/dist/defaultTagOrder.js.map +0 -1
- package/dist/exportParser.js.map +0 -1
- package/dist/generateRule.js.map +0 -1
- package/dist/getDefaultTagStructureForMode.js.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/iterateJsdoc.js.map +0 -1
- package/dist/jsdocUtils.js.map +0 -1
- package/dist/rules/checkAccess.js.map +0 -1
- package/dist/rules/checkAlignment.js.map +0 -1
- package/dist/rules/checkExamples.js.map +0 -1
- package/dist/rules/checkIndentation.js.map +0 -1
- package/dist/rules/checkLineAlignment.js.map +0 -1
- package/dist/rules/checkParamNames.js.map +0 -1
- package/dist/rules/checkPropertyNames.js.map +0 -1
- package/dist/rules/checkSyntax.js.map +0 -1
- package/dist/rules/checkTagNames.js.map +0 -1
- package/dist/rules/checkTypes.js.map +0 -1
- package/dist/rules/checkValues.js.map +0 -1
- package/dist/rules/emptyTags.js.map +0 -1
- package/dist/rules/implementsOnClasses.js.map +0 -1
- package/dist/rules/importsAsDependencies.js.map +0 -1
- package/dist/rules/informativeDocs.js.map +0 -1
- package/dist/rules/matchDescription.js.map +0 -1
- package/dist/rules/matchName.js.map +0 -1
- package/dist/rules/multilineBlocks.js.map +0 -1
- package/dist/rules/noBadBlocks.js.map +0 -1
- package/dist/rules/noBlankBlockDescriptions.js.map +0 -1
- package/dist/rules/noBlankBlocks.js.map +0 -1
- package/dist/rules/noDefaults.js.map +0 -1
- package/dist/rules/noMissingSyntax.js.map +0 -1
- package/dist/rules/noMultiAsterisks.js.map +0 -1
- package/dist/rules/noRestrictedSyntax.js.map +0 -1
- package/dist/rules/noTypes.js.map +0 -1
- package/dist/rules/noUndefinedTypes.js.map +0 -1
- package/dist/rules/requireAsteriskPrefix.js.map +0 -1
- package/dist/rules/requireDescription.js.map +0 -1
- package/dist/rules/requireDescriptionCompleteSentence.js.map +0 -1
- package/dist/rules/requireExample.js.map +0 -1
- package/dist/rules/requireFileOverview.js.map +0 -1
- package/dist/rules/requireHyphenBeforeParamDescription.js.map +0 -1
- package/dist/rules/requireJsdoc.js.map +0 -1
- package/dist/rules/requireParam.js.map +0 -1
- package/dist/rules/requireParamDescription.js.map +0 -1
- package/dist/rules/requireParamName.js.map +0 -1
- package/dist/rules/requireParamType.js.map +0 -1
- package/dist/rules/requireProperty.js.map +0 -1
- package/dist/rules/requirePropertyDescription.js.map +0 -1
- package/dist/rules/requirePropertyName.js.map +0 -1
- package/dist/rules/requirePropertyType.js.map +0 -1
- package/dist/rules/requireReturns.js.map +0 -1
- package/dist/rules/requireReturnsCheck.js.map +0 -1
- package/dist/rules/requireReturnsDescription.js.map +0 -1
- package/dist/rules/requireReturnsType.js.map +0 -1
- package/dist/rules/requireThrows.js.map +0 -1
- package/dist/rules/requireYields.js.map +0 -1
- package/dist/rules/requireYieldsCheck.js.map +0 -1
- package/dist/rules/sortTags.js.map +0 -1
- package/dist/rules/tagLines.js.map +0 -1
- package/dist/rules/textEscaping.js.map +0 -1
- package/dist/rules/validTypes.js.map +0 -1
- package/dist/tagNames.js.map +0 -1
- package/dist/utils/hasReturnValue.js.map +0 -1
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"getDefaultTagStructureForMode.cjs","names":["getDefaultTagStructureForMode","mode","isJsdoc","isClosure","isTypescript","isPermissive","isJsdocOrPermissive","isJsdocOrTypescript","isTypescriptOrClosure","isClosureOrPermissive","isJsdocTypescriptOrPermissive","Map","_default","exports","default","module"],"sources":["../src/getDefaultTagStructureForMode.js"],"sourcesContent":["/**\n * @typedef {Map<string, Map<string, (string|boolean)>>} TagStructure\n */\n/**\n * @param {import('./jsdocUtils.js').ParserMode} mode\n * @returns {TagStructure}\n */\nconst getDefaultTagStructureForMode = (mode) => {\n const isJsdoc = mode === 'jsdoc';\n const isClosure = mode === 'closure';\n const isTypescript = mode === 'typescript';\n const isPermissive = mode === 'permissive';\n\n const isJsdocOrPermissive = isJsdoc || isPermissive;\n const isJsdocOrTypescript = isJsdoc || isTypescript;\n const isTypescriptOrClosure = isTypescript || isClosure;\n const isClosureOrPermissive = isClosure || isPermissive;\n const isJsdocTypescriptOrPermissive = isJsdocOrTypescript || isPermissive;\n\n // Properties:\n // `namepathRole` - 'namepath-referencing'|'namepath-defining'|'namepath-or-url-referencing'|'text'|false\n // `typeAllowed` - boolean\n // `nameRequired` - boolean\n // `typeRequired` - boolean\n // `typeOrNameRequired` - boolean\n\n // All of `typeAllowed` have a signature with \"type\" except for\n // `augments`/`extends` (\"namepath\")\n // `param`/`arg`/`argument` (no signature)\n // `property`/`prop` (no signature)\n // `modifies` (undocumented)\n\n // None of the `namepathRole: 'namepath-defining'` show as having curly\n // brackets for their name/namepath\n\n // Among `namepath-defining` and `namepath-referencing`, these do not seem\n // to allow curly brackets in their doc signature or examples (`modifies`\n // references namepaths within its type brackets and `param` is\n // name-defining but not namepath-defining, so not part of these groups)\n\n // Todo: Should support special processing for \"name\" as distinct from\n // \"namepath\" (e.g., param can't define a namepath)\n\n // Todo: Should support a `tutorialID` type (for `@tutorial` block and\n // inline)\n\n /**\n * @type {TagStructure}\n */\n return new Map([\n [\n 'alias', new Map(/** @type {[string, string|boolean][]} */ ([\n // Signature seems to require a \"namepath\" (and no counter-examples)\n [\n 'namepathRole', 'namepath-defining',\n ],\n\n // \"namepath\"\n [\n 'typeOrNameRequired', true,\n ],\n ])),\n ],\n\n [\n 'arg', new Map(/** @type {[string, string|boolean][]} */ ([\n [\n 'namepathRole', 'namepath-defining',\n ],\n\n // See `param`\n [\n 'nameRequired', true,\n ],\n\n // Has no formal signature in the docs but shows curly brackets\n // in the examples\n [\n 'typeAllowed', true,\n ],\n ])),\n ],\n\n [\n 'argument', new Map(/** @type {[string, string|boolean][]} */ ([\n [\n 'namepathRole', 'namepath-defining',\n ],\n\n // See `param`\n [\n 'nameRequired', true,\n ],\n\n // Has no formal signature in the docs but shows curly brackets\n // in the examples\n [\n 'typeAllowed', true,\n ],\n ])),\n ],\n\n [\n 'augments', new Map(/** @type {[string, string|boolean][]} */ ([\n // Signature seems to require a \"namepath\" (and no counter-examples)\n [\n 'namepathRole', 'namepath-referencing',\n ],\n\n // Does not show curly brackets in either the signature or examples\n [\n 'typeAllowed', true,\n ],\n\n // \"namepath\"\n [\n 'typeOrNameRequired', true,\n ],\n ])),\n ],\n\n [\n 'borrows', new Map(/** @type {[string, string|boolean][]} */ ([\n // `borrows` has a different format, however, so needs special parsing;\n // seems to require both, and as \"namepath\"'s\n [\n 'namepathRole', 'namepath-referencing',\n ],\n\n // \"namepath\"\n [\n 'typeOrNameRequired', true,\n ],\n ])),\n ],\n\n [\n 'callback', new Map(/** @type {[string, string|boolean][]} */ ([\n // Seems to require a \"namepath\" in the signature (with no\n // counter-examples); TypeScript does not enforce but seems\n // problematic as not attached so presumably not useable without it\n [\n 'namepathRole', 'namepath-defining',\n ],\n\n // \"namepath\"\n [\n 'nameRequired', true,\n ],\n ])),\n ],\n\n [\n 'class', new Map(/** @type {[string, string|boolean][]} */ ([\n // Allows for \"name\"'s in signature, but indicated as optional\n [\n 'namepathRole', 'namepath-defining',\n ],\n\n // Not in use, but should be this value if using to power `empty-tags`\n [\n 'nameAllowed', true,\n ],\n\n [\n 'typeAllowed', true,\n ],\n ])),\n ],\n\n [\n 'const', new Map(/** @type {[string, string|boolean][]} */ ([\n // Allows for \"name\"'s in signature, but indicated as optional\n [\n 'namepathRole', 'namepath-defining',\n ],\n\n [\n 'typeAllowed', true,\n ],\n ])),\n ],\n [\n 'constant', new Map(/** @type {[string, string|boolean][]} */ ([\n // Allows for \"name\"'s in signature, but indicated as optional\n [\n 'namepathRole', 'namepath-defining',\n ],\n\n [\n 'typeAllowed', true,\n ],\n ])),\n ],\n [\n 'constructor', new Map(/** @type {[string, string|boolean][]} */ ([\n // Allows for \"name\"'s in signature, but indicated as optional\n [\n 'namepathRole', 'namepath-defining',\n ],\n\n [\n 'typeAllowed', true,\n ],\n ])),\n ],\n\n [\n 'constructs', new Map(/** @type {[string, string|boolean][]} */ ([\n // Allows for \"name\"'s in signature, but indicated as optional\n [\n 'namepathRole', 'namepath-defining',\n ],\n\n [\n 'nameRequired', false,\n ],\n\n [\n 'typeAllowed', false,\n ],\n ])),\n ],\n\n [\n 'define', new Map(/** @type {[string, string|boolean][]} */ ([\n [\n 'typeRequired', isClosure,\n ],\n ])),\n ],\n\n [\n 'emits', new Map(/** @type {[string, string|boolean][]} */ ([\n // Signature seems to require a \"name\" (of an event) and no counter-examples\n [\n 'namepathRole', 'namepath-referencing',\n ],\n\n [\n 'nameRequired', true,\n ],\n\n [\n 'typeAllowed', false,\n ],\n ])),\n ],\n\n [\n 'enum', new Map(/** @type {[string, string|boolean][]} */ ([\n // Has example showing curly brackets but not in doc signature\n [\n 'typeAllowed', true,\n ],\n ])),\n ],\n\n [\n 'event', new Map(/** @type {[string, string|boolean][]} */ ([\n // The doc signature of `event` seems to require a \"name\"\n [\n 'nameRequired', true,\n ],\n\n // Appears to require a \"name\" in its signature, albeit somewhat\n // different from other \"name\"'s (including as described\n // at https://jsdoc.app/about-namepaths.html )\n [\n 'namepathRole', 'namepath-defining',\n ],\n ])),\n ],\n\n [\n 'exception', new Map(/** @type {[string, string|boolean][]} */ ([\n // Shows curly brackets in the signature and in the examples\n [\n 'typeAllowed', true,\n ],\n ])),\n ],\n\n // Closure\n [\n 'export', new Map(/** @type {[string, string|boolean][]} */ ([\n [\n 'typeAllowed', isClosureOrPermissive,\n ],\n ])),\n ],\n\n [\n 'exports', new Map(/** @type {[string, string|boolean][]} */ ([\n [\n 'namepathRole', 'namepath-defining',\n ],\n\n [\n 'nameRequired', isJsdoc,\n ],\n\n [\n 'typeAllowed', isClosureOrPermissive,\n ],\n ])),\n ],\n\n [\n 'extends', new Map(/** @type {[string, string|boolean][]} */ ([\n // Signature seems to require a \"namepath\" (and no counter-examples)\n [\n 'namepathRole', 'namepath-referencing',\n ],\n\n // Does not show curly brackets in either the signature or examples\n [\n 'typeAllowed', isTypescriptOrClosure || isPermissive,\n ],\n\n [\n 'nameRequired', isJsdoc,\n ],\n\n // \"namepath\"\n [\n 'typeOrNameRequired', isTypescriptOrClosure || isPermissive,\n ],\n ])),\n ],\n\n [\n 'external', new Map(/** @type {[string, string|boolean][]} */ ([\n // Appears to require a \"name\" in its signature, albeit somewhat\n // different from other \"name\"'s (including as described\n // at https://jsdoc.app/about-namepaths.html )\n [\n 'namepathRole', 'namepath-defining',\n ],\n\n // \"name\" (and a special syntax for the `external` name)\n [\n 'nameRequired', true,\n ],\n\n [\n 'typeAllowed', false,\n ],\n ])),\n ],\n\n [\n 'fires', new Map(/** @type {[string, string|boolean][]} */ ([\n // Signature seems to require a \"name\" (of an event) and no\n // counter-examples\n [\n 'namepathRole', 'namepath-referencing',\n ],\n\n [\n 'nameRequired', true,\n ],\n\n [\n 'typeAllowed', false,\n ],\n ])),\n ],\n\n [\n 'function', new Map(/** @type {[string, string|boolean][]} */ ([\n // Allows for \"name\"'s in signature, but indicated as optional\n [\n 'namepathRole', 'namepath-defining',\n ],\n\n [\n 'nameRequired', false,\n ],\n\n [\n 'typeAllowed', false,\n ],\n ])),\n ],\n [\n 'func', new Map(/** @type {[string, string|boolean][]} */ ([\n // Allows for \"name\"'s in signature, but indicated as optional\n [\n 'namepathRole', 'namepath-defining',\n ],\n ])),\n ],\n\n [\n 'host', new Map(/** @type {[string, string|boolean][]} */ ([\n // Appears to require a \"name\" in its signature, albeit somewhat\n // different from other \"name\"'s (including as described\n // at https://jsdoc.app/about-namepaths.html )\n [\n 'namepathRole', 'namepath-defining',\n ],\n\n // See `external`\n [\n 'nameRequired', true,\n ],\n\n [\n 'typeAllowed', false,\n ],\n ])),\n ],\n\n [\n 'interface', new Map(/** @type {[string, string|boolean][]} */ ([\n // Allows for \"name\" in signature, but indicates as optional\n [\n 'namepathRole',\n isJsdocTypescriptOrPermissive ? 'namepath-defining' : false,\n ],\n\n // Not in use, but should be this value if using to power `empty-tags`\n [\n 'nameAllowed', isClosure,\n ],\n\n [\n 'typeAllowed', false,\n ],\n ])),\n ],\n\n [\n 'internal', new Map(/** @type {[string, string|boolean][]} */ ([\n // https://www.typescriptlang.org/tsconfig/#stripInternal\n [\n 'namepathRole', false,\n ],\n // Not in use, but should be this value if using to power `empty-tags`\n [\n 'nameAllowed', false,\n ],\n ])),\n ],\n\n [\n 'implements', new Map(/** @type {[string, string|boolean][]} */ ([\n // Shows curly brackets in the doc signature and examples\n // \"typeExpression\"\n [\n 'typeRequired', true,\n ],\n ])),\n ],\n\n [\n 'lends', new Map(/** @type {[string, string|boolean][]} */ ([\n // Signature seems to require a \"namepath\" (and no counter-examples)\n [\n 'namepathRole', 'namepath-referencing',\n ],\n\n // \"namepath\"\n [\n 'typeOrNameRequired', true,\n ],\n ])),\n ],\n\n [\n 'link', new Map(/** @type {[string, string|boolean][]} */ ([\n // Signature seems to require a namepath OR URL and might be checked as such.\n [\n 'namepathRole', 'namepath-or-url-referencing',\n ],\n\n ])),\n ],\n\n [\n 'linkcode', new Map(/** @type {[string, string|boolean][]} */ ([\n // Synonym for \"link\"\n // Signature seems to require a namepath OR URL and might be checked as such.\n [\n 'namepathRole', 'namepath-or-url-referencing',\n ],\n ])),\n ],\n\n [\n 'linkplain', new Map(/** @type {[string, string|boolean][]} */ ([\n // Synonym for \"link\"\n // Signature seems to require a namepath OR URL and might be checked as such.\n [\n 'namepathRole', 'namepath-or-url-referencing',\n ],\n ])),\n ],\n\n [\n 'listens', new Map(/** @type {[string, string|boolean][]} */ ([\n // Signature seems to require a \"name\" (of an event) and no\n // counter-examples\n [\n 'namepathRole', 'namepath-referencing',\n ],\n\n [\n 'nameRequired', true,\n ],\n\n [\n 'typeAllowed', false,\n ],\n ])),\n ],\n\n [\n 'member', new Map(/** @type {[string, string|boolean][]} */ ([\n // Allows for \"name\"'s in signature, but indicated as optional\n [\n 'namepathRole', 'namepath-defining',\n ],\n\n // Has example showing curly brackets but not in doc signature\n [\n 'typeAllowed', true,\n ],\n ])),\n ],\n\n [\n 'memberof', new Map(/** @type {[string, string|boolean][]} */ ([\n // Signature seems to require a \"namepath\" (and no counter-examples),\n // though it allows an incomplete namepath ending with connecting symbol\n [\n 'namepathRole', 'namepath-referencing',\n ],\n\n // \"namepath\"\n [\n 'typeOrNameRequired', true,\n ],\n ])),\n ],\n [\n 'memberof!', new Map(/** @type {[string, string|boolean][]} */ ([\n // Signature seems to require a \"namepath\" (and no counter-examples),\n // though it allows an incomplete namepath ending with connecting symbol\n [\n 'namepathRole', 'namepath-referencing',\n ],\n\n // \"namepath\"\n [\n 'typeOrNameRequired', true,\n ],\n ])),\n ],\n\n [\n 'method', new Map(/** @type {[string, string|boolean][]} */ ([\n // Allows for \"name\"'s in signature, but indicated as optional\n [\n 'namepathRole', 'namepath-defining',\n ],\n ])),\n ],\n [\n 'mixes', new Map(/** @type {[string, string|boolean][]} */ ([\n // Signature seems to require a \"OtherObjectPath\" with no\n // counter-examples\n [\n 'namepathRole', 'namepath-referencing',\n ],\n\n // \"OtherObjectPath\"\n [\n 'typeOrNameRequired', true,\n ],\n ])),\n ],\n\n [\n 'mixin', new Map(/** @type {[string, string|boolean][]} */ ([\n // Allows for \"name\"'s in signature, but indicated as optional\n [\n 'namepathRole', 'namepath-defining',\n ],\n\n [\n 'nameRequired', false,\n ],\n\n [\n 'typeAllowed', false,\n ],\n ])),\n ],\n\n [\n 'modifies', new Map(/** @type {[string, string|boolean][]} */ ([\n // Has no documentation, but test example has curly brackets, and\n // \"name\" would be suggested rather than \"namepath\" based on example;\n // not sure if name is required\n [\n 'typeAllowed', true,\n ],\n ])),\n ],\n\n [\n 'module', new Map(/** @type {[string, string|boolean][]} */ ([\n // Optional \"name\" and no curly brackets\n // this block impacts `no-undefined-types` and `valid-types` (search for\n // \"isNamepathDefiningTag|tagMightHaveNamepath|tagMightHaveEitherTypeOrNamePosition\")\n [\n 'namepathRole', isJsdoc ? 'namepath-defining' : 'text',\n ],\n\n // Shows the signature with curly brackets but not in the example\n [\n 'typeAllowed', true,\n ],\n ])),\n ],\n\n [\n 'name', new Map(/** @type {[string, string|boolean][]} */ ([\n // Seems to require a \"namepath\" in the signature (with no\n // counter-examples)\n [\n 'namepathRole', 'namepath-defining',\n ],\n\n // \"namepath\"\n [\n 'nameRequired', true,\n ],\n\n // \"namepath\"\n [\n 'typeOrNameRequired', true,\n ],\n ])),\n ],\n\n [\n 'namespace', new Map(/** @type {[string, string|boolean][]} */ ([\n // Allows for \"name\"'s in signature, but indicated as optional\n [\n 'namepathRole', 'namepath-defining',\n ],\n\n // Shows the signature with curly brackets but not in the example\n [\n 'typeAllowed', true,\n ],\n ])),\n ],\n [\n 'package', new Map(/** @type {[string, string|boolean][]} */ ([\n // Shows the signature with curly brackets but not in the example\n // \"typeExpression\"\n [\n 'typeAllowed', isClosureOrPermissive,\n ],\n ])),\n ],\n\n [\n 'param', new Map(/** @type {[string, string|boolean][]} */ ([\n [\n 'namepathRole', 'namepath-defining',\n ],\n\n // Though no signature provided requiring, per\n // https://jsdoc.app/tags-param.html:\n // \"The @param tag requires you to specify the name of the parameter you\n // are documenting.\"\n [\n 'nameRequired', true,\n ],\n\n // Has no formal signature in the docs but shows curly brackets\n // in the examples\n [\n 'typeAllowed', true,\n ],\n ])),\n ],\n\n [\n 'private', new Map(/** @type {[string, string|boolean][]} */ ([\n // Shows the signature with curly brackets but not in the example\n // \"typeExpression\"\n [\n 'typeAllowed', isClosureOrPermissive,\n ],\n ])),\n ],\n\n [\n 'prop', new Map(/** @type {[string, string|boolean][]} */ ([\n [\n 'namepathRole', 'namepath-defining',\n ],\n\n // See `property`\n [\n 'nameRequired', true,\n ],\n\n // Has no formal signature in the docs but shows curly brackets\n // in the examples\n [\n 'typeAllowed', true,\n ],\n ])),\n ],\n\n [\n 'property', new Map(/** @type {[string, string|boolean][]} */ ([\n [\n 'namepathRole', 'namepath-defining',\n ],\n\n // No docs indicate required, but since parallel to `param`, we treat as\n // such:\n [\n 'nameRequired', true,\n ],\n\n // Has no formal signature in the docs but shows curly brackets\n // in the examples\n [\n 'typeAllowed', true,\n ],\n ])),\n ],\n\n [\n 'protected', new Map(/** @type {[string, string|boolean][]} */ ([\n // Shows the signature with curly brackets but not in the example\n // \"typeExpression\"\n [\n 'typeAllowed', isClosureOrPermissive,\n ],\n ])),\n ],\n\n [\n 'public', new Map(/** @type {[string, string|boolean][]} */ ([\n // Does not show a signature nor show curly brackets in the example\n [\n 'typeAllowed', isClosureOrPermissive,\n ],\n ])),\n ],\n\n [\n 'requires', new Map(/** @type {[string, string|boolean][]} */ ([\n // <someModuleName>\n [\n 'namepathRole', 'namepath-referencing',\n ],\n\n [\n 'nameRequired', true,\n ],\n\n [\n 'typeAllowed', false,\n ],\n ])),\n ],\n\n [\n 'returns', new Map(/** @type {[string, string|boolean][]} */ ([\n // Shows curly brackets in the signature and in the examples\n [\n 'typeAllowed', true,\n ],\n ])),\n ],\n [\n 'return', new Map(/** @type {[string, string|boolean][]} */ ([\n // Shows curly brackets in the signature and in the examples\n [\n 'typeAllowed', true,\n ],\n ])),\n ],\n\n [\n 'satisfies', new Map(/** @type {[string, string|boolean][]} */ ([\n // Shows curly brackets in the doc signature and examples\n [\n 'typeRequired', true,\n ],\n ])),\n ],\n\n [\n 'see', new Map(/** @type {[string, string|boolean][]} */ ([\n // Signature allows for \"namepath\" or text, so user must configure to\n // 'namepath-referencing' to enforce checks\n [\n 'namepathRole', 'text',\n ],\n ])),\n ],\n\n [\n 'static', new Map(/** @type {[string, string|boolean][]} */ ([\n // Does not show a signature nor show curly brackets in the example\n [\n 'typeAllowed', isClosureOrPermissive,\n ],\n ])),\n ],\n\n [\n 'suppress', new Map(/** @type {[string, string|boolean][]} */ ([\n [\n 'namepathRole', !isClosure,\n ],\n [\n 'typeRequired', isClosure,\n ],\n ])),\n ],\n\n [\n 'template', new Map(/** @type {[string, string|boolean][]} */ ([\n [\n 'namepathRole', isJsdoc ? 'text' : 'namepath-referencing',\n ],\n\n [\n 'nameRequired', !isJsdoc,\n ],\n\n // Though defines `namepathRole: 'namepath-defining'` in a sense, it is\n // not parseable in the same way for template (e.g., allowing commas),\n // so not adding\n [\n 'typeAllowed', isTypescriptOrClosure || isPermissive,\n ],\n ])),\n ],\n\n [\n 'this', new Map(/** @type {[string, string|boolean][]} */ ([\n // Signature seems to require a \"namepath\" (and no counter-examples)\n // Not used with namepath in Closure/TypeScript, however\n [\n 'namepathRole', isJsdoc ? 'namepath-referencing' : false,\n ],\n\n [\n 'typeRequired', isTypescriptOrClosure,\n ],\n\n // namepath\n [\n 'typeOrNameRequired', isJsdoc,\n ],\n ])),\n ],\n\n [\n 'throws', new Map(/** @type {[string, string|boolean][]} */ ([\n // Shows curly brackets in the signature and in the examples\n [\n 'typeAllowed', true,\n ],\n ])),\n ],\n\n [\n 'tutorial', new Map(/** @type {[string, string|boolean][]} */ ([\n // (a tutorial ID)\n [\n 'nameRequired', true,\n ],\n\n [\n 'typeAllowed', false,\n ],\n ])),\n ],\n\n [\n 'type', new Map(/** @type {[string, string|boolean][]} */ ([\n // Shows curly brackets in the doc signature and examples\n // \"typeName\"\n [\n 'typeRequired', true,\n ],\n ])),\n ],\n\n [\n 'typedef', new Map(/** @type {[string, string|boolean][]} */ ([\n // Seems to require a \"namepath\" in the signature (with no\n // counter-examples)\n [\n 'namepathRole', 'namepath-defining',\n ],\n\n // TypeScript may allow it to be dropped if followed by @property or @member;\n // also shown as missing in Closure\n // \"namepath\"\n [\n 'nameRequired', isJsdocOrPermissive,\n ],\n\n // Is not `typeRequired` for TypeScript because it gives an error:\n // JSDoc '@typedef' tag should either have a type annotation or be followed by '@property' or '@member' tags.\n\n // Has example showing curly brackets but not in doc signature\n [\n 'typeAllowed', true,\n ],\n\n // TypeScript may allow it to be dropped if followed by @property or @member\n // \"namepath\"\n [\n 'typeOrNameRequired', !isTypescript,\n ],\n ])),\n ],\n\n [\n 'var', new Map(/** @type {[string, string|boolean][]} */ ([\n // Allows for \"name\"'s in signature, but indicated as optional\n [\n 'namepathRole', 'namepath-defining',\n ],\n\n // Has example showing curly brackets but not in doc signature\n [\n 'typeAllowed', true,\n ],\n ])),\n ],\n\n [\n 'yields', new Map(/** @type {[string, string|boolean][]} */ ([\n // Shows curly brackets in the signature and in the examples\n [\n 'typeAllowed', true,\n ],\n ])),\n ],\n [\n 'yield', new Map(/** @type {[string, string|boolean][]} */ ([\n // Shows curly brackets in the signature and in the examples\n [\n 'typeAllowed', true,\n ],\n ])),\n ],\n ]);\n};\n\nexport default getDefaultTagStructureForMode;\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMA,6BAA6B,GAAIC,IAAI,IAAK;EAC9C,MAAMC,OAAO,GAAGD,IAAI,KAAK,OAAO;EAChC,MAAME,SAAS,GAAGF,IAAI,KAAK,SAAS;EACpC,MAAMG,YAAY,GAAGH,IAAI,KAAK,YAAY;EAC1C,MAAMI,YAAY,GAAGJ,IAAI,KAAK,YAAY;EAE1C,MAAMK,mBAAmB,GAAGJ,OAAO,IAAIG,YAAY;EACnD,MAAME,mBAAmB,GAAGL,OAAO,IAAIE,YAAY;EACnD,MAAMI,qBAAqB,GAAGJ,YAAY,IAAID,SAAS;EACvD,MAAMM,qBAAqB,GAAGN,SAAS,IAAIE,YAAY;EACvD,MAAMK,6BAA6B,GAAGH,mBAAmB,IAAIF,YAAY;;EAEzE;EACA;EACA;EACA;EACA;EACA;;EAEA;EACA;EACA;EACA;EACA;;EAEA;EACA;;EAEA;EACA;EACA;EACA;;EAEA;EACA;;EAEA;EACA;;EAEA;AACF;AACA;EACE,OAAO,IAAIM,GAAG,CAAC,CACb,CACE,OAAO,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC1D;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC;EAED;EACA,CACE,oBAAoB,EAAE,IAAI,CAC3B,CACD,CAAC,CACJ,EAED,CACE,KAAK,EAAE,IAAIA,GAAG,EAAC,yCAA2C,CACxD,CACE,cAAc,EAAE,mBAAmB,CACpC;EAED;EACA,CACE,cAAc,EAAE,IAAI,CACrB;EAED;EACA;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EAED,CACE,UAAU,EAAE,IAAIA,GAAG,EAAC,yCAA2C,CAC7D,CACE,cAAc,EAAE,mBAAmB,CACpC;EAED;EACA,CACE,cAAc,EAAE,IAAI,CACrB;EAED;EACA;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EAED,CACE,UAAU,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC7D;EACA,CACE,cAAc,EAAE,sBAAsB,CACvC;EAED;EACA,CACE,aAAa,EAAE,IAAI,CACpB;EAED;EACA,CACE,oBAAoB,EAAE,IAAI,CAC3B,CACD,CAAC,CACJ,EAED,CACE,SAAS,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC5D;EACA;EACA,CACE,cAAc,EAAE,sBAAsB,CACvC;EAED;EACA,CACE,oBAAoB,EAAE,IAAI,CAC3B,CACD,CAAC,CACJ,EAED,CACE,UAAU,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC7D;EACA;EACA;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC;EAED;EACA,CACE,cAAc,EAAE,IAAI,CACrB,CACD,CAAC,CACJ,EAED,CACE,OAAO,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC1D;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC;EAED;EACA,CACE,aAAa,EAAE,IAAI,CACpB,EAED,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EAED,CACE,OAAO,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC1D;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC,EAED,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EACD,CACE,UAAU,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC7D;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC,EAED,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EACD,CACE,aAAa,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAChE;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC,EAED,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EAED,CACE,YAAY,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC/D;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC,EAED,CACE,cAAc,EAAE,KAAK,CACtB,EAED,CACE,aAAa,EAAE,KAAK,CACrB,CACD,CAAC,CACJ,EAED,CACE,QAAQ,EAAE,IAAIA,GAAG,EAAC,yCAA2C,CAC3D,CACE,cAAc,EAAER,SAAS,CAC1B,CACD,CAAC,CACJ,EAED,CACE,OAAO,EAAE,IAAIQ,GAAG,EAAC,yCAA2C;EAC1D;EACA,CACE,cAAc,EAAE,sBAAsB,CACvC,EAED,CACE,cAAc,EAAE,IAAI,CACrB,EAED,CACE,aAAa,EAAE,KAAK,CACrB,CACD,CAAC,CACJ,EAED,CACE,MAAM,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EACzD;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EAED,CACE,OAAO,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC1D;EACA,CACE,cAAc,EAAE,IAAI,CACrB;EAED;EACA;EACA;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC,CACD,CAAC,CACJ,EAED,CACE,WAAW,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC9D;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ;EAED;EACA,CACE,QAAQ,EAAE,IAAIA,GAAG,EAAC,yCAA2C,CAC3D,CACE,aAAa,EAAEF,qBAAqB,CACrC,CACD,CAAC,CACJ,EAED,CACE,SAAS,EAAE,IAAIE,GAAG,EAAC,yCAA2C,CAC5D,CACE,cAAc,EAAE,mBAAmB,CACpC,EAED,CACE,cAAc,EAAET,OAAO,CACxB,EAED,CACE,aAAa,EAAEO,qBAAqB,CACrC,CACD,CAAC,CACJ,EAED,CACE,SAAS,EAAE,IAAIE,GAAG,EAAC,yCAA2C;EAC5D;EACA,CACE,cAAc,EAAE,sBAAsB,CACvC;EAED;EACA,CACE,aAAa,EAAEH,qBAAqB,IAAIH,YAAY,CACrD,EAED,CACE,cAAc,EAAEH,OAAO,CACxB;EAED;EACA,CACE,oBAAoB,EAAEM,qBAAqB,IAAIH,YAAY,CAC5D,CACD,CAAC,CACJ,EAED,CACE,UAAU,EAAE,IAAIM,GAAG,EAAC,yCAA2C;EAC7D;EACA;EACA;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC;EAED;EACA,CACE,cAAc,EAAE,IAAI,CACrB,EAED,CACE,aAAa,EAAE,KAAK,CACrB,CACD,CAAC,CACJ,EAED,CACE,OAAO,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC1D;EACA;EACA,CACE,cAAc,EAAE,sBAAsB,CACvC,EAED,CACE,cAAc,EAAE,IAAI,CACrB,EAED,CACE,aAAa,EAAE,KAAK,CACrB,CACD,CAAC,CACJ,EAED,CACE,UAAU,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC7D;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC,EAED,CACE,cAAc,EAAE,KAAK,CACtB,EAED,CACE,aAAa,EAAE,KAAK,CACrB,CACD,CAAC,CACJ,EACD,CACE,MAAM,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EACzD;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC,CACD,CAAC,CACJ,EAED,CACE,MAAM,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EACzD;EACA;EACA;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC;EAED;EACA,CACE,cAAc,EAAE,IAAI,CACrB,EAED,CACE,aAAa,EAAE,KAAK,CACrB,CACD,CAAC,CACJ,EAED,CACE,WAAW,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC9D;EACA,CACE,cAAc,EACdD,6BAA6B,GAAG,mBAAmB,GAAG,KAAK,CAC5D;EAED;EACA,CACE,aAAa,EAAEP,SAAS,CACzB,EAED,CACE,aAAa,EAAE,KAAK,CACrB,CACD,CAAC,CACJ,EAED,CACE,UAAU,EAAE,IAAIQ,GAAG,EAAC,yCAA2C;EAC7D;EACA,CACE,cAAc,EAAE,KAAK,CACtB;EACD;EACA,CACE,aAAa,EAAE,KAAK,CACrB,CACD,CAAC,CACJ,EAED,CACE,YAAY,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC/D;EACA;EACA,CACE,cAAc,EAAE,IAAI,CACrB,CACD,CAAC,CACJ,EAED,CACE,OAAO,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC1D;EACA,CACE,cAAc,EAAE,sBAAsB,CACvC;EAED;EACA,CACE,oBAAoB,EAAE,IAAI,CAC3B,CACD,CAAC,CACJ,EAED,CACE,MAAM,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EACzD;EACA,CACE,cAAc,EAAE,6BAA6B,CAC9C,CAED,CAAC,CACJ,EAED,CACE,UAAU,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC7D;EACA;EACA,CACE,cAAc,EAAE,6BAA6B,CAC9C,CACD,CAAC,CACJ,EAED,CACE,WAAW,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC9D;EACA;EACA,CACE,cAAc,EAAE,6BAA6B,CAC9C,CACD,CAAC,CACJ,EAED,CACE,SAAS,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC5D;EACA;EACA,CACE,cAAc,EAAE,sBAAsB,CACvC,EAED,CACE,cAAc,EAAE,IAAI,CACrB,EAED,CACE,aAAa,EAAE,KAAK,CACrB,CACD,CAAC,CACJ,EAED,CACE,QAAQ,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC3D;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC;EAED;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EAED,CACE,UAAU,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC7D;EACA;EACA,CACE,cAAc,EAAE,sBAAsB,CACvC;EAED;EACA,CACE,oBAAoB,EAAE,IAAI,CAC3B,CACD,CAAC,CACJ,EACD,CACE,WAAW,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC9D;EACA;EACA,CACE,cAAc,EAAE,sBAAsB,CACvC;EAED;EACA,CACE,oBAAoB,EAAE,IAAI,CAC3B,CACD,CAAC,CACJ,EAED,CACE,QAAQ,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC3D;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC,CACD,CAAC,CACJ,EACD,CACE,OAAO,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC1D;EACA;EACA,CACE,cAAc,EAAE,sBAAsB,CACvC;EAED;EACA,CACE,oBAAoB,EAAE,IAAI,CAC3B,CACD,CAAC,CACJ,EAED,CACE,OAAO,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC1D;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC,EAED,CACE,cAAc,EAAE,KAAK,CACtB,EAED,CACE,aAAa,EAAE,KAAK,CACrB,CACD,CAAC,CACJ,EAED,CACE,UAAU,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC7D;EACA;EACA;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EAED,CACE,QAAQ,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC3D;EACA;EACA;EACA,CACE,cAAc,EAAET,OAAO,GAAG,mBAAmB,GAAG,MAAM,CACvD;EAED;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EAED,CACE,MAAM,EAAE,IAAIS,GAAG,EAAC,yCAA2C;EACzD;EACA;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC;EAED;EACA,CACE,cAAc,EAAE,IAAI,CACrB;EAED;EACA,CACE,oBAAoB,EAAE,IAAI,CAC3B,CACD,CAAC,CACJ,EAED,CACE,WAAW,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC9D;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC;EAED;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EACD,CACE,SAAS,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC5D;EACA;EACA,CACE,aAAa,EAAEF,qBAAqB,CACrC,CACD,CAAC,CACJ,EAED,CACE,OAAO,EAAE,IAAIE,GAAG,EAAC,yCAA2C,CAC1D,CACE,cAAc,EAAE,mBAAmB,CACpC;EAED;EACA;EACA;EACA;EACA,CACE,cAAc,EAAE,IAAI,CACrB;EAED;EACA;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EAED,CACE,SAAS,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC5D;EACA;EACA,CACE,aAAa,EAAEF,qBAAqB,CACrC,CACD,CAAC,CACJ,EAED,CACE,MAAM,EAAE,IAAIE,GAAG,EAAC,yCAA2C,CACzD,CACE,cAAc,EAAE,mBAAmB,CACpC;EAED;EACA,CACE,cAAc,EAAE,IAAI,CACrB;EAED;EACA;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EAED,CACE,UAAU,EAAE,IAAIA,GAAG,EAAC,yCAA2C,CAC7D,CACE,cAAc,EAAE,mBAAmB,CACpC;EAED;EACA;EACA,CACE,cAAc,EAAE,IAAI,CACrB;EAED;EACA;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EAED,CACE,WAAW,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC9D;EACA;EACA,CACE,aAAa,EAAEF,qBAAqB,CACrC,CACD,CAAC,CACJ,EAED,CACE,QAAQ,EAAE,IAAIE,GAAG,EAAC,yCAA2C;EAC3D;EACA,CACE,aAAa,EAAEF,qBAAqB,CACrC,CACD,CAAC,CACJ,EAED,CACE,UAAU,EAAE,IAAIE,GAAG,EAAC,yCAA2C;EAC7D;EACA,CACE,cAAc,EAAE,sBAAsB,CACvC,EAED,CACE,cAAc,EAAE,IAAI,CACrB,EAED,CACE,aAAa,EAAE,KAAK,CACrB,CACD,CAAC,CACJ,EAED,CACE,SAAS,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC5D;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EACD,CACE,QAAQ,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC3D;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EAED,CACE,WAAW,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC9D;EACA,CACE,cAAc,EAAE,IAAI,CACrB,CACD,CAAC,CACJ,EAED,CACE,KAAK,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EACxD;EACA;EACA,CACE,cAAc,EAAE,MAAM,CACvB,CACD,CAAC,CACJ,EAED,CACE,QAAQ,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC3D;EACA,CACE,aAAa,EAAEF,qBAAqB,CACrC,CACD,CAAC,CACJ,EAED,CACE,UAAU,EAAE,IAAIE,GAAG,EAAC,yCAA2C,CAC7D,CACE,cAAc,EAAE,CAACR,SAAS,CAC3B,EACD,CACE,cAAc,EAAEA,SAAS,CAC1B,CACD,CAAC,CACJ,EAED,CACE,UAAU,EAAE,IAAIQ,GAAG,EAAC,yCAA2C,CAC7D,CACE,cAAc,EAAET,OAAO,GAAG,MAAM,GAAG,sBAAsB,CAC1D,EAED,CACE,cAAc,EAAE,CAACA,OAAO,CACzB;EAED;EACA;EACA;EACA,CACE,aAAa,EAAEM,qBAAqB,IAAIH,YAAY,CACrD,CACD,CAAC,CACJ,EAED,CACE,MAAM,EAAE,IAAIM,GAAG,EAAC,yCAA2C;EACzD;EACA;EACA,CACE,cAAc,EAAET,OAAO,GAAG,sBAAsB,GAAG,KAAK,CACzD,EAED,CACE,cAAc,EAAEM,qBAAqB,CACtC;EAED;EACA,CACE,oBAAoB,EAAEN,OAAO,CAC9B,CACD,CAAC,CACJ,EAED,CACE,QAAQ,EAAE,IAAIS,GAAG,EAAC,yCAA2C;EAC3D;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EAED,CACE,UAAU,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC7D;EACA,CACE,cAAc,EAAE,IAAI,CACrB,EAED,CACE,aAAa,EAAE,KAAK,CACrB,CACD,CAAC,CACJ,EAED,CACE,MAAM,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EACzD;EACA;EACA,CACE,cAAc,EAAE,IAAI,CACrB,CACD,CAAC,CACJ,EAED,CACE,SAAS,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC5D;EACA;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC;EAED;EACA;EACA;EACA,CACE,cAAc,EAAEL,mBAAmB,CACpC;EAED;EACA;;EAEA;EACA,CACE,aAAa,EAAE,IAAI,CACpB;EAED;EACA;EACA,CACE,oBAAoB,EAAE,CAACF,YAAY,CACpC,CACD,CAAC,CACJ,EAED,CACE,KAAK,EAAE,IAAIO,GAAG,EAAC,yCAA2C;EACxD;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC;EAED;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EAED,CACE,QAAQ,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC3D;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EACD,CACE,OAAO,EAAE,IAAIA,GAAG,EAAC,yCAA2C;EAC1D;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,CACF,CAAC;AACJ,CAAC;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAC,OAAA,GAEad,6BAA6B;AAAAe,MAAA,CAAAF,OAAA,GAAAA,OAAA,CAAAC,OAAA"}
|
|
@@ -4,59 +4,59 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
4
4
|
value: true
|
|
5
5
|
});
|
|
6
6
|
exports.default = void 0;
|
|
7
|
-
var _checkAccess = _interopRequireDefault(require("./rules/checkAccess.
|
|
8
|
-
var _checkAlignment = _interopRequireDefault(require("./rules/checkAlignment.
|
|
9
|
-
var _checkExamples = _interopRequireDefault(require("./rules/checkExamples.
|
|
10
|
-
var _checkIndentation = _interopRequireDefault(require("./rules/checkIndentation.
|
|
11
|
-
var _checkLineAlignment = _interopRequireDefault(require("./rules/checkLineAlignment.
|
|
12
|
-
var _checkParamNames = _interopRequireDefault(require("./rules/checkParamNames.
|
|
13
|
-
var _checkPropertyNames = _interopRequireDefault(require("./rules/checkPropertyNames.
|
|
14
|
-
var _checkSyntax = _interopRequireDefault(require("./rules/checkSyntax.
|
|
15
|
-
var _checkTagNames = _interopRequireDefault(require("./rules/checkTagNames.
|
|
16
|
-
var _checkTypes = _interopRequireDefault(require("./rules/checkTypes.
|
|
17
|
-
var _checkValues = _interopRequireDefault(require("./rules/checkValues.
|
|
18
|
-
var _emptyTags = _interopRequireDefault(require("./rules/emptyTags.
|
|
19
|
-
var _implementsOnClasses = _interopRequireDefault(require("./rules/implementsOnClasses.
|
|
20
|
-
var _importsAsDependencies = _interopRequireDefault(require("./rules/importsAsDependencies.
|
|
21
|
-
var _informativeDocs = _interopRequireDefault(require("./rules/informativeDocs.
|
|
22
|
-
var _matchDescription = _interopRequireDefault(require("./rules/matchDescription.
|
|
23
|
-
var _matchName = _interopRequireDefault(require("./rules/matchName.
|
|
24
|
-
var _multilineBlocks = _interopRequireDefault(require("./rules/multilineBlocks.
|
|
25
|
-
var _noBadBlocks = _interopRequireDefault(require("./rules/noBadBlocks.
|
|
26
|
-
var _noBlankBlockDescriptions = _interopRequireDefault(require("./rules/noBlankBlockDescriptions.
|
|
27
|
-
var _noBlankBlocks = _interopRequireDefault(require("./rules/noBlankBlocks.
|
|
28
|
-
var _noDefaults = _interopRequireDefault(require("./rules/noDefaults.
|
|
29
|
-
var _noMissingSyntax = _interopRequireDefault(require("./rules/noMissingSyntax.
|
|
30
|
-
var _noMultiAsterisks = _interopRequireDefault(require("./rules/noMultiAsterisks.
|
|
31
|
-
var _noRestrictedSyntax = _interopRequireDefault(require("./rules/noRestrictedSyntax.
|
|
32
|
-
var _noTypes = _interopRequireDefault(require("./rules/noTypes.
|
|
33
|
-
var _noUndefinedTypes = _interopRequireDefault(require("./rules/noUndefinedTypes.
|
|
34
|
-
var _requireAsteriskPrefix = _interopRequireDefault(require("./rules/requireAsteriskPrefix.
|
|
35
|
-
var _requireDescription = _interopRequireDefault(require("./rules/requireDescription.
|
|
36
|
-
var _requireDescriptionCompleteSentence = _interopRequireDefault(require("./rules/requireDescriptionCompleteSentence.
|
|
37
|
-
var _requireExample = _interopRequireDefault(require("./rules/requireExample.
|
|
38
|
-
var _requireFileOverview = _interopRequireDefault(require("./rules/requireFileOverview.
|
|
39
|
-
var _requireHyphenBeforeParamDescription = _interopRequireDefault(require("./rules/requireHyphenBeforeParamDescription.
|
|
40
|
-
var _requireJsdoc = _interopRequireDefault(require("./rules/requireJsdoc.
|
|
41
|
-
var _requireParam = _interopRequireDefault(require("./rules/requireParam.
|
|
42
|
-
var _requireParamDescription = _interopRequireDefault(require("./rules/requireParamDescription.
|
|
43
|
-
var _requireParamName = _interopRequireDefault(require("./rules/requireParamName.
|
|
44
|
-
var _requireParamType = _interopRequireDefault(require("./rules/requireParamType.
|
|
45
|
-
var _requireProperty = _interopRequireDefault(require("./rules/requireProperty.
|
|
46
|
-
var _requirePropertyDescription = _interopRequireDefault(require("./rules/requirePropertyDescription.
|
|
47
|
-
var _requirePropertyName = _interopRequireDefault(require("./rules/requirePropertyName.
|
|
48
|
-
var _requirePropertyType = _interopRequireDefault(require("./rules/requirePropertyType.
|
|
49
|
-
var _requireReturns = _interopRequireDefault(require("./rules/requireReturns.
|
|
50
|
-
var _requireReturnsCheck = _interopRequireDefault(require("./rules/requireReturnsCheck.
|
|
51
|
-
var _requireReturnsDescription = _interopRequireDefault(require("./rules/requireReturnsDescription.
|
|
52
|
-
var _requireReturnsType = _interopRequireDefault(require("./rules/requireReturnsType.
|
|
53
|
-
var _requireThrows = _interopRequireDefault(require("./rules/requireThrows.
|
|
54
|
-
var _requireYields = _interopRequireDefault(require("./rules/requireYields.
|
|
55
|
-
var _requireYieldsCheck = _interopRequireDefault(require("./rules/requireYieldsCheck.
|
|
56
|
-
var _sortTags = _interopRequireDefault(require("./rules/sortTags.
|
|
57
|
-
var _tagLines = _interopRequireDefault(require("./rules/tagLines.
|
|
58
|
-
var _textEscaping = _interopRequireDefault(require("./rules/textEscaping.
|
|
59
|
-
var _validTypes = _interopRequireDefault(require("./rules/validTypes.
|
|
7
|
+
var _checkAccess = _interopRequireDefault(require("./rules/checkAccess.cjs"));
|
|
8
|
+
var _checkAlignment = _interopRequireDefault(require("./rules/checkAlignment.cjs"));
|
|
9
|
+
var _checkExamples = _interopRequireDefault(require("./rules/checkExamples.cjs"));
|
|
10
|
+
var _checkIndentation = _interopRequireDefault(require("./rules/checkIndentation.cjs"));
|
|
11
|
+
var _checkLineAlignment = _interopRequireDefault(require("./rules/checkLineAlignment.cjs"));
|
|
12
|
+
var _checkParamNames = _interopRequireDefault(require("./rules/checkParamNames.cjs"));
|
|
13
|
+
var _checkPropertyNames = _interopRequireDefault(require("./rules/checkPropertyNames.cjs"));
|
|
14
|
+
var _checkSyntax = _interopRequireDefault(require("./rules/checkSyntax.cjs"));
|
|
15
|
+
var _checkTagNames = _interopRequireDefault(require("./rules/checkTagNames.cjs"));
|
|
16
|
+
var _checkTypes = _interopRequireDefault(require("./rules/checkTypes.cjs"));
|
|
17
|
+
var _checkValues = _interopRequireDefault(require("./rules/checkValues.cjs"));
|
|
18
|
+
var _emptyTags = _interopRequireDefault(require("./rules/emptyTags.cjs"));
|
|
19
|
+
var _implementsOnClasses = _interopRequireDefault(require("./rules/implementsOnClasses.cjs"));
|
|
20
|
+
var _importsAsDependencies = _interopRequireDefault(require("./rules/importsAsDependencies.cjs"));
|
|
21
|
+
var _informativeDocs = _interopRequireDefault(require("./rules/informativeDocs.cjs"));
|
|
22
|
+
var _matchDescription = _interopRequireDefault(require("./rules/matchDescription.cjs"));
|
|
23
|
+
var _matchName = _interopRequireDefault(require("./rules/matchName.cjs"));
|
|
24
|
+
var _multilineBlocks = _interopRequireDefault(require("./rules/multilineBlocks.cjs"));
|
|
25
|
+
var _noBadBlocks = _interopRequireDefault(require("./rules/noBadBlocks.cjs"));
|
|
26
|
+
var _noBlankBlockDescriptions = _interopRequireDefault(require("./rules/noBlankBlockDescriptions.cjs"));
|
|
27
|
+
var _noBlankBlocks = _interopRequireDefault(require("./rules/noBlankBlocks.cjs"));
|
|
28
|
+
var _noDefaults = _interopRequireDefault(require("./rules/noDefaults.cjs"));
|
|
29
|
+
var _noMissingSyntax = _interopRequireDefault(require("./rules/noMissingSyntax.cjs"));
|
|
30
|
+
var _noMultiAsterisks = _interopRequireDefault(require("./rules/noMultiAsterisks.cjs"));
|
|
31
|
+
var _noRestrictedSyntax = _interopRequireDefault(require("./rules/noRestrictedSyntax.cjs"));
|
|
32
|
+
var _noTypes = _interopRequireDefault(require("./rules/noTypes.cjs"));
|
|
33
|
+
var _noUndefinedTypes = _interopRequireDefault(require("./rules/noUndefinedTypes.cjs"));
|
|
34
|
+
var _requireAsteriskPrefix = _interopRequireDefault(require("./rules/requireAsteriskPrefix.cjs"));
|
|
35
|
+
var _requireDescription = _interopRequireDefault(require("./rules/requireDescription.cjs"));
|
|
36
|
+
var _requireDescriptionCompleteSentence = _interopRequireDefault(require("./rules/requireDescriptionCompleteSentence.cjs"));
|
|
37
|
+
var _requireExample = _interopRequireDefault(require("./rules/requireExample.cjs"));
|
|
38
|
+
var _requireFileOverview = _interopRequireDefault(require("./rules/requireFileOverview.cjs"));
|
|
39
|
+
var _requireHyphenBeforeParamDescription = _interopRequireDefault(require("./rules/requireHyphenBeforeParamDescription.cjs"));
|
|
40
|
+
var _requireJsdoc = _interopRequireDefault(require("./rules/requireJsdoc.cjs"));
|
|
41
|
+
var _requireParam = _interopRequireDefault(require("./rules/requireParam.cjs"));
|
|
42
|
+
var _requireParamDescription = _interopRequireDefault(require("./rules/requireParamDescription.cjs"));
|
|
43
|
+
var _requireParamName = _interopRequireDefault(require("./rules/requireParamName.cjs"));
|
|
44
|
+
var _requireParamType = _interopRequireDefault(require("./rules/requireParamType.cjs"));
|
|
45
|
+
var _requireProperty = _interopRequireDefault(require("./rules/requireProperty.cjs"));
|
|
46
|
+
var _requirePropertyDescription = _interopRequireDefault(require("./rules/requirePropertyDescription.cjs"));
|
|
47
|
+
var _requirePropertyName = _interopRequireDefault(require("./rules/requirePropertyName.cjs"));
|
|
48
|
+
var _requirePropertyType = _interopRequireDefault(require("./rules/requirePropertyType.cjs"));
|
|
49
|
+
var _requireReturns = _interopRequireDefault(require("./rules/requireReturns.cjs"));
|
|
50
|
+
var _requireReturnsCheck = _interopRequireDefault(require("./rules/requireReturnsCheck.cjs"));
|
|
51
|
+
var _requireReturnsDescription = _interopRequireDefault(require("./rules/requireReturnsDescription.cjs"));
|
|
52
|
+
var _requireReturnsType = _interopRequireDefault(require("./rules/requireReturnsType.cjs"));
|
|
53
|
+
var _requireThrows = _interopRequireDefault(require("./rules/requireThrows.cjs"));
|
|
54
|
+
var _requireYields = _interopRequireDefault(require("./rules/requireYields.cjs"));
|
|
55
|
+
var _requireYieldsCheck = _interopRequireDefault(require("./rules/requireYieldsCheck.cjs"));
|
|
56
|
+
var _sortTags = _interopRequireDefault(require("./rules/sortTags.cjs"));
|
|
57
|
+
var _tagLines = _interopRequireDefault(require("./rules/tagLines.cjs"));
|
|
58
|
+
var _textEscaping = _interopRequireDefault(require("./rules/textEscaping.cjs"));
|
|
59
|
+
var _validTypes = _interopRequireDefault(require("./rules/validTypes.cjs"));
|
|
60
60
|
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
61
61
|
/**
|
|
62
62
|
* @type {import('eslint').ESLint.Plugin & {
|
|
@@ -68,7 +68,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
|
|
|
68
68
|
* "flat/recommended-typescript-error"|
|
|
69
69
|
* "flat/recommended-typescript-flavor"|
|
|
70
70
|
* "flat/recommended-typescript-flavor-error",
|
|
71
|
-
* import('eslint').
|
|
71
|
+
* import('eslint').Linter.FlatConfig
|
|
72
72
|
* >
|
|
73
73
|
* }}
|
|
74
74
|
*/
|
|
@@ -135,10 +135,11 @@ const index = {
|
|
|
135
135
|
/**
|
|
136
136
|
* @param {"warn"|"error"} warnOrError
|
|
137
137
|
* @param {boolean} [flat]
|
|
138
|
-
* @returns {import('eslint').
|
|
138
|
+
* @returns {import('eslint').Linter.FlatConfig}
|
|
139
139
|
*/
|
|
140
140
|
const createRecommendedRuleset = (warnOrError, flat) => {
|
|
141
141
|
return {
|
|
142
|
+
// @ts-expect-error Ok
|
|
142
143
|
plugins: flat ? {
|
|
143
144
|
jsdoc: index
|
|
144
145
|
} : ['jsdoc'],
|
|
@@ -203,7 +204,7 @@ const createRecommendedRuleset = (warnOrError, flat) => {
|
|
|
203
204
|
/**
|
|
204
205
|
* @param {"warn"|"error"} warnOrError
|
|
205
206
|
* @param {boolean} [flat]
|
|
206
|
-
* @returns {import('eslint').
|
|
207
|
+
* @returns {import('eslint').Linter.FlatConfig}
|
|
207
208
|
*/
|
|
208
209
|
const createRecommendedTypeScriptRuleset = (warnOrError, flat) => {
|
|
209
210
|
const ruleset = createRecommendedRuleset(warnOrError, flat);
|
|
@@ -228,7 +229,7 @@ const createRecommendedTypeScriptRuleset = (warnOrError, flat) => {
|
|
|
228
229
|
/**
|
|
229
230
|
* @param {"warn"|"error"} warnOrError
|
|
230
231
|
* @param {boolean} [flat]
|
|
231
|
-
* @returns {import('eslint').
|
|
232
|
+
* @returns {import('eslint').Linter.FlatConfig}
|
|
232
233
|
*/
|
|
233
234
|
const createRecommendedTypeScriptFlavorRuleset = (warnOrError, flat) => {
|
|
234
235
|
const ruleset = createRecommendedRuleset(warnOrError, flat);
|
|
@@ -243,7 +244,7 @@ const createRecommendedTypeScriptFlavorRuleset = (warnOrError, flat) => {
|
|
|
243
244
|
};
|
|
244
245
|
};
|
|
245
246
|
|
|
246
|
-
/*
|
|
247
|
+
/* c8 ignore next 3 -- TS */
|
|
247
248
|
if (!index.configs) {
|
|
248
249
|
throw new Error('TypeScript guard');
|
|
249
250
|
}
|
|
@@ -261,4 +262,4 @@ index.configs['flat/recommended-typescript-flavor'] = createRecommendedTypeScrip
|
|
|
261
262
|
index.configs['flat/recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error', true);
|
|
262
263
|
var _default = exports.default = index;
|
|
263
264
|
module.exports = exports.default;
|
|
264
|
-
//# sourceMappingURL=index.
|
|
265
|
+
//# sourceMappingURL=index.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.cjs","names":["_checkAccess","_interopRequireDefault","require","_checkAlignment","_checkExamples","_checkIndentation","_checkLineAlignment","_checkParamNames","_checkPropertyNames","_checkSyntax","_checkTagNames","_checkTypes","_checkValues","_emptyTags","_implementsOnClasses","_importsAsDependencies","_informativeDocs","_matchDescription","_matchName","_multilineBlocks","_noBadBlocks","_noBlankBlockDescriptions","_noBlankBlocks","_noDefaults","_noMissingSyntax","_noMultiAsterisks","_noRestrictedSyntax","_noTypes","_noUndefinedTypes","_requireAsteriskPrefix","_requireDescription","_requireDescriptionCompleteSentence","_requireExample","_requireFileOverview","_requireHyphenBeforeParamDescription","_requireJsdoc","_requireParam","_requireParamDescription","_requireParamName","_requireParamType","_requireProperty","_requirePropertyDescription","_requirePropertyName","_requirePropertyType","_requireReturns","_requireReturnsCheck","_requireReturnsDescription","_requireReturnsType","_requireThrows","_requireYields","_requireYieldsCheck","_sortTags","_tagLines","_textEscaping","_validTypes","obj","__esModule","default","index","configs","rules","checkAccess","checkAlignment","checkExamples","checkIndentation","checkLineAlignment","checkParamNames","checkPropertyNames","checkSyntax","checkTagNames","checkTypes","checkValues","emptyTags","implementsOnClasses","importsAsDependencies","informativeDocs","matchDescription","matchName","multilineBlocks","noBadBlocks","noBlankBlockDescriptions","noBlankBlocks","noDefaults","noMissingSyntax","noMultiAsterisks","noRestrictedSyntax","noTypes","noUndefinedTypes","requireAsteriskPrefix","requireDescription","requireDescriptionCompleteSentence","requireExample","requireFileOverview","requireHyphenBeforeParamDescription","requireJsdoc","requireParam","requireParamDescription","requireParamName","requireParamType","requireProperty","requirePropertyDescription","requirePropertyName","requirePropertyType","requireReturns","requireReturnsCheck","requireReturnsDescription","requireReturnsType","requireThrows","requireYields","requireYieldsCheck","sortTags","tagLines","textEscaping","validTypes","createRecommendedRuleset","warnOrError","flat","plugins","jsdoc","createRecommendedTypeScriptRuleset","ruleset","typed","createRecommendedTypeScriptFlavorRuleset","Error","recommended","_default","exports","module"],"sources":["../src/index.js"],"sourcesContent":["import checkAccess from './rules/checkAccess.js';\nimport checkAlignment from './rules/checkAlignment.js';\nimport checkExamples from './rules/checkExamples.js';\nimport checkIndentation from './rules/checkIndentation.js';\nimport checkLineAlignment from './rules/checkLineAlignment.js';\nimport checkParamNames from './rules/checkParamNames.js';\nimport checkPropertyNames from './rules/checkPropertyNames.js';\nimport checkSyntax from './rules/checkSyntax.js';\nimport checkTagNames from './rules/checkTagNames.js';\nimport checkTypes from './rules/checkTypes.js';\nimport checkValues from './rules/checkValues.js';\nimport emptyTags from './rules/emptyTags.js';\nimport implementsOnClasses from './rules/implementsOnClasses.js';\nimport importsAsDependencies from './rules/importsAsDependencies.js';\nimport informativeDocs from './rules/informativeDocs.js';\nimport matchDescription from './rules/matchDescription.js';\nimport matchName from './rules/matchName.js';\nimport multilineBlocks from './rules/multilineBlocks.js';\nimport noBadBlocks from './rules/noBadBlocks.js';\nimport noBlankBlockDescriptions from './rules/noBlankBlockDescriptions.js';\nimport noBlankBlocks from './rules/noBlankBlocks.js';\nimport noDefaults from './rules/noDefaults.js';\nimport noMissingSyntax from './rules/noMissingSyntax.js';\nimport noMultiAsterisks from './rules/noMultiAsterisks.js';\nimport noRestrictedSyntax from './rules/noRestrictedSyntax.js';\nimport noTypes from './rules/noTypes.js';\nimport noUndefinedTypes from './rules/noUndefinedTypes.js';\nimport requireAsteriskPrefix from './rules/requireAsteriskPrefix.js';\nimport requireDescription from './rules/requireDescription.js';\nimport requireDescriptionCompleteSentence from './rules/requireDescriptionCompleteSentence.js';\nimport requireExample from './rules/requireExample.js';\nimport requireFileOverview from './rules/requireFileOverview.js';\nimport requireHyphenBeforeParamDescription from './rules/requireHyphenBeforeParamDescription.js';\nimport requireJsdoc from './rules/requireJsdoc.js';\nimport requireParam from './rules/requireParam.js';\nimport requireParamDescription from './rules/requireParamDescription.js';\nimport requireParamName from './rules/requireParamName.js';\nimport requireParamType from './rules/requireParamType.js';\nimport requireProperty from './rules/requireProperty.js';\nimport requirePropertyDescription from './rules/requirePropertyDescription.js';\nimport requirePropertyName from './rules/requirePropertyName.js';\nimport requirePropertyType from './rules/requirePropertyType.js';\nimport requireReturns from './rules/requireReturns.js';\nimport requireReturnsCheck from './rules/requireReturnsCheck.js';\nimport requireReturnsDescription from './rules/requireReturnsDescription.js';\nimport requireReturnsType from './rules/requireReturnsType.js';\nimport requireThrows from './rules/requireThrows.js';\nimport requireYields from './rules/requireYields.js';\nimport requireYieldsCheck from './rules/requireYieldsCheck.js';\nimport sortTags from './rules/sortTags.js';\nimport tagLines from './rules/tagLines.js';\nimport textEscaping from './rules/textEscaping.js';\nimport validTypes from './rules/validTypes.js';\n\n/**\n * @type {import('eslint').ESLint.Plugin & {\n * configs: Record<\n * \"recommended\"|\"recommended-error\"|\"recommended-typescript\"|\n * \"recommended-typescript-error\"|\"recommended-typescript-flavor\"|\n * \"recommended-typescript-flavor-error\"|\"flat/recommended\"|\n * \"flat/recommended-error\"|\"flat/recommended-typescript\"|\n * \"flat/recommended-typescript-error\"|\n * \"flat/recommended-typescript-flavor\"|\n * \"flat/recommended-typescript-flavor-error\",\n * import('eslint').Linter.FlatConfig\n * >\n * }}\n */\nconst index = {\n // @ts-expect-error Ok\n configs: {},\n rules: {\n 'check-access': checkAccess,\n 'check-alignment': checkAlignment,\n 'check-examples': checkExamples,\n 'check-indentation': checkIndentation,\n 'check-line-alignment': checkLineAlignment,\n 'check-param-names': checkParamNames,\n 'check-property-names': checkPropertyNames,\n 'check-syntax': checkSyntax,\n 'check-tag-names': checkTagNames,\n 'check-types': checkTypes,\n 'check-values': checkValues,\n 'empty-tags': emptyTags,\n 'implements-on-classes': implementsOnClasses,\n 'imports-as-dependencies': importsAsDependencies,\n 'informative-docs': informativeDocs,\n 'match-description': matchDescription,\n 'match-name': matchName,\n 'multiline-blocks': multilineBlocks,\n 'no-bad-blocks': noBadBlocks,\n 'no-blank-block-descriptions': noBlankBlockDescriptions,\n 'no-blank-blocks': noBlankBlocks,\n 'no-defaults': noDefaults,\n 'no-missing-syntax': noMissingSyntax,\n 'no-multi-asterisks': noMultiAsterisks,\n 'no-restricted-syntax': noRestrictedSyntax,\n 'no-types': noTypes,\n 'no-undefined-types': noUndefinedTypes,\n 'require-asterisk-prefix': requireAsteriskPrefix,\n 'require-description': requireDescription,\n 'require-description-complete-sentence': requireDescriptionCompleteSentence,\n 'require-example': requireExample,\n 'require-file-overview': requireFileOverview,\n 'require-hyphen-before-param-description': requireHyphenBeforeParamDescription,\n 'require-jsdoc': requireJsdoc,\n 'require-param': requireParam,\n 'require-param-description': requireParamDescription,\n 'require-param-name': requireParamName,\n 'require-param-type': requireParamType,\n 'require-property': requireProperty,\n 'require-property-description': requirePropertyDescription,\n 'require-property-name': requirePropertyName,\n 'require-property-type': requirePropertyType,\n 'require-returns': requireReturns,\n 'require-returns-check': requireReturnsCheck,\n 'require-returns-description': requireReturnsDescription,\n 'require-returns-type': requireReturnsType,\n 'require-throws': requireThrows,\n 'require-yields': requireYields,\n 'require-yields-check': requireYieldsCheck,\n 'sort-tags': sortTags,\n 'tag-lines': tagLines,\n 'text-escaping': textEscaping,\n 'valid-types': validTypes,\n },\n};\n\n/**\n * @param {\"warn\"|\"error\"} warnOrError\n * @param {boolean} [flat]\n * @returns {import('eslint').Linter.FlatConfig}\n */\nconst createRecommendedRuleset = (warnOrError, flat) => {\n return {\n // @ts-expect-error Ok\n plugins: flat ? {\n jsdoc: index,\n } : [\n 'jsdoc',\n ],\n rules: {\n 'jsdoc/check-access': warnOrError,\n 'jsdoc/check-alignment': warnOrError,\n 'jsdoc/check-examples': 'off',\n 'jsdoc/check-indentation': 'off',\n 'jsdoc/check-line-alignment': 'off',\n 'jsdoc/check-param-names': warnOrError,\n 'jsdoc/check-property-names': warnOrError,\n 'jsdoc/check-syntax': 'off',\n 'jsdoc/check-tag-names': warnOrError,\n 'jsdoc/check-types': warnOrError,\n 'jsdoc/check-values': warnOrError,\n 'jsdoc/empty-tags': warnOrError,\n 'jsdoc/implements-on-classes': warnOrError,\n 'jsdoc/imports-as-dependencies': 'off',\n 'jsdoc/informative-docs': 'off',\n 'jsdoc/match-description': 'off',\n 'jsdoc/match-name': 'off',\n 'jsdoc/multiline-blocks': warnOrError,\n 'jsdoc/no-bad-blocks': 'off',\n 'jsdoc/no-blank-block-descriptions': 'off',\n 'jsdoc/no-blank-blocks': 'off',\n 'jsdoc/no-defaults': warnOrError,\n 'jsdoc/no-missing-syntax': 'off',\n 'jsdoc/no-multi-asterisks': warnOrError,\n 'jsdoc/no-restricted-syntax': 'off',\n 'jsdoc/no-types': 'off',\n 'jsdoc/no-undefined-types': warnOrError,\n 'jsdoc/require-asterisk-prefix': 'off',\n 'jsdoc/require-description': 'off',\n 'jsdoc/require-description-complete-sentence': 'off',\n 'jsdoc/require-example': 'off',\n 'jsdoc/require-file-overview': 'off',\n 'jsdoc/require-hyphen-before-param-description': 'off',\n 'jsdoc/require-jsdoc': warnOrError,\n 'jsdoc/require-param': warnOrError,\n 'jsdoc/require-param-description': warnOrError,\n 'jsdoc/require-param-name': warnOrError,\n 'jsdoc/require-param-type': warnOrError,\n 'jsdoc/require-property': warnOrError,\n 'jsdoc/require-property-description': warnOrError,\n 'jsdoc/require-property-name': warnOrError,\n 'jsdoc/require-property-type': warnOrError,\n 'jsdoc/require-returns': warnOrError,\n 'jsdoc/require-returns-check': warnOrError,\n 'jsdoc/require-returns-description': warnOrError,\n 'jsdoc/require-returns-type': warnOrError,\n 'jsdoc/require-throws': 'off',\n 'jsdoc/require-yields': warnOrError,\n 'jsdoc/require-yields-check': warnOrError,\n 'jsdoc/sort-tags': 'off',\n 'jsdoc/tag-lines': warnOrError,\n 'jsdoc/text-escaping': 'off',\n 'jsdoc/valid-types': warnOrError,\n },\n };\n};\n\n/**\n * @param {\"warn\"|\"error\"} warnOrError\n * @param {boolean} [flat]\n * @returns {import('eslint').Linter.FlatConfig}\n */\nconst createRecommendedTypeScriptRuleset = (warnOrError, flat) => {\n const ruleset = createRecommendedRuleset(warnOrError, flat);\n\n return {\n ...ruleset,\n rules: {\n ...ruleset.rules,\n /* eslint-disable indent -- Extra indent to avoid use by auto-rule-editing */\n 'jsdoc/check-tag-names': [\n warnOrError, {\n typed: true,\n },\n ],\n 'jsdoc/no-types': warnOrError,\n 'jsdoc/no-undefined-types': 'off',\n 'jsdoc/require-param-type': 'off',\n 'jsdoc/require-property-type': 'off',\n 'jsdoc/require-returns-type': 'off',\n /* eslint-enable indent */\n },\n };\n};\n\n/**\n * @param {\"warn\"|\"error\"} warnOrError\n * @param {boolean} [flat]\n * @returns {import('eslint').Linter.FlatConfig}\n */\nconst createRecommendedTypeScriptFlavorRuleset = (warnOrError, flat) => {\n const ruleset = createRecommendedRuleset(warnOrError, flat);\n\n return {\n ...ruleset,\n rules: {\n ...ruleset.rules,\n /* eslint-disable indent -- Extra indent to avoid use by auto-rule-editing */\n 'jsdoc/no-undefined-types': 'off',\n /* eslint-enable indent */\n },\n };\n};\n\n/* c8 ignore next 3 -- TS */\nif (!index.configs) {\n throw new Error('TypeScript guard');\n}\n\nindex.configs.recommended = createRecommendedRuleset('warn');\nindex.configs['recommended-error'] = createRecommendedRuleset('error');\nindex.configs['recommended-typescript'] = createRecommendedTypeScriptRuleset('warn');\nindex.configs['recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error');\nindex.configs['recommended-typescript-flavor'] = createRecommendedTypeScriptFlavorRuleset('warn');\nindex.configs['recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error');\n\nindex.configs['flat/recommended'] = createRecommendedRuleset('warn', true);\nindex.configs['flat/recommended-error'] = createRecommendedRuleset('error', true);\nindex.configs['flat/recommended-typescript'] = createRecommendedTypeScriptRuleset('warn', true);\nindex.configs['flat/recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error', true);\nindex.configs['flat/recommended-typescript-flavor'] = createRecommendedTypeScriptFlavorRuleset('warn', true);\nindex.configs['flat/recommended-typescript-flavor-error'] = createRecommendedTypeScriptFlavorRuleset('error', true);\n\nexport default index;\n"],"mappings":";;;;;;AAAA,IAAAA,YAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,eAAA,GAAAF,sBAAA,CAAAC,OAAA;AACA,IAAAE,cAAA,GAAAH,sBAAA,CAAAC,OAAA;AACA,IAAAG,iBAAA,GAAAJ,sBAAA,CAAAC,OAAA;AACA,IAAAI,mBAAA,GAAAL,sBAAA,CAAAC,OAAA;AACA,IAAAK,gBAAA,GAAAN,sBAAA,CAAAC,OAAA;AACA,IAAAM,mBAAA,GAAAP,sBAAA,CAAAC,OAAA;AACA,IAAAO,YAAA,GAAAR,sBAAA,CAAAC,OAAA;AACA,IAAAQ,cAAA,GAAAT,sBAAA,CAAAC,OAAA;AACA,IAAAS,WAAA,GAAAV,sBAAA,CAAAC,OAAA;AACA,IAAAU,YAAA,GAAAX,sBAAA,CAAAC,OAAA;AACA,IAAAW,UAAA,GAAAZ,sBAAA,CAAAC,OAAA;AACA,IAAAY,oBAAA,GAAAb,sBAAA,CAAAC,OAAA;AACA,IAAAa,sBAAA,GAAAd,sBAAA,CAAAC,OAAA;AACA,IAAAc,gBAAA,GAAAf,sBAAA,CAAAC,OAAA;AACA,IAAAe,iBAAA,GAAAhB,sBAAA,CAAAC,OAAA;AACA,IAAAgB,UAAA,GAAAjB,sBAAA,CAAAC,OAAA;AACA,IAAAiB,gBAAA,GAAAlB,sBAAA,CAAAC,OAAA;AACA,IAAAkB,YAAA,GAAAnB,sBAAA,CAAAC,OAAA;AACA,IAAAmB,yBAAA,GAAApB,sBAAA,CAAAC,OAAA;AACA,IAAAoB,cAAA,GAAArB,sBAAA,CAAAC,OAAA;AACA,IAAAqB,WAAA,GAAAtB,sBAAA,CAAAC,OAAA;AACA,IAAAsB,gBAAA,GAAAvB,sBAAA,CAAAC,OAAA;AACA,IAAAuB,iBAAA,GAAAxB,sBAAA,CAAAC,OAAA;AACA,IAAAwB,mBAAA,GAAAzB,sBAAA,CAAAC,OAAA;AACA,IAAAyB,QAAA,GAAA1B,sBAAA,CAAAC,OAAA;AACA,IAAA0B,iBAAA,GAAA3B,sBAAA,CAAAC,OAAA;AACA,IAAA2B,sBAAA,GAAA5B,sBAAA,CAAAC,OAAA;AACA,IAAA4B,mBAAA,GAAA7B,sBAAA,CAAAC,OAAA;AACA,IAAA6B,mCAAA,GAAA9B,sBAAA,CAAAC,OAAA;AACA,IAAA8B,eAAA,GAAA/B,sBAAA,CAAAC,OAAA;AACA,IAAA+B,oBAAA,GAAAhC,sBAAA,CAAAC,OAAA;AACA,IAAAgC,oCAAA,GAAAjC,sBAAA,CAAAC,OAAA;AACA,IAAAiC,aAAA,GAAAlC,sBAAA,CAAAC,OAAA;AACA,IAAAkC,aAAA,GAAAnC,sBAAA,CAAAC,OAAA;AACA,IAAAmC,wBAAA,GAAApC,sBAAA,CAAAC,OAAA;AACA,IAAAoC,iBAAA,GAAArC,sBAAA,CAAAC,OAAA;AACA,IAAAqC,iBAAA,GAAAtC,sBAAA,CAAAC,OAAA;AACA,IAAAsC,gBAAA,GAAAvC,sBAAA,CAAAC,OAAA;AACA,IAAAuC,2BAAA,GAAAxC,sBAAA,CAAAC,OAAA;AACA,IAAAwC,oBAAA,GAAAzC,sBAAA,CAAAC,OAAA;AACA,IAAAyC,oBAAA,GAAA1C,sBAAA,CAAAC,OAAA;AACA,IAAA0C,eAAA,GAAA3C,sBAAA,CAAAC,OAAA;AACA,IAAA2C,oBAAA,GAAA5C,sBAAA,CAAAC,OAAA;AACA,IAAA4C,0BAAA,GAAA7C,sBAAA,CAAAC,OAAA;AACA,IAAA6C,mBAAA,GAAA9C,sBAAA,CAAAC,OAAA;AACA,IAAA8C,cAAA,GAAA/C,sBAAA,CAAAC,OAAA;AACA,IAAA+C,cAAA,GAAAhD,sBAAA,CAAAC,OAAA;AACA,IAAAgD,mBAAA,GAAAjD,sBAAA,CAAAC,OAAA;AACA,IAAAiD,SAAA,GAAAlD,sBAAA,CAAAC,OAAA;AACA,IAAAkD,SAAA,GAAAnD,sBAAA,CAAAC,OAAA;AACA,IAAAmD,aAAA,GAAApD,sBAAA,CAAAC,OAAA;AACA,IAAAoD,WAAA,GAAArD,sBAAA,CAAAC,OAAA;AAA+C,SAAAD,uBAAAsD,GAAA,WAAAA,GAAA,IAAAA,GAAA,CAAAC,UAAA,GAAAD,GAAA,KAAAE,OAAA,EAAAF,GAAA;AAE/C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMG,KAAK,GAAG;EACZ;EACAC,OAAO,EAAE,CAAC,CAAC;EACXC,KAAK,EAAE;IACL,cAAc,EAAEC,oBAAW;IAC3B,iBAAiB,EAAEC,uBAAc;IACjC,gBAAgB,EAAEC,sBAAa;IAC/B,mBAAmB,EAAEC,yBAAgB;IACrC,sBAAsB,EAAEC,2BAAkB;IAC1C,mBAAmB,EAAEC,wBAAe;IACpC,sBAAsB,EAAEC,2BAAkB;IAC1C,cAAc,EAAEC,oBAAW;IAC3B,iBAAiB,EAAEC,sBAAa;IAChC,aAAa,EAAEC,mBAAU;IACzB,cAAc,EAAEC,oBAAW;IAC3B,YAAY,EAAEC,kBAAS;IACvB,uBAAuB,EAAEC,4BAAmB;IAC5C,yBAAyB,EAAEC,8BAAqB;IAChD,kBAAkB,EAAEC,wBAAe;IACnC,mBAAmB,EAAEC,yBAAgB;IACrC,YAAY,EAAEC,kBAAS;IACvB,kBAAkB,EAAEC,wBAAe;IACnC,eAAe,EAAEC,oBAAW;IAC5B,6BAA6B,EAAEC,iCAAwB;IACvD,iBAAiB,EAAEC,sBAAa;IAChC,aAAa,EAAEC,mBAAU;IACzB,mBAAmB,EAAEC,wBAAe;IACpC,oBAAoB,EAAEC,yBAAgB;IACtC,sBAAsB,EAAEC,2BAAkB;IAC1C,UAAU,EAAEC,gBAAO;IACnB,oBAAoB,EAAEC,yBAAgB;IACtC,yBAAyB,EAAEC,8BAAqB;IAChD,qBAAqB,EAAEC,2BAAkB;IACzC,uCAAuC,EAAEC,2CAAkC;IAC3E,iBAAiB,EAAEC,uBAAc;IACjC,uBAAuB,EAAEC,4BAAmB;IAC5C,yCAAyC,EAAEC,4CAAmC;IAC9E,eAAe,EAAEC,qBAAY;IAC7B,eAAe,EAAEC,qBAAY;IAC7B,2BAA2B,EAAEC,gCAAuB;IACpD,oBAAoB,EAAEC,yBAAgB;IACtC,oBAAoB,EAAEC,yBAAgB;IACtC,kBAAkB,EAAEC,wBAAe;IACnC,8BAA8B,EAAEC,mCAA0B;IAC1D,uBAAuB,EAAEC,4BAAmB;IAC5C,uBAAuB,EAAEC,4BAAmB;IAC5C,iBAAiB,EAAEC,uBAAc;IACjC,uBAAuB,EAAEC,4BAAmB;IAC5C,6BAA6B,EAAEC,kCAAyB;IACxD,sBAAsB,EAAEC,2BAAkB;IAC1C,gBAAgB,EAAEC,sBAAa;IAC/B,gBAAgB,EAAEC,sBAAa;IAC/B,sBAAsB,EAAEC,2BAAkB;IAC1C,WAAW,EAAEC,iBAAQ;IACrB,WAAW,EAAEC,iBAAQ;IACrB,eAAe,EAAEC,qBAAY;IAC7B,aAAa,EAAEC;EACjB;AACF,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,MAAMC,wBAAwB,GAAGA,CAACC,WAAW,EAAEC,IAAI,KAAK;EACtD,OAAO;IACL;IACAC,OAAO,EAAED,IAAI,GAAG;MACdE,KAAK,EAAE5D;IACT,CAAC,GAAG,CACF,OAAO,CACR;IACDE,KAAK,EAAE;MACL,oBAAoB,EAAEuD,WAAW;MACjC,uBAAuB,EAAEA,WAAW;MACpC,sBAAsB,EAAE,KAAK;MAC7B,yBAAyB,EAAE,KAAK;MAChC,4BAA4B,EAAE,KAAK;MACnC,yBAAyB,EAAEA,WAAW;MACtC,4BAA4B,EAAEA,WAAW;MACzC,oBAAoB,EAAE,KAAK;MAC3B,uBAAuB,EAAEA,WAAW;MACpC,mBAAmB,EAAEA,WAAW;MAChC,oBAAoB,EAAEA,WAAW;MACjC,kBAAkB,EAAEA,WAAW;MAC/B,6BAA6B,EAAEA,WAAW;MAC1C,+BAA+B,EAAE,KAAK;MACtC,wBAAwB,EAAE,KAAK;MAC/B,yBAAyB,EAAE,KAAK;MAChC,kBAAkB,EAAE,KAAK;MACzB,wBAAwB,EAAEA,WAAW;MACrC,qBAAqB,EAAE,KAAK;MAC5B,mCAAmC,EAAE,KAAK;MAC1C,uBAAuB,EAAE,KAAK;MAC9B,mBAAmB,EAAEA,WAAW;MAChC,yBAAyB,EAAE,KAAK;MAChC,0BAA0B,EAAEA,WAAW;MACvC,4BAA4B,EAAE,KAAK;MACnC,gBAAgB,EAAE,KAAK;MACvB,0BAA0B,EAAEA,WAAW;MACvC,+BAA+B,EAAE,KAAK;MACtC,2BAA2B,EAAE,KAAK;MAClC,6CAA6C,EAAE,KAAK;MACpD,uBAAuB,EAAE,KAAK;MAC9B,6BAA6B,EAAE,KAAK;MACpC,+CAA+C,EAAE,KAAK;MACtD,qBAAqB,EAAEA,WAAW;MAClC,qBAAqB,EAAEA,WAAW;MAClC,iCAAiC,EAAEA,WAAW;MAC9C,0BAA0B,EAAEA,WAAW;MACvC,0BAA0B,EAAEA,WAAW;MACvC,wBAAwB,EAAEA,WAAW;MACrC,oCAAoC,EAAEA,WAAW;MACjD,6BAA6B,EAAEA,WAAW;MAC1C,6BAA6B,EAAEA,WAAW;MAC1C,uBAAuB,EAAEA,WAAW;MACpC,6BAA6B,EAAEA,WAAW;MAC1C,mCAAmC,EAAEA,WAAW;MAChD,4BAA4B,EAAEA,WAAW;MACzC,sBAAsB,EAAE,KAAK;MAC7B,sBAAsB,EAAEA,WAAW;MACnC,4BAA4B,EAAEA,WAAW;MACzC,iBAAiB,EAAE,KAAK;MACxB,iBAAiB,EAAEA,WAAW;MAC9B,qBAAqB,EAAE,KAAK;MAC5B,mBAAmB,EAAEA;IACvB;EACF,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,MAAMI,kCAAkC,GAAGA,CAACJ,WAAW,EAAEC,IAAI,KAAK;EAChE,MAAMI,OAAO,GAAGN,wBAAwB,CAACC,WAAW,EAAEC,IAAI,CAAC;EAE3D,OAAO;IACL,GAAGI,OAAO;IACV5D,KAAK,EAAE;MACL,GAAG4D,OAAO,CAAC5D,KAAK;MAChB;MACE,uBAAuB,EAAE,CACvBuD,WAAW,EAAE;QACXM,KAAK,EAAE;MACT,CAAC,CACF;MACD,gBAAgB,EAAEN,WAAW;MAC7B,0BAA0B,EAAE,KAAK;MACjC,0BAA0B,EAAE,KAAK;MACjC,6BAA6B,EAAE,KAAK;MACpC,4BAA4B,EAAE;MAChC;IACF;EACF,CAAC;AACH,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA,MAAMO,wCAAwC,GAAGA,CAACP,WAAW,EAAEC,IAAI,KAAK;EACtE,MAAMI,OAAO,GAAGN,wBAAwB,CAACC,WAAW,EAAEC,IAAI,CAAC;EAE3D,OAAO;IACL,GAAGI,OAAO;IACV5D,KAAK,EAAE;MACL,GAAG4D,OAAO,CAAC5D,KAAK;MAChB;MACE,0BAA0B,EAAE;MAC9B;IACF;EACF,CAAC;AACH,CAAC;;AAED;AACA,IAAI,CAACF,KAAK,CAACC,OAAO,EAAE;EAClB,MAAM,IAAIgE,KAAK,CAAC,kBAAkB,CAAC;AACrC;AAEAjE,KAAK,CAACC,OAAO,CAACiE,WAAW,GAAGV,wBAAwB,CAAC,MAAM,CAAC;AAC5DxD,KAAK,CAACC,OAAO,CAAC,mBAAmB,CAAC,GAAGuD,wBAAwB,CAAC,OAAO,CAAC;AACtExD,KAAK,CAACC,OAAO,CAAC,wBAAwB,CAAC,GAAG4D,kCAAkC,CAAC,MAAM,CAAC;AACpF7D,KAAK,CAACC,OAAO,CAAC,8BAA8B,CAAC,GAAG4D,kCAAkC,CAAC,OAAO,CAAC;AAC3F7D,KAAK,CAACC,OAAO,CAAC,+BAA+B,CAAC,GAAG+D,wCAAwC,CAAC,MAAM,CAAC;AACjGhE,KAAK,CAACC,OAAO,CAAC,qCAAqC,CAAC,GAAG+D,wCAAwC,CAAC,OAAO,CAAC;AAExGhE,KAAK,CAACC,OAAO,CAAC,kBAAkB,CAAC,GAAGuD,wBAAwB,CAAC,MAAM,EAAE,IAAI,CAAC;AAC1ExD,KAAK,CAACC,OAAO,CAAC,wBAAwB,CAAC,GAAGuD,wBAAwB,CAAC,OAAO,EAAE,IAAI,CAAC;AACjFxD,KAAK,CAACC,OAAO,CAAC,6BAA6B,CAAC,GAAG4D,kCAAkC,CAAC,MAAM,EAAE,IAAI,CAAC;AAC/F7D,KAAK,CAACC,OAAO,CAAC,mCAAmC,CAAC,GAAG4D,kCAAkC,CAAC,OAAO,EAAE,IAAI,CAAC;AACtG7D,KAAK,CAACC,OAAO,CAAC,oCAAoC,CAAC,GAAG+D,wCAAwC,CAAC,MAAM,EAAE,IAAI,CAAC;AAC5GhE,KAAK,CAACC,OAAO,CAAC,0CAA0C,CAAC,GAAG+D,wCAAwC,CAAC,OAAO,EAAE,IAAI,CAAC;AAAC,IAAAG,QAAA,GAAAC,OAAA,CAAArE,OAAA,GAErGC,KAAK;AAAAqE,MAAA,CAAAD,OAAA,GAAAA,OAAA,CAAArE,OAAA"}
|
package/dist/index.d.ts
CHANGED
|
@@ -9,11 +9,11 @@ export default index;
|
|
|
9
9
|
* "flat/recommended-typescript-error"|
|
|
10
10
|
* "flat/recommended-typescript-flavor"|
|
|
11
11
|
* "flat/recommended-typescript-flavor-error",
|
|
12
|
-
* import('eslint').
|
|
12
|
+
* import('eslint').Linter.FlatConfig
|
|
13
13
|
* >
|
|
14
14
|
* }}
|
|
15
15
|
*/
|
|
16
16
|
declare const index: import('eslint').ESLint.Plugin & {
|
|
17
|
-
configs: Record<"recommended" | "recommended-error" | "recommended-typescript" | "recommended-typescript-error" | "recommended-typescript-flavor" | "recommended-typescript-flavor-error" | "flat/recommended" | "flat/recommended-error" | "flat/recommended-typescript" | "flat/recommended-typescript-error" | "flat/recommended-typescript-flavor" | "flat/recommended-typescript-flavor-error", import('eslint').
|
|
17
|
+
configs: Record<"recommended" | "recommended-error" | "recommended-typescript" | "recommended-typescript-error" | "recommended-typescript-flavor" | "recommended-typescript-flavor-error" | "flat/recommended" | "flat/recommended-error" | "flat/recommended-typescript" | "flat/recommended-typescript-error" | "flat/recommended-typescript-flavor" | "flat/recommended-typescript-flavor-error", import('eslint').Linter.FlatConfig>;
|
|
18
18
|
};
|
|
19
19
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":";AAsDA;;;;;;;;;;;;;GAaG;AACH,qBAbU,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,GAAG;IAC1C,OAAW,EAAE,OACb,aAAmB,GAAC,mBAAmB,GAAC,wBAAwB,GAChE,8BAAsC,GAAC,+BAA+B,GACtE,qCAA6C,GAAC,kBAAkB,GAChE,wBAAgC,GAAC,6BAA6B,GAC9D,mCAA2C,GAC3C,oCAA4C,GAC5C,0CAAkD,EAClD,OAAa,QAAQ,EAAE,MAAM,CAAC,UAAU,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":";AAsDA;;;;;;;;;;;;;GAaG;AACH,qBAbU,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,GAAG;IAC1C,OAAW,EAAE,OACb,aAAmB,GAAC,mBAAmB,GAAC,wBAAwB,GAChE,8BAAsC,GAAC,+BAA+B,GACtE,qCAA6C,GAAC,kBAAkB,GAChE,wBAAgC,GAAC,6BAA6B,GAC9D,mCAA2C,GAC3C,oCAA4C,GAC5C,0CAAkD,EAClD,OAAa,QAAQ,EAAE,MAAM,CAAC,UAAU,CACnC,CAAA;CACF,CA4DF"}
|
|
@@ -11,7 +11,7 @@ Object.defineProperty(exports, "parseComment", {
|
|
|
11
11
|
return _jsdoccomment.parseComment;
|
|
12
12
|
}
|
|
13
13
|
});
|
|
14
|
-
var _jsdocUtils = _interopRequireDefault(require("./jsdocUtils.
|
|
14
|
+
var _jsdocUtils = _interopRequireDefault(require("./jsdocUtils.cjs"));
|
|
15
15
|
var _jsdoccomment = require("@es-joy/jsdoccomment");
|
|
16
16
|
var _commentParser = require("comment-parser");
|
|
17
17
|
var _esquery = _interopRequireDefault(require("esquery"));
|
|
@@ -674,10 +674,10 @@ const getBasicUtils = (context, {
|
|
|
674
674
|
* @returns {Utils}
|
|
675
675
|
*/
|
|
676
676
|
const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iteratingAll, ruleConfig, indent) => {
|
|
677
|
-
|
|
678
|
-
|
|
677
|
+
const ancestors = /** @type {import('eslint').Rule.Node[]} */node ? sc.getAncestors ? sc.getAncestors(node)
|
|
678
|
+
/* c8 ignore next 4 */ : context.getAncestors() : [];
|
|
679
679
|
|
|
680
|
-
|
|
680
|
+
/* c8 ignore next -- Fallback to deprecated method */
|
|
681
681
|
const {
|
|
682
682
|
sourceCode = context.getSourceCode()
|
|
683
683
|
} = context;
|
|
@@ -872,7 +872,7 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
|
|
|
872
872
|
return false;
|
|
873
873
|
});
|
|
874
874
|
|
|
875
|
-
/*
|
|
875
|
+
/* c8 ignore else -- Won't be called if missing */
|
|
876
876
|
if (descLines.length) {
|
|
877
877
|
jsdoc.source.splice( /** @type {Integer} */startIdx, /** @type {Integer} */endIdx - ( /** @type {Integer} */startIdx), ...setter(
|
|
878
878
|
/**
|
|
@@ -896,7 +896,7 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
|
|
|
896
896
|
end
|
|
897
897
|
}
|
|
898
898
|
}, idx) => {
|
|
899
|
-
|
|
899
|
+
/* c8 ignore next 3 -- Already checked */
|
|
900
900
|
if (idx && (tag || end)) {
|
|
901
901
|
return true;
|
|
902
902
|
}
|
|
@@ -955,7 +955,7 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
|
|
|
955
955
|
}) => {
|
|
956
956
|
return number === srcNumber;
|
|
957
957
|
});
|
|
958
|
-
//
|
|
958
|
+
// c8 ignore else
|
|
959
959
|
if (sourceIndex > -1) {
|
|
960
960
|
let spliceCount = 1;
|
|
961
961
|
tagSource.slice(tagIdx + 1).some(({
|
|
@@ -975,8 +975,6 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
|
|
|
975
975
|
delimiter,
|
|
976
976
|
end
|
|
977
977
|
} = jsdoc.source[spliceIdx].tokens;
|
|
978
|
-
|
|
979
|
-
/* istanbul ignore if -- Currently want to clear entirely if removing tags */
|
|
980
978
|
if (spliceIdx === 0 && jsdoc.tags.length >= 2 || !removeEmptyBlock && (end || delimiter === '/**')) {
|
|
981
979
|
const {
|
|
982
980
|
tokens
|
|
@@ -996,8 +994,7 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
|
|
|
996
994
|
lastIndex = sourceIndex;
|
|
997
995
|
return true;
|
|
998
996
|
}
|
|
999
|
-
|
|
1000
|
-
// istanbul ignore next
|
|
997
|
+
/* c8 ignore next */
|
|
1001
998
|
return false;
|
|
1002
999
|
});
|
|
1003
1000
|
for (const [idx, src] of jsdoc.source.slice(lastIndex).entries()) {
|
|
@@ -1116,7 +1113,7 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
|
|
|
1116
1113
|
}) => {
|
|
1117
1114
|
return number === srcNumber && !end;
|
|
1118
1115
|
});
|
|
1119
|
-
//
|
|
1116
|
+
// c8 ignore else
|
|
1120
1117
|
if (sourceIndex > -1) {
|
|
1121
1118
|
const lines = makeLines();
|
|
1122
1119
|
jsdoc.source.splice(sourceIndex + tagSourceOffset, 0, ...lines);
|
|
@@ -1125,8 +1122,7 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
|
|
|
1125
1122
|
lastIndex = sourceIndex;
|
|
1126
1123
|
return true;
|
|
1127
1124
|
}
|
|
1128
|
-
|
|
1129
|
-
// istanbul ignore next
|
|
1125
|
+
/* c8 ignore next */
|
|
1130
1126
|
return false;
|
|
1131
1127
|
});
|
|
1132
1128
|
for (const [idx, src] of jsdoc.source.slice(lastIndex).entries()) {
|
|
@@ -1163,7 +1159,7 @@ const getUtils = (node, jsdoc, jsdocNode, settings, report, context, sc, iterati
|
|
|
1163
1159
|
postName = '';
|
|
1164
1160
|
} else if (postType) {
|
|
1165
1161
|
postType = '';
|
|
1166
|
-
} else /*
|
|
1162
|
+
} else /* c8 ignore else -- `comment-parser` prevents empty blocks currently per https://github.com/syavorsky/comment-parser/issues/128 */if (postTag) {
|
|
1167
1163
|
postTag = '';
|
|
1168
1164
|
}
|
|
1169
1165
|
}
|
|
@@ -1637,7 +1633,6 @@ const makeReport = (context, commentNode) => {
|
|
|
1637
1633
|
};
|
|
1638
1634
|
|
|
1639
1635
|
// Todo: Remove ignore once `check-examples` can be restored for ESLint 8+
|
|
1640
|
-
// istanbul ignore if
|
|
1641
1636
|
if ('column' in jsdocLoc && typeof jsdocLoc.column === 'number') {
|
|
1642
1637
|
const colNumber = /** @type {import('eslint').AST.SourceLocation} */commentNode.loc.start.column + jsdocLoc.column;
|
|
1643
1638
|
loc.end.column = colNumber;
|
|
@@ -1841,7 +1836,7 @@ const iterateAllJsdocs = (iterator, ruleConfig, contexts, additiveCommentContext
|
|
|
1841
1836
|
* @returns {void}
|
|
1842
1837
|
*/
|
|
1843
1838
|
const callIterator = (context, node, jsdocNodes, state, lastCall) => {
|
|
1844
|
-
|
|
1839
|
+
/* c8 ignore next -- Fallback to deprecated method */
|
|
1845
1840
|
const {
|
|
1846
1841
|
sourceCode = context.getSourceCode()
|
|
1847
1842
|
} = context;
|
|
@@ -1908,7 +1903,7 @@ const iterateAllJsdocs = (iterator, ruleConfig, contexts, additiveCommentContext
|
|
|
1908
1903
|
return {
|
|
1909
1904
|
// @ts-expect-error ESLint accepts
|
|
1910
1905
|
create(context) {
|
|
1911
|
-
|
|
1906
|
+
/* c8 ignore next -- Fallback to deprecated method */
|
|
1912
1907
|
const {
|
|
1913
1908
|
sourceCode = context.getSourceCode()
|
|
1914
1909
|
} = context;
|
|
@@ -1970,7 +1965,7 @@ const iterateAllJsdocs = (iterator, ruleConfig, contexts, additiveCommentContext
|
|
|
1970
1965
|
const checkFile = (iterator, ruleConfig) => {
|
|
1971
1966
|
return {
|
|
1972
1967
|
create(context) {
|
|
1973
|
-
|
|
1968
|
+
/* c8 ignore next -- Fallback to deprecated method */
|
|
1974
1969
|
const {
|
|
1975
1970
|
sourceCode = context.getSourceCode()
|
|
1976
1971
|
} = context;
|
|
@@ -2063,7 +2058,7 @@ function iterateJsdoc(iterator, ruleConfig) {
|
|
|
2063
2058
|
}
|
|
2064
2059
|
}
|
|
2065
2060
|
|
|
2066
|
-
|
|
2061
|
+
/* c8 ignore next -- Fallback to deprecated method */
|
|
2067
2062
|
const {
|
|
2068
2063
|
sourceCode = context.getSourceCode()
|
|
2069
2064
|
} = context;
|
|
@@ -2122,4 +2117,4 @@ function iterateJsdoc(iterator, ruleConfig) {
|
|
|
2122
2117
|
meta: ruleConfig.meta
|
|
2123
2118
|
};
|
|
2124
2119
|
}
|
|
2125
|
-
//# sourceMappingURL=iterateJsdoc.
|
|
2120
|
+
//# sourceMappingURL=iterateJsdoc.cjs.map
|