eslint-plugin-jsdoc 53.0.1 → 54.0.0

package/dist/getDefaultTagStructureForMode.js

@@ -1,188 +0,0 @@
-//#region src/getDefaultTagStructureForMode.js
-/**
-* @typedef {Map<string, Map<string, (string|boolean)>>} TagStructure
-*/
-/**
-* @param {import('./jsdocUtils.js').ParserMode} mode
-* @returns {TagStructure}
-*/
-const getDefaultTagStructureForMode = (mode) => {
-	const isJsdoc = mode === "jsdoc";
-	const isClosure = mode === "closure";
-	const isTypescript = mode === "typescript";
-	const isPermissive = mode === "permissive";
-	const isJsdocOrPermissive = isJsdoc || isPermissive;
-	const isJsdocOrTypescript = isJsdoc || isTypescript;
-	const isTypescriptOrClosure = isTypescript || isClosure;
-	const isClosureOrPermissive = isClosure || isPermissive;
-	const isJsdocTypescriptOrPermissive = isJsdocOrTypescript || isPermissive;
-	/**
-	* @type {TagStructure}
-	*/
-	return new Map([
-		["alias", new Map([["namepathRole", "namepath-defining"], ["typeOrNameRequired", true]])],
-		["arg", new Map([
-			["namepathRole", "namepath-defining"],
-			["nameRequired", true],
-			["typeAllowed", true]
-		])],
-		["argument", new Map([
-			["namepathRole", "namepath-defining"],
-			["nameRequired", true],
-			["typeAllowed", true]
-		])],
-		["augments", new Map([
-			["namepathRole", "namepath-referencing"],
-			["typeAllowed", true],
-			["typeOrNameRequired", true]
-		])],
-		["borrows", new Map([["namepathRole", "namepath-referencing"], ["typeOrNameRequired", true]])],
-		["callback", new Map([["namepathRole", "namepath-defining"], ["nameRequired", true]])],
-		["class", new Map([
-			["nameAllowed", true],
-			["namepathRole", "namepath-defining"],
-			["typeAllowed", true]
-		])],
-		["const", new Map([["namepathRole", "namepath-defining"], ["typeAllowed", true]])],
-		["constant", new Map([["namepathRole", "namepath-defining"], ["typeAllowed", true]])],
-		["constructor", new Map([["namepathRole", "namepath-defining"], ["typeAllowed", true]])],
-		["constructs", new Map([
-			["namepathRole", "namepath-defining"],
-			["nameRequired", false],
-			["typeAllowed", false]
-		])],
-		["define", new Map([["typeRequired", isClosure]])],
-		["emits", new Map([
-			["namepathRole", "namepath-referencing"],
-			["nameRequired", true],
-			["typeAllowed", false]
-		])],
-		["enum", new Map([["typeAllowed", true]])],
-		["event", new Map([["namepathRole", "namepath-defining"], ["nameRequired", true]])],
-		["exception", new Map([["typeAllowed", true]])],
-		["export", new Map([["typeAllowed", isClosureOrPermissive]])],
-		["exports", new Map([
-			["namepathRole", "namepath-defining"],
-			["nameRequired", isJsdoc],
-			["typeAllowed", isClosureOrPermissive]
-		])],
-		["extends", new Map([
-			["namepathRole", "namepath-referencing"],
-			["nameRequired", isJsdoc],
-			["typeAllowed", isTypescriptOrClosure || isPermissive],
-			["typeOrNameRequired", isTypescriptOrClosure || isPermissive]
-		])],
-		["external", new Map([
-			["namepathRole", "namepath-defining"],
-			["nameRequired", true],
-			["typeAllowed", false]
-		])],
-		["fires", new Map([
-			["namepathRole", "namepath-referencing"],
-			["nameRequired", true],
-			["typeAllowed", false]
-		])],
-		["func", new Map([["namepathRole", "namepath-defining"]])],
-		["function", new Map([
-			["namepathRole", "namepath-defining"],
-			["nameRequired", false],
-			["typeAllowed", false]
-		])],
-		["host", new Map([
-			["namepathRole", "namepath-defining"],
-			["nameRequired", true],
-			["typeAllowed", false]
-		])],
-		["implements", new Map([["typeRequired", true]])],
-		["interface", new Map([
-			["nameAllowed", isClosure],
-			["namepathRole", isJsdocTypescriptOrPermissive ? "namepath-defining" : false],
-			["typeAllowed", false]
-		])],
-		["internal", new Map([["nameAllowed", false], ["namepathRole", false]])],
-		["lends", new Map([["namepathRole", "namepath-referencing"], ["typeOrNameRequired", true]])],
-		["link", new Map([["namepathRole", "namepath-or-url-referencing"]])],
-		["linkcode", new Map([["namepathRole", "namepath-or-url-referencing"]])],
-		["linkplain", new Map([["namepathRole", "namepath-or-url-referencing"]])],
-		["listens", new Map([
-			["namepathRole", "namepath-referencing"],
-			["nameRequired", true],
-			["typeAllowed", false]
-		])],
-		["member", new Map([["namepathRole", "namepath-defining"], ["typeAllowed", true]])],
-		["memberof!", new Map([["namepathRole", "namepath-referencing"], ["typeOrNameRequired", true]])],
-		["memberof", new Map([["namepathRole", "namepath-referencing"], ["typeOrNameRequired", true]])],
-		["method", new Map([["namepathRole", "namepath-defining"]])],
-		["mixes", new Map([["namepathRole", "namepath-referencing"], ["typeOrNameRequired", true]])],
-		["mixin", new Map([
-			["namepathRole", "namepath-defining"],
-			["nameRequired", false],
-			["typeAllowed", false]
-		])],
-		["modifies", new Map([["typeAllowed", true]])],
-		["module", new Map([["namepathRole", isJsdoc ? "namepath-defining" : "text"], ["typeAllowed", true]])],
-		["name", new Map([
-			["namepathRole", "namepath-defining"],
-			["nameRequired", true],
-			["typeOrNameRequired", true]
-		])],
-		["namespace", new Map([["namepathRole", "namepath-defining"], ["typeAllowed", true]])],
-		["package", new Map([["typeAllowed", isClosureOrPermissive]])],
-		["param", new Map([
-			["namepathRole", "namepath-defining"],
-			["nameRequired", true],
-			["typeAllowed", true]
-		])],
-		["private", new Map([["typeAllowed", isClosureOrPermissive]])],
-		["prop", new Map([
-			["namepathRole", "namepath-defining"],
-			["nameRequired", true],
-			["typeAllowed", true]
-		])],
-		["property", new Map([
-			["namepathRole", "namepath-defining"],
-			["nameRequired", true],
-			["typeAllowed", true]
-		])],
-		["protected", new Map([["typeAllowed", isClosureOrPermissive]])],
-		["public", new Map([["typeAllowed", isClosureOrPermissive]])],
-		["requires", new Map([
-			["namepathRole", "namepath-referencing"],
-			["nameRequired", true],
-			["typeAllowed", false]
-		])],
-		["return", new Map([["typeAllowed", true]])],
-		["returns", new Map([["typeAllowed", true]])],
-		["satisfies", new Map([["typeRequired", true]])],
-		["see", new Map([["namepathRole", "text"]])],
-		["static", new Map([["typeAllowed", isClosureOrPermissive]])],
-		["suppress", new Map([["namepathRole", !isClosure], ["typeRequired", isClosure]])],
-		["template", new Map([
-			["namepathRole", isJsdoc ? "text" : "namepath-referencing"],
-			["nameRequired", !isJsdoc],
-			["typeAllowed", isTypescriptOrClosure || isPermissive]
-		])],
-		["this", new Map([
-			["namepathRole", isJsdoc ? "namepath-referencing" : false],
-			["typeOrNameRequired", isJsdoc],
-			["typeRequired", isTypescriptOrClosure]
-		])],
-		["throws", new Map([["typeAllowed", true]])],
-		["tutorial", new Map([["nameRequired", true], ["typeAllowed", false]])],
-		["type", new Map([["typeRequired", true]])],
-		["typedef", new Map([
-			["namepathRole", "namepath-defining"],
-			["nameRequired", isJsdocOrPermissive],
-			["typeAllowed", true],
-			["typeOrNameRequired", !isTypescript]
-		])],
-		["var", new Map([["namepathRole", "namepath-defining"], ["typeAllowed", true]])],
-		["yield", new Map([["typeAllowed", true]])],
-		["yields", new Map([["typeAllowed", true]])]
-	]);
-};
-var getDefaultTagStructureForMode_default = getDefaultTagStructureForMode;
-
-//#endregion
-export { getDefaultTagStructureForMode_default as default };
-//# sourceMappingURL=getDefaultTagStructureForMode.js.map

package/dist/getDefaultTagStructureForMode.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getDefaultTagStructureForMode.js","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'|'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        // 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        // 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        //  \"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      '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', '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      '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":";;;;;;;;AAOA,MAAM,gCAAgC,CAAC,SAAS;CAC9C,MAAM,UAAU,SAAS;CACzB,MAAM,YAAY,SAAS;CAC3B,MAAM,eAAe,SAAS;CAC9B,MAAM,eAAe,SAAS;CAE9B,MAAM,sBAAsB,WAAW;CACvC,MAAM,sBAAsB,WAAW;CACvC,MAAM,wBAAwB,gBAAgB;CAC9C,MAAM,wBAAwB,aAAa;CAC3C,MAAM,gCAAgC,uBAAuB;;;;AAgC7D,QAAO,IAAI,IAAI;EACb,CACE,SAAS,IAAI,IAA+C,CAE1D,CACE,gBAAgB,mBACjB,GAGD,CACE,sBAAsB,IACvB,CACF,EACF;EAED,CACE,OAAO,IAAI,IAA+C;GACxD,CACE,gBAAgB,mBACjB;GAGD,CACE,gBAAgB,IACjB;GAID,CACE,eAAe,IAChB;EACF,EACF;EAED,CACE,YAAY,IAAI,IAA+C;GAC7D,CACE,gBAAgB,mBACjB;GAGD,CACE,gBAAgB,IACjB;GAID,CACE,eAAe,IAChB;EACF,EACF;EAED,CACE,YAAY,IAAI,IAA+C;GAE7D,CACE,gBAAgB,sBACjB;GAGD,CACE,eAAe,IAChB;GAGD,CACE,sBAAsB,IACvB;EACF,EACF;EAED,CACE,WAAW,IAAI,IAA+C,CAG5D,CACE,gBAAgB,sBACjB,GAGD,CACE,sBAAsB,IACvB,CACF,EACF;EAED,CACE,YAAY,IAAI,IAA+C,CAI7D,CACE,gBAAgB,mBACjB,GAGD,CACE,gBAAgB,IACjB,CACF,EACF;EAED,CACE,SAAS,IAAI,IAA+C;GAE1D,CACE,eAAe,IAChB;GAGD,CACE,gBAAgB,mBACjB;GAED,CACE,eAAe,IAChB;EACF,EACF;EAED,CACE,SAAS,IAAI,IAA+C,CAE1D,CACE,gBAAgB,mBACjB,GAED,CACE,eAAe,IAChB,CACF,EACF;EACD,CACE,YAAY,IAAI,IAA+C,CAE7D,CACE,gBAAgB,mBACjB,GAED,CACE,eAAe,IAChB,CACF,EACF;EACD,CACE,eAAe,IAAI,IAA+C,CAEhE,CACE,gBAAgB,mBACjB,GAED,CACE,eAAe,IAChB,CACF,EACF;EAED,CACE,cAAc,IAAI,IAA+C;GAE/D,CACE,gBAAgB,mBACjB;GAED,CACE,gBAAgB,KACjB;GAED,CACE,eAAe,KAChB;EACF,EACF;EAED,CACE,UAAU,IAAI,IAA+C,CAC3D,CACE,gBAAgB,SACjB,CACF,EACF;EAED,CACE,SAAS,IAAI,IAA+C;GAE1D,CACE,gBAAgB,sBACjB;GAED,CACE,gBAAgB,IACjB;GAED,CACE,eAAe,KAChB;EACF,EACF;EAED,CACE,QAAQ,IAAI,IAA+C,CAEzD,CACE,eAAe,IAChB,CACF,EACF;EAED,CACE,SAAS,IAAI,IAA+C,CAI1D,CACE,gBAAgB,mBACjB,GAGD,CACE,gBAAgB,IACjB,CACF,EACF;EAED,CACE,aAAa,IAAI,IAA+C,CAE9D,CACE,eAAe,IAChB,CACF,EACF;EAGD,CACE,UAAU,IAAI,IAA+C,CAC3D,CACE,eAAe,qBAChB,CACF,EACF;EAED,CACE,WAAW,IAAI,IAA+C;GAC5D,CACE,gBAAgB,mBACjB;GAED,CACE,gBAAgB,OACjB;GAED,CACE,eAAe,qBAChB;EACF,EACF;EAED,CACE,WAAW,IAAI,IAA+C;GAE5D,CACE,gBAAgB,sBACjB;GAED,CACE,gBAAgB,OACjB;GAGD,CACE,eAAe,yBAAyB,YACzC;GAGD,CACE,sBAAsB,yBAAyB,YAChD;EACF,EACF;EAED,CACE,YAAY,IAAI,IAA+C;GAI7D,CACE,gBAAgB,mBACjB;GAGD,CACE,gBAAgB,IACjB;GAED,CACE,eAAe,KAChB;EACF,EACF;EAED,CACE,SAAS,IAAI,IAA+C;GAG1D,CACE,gBAAgB,sBACjB;GAED,CACE,gBAAgB,IACjB;GAED,CACE,eAAe,KAChB;EACF,EACF;EAED,CACE,QAAQ,IAAI,IAA+C,CAEzD,CACE,gBAAgB,mBACjB,CACF,EACF;EACD,CACE,YAAY,IAAI,IAA+C;GAE7D,CACE,gBAAgB,mBACjB;GAED,CACE,gBAAgB,KACjB;GAED,CACE,eAAe,KAChB;EACF,EACF;EAED,CACE,QAAQ,IAAI,IAA+C;GAIzD,CACE,gBAAgB,mBACjB;GAGD,CACE,gBAAgB,IACjB;GAED,CACE,eAAe,KAChB;EACF,EACF;EAED,CACE,cAAc,IAAI,IAA+C,CAG/D,CACE,gBAAgB,IACjB,CACF,EACF;EAED,CACE,aAAa,IAAI,IAA+C;GAE9D,CACE,eAAe,SAChB;GAGD,CACE,gBACA,gCAAgC,sBAAsB,KACvD;GAED,CACE,eAAe,KAChB;EACF,EACF;EAED,CACE,YAAY,IAAI,IAA+C,CAE7D,CACE,eAAe,KAChB,GAED,CACE,gBAAgB,KACjB,CACF,EACF;EAED,CACE,SAAS,IAAI,IAA+C,CAE1D,CACE,gBAAgB,sBACjB,GAGD,CACE,sBAAsB,IACvB,CACF,EACF;EAED,CACE,QAAQ,IAAI,IAA+C,CAEzD,CACE,gBAAgB,6BACjB,CAEF,EACF;EAED,CACE,YAAY,IAAI,IAA+C,CAG7D,CACE,gBAAgB,6BACjB,CACF,EACF;EAED,CACE,aAAa,IAAI,IAA+C,CAG9D,CACE,gBAAgB,6BACjB,CACF,EACF;EAED,CACE,WAAW,IAAI,IAA+C;GAG5D,CACE,gBAAgB,sBACjB;GAED,CACE,gBAAgB,IACjB;GAED,CACE,eAAe,KAChB;EACF,EACF;EAED,CACE,UAAU,IAAI,IAA+C,CAE3D,CACE,gBAAgB,mBACjB,GAGD,CACE,eAAe,IAChB,CACF,EACF;EAED,CACE,aAAa,IAAI,IAA+C,CAG9D,CACE,gBAAgB,sBACjB,GAGD,CACE,sBAAsB,IACvB,CACF,EACF;EACD,CACE,YAAY,IAAI,IAA+C,CAG7D,CACE,gBAAgB,sBACjB,GAGD,CACE,sBAAsB,IACvB,CACF,EACF;EAED,CACE,UAAU,IAAI,IAA+C,CAE3D,CACE,gBAAgB,mBACjB,CACF,EACF;EACD,CACE,SAAS,IAAI,IAA+C,CAG1D,CACE,gBAAgB,sBACjB,GAGD,CACE,sBAAsB,IACvB,CACF,EACF;EAED,CACE,SAAS,IAAI,IAA+C;GAE1D,CACE,gBAAgB,mBACjB;GAED,CACE,gBAAgB,KACjB;GAED,CACE,eAAe,KAChB;EACF,EACF;EAED,CACE,YAAY,IAAI,IAA+C,CAI7D,CACE,eAAe,IAChB,CACF,EACF;EAED,CACE,UAAU,IAAI,IAA+C,CAI3D,CACE,gBAAgB,UAAU,sBAAsB,MACjD,GAGD,CACE,eAAe,IAChB,CACF,EACF;EAED,CACE,QAAQ,IAAI,IAA+C;GAGzD,CACE,gBAAgB,mBACjB;GAGD,CACE,gBAAgB,IACjB;GAGD,CACE,sBAAsB,IACvB;EACF,EACF;EAED,CACE,aAAa,IAAI,IAA+C,CAE9D,CACE,gBAAgB,mBACjB,GAGD,CACE,eAAe,IAChB,CACF,EACF;EACD,CACE,WAAW,IAAI,IAA+C,CAG5D,CACE,eAAe,qBAChB,CACF,EACF;EAED,CACE,SAAS,IAAI,IAA+C;GAC1D,CACE,gBAAgB,mBACjB;GAMD,CACE,gBAAgB,IACjB;GAID,CACE,eAAe,IAChB;EACF,EACF;EAED,CACE,WAAW,IAAI,IAA+C,CAG5D,CACE,eAAe,qBAChB,CACF,EACF;EAED,CACE,QAAQ,IAAI,IAA+C;GACzD,CACE,gBAAgB,mBACjB;GAGD,CACE,gBAAgB,IACjB;GAID,CACE,eAAe,IAChB;EACF,EACF;EAED,CACE,YAAY,IAAI,IAA+C;GAC7D,CACE,gBAAgB,mBACjB;GAID,CACE,gBAAgB,IACjB;GAID,CACE,eAAe,IAChB;EACF,EACF;EAED,CACE,aAAa,IAAI,IAA+C,CAG9D,CACE,eAAe,qBAChB,CACF,EACF;EAED,CACE,UAAU,IAAI,IAA+C,CAE3D,CACE,eAAe,qBAChB,CACF,EACF;EAED,CACE,YAAY,IAAI,IAA+C;GAE7D,CACE,gBAAgB,sBACjB;GAED,CACE,gBAAgB,IACjB;GAED,CACE,eAAe,KAChB;EACF,EACF;EAED,CACE,UAAU,IAAI,IAA+C,CAE3D,CACE,eAAe,IAChB,CACF,EACF;EACD,CACE,WAAW,IAAI,IAA+C,CAE5D,CACE,eAAe,IAChB,CACF,EACF;EAED,CACE,aAAa,IAAI,IAA+C,CAE9D,CACE,gBAAgB,IACjB,CACF,EACF;EAED,CACE,OAAO,IAAI,IAA+C,CAGxD,CACE,gBAAgB,MACjB,CACF,EACF;EAED,CACE,UAAU,IAAI,IAA+C,CAE3D,CACE,eAAe,qBAChB,CACF,EACF;EAED,CACE,YAAY,IAAI,IAA+C,CAC7D,CACE,gBAAgB,CAAC,SAClB,GACD,CACE,gBAAgB,SACjB,CACF,EACF;EAED,CACE,YAAY,IAAI,IAA+C;GAC7D,CACE,gBAAgB,UAAU,SAAS,sBACpC;GAED,CACE,gBAAgB,CAAC,OAClB;GAKD,CACE,eAAe,yBAAyB,YACzC;EACF,EACF;EAED,CACE,QAAQ,IAAI,IAA+C;GAGzD,CACE,gBAAgB,UAAU,yBAAyB,KACpD;GAGD,CACE,sBAAsB,OACvB;GAED,CACE,gBAAgB,qBACjB;EACF,EACF;EAED,CACE,UAAU,IAAI,IAA+C,CAE3D,CACE,eAAe,IAChB,CACF,EACF;EAED,CACE,YAAY,IAAI,IAA+C,CAE7D,CACE,gBAAgB,IACjB,GAED,CACE,eAAe,KAChB,CACF,EACF;EAED,CACE,QAAQ,IAAI,IAA+C,CAGzD,CACE,gBAAgB,IACjB,CACF,EACF;EAED,CACE,WAAW,IAAI,IAA+C;GAG5D,CACE,gBAAgB,mBACjB;GAKD,CACE,gBAAgB,mBACjB;GAMD,CACE,eAAe,IAChB;GAID,CACE,sBAAsB,CAAC,YACxB;EACF,EACF;EAED,CACE,OAAO,IAAI,IAA+C,CAExD,CACE,gBAAgB,mBACjB,GAGD,CACE,eAAe,IAChB,CACF,EACF;EAED,CACE,SAAS,IAAI,IAA+C,CAE1D,CACE,eAAe,IAChB,CACF,EACF;EACD,CACE,UAAU,IAAI,IAA+C,CAE3D,CACE,eAAe,IAChB,CACF,EACF;CACF;AACF;AAED,4CAAe"}

package/dist/getJsdocProcessorPlugin.d.cts

@@ -1,70 +0,0 @@
-import { ESLint, Linter } from "eslint";
-
-//#region src/getJsdocProcessorPlugin.d.ts
-declare function getJsdocProcessorPlugin(options?: JsdocProcessorOptions): ESLint.Plugin;
-type Integer = number;
-type JsdocProcessorOptions = {
-  /**
-   * Require captions for example tags
-   */
-  captionRequired?: boolean | undefined;
-  /**
-   * See docs
-   */
-  paddedIndent?: number | undefined;
-  /**
-   * See docs
-   */
-  checkDefaults?: boolean | undefined;
-  /**
-   * See docs
-   */
-  checkParams?: boolean | undefined;
-  /**
-   * See docs
-   */
-  checkExamples?: boolean | undefined;
-  /**
-   * See docs
-   */
-  checkProperties?: boolean | undefined;
-  /**
-   * See docs
-   */
-  matchingFileName?: string | undefined;
-  /**
-   * See docs
-   */
-  matchingFileNameDefaults?: string | undefined;
-  /**
-   * See docs
-   */
-  matchingFileNameParams?: string | undefined;
-  /**
-   * See docs
-   */
-  matchingFileNameProperties?: string | undefined;
-  /**
-   * See docs
-   */
-  exampleCodeRegex?: string | RegExp | undefined;
-  /**
-   * See docs
-   */
-  rejectExampleCodeRegex?: string | RegExp | undefined;
-  /**
-   * See docs
-   */
-  allowedLanguagesToProcess?: string[] | undefined;
-  /**
-   * See docs
-   */
-  sourceType?: "script" | "module" | undefined;
-  /**
-   * See docs
-   */
-  parser?: Linter.ESTreeParser | Linter.NonESTreeParser | undefined;
-};
-//#endregion
-export { Integer, JsdocProcessorOptions, getJsdocProcessorPlugin };
-//# sourceMappingURL=getJsdocProcessorPlugin.d.cts.map

package/dist/getJsdocProcessorPlugin.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getJsdocProcessorPlugin.d.cts","names":[],"sources":["../src/getJsdocProcessorPlugin.js"],"sourcesContent":[],"mappings":";;;iBA8GO,uBAAA,WAHI,wBACE,MAAA,CAAA;;;EAEN;;;EAHyB,eACnB,CAAA,EAAA,OAAA,GAAA,SAAA;EAAa"}