eslint-plugin-jsdoc 63.3.2 → 64.0.0

package/dist/getDefaultTagStructureForMode.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"getDefaultTagStructureForMode.cjs","names":[],"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'|'name-defining'|'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)\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        // Not in use, but should be this value if using to power `empty-tags`\n        [\n          'nameAllowed', true,\n        ],\n\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      '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        [\n          'namepathRole', 'name-defining',\n        ],\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        // 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        // The doc signature of `event` seems to require a \"name\"\n        [\n          'nameRequired', true,\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        [\n          'nameRequired', isJsdoc,\n        ],\n\n        // Does not show curly brackets in either the signature or examples\n        [\n          'typeAllowed', isTypescriptOrClosure || isPermissive,\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      '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      '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    [\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      '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      'interface', new Map(/** @type {[string, string|boolean][]} */ ([\n        // Not in use, but should be this value if using to power `empty-tags`\n        [\n          'nameAllowed', isClosure,\n        ],\n\n        // Allows for \"name\" in signature, but indicates as optional\n        [\n          'namepathRole',\n          isJsdocTypescriptOrPermissive ? 'namepath-defining' : false,\n        ],\n\n        [\n          'typeAllowed', false,\n        ],\n      ])),\n    ],\n\n    [\n      'internal', new Map(/** @type {[string, string|boolean][]} */ ([\n        // Not in use, but should be this value if using to power `empty-tags`\n        [\n          'nameAllowed', false,\n        ],\n        // https://www.typescriptlang.org/tsconfig/#stripInternal\n        [\n          'namepathRole', false,\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        //  \"isNameOrNamepathDefiningTag|tagMightHaveNameOrNamepath|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      '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      '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    [\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        // namepath\n        [\n          'typeOrNameRequired', isJsdoc,\n        ],\n\n        [\n          'typeRequired', isTypescriptOrClosure,\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', 'name-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      '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      '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};\n\nexport default getDefaultTagStructureForMode;\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,6BAA6B,GAAI,IAAI,IAAK;EAC9C,MAAM,OAAO,GAAG,IAAI,KAAK,OAAO;EAChC,MAAM,SAAS,GAAG,IAAI,KAAK,SAAS;EACpC,MAAM,YAAY,GAAG,IAAI,KAAK,YAAY;EAC1C,MAAM,YAAY,GAAG,IAAI,KAAK,YAAY;EAE1C,MAAM,mBAAmB,GAAG,OAAO,IAAI,YAAY;EACnD,MAAM,mBAAmB,GAAG,OAAO,IAAI,YAAY;EACnD,MAAM,qBAAqB,GAAG,YAAY,IAAI,SAAS;EACvD,MAAM,qBAAqB,GAAG,SAAS,IAAI,YAAY;EACvD,MAAM,6BAA6B,GAAG,mBAAmB,IAAI,YAAY;;EAEzE;EACA;EACA;EACA;EACA;EACA;;EAEA;EACA;EACA;EACA;EACA;;EAEA;EACA;;EAEA;EACA;EACA;;EAEA;EACA;;EAEA;AACF;AACA;EACE,OAAO,IAAI,GAAG,CAAC,CACb,CACE,OAAO,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC1D;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC;EAED;EACA,CACE,oBAAoB,EAAE,IAAI,CAC3B,CACD,CAAC,CACJ,EAED,CACE,KAAK,EAAE,IAAI,GAAG,CAAC,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,IAAI,GAAG,CAAC,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,IAAI,GAAG,CAAC,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,IAAI,GAAG,CAAC,yCAA2C;EAC5D;EACA;EACA,CACE,cAAc,EAAE,sBAAsB,CACvC;EAED;EACA,CACE,oBAAoB,EAAE,IAAI,CAC3B,CACD,CAAC,CACJ,EAED,CACE,UAAU,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC7D;EACA;EACA;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC;EAED;EACA,CACE,cAAc,EAAE,IAAI,CACrB,CACD,CAAC,CACJ,EAED,CACE,OAAO,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC1D;EACA,CACE,aAAa,EAAE,IAAI,CACpB;EAED;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC,EAED,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EAED,CACE,OAAO,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC1D;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC,EAED,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EACD,CACE,UAAU,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC7D;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC,EAED,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EACD,CACE,aAAa,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAChE;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC,EAED,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EAED,CACE,YAAY,EAAE,IAAI,GAAG,CAAC,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,IAAI,GAAG,CAAC,yCAA2C,CAC3D,CACE,cAAc,EAAE,SAAS,CAC1B,CACD,CAAC,CACJ,EAED,CACE,OAAO,EAAE,IAAI,GAAG,CAAC,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,IAAI,GAAG,CAAC,yCAA2C,CACzD,CACE,cAAc,EAAE,eAAe,CAChC;EACD;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EAED,CACE,OAAO,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC1D;EACA;EACA;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC;EAED;EACA,CACE,cAAc,EAAE,IAAI,CACrB,CACD,CAAC,CACJ,EAED,CACE,WAAW,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC9D;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ;EAED;EACA,CACE,QAAQ,EAAE,IAAI,GAAG,CAAC,yCAA2C,CAC3D,CACE,aAAa,EAAE,qBAAqB,CACrC,CACD,CAAC,CACJ,EAED,CACE,SAAS,EAAE,IAAI,GAAG,CAAC,yCAA2C,CAC5D,CACE,cAAc,EAAE,mBAAmB,CACpC,EAED,CACE,cAAc,EAAE,OAAO,CACxB,EAED,CACE,aAAa,EAAE,qBAAqB,CACrC,CACD,CAAC,CACJ,EAED,CACE,SAAS,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC5D;EACA,CACE,cAAc,EAAE,sBAAsB,CACvC,EAED,CACE,cAAc,EAAE,OAAO,CACxB;EAED;EACA,CACE,aAAa,EAAE,qBAAqB,IAAI,YAAY,CACrD;EAED;EACA,CACE,oBAAoB,EAAE,qBAAqB,IAAI,YAAY,CAC5D,CACD,CAAC,CACJ,EAED,CACE,UAAU,EAAE,IAAI,GAAG,CAAC,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,IAAI,GAAG,CAAC,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,MAAM,EAAE,IAAI,GAAG,CAAC,yCAA2C;EACzD;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC,CACD,CAAC,CACJ,EACD,CACE,UAAU,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC7D;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC,EAED,CACE,cAAc,EAAE,KAAK,CACtB,EAED,CACE,aAAa,EAAE,KAAK,CACrB,CACD,CAAC,CACJ,EAED,CACE,MAAM,EAAE,IAAI,GAAG,CAAC,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,YAAY,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC/D;EACA;EACA,CACE,cAAc,EAAE,IAAI,CACrB,CACD,CAAC,CACJ,EAED,CACE,WAAW,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC9D;EACA,CACE,aAAa,EAAE,SAAS,CACzB;EAED;EACA,CACE,cAAc,EACd,6BAA6B,GAAG,mBAAmB,GAAG,KAAK,CAC5D,EAED,CACE,aAAa,EAAE,KAAK,CACrB,CACD,CAAC,CACJ,EAED,CACE,UAAU,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC7D;EACA,CACE,aAAa,EAAE,KAAK,CACrB;EACD;EACA,CACE,cAAc,EAAE,KAAK,CACtB,CACD,CAAC,CACJ,EAED,CACE,OAAO,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC1D;EACA,CACE,cAAc,EAAE,sBAAsB,CACvC;EAED;EACA,CACE,oBAAoB,EAAE,IAAI,CAC3B,CACD,CAAC,CACJ,EAED,CACE,MAAM,EAAE,IAAI,GAAG,CAAC,yCAA2C;EACzD;EACA,CACE,cAAc,EAAE,6BAA6B,CAC9C,CAED,CAAC,CACJ,EAED,CACE,UAAU,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC7D;EACA;EACA,CACE,cAAc,EAAE,6BAA6B,CAC9C,CACD,CAAC,CACJ,EAED,CACE,WAAW,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC9D;EACA;EACA,CACE,cAAc,EAAE,6BAA6B,CAC9C,CACD,CAAC,CACJ,EAED,CACE,SAAS,EAAE,IAAI,GAAG,CAAC,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,IAAI,GAAG,CAAC,yCAA2C;EAC3D;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC;EAED;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EAED,CACE,WAAW,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC9D;EACA;EACA,CACE,cAAc,EAAE,sBAAsB,CACvC;EAED;EACA,CACE,oBAAoB,EAAE,IAAI,CAC3B,CACD,CAAC,CACJ,EACD,CACE,UAAU,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC7D;EACA;EACA,CACE,cAAc,EAAE,sBAAsB,CACvC;EAED;EACA,CACE,oBAAoB,EAAE,IAAI,CAC3B,CACD,CAAC,CACJ,EAED,CACE,QAAQ,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC3D;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC,CACD,CAAC,CACJ,EACD,CACE,OAAO,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC1D;EACA;EACA,CACE,cAAc,EAAE,sBAAsB,CACvC;EAED;EACA,CACE,oBAAoB,EAAE,IAAI,CAC3B,CACD,CAAC,CACJ,EAED,CACE,OAAO,EAAE,IAAI,GAAG,CAAC,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,IAAI,GAAG,CAAC,yCAA2C;EAC7D;EACA;EACA;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EAED,CACE,QAAQ,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC3D;EACA;EACA;EACA,CACE,cAAc,EAAE,OAAO,GAAG,mBAAmB,GAAG,MAAM,CACvD;EAED;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EAED,CACE,MAAM,EAAE,IAAI,GAAG,CAAC,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,IAAI,GAAG,CAAC,yCAA2C;EAC9D;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC;EAED;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EACD,CACE,SAAS,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC5D;EACA;EACA,CACE,aAAa,EAAE,qBAAqB,CACrC,CACD,CAAC,CACJ,EAED,CACE,OAAO,EAAE,IAAI,GAAG,CAAC,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,IAAI,GAAG,CAAC,yCAA2C;EAC5D;EACA;EACA,CACE,aAAa,EAAE,qBAAqB,CACrC,CACD,CAAC,CACJ,EAED,CACE,MAAM,EAAE,IAAI,GAAG,CAAC,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,IAAI,GAAG,CAAC,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,IAAI,GAAG,CAAC,yCAA2C;EAC9D;EACA;EACA,CACE,aAAa,EAAE,qBAAqB,CACrC,CACD,CAAC,CACJ,EAED,CACE,QAAQ,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC3D;EACA,CACE,aAAa,EAAE,qBAAqB,CACrC,CACD,CAAC,CACJ,EAED,CACE,UAAU,EAAE,IAAI,GAAG,CAAC,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,QAAQ,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC3D;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EACD,CACE,SAAS,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC5D;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EAED,CACE,WAAW,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC9D;EACA,CACE,cAAc,EAAE,IAAI,CACrB,CACD,CAAC,CACJ,EAED,CACE,KAAK,EAAE,IAAI,GAAG,CAAC,yCAA2C;EACxD;EACA;EACA,CACE,cAAc,EAAE,MAAM,CACvB,CACD,CAAC,CACJ,EAED,CACE,QAAQ,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC3D;EACA,CACE,aAAa,EAAE,qBAAqB,CACrC,CACD,CAAC,CACJ,EAED,CACE,UAAU,EAAE,IAAI,GAAG,CAAC,yCAA2C,CAC7D,CACE,cAAc,EAAE,CAAC,SAAS,CAC3B,EACD,CACE,cAAc,EAAE,SAAS,CAC1B,CACD,CAAC,CACJ,EAED,CACE,UAAU,EAAE,IAAI,GAAG,CAAC,yCAA2C,CAC7D,CACE,cAAc,EAAE,OAAO,GAAG,MAAM,GAAG,sBAAsB,CAC1D,EAED,CACE,cAAc,EAAE,CAAC,OAAO,CACzB;EAED;EACA;EACA;EACA,CACE,aAAa,EAAE,qBAAqB,IAAI,YAAY,CACrD,CACD,CAAC,CACJ,EAED,CACE,MAAM,EAAE,IAAI,GAAG,CAAC,yCAA2C;EACzD;EACA;EACA,CACE,cAAc,EAAE,OAAO,GAAG,sBAAsB,GAAG,KAAK,CACzD;EAED;EACA,CACE,oBAAoB,EAAE,OAAO,CAC9B,EAED,CACE,cAAc,EAAE,qBAAqB,CACtC,CACD,CAAC,CACJ,EAED,CACE,QAAQ,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC3D;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EAED,CACE,UAAU,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC7D;EACA,CACE,cAAc,EAAE,IAAI,CACrB,EAED,CACE,aAAa,EAAE,KAAK,CACrB,CACD,CAAC,CACJ,EAED,CACE,MAAM,EAAE,IAAI,GAAG,CAAC,yCAA2C;EACzD;EACA;EACA,CACE,cAAc,EAAE,IAAI,CACrB,CACD,CAAC,CACJ,EAED,CACE,SAAS,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC5D;EACA;EACA,CACE,cAAc,EAAE,eAAe,CAChC;EAED;EACA;EACA;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC;EAED;EACA;;EAEA;EACA,CACE,aAAa,EAAE,IAAI,CACpB;EAED;EACA;EACA,CACE,oBAAoB,EAAE,CAAC,YAAY,CACpC,CACD,CAAC,CACJ,EAED,CACE,KAAK,EAAE,IAAI,GAAG,CAAC,yCAA2C;EACxD;EACA,CACE,cAAc,EAAE,mBAAmB,CACpC;EAED;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EAED,CACE,OAAO,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC1D;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,EACD,CACE,QAAQ,EAAE,IAAI,GAAG,CAAC,yCAA2C;EAC3D;EACA,CACE,aAAa,EAAE,IAAI,CACpB,CACD,CAAC,CACJ,CACF,CAAC;AACJ,CAAC;AAAC,iCAEa,6BAA6B;AAAA","ignoreList":[]}

package/dist/getJsdocProcessorPlugin.cjs

@@ -1,587 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getJsdocProcessorPlugin = void 0;
-var _jsdocUtils = require("./jsdocUtils.cjs");
-var _jsdoccomment = require("@es-joy/jsdoccomment");
-var espree = _interopRequireWildcard(require("espree"));
-var _htmlEntities = require("html-entities");
-var _nodeFs = require("node:fs");
-var _nodePath = require("node:path");
-function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
-/**
- * @import {
- *   Integer,
- *   JsdocBlockWithInline,
- * } from './iterateJsdoc.js';
- * @import {
- *   ESLint,
- *   Linter,
- * } from 'eslint';
- */
-
-const {
-  version
-} = JSON.parse((0, _nodeFs.readFileSync)((0, _nodePath.join)(__dirname, '../package.json'), 'utf8'));
-
-// const zeroBasedLineIndexAdjust = -1;
-const likelyNestedJSDocIndentSpace = 1;
-const preTagSpaceLength = 1;
-
-// If a space is present, we should ignore it
-const firstLinePrefixLength = preTagSpaceLength;
-const hasCaptionRegex = /^\s*<caption>([\s\S]*?)<\/caption>/v;
-
-/**
- * @param {string} str
- * @returns {string}
- */
-const escapeStringRegexp = str => {
-  return str.replaceAll(/[.*+?^$\{\}\(\)\|\[\]\\]/gv, '\\$&');
-};
-
-/**
- * @param {string} str
- * @param {string} ch
- * @returns {Integer}
- */
-const countChars = (str, ch) => {
-  return (str.match(new RegExp(escapeStringRegexp(ch), 'gv')) || []).length;
-};
-
-/**
- * @param {string} text
- * @returns {[
- *   Integer,
- *   Integer
- * ]}
- */
-const getLinesCols = text => {
-  const matchLines = countChars(text, '\n');
-  const colDelta = matchLines ? text.slice(text.lastIndexOf('\n') + 1).length : text.length;
-  return [matchLines, colDelta];
-};
-
-/**
- * @typedef {number} Integer
- */
-/**
- * @typedef {object} JsdocProcessorOptions
- * @property {boolean} [captionRequired] Require captions for example tags
- * @property {Integer} [paddedIndent] See docs
- * @property {boolean} [checkDefaults] See docs
- * @property {boolean} [checkParams] See docs
- * @property {boolean} [checkExamples] See docs
- * @property {boolean} [checkProperties] See docs
- * @property {string} [matchingFileName] See docs
- * @property {string} [matchingFileNameDefaults] See docs
- * @property {string} [matchingFileNameParams] See docs
- * @property {string} [matchingFileNameProperties] See docs
- * @property {string|RegExp} [exampleCodeRegex] See docs
- * @property {string|RegExp} [rejectExampleCodeRegex] See docs
- * @property {string[]} [allowedLanguagesToProcess] See docs
- * @property {"script"|"module"} [sourceType] See docs
- * @property {import('eslint').Linter.ESTreeParser|import('eslint').Linter.NonESTreeParser} [parser] See docs
- */
-
-/**
- * We use a function for the ability of the user to pass in a config, but
- * without requiring all users of the plugin to do so.
- * @param {JsdocProcessorOptions} [options]
- * @returns {ESLint.Plugin}
- */
-const getJsdocProcessorPlugin = (options = {}) => {
-  /**
-   * @typedef {{
-   *   text: string,
-   *   filename: string|null|undefined
-   * }} TextAndFileName
-   */
-
-  const {
-    allowedLanguagesToProcess = ['js', 'ts', 'javascript', 'typescript'],
-    captionRequired = false,
-    checkDefaults = false,
-    checkExamples = true,
-    checkParams = false,
-    checkProperties = false,
-    exampleCodeRegex = null,
-    matchingFileName = null,
-    matchingFileNameDefaults = null,
-    matchingFileNameParams = null,
-    matchingFileNameProperties = null,
-    paddedIndent = 0,
-    parser = undefined,
-    rejectExampleCodeRegex = null,
-    sourceType = 'module'
-  } = options;
-
-  /** @type {RegExp} */
-  let exampleCodeRegExp;
-  /** @type {RegExp} */
-  let rejectExampleCodeRegExp;
-  if (exampleCodeRegex) {
-    exampleCodeRegExp = typeof exampleCodeRegex === 'string' ? (0, _jsdocUtils.getRegexFromString)(exampleCodeRegex) : exampleCodeRegex;
-  }
-  if (rejectExampleCodeRegex) {
-    rejectExampleCodeRegExp = typeof rejectExampleCodeRegex === 'string' ? (0, _jsdocUtils.getRegexFromString)(rejectExampleCodeRegex) : rejectExampleCodeRegex;
-  }
-
-  /**
-   * @type {{
-   *   targetTagName: string,
-   *   ext: string,
-   *   codeStartLine: number,
-   *   codeStartCol: number,
-   *   nonJSPrefacingCols: number,
-   *   commentLineCols: [number, number]
-   * }[]}
-   */
-  const otherInfo = [];
-
-  /** @type {import('eslint').Linter.LintMessage[]} */
-  let extraMessages = [];
-
-  /**
-   * @param {JsdocBlockWithInline} jsdoc
-   * @param {string} jsFileName
-   * @param {[number, number]} commentLineCols
-   */
-  const getTextsAndFileNames = (jsdoc, jsFileName, commentLineCols) => {
-    /**
-     * @type {TextAndFileName[]}
-     */
-    const textsAndFileNames = [];
-
-    /**
-     * @param {{
-     *   filename: string|null,
-     *   defaultFileName: string|undefined,
-     *   source: string,
-     *   targetTagName: string,
-     *   rules?: import('eslint').Linter.RulesRecord|undefined,
-     *   lines?: Integer,
-     *   cols?: Integer,
-     *   skipInit?: boolean,
-     *   ext: string,
-     *   sources?: {
-     *     nonJSPrefacingCols: Integer,
-     *     nonJSPrefacingLines: Integer,
-     *     string: string,
-     *   }[],
-     *   tag?: import('comment-parser').Spec & {
-     *     line?: Integer,
-     *   }|{
-     *     line: Integer,
-     *   }
-     * }} cfg
-     */
-    const checkSource = ({
-      cols = 0,
-      defaultFileName,
-      ext,
-      filename,
-      lines = 0,
-      skipInit,
-      source,
-      sources = [],
-      tag = {
-        line: 0
-      },
-      targetTagName
-    }) => {
-      if (!skipInit) {
-        sources.push({
-          nonJSPrefacingCols: cols,
-          nonJSPrefacingLines: lines,
-          string: source
-        });
-      }
-
-      /**
-       * @param {{
-       *   nonJSPrefacingCols: Integer,
-       *   nonJSPrefacingLines: Integer,
-       *   string: string
-       * }} cfg
-       */
-      const addSourceInfo = function ({
-        nonJSPrefacingCols,
-        nonJSPrefacingLines,
-        string
-      }) {
-        const src = paddedIndent ? string.replaceAll(new RegExp(`(^|\n) {${paddedIndent}}(?!$)`, 'gv'), '\n') : string;
-
-        // Programmatic ESLint API: https://eslint.org/docs/developer-guide/nodejs-api
-        const file = filename || defaultFileName;
-        if (!('line' in tag)) {
-          tag.line = tag.source[0].number;
-        }
-
-        // NOTE: `tag.line` can be 0 if of form `/** @tag ... */`
-        const codeStartLine =
-        /**
-         * @type {import('comment-parser').Spec & {
-         *     line: Integer,
-         * }}
-         */
-        tag.line + nonJSPrefacingLines;
-        const codeStartCol = likelyNestedJSDocIndentSpace;
-        textsAndFileNames.push({
-          filename: file,
-          // See https://github.com/gajus/eslint-plugin-jsdoc/issues/710
-          text: src.replaceAll(/(?<=\*)\\(?=\\*\/)/gv, '').replaceAll(/&([^\s;]+);/gv, (_, code) => {
-            // Dec
-            if (/^#\d+$/v.test(code)) {
-              return String.fromCodePoint(Number.parseInt(code.slice(1), 10));
-            }
-
-            // Hex
-            if (/^#x\d+$/v.test(code)) {
-              return String.fromCodePoint(Number.parseInt(code.slice(2), 16));
-            }
-            return (0, _htmlEntities.decode)(_, {
-              level: 'html5'
-            });
-          })
-        });
-        otherInfo.push({
-          codeStartCol,
-          codeStartLine,
-          commentLineCols,
-          ext,
-          nonJSPrefacingCols,
-          targetTagName
-        });
-      };
-      for (const targetSource of sources) {
-        addSourceInfo(targetSource);
-      }
-    };
-
-    /**
-     *
-     * @param {string|null} filename
-     * @param {string} [ext] Since `eslint-plugin-markdown` v2, and
-     *   ESLint 7, this is the default which other JS-fenced rules will used.
-     *   Formerly "md" was the default.
-     * @returns {{
-     *   defaultFileName: string|undefined,
-     *   filename: string|null,
-     *   ext: string
-     * }}
-     */
-    const getFilenameInfo = (filename, ext = 'md/*.js') => {
-      let defaultFileName;
-      if (!filename) {
-        if (typeof jsFileName === 'string' && jsFileName.includes('.')) {
-          defaultFileName = jsFileName.replace(/\.[^.]*$/v, `.${ext}`);
-        } else {
-          defaultFileName = `dummy.${ext}`;
-        }
-      }
-      return {
-        defaultFileName,
-        ext,
-        filename
-      };
-    };
-    if (checkDefaults) {
-      const filenameInfo = getFilenameInfo(matchingFileNameDefaults, 'jsdoc-defaults');
-      (0, _jsdocUtils.forEachPreferredTag)(jsdoc, 'default', (tag, targetTagName) => {
-        if (!tag.description.trim()) {
-          return;
-        }
-        checkSource({
-          source: `(${(0, _jsdocUtils.getTagDescription)(tag)})`,
-          targetTagName,
-          ...filenameInfo
-        });
-      });
-    }
-    if (checkParams) {
-      const filenameInfo = getFilenameInfo(matchingFileNameParams, 'jsdoc-params');
-      (0, _jsdocUtils.forEachPreferredTag)(jsdoc, 'param', (tag, targetTagName) => {
-        if (!tag.default || !tag.default.trim()) {
-          return;
-        }
-        checkSource({
-          source: `(${tag.default})`,
-          targetTagName,
-          ...filenameInfo
-        });
-      });
-    }
-    if (checkProperties) {
-      const filenameInfo = getFilenameInfo(matchingFileNameProperties, 'jsdoc-properties');
-      (0, _jsdocUtils.forEachPreferredTag)(jsdoc, 'property', (tag, targetTagName) => {
-        if (!tag.default || !tag.default.trim()) {
-          return;
-        }
-        checkSource({
-          source: `(${tag.default})`,
-          targetTagName,
-          ...filenameInfo
-        });
-      });
-    }
-    if (!checkExamples) {
-      return textsAndFileNames;
-    }
-    const tagName = /** @type {string} */(0, _jsdocUtils.getPreferredTagName)(jsdoc, {
-      tagName: 'example'
-    });
-    if (!(0, _jsdocUtils.hasTag)(jsdoc, tagName)) {
-      return textsAndFileNames;
-    }
-    const matchingFilenameInfo = getFilenameInfo(matchingFileName);
-    (0, _jsdocUtils.forEachPreferredTag)(jsdoc, 'example', (tag, targetTagName) => {
-      let source = /** @type {string} */(0, _jsdocUtils.getTagDescription)(tag);
-      const match = source.match(hasCaptionRegex);
-      if (captionRequired && (!match || !match[1].trim())) {
-        extraMessages.push({
-          column: commentLineCols[1] + 1,
-          line: 1 + commentLineCols[0] + (tag.line ?? tag.source[0].number),
-          message: `@${targetTagName} error - Caption is expected for examples.`,
-          ruleId: 'jsdoc/example-missing-caption',
-          severity: 2
-        });
-        return;
-      }
-      source = source.replace(hasCaptionRegex, '');
-      const [lines, cols] = match ? getLinesCols(match[0]) : [0, 0];
-      if (exampleCodeRegex && !exampleCodeRegExp.test(source) || rejectExampleCodeRegex && rejectExampleCodeRegExp.test(source)) {
-        return;
-      }
-
-      // If `allowedLanguagesToProcess` is falsy, all languages should be processed.
-      if (allowedLanguagesToProcess) {
-        const matches = /^\s*```(?<language>\S+)([\s\S]*)```\s*$/v.exec(source);
-        if (matches?.groups && !allowedLanguagesToProcess.includes(matches.groups.language.toLowerCase())) {
-          return;
-        }
-      }
-      const sources = [];
-      let skipInit = false;
-      if (exampleCodeRegex) {
-        let nonJSPrefacingCols = 0;
-        let nonJSPrefacingLines = 0;
-        let startingIndex = 0;
-        let lastStringCount = 0;
-        let exampleCode;
-        exampleCodeRegExp.lastIndex = 0;
-        while ((exampleCode = exampleCodeRegExp.exec(source)) !== null) {
-          const {
-            '0': n0,
-            '1': n1,
-            index
-          } = exampleCode;
-
-          // Count anything preceding user regex match (can affect line numbering)
-          const preMatch = source.slice(startingIndex, index);
-          const [preMatchLines, colDelta] = getLinesCols(preMatch);
-          let nonJSPreface;
-          let nonJSPrefaceLineCount;
-          if (n1) {
-            const idx = n0.indexOf(n1);
-            nonJSPreface = n0.slice(0, idx);
-            nonJSPrefaceLineCount = countChars(nonJSPreface, '\n');
-          } else {
-            nonJSPreface = '';
-            nonJSPrefaceLineCount = 0;
-          }
-          nonJSPrefacingLines += lastStringCount + preMatchLines + nonJSPrefaceLineCount;
-
-          // Ignore `preMatch` delta if newlines here
-          if (nonJSPrefaceLineCount) {
-            const charsInLastLine = nonJSPreface.slice(nonJSPreface.lastIndexOf('\n') + 1).length;
-            nonJSPrefacingCols += charsInLastLine;
-          } else {
-            nonJSPrefacingCols += colDelta + nonJSPreface.length;
-          }
-          const string = n1 || n0;
-          sources.push({
-            nonJSPrefacingCols,
-            nonJSPrefacingLines,
-            string
-          });
-          startingIndex = exampleCodeRegExp.lastIndex;
-          lastStringCount = countChars(string, '\n');
-          if (!exampleCodeRegExp.global) {
-            break;
-          }
-        }
-        skipInit = true;
-      }
-      checkSource({
-        cols,
-        lines,
-        skipInit,
-        source,
-        sources,
-        tag,
-        targetTagName,
-        ...matchingFilenameInfo
-      });
-    });
-    return textsAndFileNames;
-  };
-
-  // See https://eslint.org/docs/latest/extend/plugins#processors-in-plugins
-  // See https://eslint.org/docs/latest/extend/custom-processors
-  // From https://github.com/eslint/eslint/issues/14745#issuecomment-869457265
-  /*
-    {
-      "files": ["*.js", "*.ts"],
-      "processor": "jsdoc/example" // a pretended value here
-    },
-    {
-      "files": [
-        "*.js/*_jsdoc-example.js",
-        "*.ts/*_jsdoc-example.js",
-        "*.js/*_jsdoc-example.ts"
-      ],
-      "rules": {
-        // specific rules for examples in jsdoc only here
-        // And other rules for `.js` and `.ts` will also be enabled for them
-      }
-    }
-  */
-  return {
-    meta: {
-      name: 'eslint-plugin-jsdoc/processor',
-      version
-    },
-    processors: {
-      examples: {
-        meta: {
-          name: 'eslint-plugin-jsdoc/preprocessor',
-          version
-        },
-        /**
-         * @param {import('eslint').Linter.LintMessage[][]} messages
-         * @param {string} filename
-         */
-        postprocess([jsMessages, ...messages
-        // eslint-disable-next-line no-unused-vars -- Placeholder
-        ], filename) {
-          for (const [idx, message] of messages.entries()) {
-            const {
-              codeStartCol,
-              codeStartLine,
-              commentLineCols,
-              nonJSPrefacingCols,
-              targetTagName
-            } = otherInfo[idx];
-            for (const msg of message) {
-              const {
-                column,
-                endColumn,
-                endLine,
-                fatal,
-                line,
-                message: messageText,
-                ruleId,
-                severity
-
-                // Todo: Make fixable
-                // fix
-                // fix: {range: [number, number], text: string}
-                // suggestions: {desc: , messageId:, fix: }[],
-              } = msg;
-              delete msg.fix;
-              const [codeCtxLine, codeCtxColumn] = commentLineCols;
-              const startLine = codeCtxLine + codeStartLine + line;
-
-              // Seems to need one more now
-              const startCol = 1 + codeCtxColumn + codeStartCol + (
-              // This might not work for line 0, but line 0 is unlikely for examples
-              line <= 1 ? nonJSPrefacingCols + firstLinePrefixLength : preTagSpaceLength) + column;
-              msg.message = '@' + targetTagName + ' ' + (severity === 2 ? 'error' : 'warning') + (ruleId ? ' (' + ruleId + ')' : '') + ': ' + (fatal ? 'Fatal: ' : '') + messageText;
-              msg.line = startLine;
-              msg.column = startCol;
-              msg.endLine = endLine ? startLine + endLine : startLine;
-              // added `- column` to offset what `endColumn` already seemed to include
-              msg.endColumn = endColumn ? startCol - column + endColumn : startCol;
-            }
-          }
-          const ret = [...jsMessages].concat(...messages, ...extraMessages);
-          extraMessages = [];
-          return ret;
-        },
-        /**
-         * @param {string} text
-         * @param {string} filename
-         * @returns {(string | Linter.ProcessorFile)[]}
-         */
-        preprocess(text, filename) {
-          try {
-            let ast;
-
-            // May be running a second time so catch and ignore
-            try {
-              ast = parser ?
-              // @ts-expect-error Should be present
-              parser.parseForESLint(text, {
-                comment: true,
-                ecmaVersion: 'latest',
-                sourceType
-              }).ast : espree.parse(text, {
-                comment: true,
-                ecmaVersion: 'latest',
-                sourceType
-              });
-            } catch {
-              return [text];
-            }
-
-            /** @type {[number, number][]} */
-            const commentLineCols = [];
-            const jsdocComments = /** @type {import('estree').Comment[]} */(
-            /**
-             * @type {import('estree').Program & {
-             *   comments?: import('estree').Comment[]
-             * }}
-             */
-            ast.comments).filter(comment => {
-              return /^\*\s/v.test(comment.value);
-            }).map(comment => {
-              const [start
-              /* c8 ignore next -- Unsupporting processors only? */] = comment.range ?? [];
-              const textToStart = text.slice(0, start);
-              const [lines, cols] = getLinesCols(textToStart);
-
-              // const lines = [...textToStart.matchAll(/\n/gv)].length
-              // const lastLinePos = textToStart.lastIndexOf('\n');
-              // const cols = lastLinePos === -1
-              //   ? 0
-              //   : textToStart.slice(lastLinePos).length;
-              commentLineCols.push([lines, cols]);
-              return (0, _jsdoccomment.parseComment)(comment);
-            });
-            return [text, ...jsdocComments.flatMap((jsdoc, idx) => {
-              return getTextsAndFileNames(jsdoc, filename, commentLineCols[idx]);
-            }).filter(
-            /**
-             * @param {TextAndFileName} file
-             * @returns {file is Linter.ProcessorFile}
-             */
-            file => {
-              return file !== null && file !== undefined;
-            })];
-            /* c8 ignore next 6 */
-          } catch (error) {
-            // eslint-disable-next-line no-console -- Debugging
-            console.log('err', filename, error);
-          }
-          return [];
-        },
-        supportsAutofix: true
-      }
-    }
-  };
-};
-exports.getJsdocProcessorPlugin = getJsdocProcessorPlugin;
-//# sourceMappingURL=getJsdocProcessorPlugin.cjs.map