eslint-plugin-jsdoc 52.0.1 → 52.0.3

package/dist/rules/validTypes.js

@@ -0,0 +1,259 @@
+import iterateJsdoc from "../iterateJsdoc.js";
+import { parse, traverse, tryParse } from "@es-joy/jsdoccomment";
+
+//#region src/rules/validTypes.js
+const inlineTags = new Set([
+	"link",
+	"linkcode",
+	"linkplain",
+	"tutorial"
+]);
+const jsdocTypePrattKeywords = new Set([
+	"import",
+	"is",
+	"readonly",
+	"typeof"
+]);
+const asExpression = /as\s+/v;
+const suppressTypes = new Set([
+	"accessControls",
+	"checkDebuggerStatement",
+	"checkEs5InheritanceCorrectnessConditions",
+	"checkPrototypalTypes",
+	"checkRegExp",
+	"checkTypes",
+	"checkVars",
+	"closureClassChecks",
+	"closureDepMethodUsageChecks",
+	"const",
+	"constantProperty",
+	"dangerousUnrecognizedTypeError",
+	"deprecated",
+	"duplicate",
+	"es5Strict",
+	"externsValidation",
+	"extraProvide",
+	"extraRequire",
+	"globalThis",
+	"invalidCasts",
+	"lateProvide",
+	"legacyGoogScopeRequire",
+	"lintChecks",
+	"lintVarDeclarations",
+	"messageConventions",
+	"misplacedTypeAnnotation",
+	"missingOverride",
+	"missingPolyfill",
+	"missingProperties",
+	"missingProvide",
+	"missingRequire",
+	"missingReturn",
+	"missingSourcesWarnings",
+	"moduleLoad",
+	"msgDescriptions",
+	"nonStandardJsDocs",
+	"partialAlias",
+	"polymer",
+	"reportUnknownTypes",
+	"strictCheckTypes",
+	"strictMissingProperties",
+	"strictModuleDepCheck",
+	"strictPrimitiveOperators",
+	"suspiciousCode",
+	"switch",
+	"transitionalSuspiciousCodeWarnings",
+	"undefinedNames",
+	"undefinedVars",
+	"underscore",
+	"unknownDefines",
+	"untranspilableFeatures",
+	"unusedLocalVariables",
+	"unusedPrivateMembers",
+	"uselessCode",
+	"useOfGoogProvide",
+	"visibility",
+	"with"
+]);
+/**
+* @param {string} path
+* @returns {boolean}
+*/
+const tryParsePathIgnoreError = (path) => {
+	try {
+		tryParse(path);
+		return true;
+	} catch {}
+	return false;
+};
+var validTypes_default = iterateJsdoc(({ context, jsdoc, report, settings, utils }) => {
+	const { allowEmptyNamepaths = false } = context.options[0] || {};
+	const { mode } = settings;
+	for (const tag of jsdoc.tags) {
+		/**
+		* @param {string} namepath
+		* @param {string} [tagName]
+		* @returns {boolean}
+		*/
+		const validNamepathParsing = function(namepath, tagName) {
+			if (tryParsePathIgnoreError(namepath) || jsdocTypePrattKeywords.has(namepath)) return true;
+			let handled = false;
+			if (tagName) switch (tagName) {
+				case "memberof":
+				case "memberof!": {
+					const endChar = namepath.slice(-1);
+					if ([
+						"#",
+						".",
+						"~"
+					].includes(endChar)) handled = tryParsePathIgnoreError(namepath.slice(0, -1));
+					break;
+				}
+				case "module":
+				case "requires":
+					if (!namepath.startsWith("module:")) handled = tryParsePathIgnoreError(`module:${namepath}`);
+					break;
+				case "borrows": {
+					const startChar = namepath.charAt(0);
+					if ([
+						"#",
+						".",
+						"~"
+					].includes(startChar)) handled = tryParsePathIgnoreError(namepath.slice(1));
+				}
+			}
+			if (!handled) {
+				report(`Syntax error in namepath: ${namepath}`, null, tag);
+				return false;
+			}
+			return true;
+		};
+		/**
+		* @param {string} type
+		* @returns {boolean}
+		*/
+		const validTypeParsing = function(type) {
+			let parsedTypes;
+			try {
+				if (mode === "permissive") parsedTypes = tryParse(type);
+				else parsedTypes = parse(type, mode);
+			} catch {
+				report(`Syntax error in type: ${type}`, null, tag);
+				return false;
+			}
+			if (mode === "closure" || mode === "typescript") traverse(parsedTypes, (node) => {
+				const { type: typ } = node;
+				if ((typ === "JsdocTypeObjectField" || typ === "JsdocTypeKeyValue") && node.right?.type === "JsdocTypeNullable" && node.right?.meta?.position === "suffix") report(`Syntax error in type: ${node.right.type}`, null, tag);
+			});
+			return true;
+		};
+		if (tag.problems.length) {
+			const msg = tag.problems.reduce((str, { message }) => {
+				return str + "; " + message;
+			}, "").slice(2);
+			report(`Invalid name: ${msg}`, null, tag);
+			continue;
+		}
+		if (tag.tag === "import") continue;
+		if (tag.tag === "borrows") {
+			const thisNamepath = utils.getTagDescription(tag).replace(asExpression, "").trim();
+			if (!asExpression.test(utils.getTagDescription(tag)) || !thisNamepath) {
+				report(`@borrows must have an "as" expression. Found "${utils.getTagDescription(tag)}"`, null, tag);
+				continue;
+			}
+			if (validNamepathParsing(thisNamepath, "borrows")) {
+				const thatNamepath = tag.name;
+				validNamepathParsing(thatNamepath);
+			}
+			continue;
+		}
+		if (tag.tag === "suppress" && mode === "closure") {
+			let parsedTypes;
+			try {
+				parsedTypes = tryParse(tag.type);
+			} catch {}
+			if (parsedTypes) traverse(parsedTypes, (node) => {
+				let type;
+				if ("value" in node && typeof node.value === "string") type = node.value;
+				if (type !== void 0 && !suppressTypes.has(type)) report(`Syntax error in suppress type: ${type}`, null, tag);
+			});
+		}
+		const otherModeMaps = [
+			"jsdoc",
+			"typescript",
+			"closure",
+			"permissive"
+		].filter((mde) => {
+			return mde !== mode;
+		}).map((mde) => {
+			return utils.getTagStructureForMode(mde);
+		});
+		const tagMightHaveNamePosition = utils.tagMightHaveNamePosition(tag.tag, otherModeMaps);
+		if (tagMightHaveNamePosition !== true && tag.name) {
+			const modeInfo = tagMightHaveNamePosition === false ? "" : ` in "${mode}" mode`;
+			report(`@${tag.tag} should not have a name${modeInfo}.`, null, tag);
+			continue;
+		}
+		if (tag.type.trim().startsWith("@")) {
+			tag.description = `{${tag.type}} ${tag.description}`;
+			tag.type = "";
+		}
+		const mightHaveTypePosition = utils.tagMightHaveTypePosition(tag.tag, otherModeMaps);
+		if (mightHaveTypePosition !== true && tag.type) {
+			const modeInfo = mightHaveTypePosition === false ? "" : ` in "${mode}" mode`;
+			report(`@${tag.tag} should not have a bracketed type${modeInfo}.`, null, tag);
+			continue;
+		}
+		const tagMustHaveNamePosition = utils.tagMustHaveNamePosition(tag.tag, otherModeMaps);
+		if (tagMustHaveNamePosition !== false && !tag.name && !allowEmptyNamepaths && ![
+			"arg",
+			"argument",
+			"param",
+			"prop",
+			"property"
+		].includes(tag.tag) && (tag.tag !== "see" || !utils.getTagDescription(tag).includes("{@link"))) {
+			const modeInfo = tagMustHaveNamePosition === true ? "" : ` in "${mode}" mode`;
+			report(`Tag @${tag.tag} must have a name/namepath${modeInfo}.`, null, tag);
+			continue;
+		}
+		const mustHaveTypePosition = utils.tagMustHaveTypePosition(tag.tag, otherModeMaps);
+		if (mustHaveTypePosition !== false && !tag.type) {
+			const modeInfo = mustHaveTypePosition === true ? "" : ` in "${mode}" mode`;
+			report(`Tag @${tag.tag} must have a type${modeInfo}.`, null, tag);
+			continue;
+		}
+		const tagMissingRequiredTypeOrNamepath = utils.tagMissingRequiredTypeOrNamepath(tag, otherModeMaps);
+		if (tagMissingRequiredTypeOrNamepath !== false && !allowEmptyNamepaths) {
+			const modeInfo = tagMissingRequiredTypeOrNamepath === true ? "" : ` in "${mode}" mode`;
+			report(`Tag @${tag.tag} must have either a type or namepath${modeInfo}.`, null, tag);
+			continue;
+		}
+		const hasTypePosition = mightHaveTypePosition === true && Boolean(tag.type);
+		if (hasTypePosition) validTypeParsing(tag.type);
+		const hasNameOrNamepathPosition = (tagMustHaveNamePosition !== false || utils.tagMightHaveNamepath(tag.tag)) && Boolean(tag.name);
+		if (hasNameOrNamepathPosition) if (mode !== "jsdoc" && tag.tag === "template") for (const namepath of utils.parseClosureTemplateTag(tag)) validNamepathParsing(namepath);
+		else validNamepathParsing(tag.name, tag.tag);
+		for (const inlineTag of tag.inlineTags) if (inlineTags.has(inlineTag.tag) && !inlineTag.text && !inlineTag.namepathOrURL) report(`Inline tag "${inlineTag.tag}" missing content`, null, tag);
+	}
+	for (const inlineTag of jsdoc.inlineTags) if (inlineTags.has(inlineTag.tag) && !inlineTag.text && !inlineTag.namepathOrURL) report(`Inline tag "${inlineTag.tag}" missing content`);
+}, {
+	iterateAllJsdocs: true,
+	meta: {
+		docs: {
+			description: "Requires all types to be valid JSDoc or Closure compiler types without syntax errors.",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/valid-types.md#repos-sticky-header"
+		},
+		schema: [{
+			additionalProperties: false,
+			properties: { allowEmptyNamepaths: {
+				default: false,
+				type: "boolean"
+			} },
+			type: "object"
+		}],
+		type: "suggestion"
+	}
+});
+
+//#endregion
+export { validTypes_default as default };
+//# sourceMappingURL=validTypes.js.map

package/dist/rules/validTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validTypes.js","names":[],"sources":["../../src/rules/validTypes.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport {\n  parse,\n  traverse,\n  tryParse,\n} from '@es-joy/jsdoccomment';\n\nconst inlineTags = new Set([\n  'link', 'linkcode', 'linkplain',\n  'tutorial',\n]);\n\nconst jsdocTypePrattKeywords = new Set([\n  'import',\n  'is',\n  'readonly',\n  'typeof',\n]);\n\nconst asExpression = /as\\s+/v;\n\nconst suppressTypes = new Set([\n  // https://github.com/google/closure-compiler/wiki/@suppress-annotations\n  // https://github.com/google/closure-compiler/blob/master/src/com/google/javascript/jscomp/parsing/ParserConfig.properties#L154\n  'accessControls',\n  'checkDebuggerStatement',\n  'checkEs5InheritanceCorrectnessConditions',\n  'checkPrototypalTypes',\n  'checkRegExp',\n  'checkTypes',\n  'checkVars',\n  'closureClassChecks',\n  'closureDepMethodUsageChecks',\n  'const',\n  'constantProperty',\n  'dangerousUnrecognizedTypeError',\n  'deprecated',\n  'duplicate',\n  'es5Strict',\n  'externsValidation',\n  'extraProvide',\n  'extraRequire',\n  'globalThis',\n  'invalidCasts',\n  'lateProvide',\n  'legacyGoogScopeRequire',\n  'lintChecks',\n  'lintVarDeclarations',\n  'messageConventions',\n  'misplacedTypeAnnotation',\n  'missingOverride',\n  'missingPolyfill',\n  'missingProperties',\n  'missingProvide',\n  'missingRequire',\n  'missingReturn',\n  'missingSourcesWarnings',\n  'moduleLoad',\n  'msgDescriptions',\n  'nonStandardJsDocs',\n  'partialAlias',\n  'polymer',\n  'reportUnknownTypes',\n  'strictCheckTypes',\n  'strictMissingProperties',\n  'strictModuleDepCheck',\n  'strictPrimitiveOperators',\n  'suspiciousCode',\n\n  // Not documented in enum\n  'switch',\n  'transitionalSuspiciousCodeWarnings',\n  'undefinedNames',\n  'undefinedVars',\n  'underscore',\n  'unknownDefines',\n  'untranspilableFeatures',\n  'unusedLocalVariables',\n\n  // Not documented?\n  'unusedPrivateMembers',\n  'uselessCode',\n  'useOfGoogProvide',\n  'visibility',\n  'with',\n]);\n\n/**\n * @param {string} path\n * @returns {boolean}\n */\nconst tryParsePathIgnoreError = (path) => {\n  try {\n    tryParse(path);\n\n    return true;\n  } catch {\n    // Keep the original error for including the whole type\n  }\n\n  return false;\n};\n\n// eslint-disable-next-line complexity\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  report,\n  settings,\n  utils,\n}) => {\n  const {\n    allowEmptyNamepaths = false,\n  } = context.options[0] || {};\n  const {\n    mode,\n  } = settings;\n\n  for (const tag of jsdoc.tags) {\n    /**\n     * @param {string} namepath\n     * @param {string} [tagName]\n     * @returns {boolean}\n     */\n    const validNamepathParsing = function (namepath, tagName) {\n      if (\n        tryParsePathIgnoreError(namepath) ||\n        jsdocTypePrattKeywords.has(namepath)\n      ) {\n        return true;\n      }\n\n      let handled = false;\n\n      if (tagName) {\n        switch (tagName) {\n          case 'memberof':\n          case 'memberof!': {\n            const endChar = namepath.slice(-1);\n            if ([\n              '#', '.', '~',\n            ].includes(endChar)) {\n              handled = tryParsePathIgnoreError(namepath.slice(0, -1));\n            }\n\n            break;\n          }\n\n          case 'module': case 'requires': {\n            if (!namepath.startsWith('module:')) {\n              handled = tryParsePathIgnoreError(`module:${namepath}`);\n            }\n\n            break;\n          }\n\n          case 'borrows': {\n            const startChar = namepath.charAt(0);\n            if ([\n              '#', '.', '~',\n            ].includes(startChar)) {\n              handled = tryParsePathIgnoreError(namepath.slice(1));\n            }\n          }\n        }\n      }\n\n      if (!handled) {\n        report(`Syntax error in namepath: ${namepath}`, null, tag);\n\n        return false;\n      }\n\n      return true;\n    };\n\n    /**\n     * @param {string} type\n     * @returns {boolean}\n     */\n    const validTypeParsing = function (type) {\n      let parsedTypes;\n      try {\n        if (mode === 'permissive') {\n          parsedTypes = tryParse(type);\n        } else {\n          parsedTypes = parse(type, mode);\n        }\n      } catch {\n        report(`Syntax error in type: ${type}`, null, tag);\n\n        return false;\n      }\n\n      if (mode === 'closure' || mode === 'typescript') {\n        traverse(parsedTypes, (node) => {\n          const {\n            type: typ,\n          } = node;\n\n          if (\n            (typ === 'JsdocTypeObjectField' || typ === 'JsdocTypeKeyValue') &&\n            node.right?.type === 'JsdocTypeNullable' &&\n            node.right?.meta?.position === 'suffix'\n          ) {\n            report(`Syntax error in type: ${node.right.type}`, null, tag);\n          }\n        });\n      }\n\n      return true;\n    };\n\n    if (tag.problems.length) {\n      const msg = tag.problems.reduce((str, {\n        message,\n      }) => {\n        return str + '; ' + message;\n      }, '').slice(2);\n      report(`Invalid name: ${msg}`, null, tag);\n      continue;\n    }\n\n    if (tag.tag === 'import') {\n      // A named import will look like a type, but not be valid; we also don't\n      //  need to check the name/namepath\n      continue;\n    }\n\n    if (tag.tag === 'borrows') {\n      const thisNamepath = /** @type {string} */ (\n        utils.getTagDescription(tag)\n      ).replace(asExpression, '')\n        .trim();\n\n      if (!asExpression.test(/** @type {string} */ (\n        utils.getTagDescription(tag)\n      )) || !thisNamepath) {\n        report(`@borrows must have an \"as\" expression. Found \"${utils.getTagDescription(tag)}\"`, null, tag);\n\n        continue;\n      }\n\n      if (validNamepathParsing(thisNamepath, 'borrows')) {\n        const thatNamepath = tag.name;\n\n        validNamepathParsing(thatNamepath);\n      }\n\n      continue;\n    }\n\n    if (tag.tag === 'suppress' && mode === 'closure') {\n      let parsedTypes;\n\n      try {\n        parsedTypes = tryParse(tag.type);\n      } catch {\n        // Ignore\n      }\n\n      if (parsedTypes) {\n        traverse(parsedTypes, (node) => {\n          let type;\n          if ('value' in node && typeof node.value === 'string') {\n            type = node.value;\n          }\n\n          if (type !== undefined && !suppressTypes.has(type)) {\n            report(`Syntax error in suppress type: ${type}`, null, tag);\n          }\n        });\n      }\n    }\n\n    const otherModeMaps = /** @type {import('../jsdocUtils.js').ParserMode[]} */ ([\n      'jsdoc', 'typescript', 'closure', 'permissive',\n    ]).filter(\n      (mde) => {\n        return mde !== mode;\n      },\n    ).map((mde) => {\n      return utils.getTagStructureForMode(mde);\n    });\n\n    const tagMightHaveNamePosition = utils.tagMightHaveNamePosition(tag.tag, otherModeMaps);\n    if (tagMightHaveNamePosition !== true && tag.name) {\n      const modeInfo = tagMightHaveNamePosition === false ? '' : ` in \"${mode}\" mode`;\n      report(`@${tag.tag} should not have a name${modeInfo}.`, null, tag);\n\n      continue;\n    }\n\n    // Documentation like `@returns {@link SomeType}` is technically ambiguous. Specifically it\n    // could either be intepreted as a type `\"@link SomeType\"` or a description `\"{@link SomeType}\"`.\n    // However this is a good heuristic.\n    if (tag.type.trim().startsWith('@')) {\n      tag.description = `{${tag.type}} ${tag.description}`;\n      tag.type = '';\n    }\n\n    const mightHaveTypePosition = utils.tagMightHaveTypePosition(tag.tag, otherModeMaps);\n    if (mightHaveTypePosition !== true && tag.type) {\n      const modeInfo = mightHaveTypePosition === false ? '' : ` in \"${mode}\" mode`;\n      report(`@${tag.tag} should not have a bracketed type${modeInfo}.`, null, tag);\n\n      continue;\n    }\n\n    // REQUIRED NAME\n    const tagMustHaveNamePosition = utils.tagMustHaveNamePosition(tag.tag, otherModeMaps);\n\n    // Don't handle `@param` here though it does require name as handled by\n    //  `require-param-name` (`@property` would similarly seem to require one,\n    //  but is handled by `require-property-name`)\n    if (tagMustHaveNamePosition !== false && !tag.name && !allowEmptyNamepaths && ![\n      'arg', 'argument', 'param',\n      'prop', 'property',\n    ].includes(tag.tag) &&\n      (tag.tag !== 'see' || !utils.getTagDescription(tag).includes('{@link'))\n    ) {\n      const modeInfo = tagMustHaveNamePosition === true ? '' : ` in \"${mode}\" mode`;\n      report(`Tag @${tag.tag} must have a name/namepath${modeInfo}.`, null, tag);\n\n      continue;\n    }\n\n    // REQUIRED TYPE\n    const mustHaveTypePosition = utils.tagMustHaveTypePosition(tag.tag, otherModeMaps);\n    if (mustHaveTypePosition !== false && !tag.type) {\n      const modeInfo = mustHaveTypePosition === true ? '' : ` in \"${mode}\" mode`;\n      report(`Tag @${tag.tag} must have a type${modeInfo}.`, null, tag);\n\n      continue;\n    }\n\n    // REQUIRED TYPE OR NAME/NAMEPATH\n    const tagMissingRequiredTypeOrNamepath = utils.tagMissingRequiredTypeOrNamepath(tag, otherModeMaps);\n    if (tagMissingRequiredTypeOrNamepath !== false && !allowEmptyNamepaths) {\n      const modeInfo = tagMissingRequiredTypeOrNamepath === true ? '' : ` in \"${mode}\" mode`;\n      report(`Tag @${tag.tag} must have either a type or namepath${modeInfo}.`, null, tag);\n\n      continue;\n    }\n\n    // VALID TYPE\n    const hasTypePosition = mightHaveTypePosition === true && Boolean(tag.type);\n    if (hasTypePosition) {\n      validTypeParsing(tag.type);\n    }\n\n    // VALID NAME/NAMEPATH\n    const hasNameOrNamepathPosition = (\n      tagMustHaveNamePosition !== false ||\n      utils.tagMightHaveNamepath(tag.tag)\n    ) && Boolean(tag.name);\n\n    if (hasNameOrNamepathPosition) {\n      if (mode !== 'jsdoc' && tag.tag === 'template') {\n        for (const namepath of utils.parseClosureTemplateTag(tag)) {\n          validNamepathParsing(namepath);\n        }\n      } else {\n        validNamepathParsing(tag.name, tag.tag);\n      }\n    }\n\n    for (const inlineTag of tag.inlineTags) {\n      if (inlineTags.has(inlineTag.tag) && !inlineTag.text && !inlineTag.namepathOrURL) {\n        report(`Inline tag \"${inlineTag.tag}\" missing content`, null, tag);\n      }\n    }\n  }\n\n  for (const inlineTag of jsdoc.inlineTags) {\n    if (inlineTags.has(inlineTag.tag) && !inlineTag.text && !inlineTag.namepathOrURL) {\n      report(`Inline tag \"${inlineTag.tag}\" missing content`);\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Requires all types to be valid JSDoc or Closure compiler types without syntax errors.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/valid-types.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          allowEmptyNamepaths: {\n            default: false,\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;AAOA,MAAM,aAAa,IAAI,IAAI;CACzB;CAAQ;CAAY;CACpB;AACD;AAED,MAAM,yBAAyB,IAAI,IAAI;CACrC;CACA;CACA;CACA;AACD;AAED,MAAM,eAAe;AAErB,MAAM,gBAAgB,IAAI,IAAI;CAG5B;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CAGA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CAGA;CACA;CACA;CACA;CACA;AACD;;;;;AAMD,MAAM,0BAA0B,CAAC,SAAS;AACxC,KAAI;EACF,SAAS,KAAK;AAEd,SAAO;CACR,QAAO,CAEP;AAED,QAAO;AACR;AAGD,yBAAe,aAAa,CAAC,EAC3B,SACA,OACA,QACA,UACA,OACD,KAAK;CACJ,MAAM,EACJ,sBAAsB,OACvB,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAC5B,MAAM,EACJ,MACD,GAAG;AAEJ,MAAK,MAAM,OAAO,MAAM,MAAM;;;;;;EAM5B,MAAM,uBAAuB,SAAU,UAAU,SAAS;AACxD,OACE,wBAAwB,SAAS,IACjC,uBAAuB,IAAI,SAAS,CAEpC,QAAO;GAGT,IAAI,UAAU;AAEd,OAAI,QACF,SAAQ,SAAR;IACE,KAAK;IACL,KAAK,aAAa;KAChB,MAAM,UAAU,SAAS,MAAM,GAAG;AAClC,SAAI;MACF;MAAK;MAAK;KACX,EAAC,SAAS,QAAQ,EACjB,UAAU,wBAAwB,SAAS,MAAM,GAAG,GAAG,CAAC;AAG1D;IACD;IAED,KAAK;IAAU,KAAK;AAClB,SAAI,CAAC,SAAS,WAAW,UAAU,EACjC,UAAU,wBAAwB,CAAC,OAAO,EAAE,UAAU,CAAC;AAGzD;IAGF,KAAK,WAAW;KACd,MAAM,YAAY,SAAS,OAAO,EAAE;AACpC,SAAI;MACF;MAAK;MAAK;KACX,EAAC,SAAS,UAAU,EACnB,UAAU,wBAAwB,SAAS,MAAM,EAAE,CAAC;IAEvD;GACF;AAGH,OAAI,CAAC,SAAS;IACZ,OAAO,CAAC,0BAA0B,EAAE,UAAU,EAAE,MAAM,IAAI;AAE1D,WAAO;GACR;AAED,UAAO;EACR;;;;;EAMD,MAAM,mBAAmB,SAAU,MAAM;GACvC,IAAI;AACJ,OAAI;AACF,QAAI,SAAS,cACX,cAAc,SAAS,KAAK;SAE5B,cAAc,MAAM,MAAM,KAAK;GAElC,QAAO;IACN,OAAO,CAAC,sBAAsB,EAAE,MAAM,EAAE,MAAM,IAAI;AAElD,WAAO;GACR;AAED,OAAI,SAAS,aAAa,SAAS,cACjC,SAAS,aAAa,CAAC,SAAS;IAC9B,MAAM,EACJ,MAAM,KACP,GAAG;AAEJ,SACG,QAAQ,0BAA0B,QAAQ,wBAC3C,KAAK,OAAO,SAAS,uBACrB,KAAK,OAAO,MAAM,aAAa,UAE/B,OAAO,CAAC,sBAAsB,EAAE,KAAK,MAAM,MAAM,EAAE,MAAM,IAAI;GAEhE,EAAC;AAGJ,UAAO;EACR;AAED,MAAI,IAAI,SAAS,QAAQ;GACvB,MAAM,MAAM,IAAI,SAAS,OAAO,CAAC,KAAK,EACpC,SACD,KAAK;AACJ,WAAO,MAAM,OAAO;GACrB,GAAE,GAAG,CAAC,MAAM,EAAE;GACf,OAAO,CAAC,cAAc,EAAE,KAAK,EAAE,MAAM,IAAI;AACzC;EACD;AAED,MAAI,IAAI,QAAQ,SAGd;AAGF,MAAI,IAAI,QAAQ,WAAW;GACzB,MAAM,eACJ,MAAM,kBAAkB,IAAI,CAC5B,QAAQ,cAAc,GAAG,CACxB,MAAM;AAET,OAAI,CAAC,aAAa,KAChB,MAAM,kBAAkB,IAAI,CAC5B,IAAI,CAAC,cAAc;IACnB,OAAO,CAAC,8CAA8C,EAAE,MAAM,kBAAkB,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,IAAI;AAEnG;GACD;AAED,OAAI,qBAAqB,cAAc,UAAU,EAAE;IACjD,MAAM,eAAe,IAAI;IAEzB,qBAAqB,aAAa;GACnC;AAED;EACD;AAED,MAAI,IAAI,QAAQ,cAAc,SAAS,WAAW;GAChD,IAAI;AAEJ,OAAI;IACF,cAAc,SAAS,IAAI,KAAK;GACjC,QAAO,CAEP;AAED,OAAI,aACF,SAAS,aAAa,CAAC,SAAS;IAC9B,IAAI;AACJ,QAAI,WAAW,QAAQ,OAAO,KAAK,UAAU,UAC3C,OAAO,KAAK;AAGd,QAAI,SAAS,UAAa,CAAC,cAAc,IAAI,KAAK,EAChD,OAAO,CAAC,+BAA+B,EAAE,MAAM,EAAE,MAAM,IAAI;GAE9D,EAAC;EAEL;EAED,MAAM,gBAAwE;GAC5E;GAAS;GAAc;GAAW;EACnC,EAAE,OACD,CAAC,QAAQ;AACP,UAAO,QAAQ;EAChB,EACF,CAAC,IAAI,CAAC,QAAQ;AACb,UAAO,MAAM,uBAAuB,IAAI;EACzC,EAAC;EAEF,MAAM,2BAA2B,MAAM,yBAAyB,IAAI,KAAK,cAAc;AACvF,MAAI,6BAA6B,QAAQ,IAAI,MAAM;GACjD,MAAM,WAAW,6BAA6B,QAAQ,KAAK,CAAC,KAAK,EAAE,KAAK,MAAM,CAAC;GAC/E,OAAO,CAAC,CAAC,EAAE,IAAI,IAAI,uBAAuB,EAAE,SAAS,CAAC,CAAC,EAAE,MAAM,IAAI;AAEnE;EACD;AAKD,MAAI,IAAI,KAAK,MAAM,CAAC,WAAW,IAAI,EAAE;GACnC,IAAI,cAAc,CAAC,CAAC,EAAE,IAAI,KAAK,EAAE,EAAE,IAAI,aAAa;GACpD,IAAI,OAAO;EACZ;EAED,MAAM,wBAAwB,MAAM,yBAAyB,IAAI,KAAK,cAAc;AACpF,MAAI,0BAA0B,QAAQ,IAAI,MAAM;GAC9C,MAAM,WAAW,0BAA0B,QAAQ,KAAK,CAAC,KAAK,EAAE,KAAK,MAAM,CAAC;GAC5E,OAAO,CAAC,CAAC,EAAE,IAAI,IAAI,iCAAiC,EAAE,SAAS,CAAC,CAAC,EAAE,MAAM,IAAI;AAE7E;EACD;EAGD,MAAM,0BAA0B,MAAM,wBAAwB,IAAI,KAAK,cAAc;AAKrF,MAAI,4BAA4B,SAAS,CAAC,IAAI,QAAQ,CAAC,uBAAuB,CAAC;GAC7E;GAAO;GAAY;GACnB;GAAQ;EACT,EAAC,SAAS,IAAI,IAAI,KAChB,IAAI,QAAQ,SAAS,CAAC,MAAM,kBAAkB,IAAI,CAAC,SAAS,SAAS,GACtE;GACA,MAAM,WAAW,4BAA4B,OAAO,KAAK,CAAC,KAAK,EAAE,KAAK,MAAM,CAAC;GAC7E,OAAO,CAAC,KAAK,EAAE,IAAI,IAAI,0BAA0B,EAAE,SAAS,CAAC,CAAC,EAAE,MAAM,IAAI;AAE1E;EACD;EAGD,MAAM,uBAAuB,MAAM,wBAAwB,IAAI,KAAK,cAAc;AAClF,MAAI,yBAAyB,SAAS,CAAC,IAAI,MAAM;GAC/C,MAAM,WAAW,yBAAyB,OAAO,KAAK,CAAC,KAAK,EAAE,KAAK,MAAM,CAAC;GAC1E,OAAO,CAAC,KAAK,EAAE,IAAI,IAAI,iBAAiB,EAAE,SAAS,CAAC,CAAC,EAAE,MAAM,IAAI;AAEjE;EACD;EAGD,MAAM,mCAAmC,MAAM,iCAAiC,KAAK,cAAc;AACnG,MAAI,qCAAqC,SAAS,CAAC,qBAAqB;GACtE,MAAM,WAAW,qCAAqC,OAAO,KAAK,CAAC,KAAK,EAAE,KAAK,MAAM,CAAC;GACtF,OAAO,CAAC,KAAK,EAAE,IAAI,IAAI,oCAAoC,EAAE,SAAS,CAAC,CAAC,EAAE,MAAM,IAAI;AAEpF;EACD;EAGD,MAAM,kBAAkB,0BAA0B,QAAQ,QAAQ,IAAI,KAAK;AAC3E,MAAI,iBACF,iBAAiB,IAAI,KAAK;EAI5B,MAAM,6BACJ,4BAA4B,SAC5B,MAAM,qBAAqB,IAAI,IAAI,KAChC,QAAQ,IAAI,KAAK;AAEtB,MAAI,0BACF,KAAI,SAAS,WAAW,IAAI,QAAQ,WAClC,MAAK,MAAM,YAAY,MAAM,wBAAwB,IAAI,EACvD,qBAAqB,SAAS;OAGhC,qBAAqB,IAAI,MAAM,IAAI,IAAI;AAI3C,OAAK,MAAM,aAAa,IAAI,WAC1B,KAAI,WAAW,IAAI,UAAU,IAAI,IAAI,CAAC,UAAU,QAAQ,CAAC,UAAU,eACjE,OAAO,CAAC,YAAY,EAAE,UAAU,IAAI,iBAAiB,CAAC,EAAE,MAAM,IAAI;CAGvE;AAED,MAAK,MAAM,aAAa,MAAM,WAC5B,KAAI,WAAW,IAAI,UAAU,IAAI,IAAI,CAAC,UAAU,QAAQ,CAAC,UAAU,eACjE,OAAO,CAAC,YAAY,EAAE,UAAU,IAAI,iBAAiB,CAAC,CAAC;AAG5D,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,qBAAqB;IACnB,SAAS;IACT,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/tagNames.cjs

@@ -1,183 +1,147 @@
-"use strict";
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.typeScriptTags = exports.jsdocTags = exports.closureTags = void 0;
+//#region src/tagNames.js
 /**
- * @typedef {{
- *   [key: string]: string[]
- * }} AliasedTags
- */
-
+* @typedef {{
+*   [key: string]: string[]
+* }} AliasedTags
+*/
 /**
- * @type {AliasedTags}
- */
-const jsdocTagsUndocumented = {
-  // Undocumented but present; see
-  // https://github.com/jsdoc/jsdoc/issues/1283#issuecomment-516816802
-  // https://github.com/jsdoc/jsdoc/blob/master/packages/jsdoc/lib/jsdoc/tag/dictionary/definitions.js#L594
-  modifies: []
-};
-
+* @type {AliasedTags}
+*/
+const jsdocTagsUndocumented = { modifies: [] };
 /**
- * @type {AliasedTags}
- */
-const jsdocTags = exports.jsdocTags = {
-  ...jsdocTagsUndocumented,
-  abstract: ['virtual'],
-  access: [],
-  alias: [],
-  async: [],
-  augments: ['extends'],
-  author: [],
-  borrows: [],
-  callback: [],
-  class: ['constructor'],
-  classdesc: [],
-  constant: ['const'],
-  constructs: [],
-  copyright: [],
-  default: ['defaultvalue'],
-  deprecated: [],
-  description: ['desc'],
-  enum: [],
-  event: [],
-  example: [],
-  exports: [],
-  external: ['host'],
-  file: ['fileoverview', 'overview'],
-  fires: ['emits'],
-  function: ['func', 'method'],
-  generator: [],
-  global: [],
-  hideconstructor: [],
-  ignore: [],
-  implements: [],
-  inheritdoc: [],
-  // Allowing casing distinct from jsdoc `definitions.js` (required in Closure)
-  inheritDoc: [],
-  inner: [],
-  instance: [],
-  interface: [],
-  kind: [],
-  lends: [],
-  license: [],
-  listens: [],
-  member: ['var'],
-  memberof: [],
-  'memberof!': [],
-  mixes: [],
-  mixin: [],
-  module: [],
-  name: [],
-  namespace: [],
-  override: [],
-  package: [],
-  param: ['arg', 'argument'],
-  private: [],
-  property: ['prop'],
-  protected: [],
-  public: [],
-  readonly: [],
-  requires: [],
-  returns: ['return'],
-  see: [],
-  since: [],
-  static: [],
-  summary: [],
-  this: [],
-  throws: ['exception'],
-  todo: [],
-  tutorial: [],
-  type: [],
-  typedef: [],
-  variation: [],
-  version: [],
-  yields: ['yield']
+* @type {AliasedTags}
+*/
+const jsdocTags = {
+	...jsdocTagsUndocumented,
+	abstract: ["virtual"],
+	access: [],
+	alias: [],
+	async: [],
+	augments: ["extends"],
+	author: [],
+	borrows: [],
+	callback: [],
+	class: ["constructor"],
+	classdesc: [],
+	constant: ["const"],
+	constructs: [],
+	copyright: [],
+	default: ["defaultvalue"],
+	deprecated: [],
+	description: ["desc"],
+	enum: [],
+	event: [],
+	example: [],
+	exports: [],
+	external: ["host"],
+	file: ["fileoverview", "overview"],
+	fires: ["emits"],
+	function: ["func", "method"],
+	generator: [],
+	global: [],
+	hideconstructor: [],
+	ignore: [],
+	implements: [],
+	inheritdoc: [],
+	inheritDoc: [],
+	inner: [],
+	instance: [],
+	interface: [],
+	kind: [],
+	lends: [],
+	license: [],
+	listens: [],
+	member: ["var"],
+	memberof: [],
+	"memberof!": [],
+	mixes: [],
+	mixin: [],
+	module: [],
+	name: [],
+	namespace: [],
+	override: [],
+	package: [],
+	param: ["arg", "argument"],
+	private: [],
+	property: ["prop"],
+	protected: [],
+	public: [],
+	readonly: [],
+	requires: [],
+	returns: ["return"],
+	see: [],
+	since: [],
+	static: [],
+	summary: [],
+	this: [],
+	throws: ["exception"],
+	todo: [],
+	tutorial: [],
+	type: [],
+	typedef: [],
+	variation: [],
+	version: [],
+	yields: ["yield"]
 };
-
 /**
- * @type {AliasedTags}
- */
-const typeScriptTags = exports.typeScriptTags = {
-  ...jsdocTags,
-  // https://github.com/microsoft/TypeScript/issues/22160
-  // https://devblogs.microsoft.com/typescript/announcing-typescript-5-5/#the-jsdoc-import-tag
-  import: [],
-  // https://www.typescriptlang.org/tsconfig/#stripInternal
-  internal: [],
-  // https://devblogs.microsoft.com/typescript/announcing-typescript-5-0/#overload-support-in-jsdoc
-  overload: [],
-  // https://devblogs.microsoft.com/typescript/announcing-typescript-5-0/#satisfies-support-in-jsdoc
-  satisfies: [],
-  // `@template` is also in TypeScript per:
-  //      https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html#supported-jsdoc
-  template: []
+* @type {AliasedTags}
+*/
+const typeScriptTags = {
+	...jsdocTags,
+	import: [],
+	internal: [],
+	overload: [],
+	satisfies: [],
+	template: []
 };
-
 /**
- * @type {AliasedTags}
- */
+* @type {AliasedTags}
+*/
 const undocumentedClosureTags = {
-  // These are in Closure source but not in jsdoc source nor in the Closure
-  //  docs: https://github.com/google/closure-compiler/blob/master/src/com/google/javascript/jscomp/parsing/Annotation.java
-  closurePrimitive: [],
-  customElement: [],
-  expose: [],
-  hidden: [],
-  idGenerator: [],
-  meaning: [],
-  mixinClass: [],
-  mixinFunction: [],
-  ngInject: [],
-  owner: [],
-  typeSummary: [],
-  wizaction: []
+	closurePrimitive: [],
+	customElement: [],
+	expose: [],
+	hidden: [],
+	idGenerator: [],
+	meaning: [],
+	mixinClass: [],
+	mixinFunction: [],
+	ngInject: [],
+	owner: [],
+	typeSummary: [],
+	wizaction: []
 };
-const {
-  /* eslint-disable no-unused-vars */
-  inheritdoc,
-  internal,
-  overload,
-  // Will be inverted to prefer `return`
-  returns,
-  satisfies,
-  /* eslint-enable no-unused-vars */
-  ...typeScriptTagsInClosure
-} = typeScriptTags;
-
+const { inheritdoc, internal, overload, returns, satisfies,...typeScriptTagsInClosure } = typeScriptTags;
 /**
- * @type {AliasedTags}
- */
-const closureTags = exports.closureTags = {
-  ...typeScriptTagsInClosure,
-  ...undocumentedClosureTags,
-  // From https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler
-  // These are all recognized in https://github.com/jsdoc/jsdoc/blob/master/packages/jsdoc/lib/jsdoc/tag/dictionary/definitions.js
-  //   except for the experimental `noinline` and the casing differences noted below
-
-  // Defined as a synonym of `const` in jsdoc `definitions.js`
-  define: [],
-  dict: [],
-  export: [],
-  externs: [],
-  final: [],
-  // With casing distinct from jsdoc `definitions.js`
-  implicitCast: [],
-  noalias: [],
-  nocollapse: [],
-  nocompile: [],
-  noinline: [],
-  nosideeffects: [],
-  polymer: [],
-  polymerBehavior: [],
-  preserve: [],
-  // Defined as a synonym of `interface` in jsdoc `definitions.js`
-  record: [],
-  return: ['returns'],
-  struct: [],
-  suppress: [],
-  unrestricted: []
+* @type {AliasedTags}
+*/
+const closureTags = {
+	...typeScriptTagsInClosure,
+	...undocumentedClosureTags,
+	define: [],
+	dict: [],
+	export: [],
+	externs: [],
+	final: [],
+	implicitCast: [],
+	noalias: [],
+	nocollapse: [],
+	nocompile: [],
+	noinline: [],
+	nosideeffects: [],
+	polymer: [],
+	polymerBehavior: [],
+	preserve: [],
+	record: [],
+	return: ["returns"],
+	struct: [],
+	suppress: [],
+	unrestricted: []
 };
+
+//#endregion
+exports.closureTags = closureTags;
+exports.jsdocTags = jsdocTags;
+exports.typeScriptTags = typeScriptTags;
 //# sourceMappingURL=tagNames.cjs.map