feat(check-tag-names): add Typedoc include, includeCode, and TSDoc inheritDoc/inheritdoc and label to allowable inline tags; add TSDoc and typedoc tags

brettz9 · brettz9 · commit 925f6e35f099 · 2026-01-29T12:00:43.000-07:00
diff --git a/.README/rules/check-tag-names.md b/.README/rules/check-tag-names.md
@@ -196,10 +196,19 @@ Also checks for unknown inline tags, with the following being permitted by defau
 (see the `inlineTags` option):
 
 ```
+// JSDoc
 link
 linkcode
 linkplain
 tutorial
+
+// TSDoc
+inheritDoc
+label
+
+// typedoc
+include
+includeCode
 ```
 
 ## Fixer
diff --git a/docs/rules/check-tag-names.md b/docs/rules/check-tag-names.md
@@ -208,10 +208,19 @@ Also checks for unknown inline tags, with the following being permitted by defau
 (see the `inlineTags` option):
 
 ```
+// JSDoc
 link
 linkcode
 linkplain
 tutorial
+
+// TSDoc
+inheritDoc
+label
+
+// typedoc
+include
+includeCode
 ```
 
 <a name="user-content-check-tag-names-fixer"></a>
@@ -251,7 +260,7 @@ Set to `false` to disable auto-removal of types that are redundant with the [`ty
 
 List of tags to allow inline.
 
-Defaults to array of `'link', 'linkcode', 'linkplain', 'tutorial'`
+Defaults to array of `'link', 'linkcode', 'linkplain', 'tutorial', 'inheritDoc', 'label', 'include', and 'includeCode'`
 
 <a name="user-content-check-tag-names-options-jsxtags"></a>
 <a name="check-tag-names-options-jsxtags"></a>
@@ -727,27 +736,57 @@ function quux (foo) {}
  * @variation
  * @version
  * @yields
+ * @alpha
+ * @beta
+ * @decorator
+ * @eventProperty
+ * @experimental
+ * @packageDocumentation
+ * @privateRemarks
+ * @remarks
+ * @sealed
+ * @category
+ * @categoryDescription
+ * @disableGroups
+ * @document
+ * @expand
+ * @expandType
+ * @group
+ * @groupDescription
+ * @hidden
+ * @hideCategories
+ * @hideGroups
+ * @inline
+ * @inlineType
+ * @mergeModuleWith
+ * @preventExpand
+ * @preventInline
+ * @primaryExport
+ * @showCategories
+ * @showGroups
+ * @sortStrategy
+ * @useDeclaredType
  * @import
  * @internal
+ * @jsx
  * @overload
  * @satisfies
  * @template
  */
 function quux (foo) {}
 // Settings: {"jsdoc":{"mode":"jsdoc"}}
-// Message: Invalid JSDoc tag name "import".
+// Message: Invalid JSDoc tag name "alpha".
 
 /** 
  * @externs
  */
 function quux (foo) {}
 // Message: Invalid JSDoc tag name "externs".
 
-/** @jsx h */
 /** @jsxFrag Fragment */
 /** @jsxImportSource preact */
 /** @jsxRuntime automatic */
-// Message: Invalid JSDoc tag name "jsx".
+// Message: Invalid JSDoc tag name "jsxFrag".
 
 /**
  * @constructor
@@ -1049,8 +1088,39 @@ function quux (foo) {}
  * @variation
  * @version
  * @yields
+ * @alpha
+ * @beta
+ * @decorator
+ * @eventProperty
+ * @experimental
+ * @packageDocumentation
+ * @privateRemarks
+ * @remarks
+ * @sealed
+ * @category
+ * @categoryDescription
+ * @disableGroups
+ * @document
+ * @expand
+ * @expandType
+ * @group
+ * @groupDescription
+ * @hidden
+ * @hideCategories
+ * @hideGroups
+ * @inline
+ * @inlineType
+ * @mergeModuleWith
+ * @preventExpand
+ * @preventInline
+ * @primaryExport
+ * @showCategories
+ * @showGroups
+ * @sortStrategy
+ * @useDeclaredType
  * @import
  * @internal
+ * @jsx
  * @overload
  * @satisfies
  * @template
diff --git a/src/rules.d.ts b/src/rules.d.ts
@@ -267,7 +267,7 @@ export interface Rules {
           /**
            * List of tags to allow inline.
            *
-           * Defaults to array of `'link', 'linkcode', 'linkplain', 'tutorial'`
+           * Defaults to array of `'link', 'linkcode', 'linkplain', 'tutorial', 'inheritDoc', 'label', 'include', and 'includeCode'`
            */
           inlineTags?: string[];
           /**
diff --git a/src/rules/checkTagNames.js b/src/rules/checkTagNames.js
@@ -82,7 +82,13 @@ export default iterateJsdoc(({
       definedTags = [],
       enableFixer = true,
       inlineTags = [
+        // jsdoc
         'link', 'linkcode', 'linkplain', 'tutorial',
+        // https://tsdoc.org/pages/spec/tag_kinds/#inline-tags
+        'inheritDoc',
+        'label',
+        // https://typedoc.org/documents/Tags.html#inline-tags
+        'include', 'includeCode',
       ],
       jsxTags,
       typed,
@@ -323,7 +329,7 @@ The format is as follows:
           inlineTags: {
             description: `List of tags to allow inline.
 
-Defaults to array of \`'link', 'linkcode', 'linkplain', 'tutorial'\``,
+Defaults to array of \`'link', 'linkcode', 'linkplain', 'tutorial', 'inheritDoc', 'label', 'include', and 'includeCode'\``,
             items: {
               type: 'string',
             },
diff --git a/src/tagNames.js b/src/tagNames.js
@@ -130,11 +130,68 @@ const jsdocTags = {
   ],
 };
 
+/**
+ * @see {@link https://tsdoc.org/}
+ * @type {AliasedTags}
+ */
+const tsdocTags = {
+  alpha: [],
+  beta: [],
+  decorator: [],
+  eventProperty: [],
+  experimental: [],
+  packageDocumentation: [],
+  privateRemarks: [],
+  remarks: [],
+  sealed: [],
+};
+
+/**
+ * @see {@link https://typedoc.org/documents/Tags.html}
+ * @type {AliasedTags}
+ */
+const typedocTags = {
+  category: [],
+  // https://typedoc.org/documents/Tags._category.html#category-descriptions
+  categoryDescription: [],
+  // https://typedoc.org/documents/Tags._group.html#disablegroups
+  disableGroups: [],
+  document: [],
+  expand: [],
+  // https://typedoc.org/documents/Tags._expand.html#expandtype
+  expandType: [],
+  group: [],
+  // https://typedoc.org/documents/Tags._group.html#groupdescription
+  groupDescription: [],
+  hidden: [],
+  // https://typedoc.org/documents/Tags._category.html#navigation-customization
+  hideCategories: [],
+  // https://typedoc.org/documents/Tags._group.html#navigation-customization
+  hideGroups: [],
+  inline: [],
+  // https://typedoc.org/documents/Tags._inline.html#inlinetype
+  inlineType: [],
+  mergeModuleWith: [],
+  // https://typedoc.org/documents/Tags._expand.html#preventexpand
+  preventExpand: [],
+  // https://typedoc.org/documents/Tags._inline.html#preventinline
+  preventInline: [],
+  primaryExport: [],
+  // https://typedoc.org/documents/Tags._category.html#navigation-customization
+  showCategories: [],
+  // https://typedoc.org/documents/Tags._group.html#navigation-customization
+  showGroups: [],
+  sortStrategy: [],
+  useDeclaredType: [],
+};
+
 /**
  * @type {AliasedTags}
  */
 const typeScriptTags = {
   ...jsdocTags,
+  ...tsdocTags,
+  ...typedocTags,
 
   // https://github.com/microsoft/TypeScript/issues/22160
   // https://devblogs.microsoft.com/typescript/announcing-typescript-5-5/#the-jsdoc-import-tag
@@ -143,6 +200,9 @@ const typeScriptTags = {
   // https://www.typescriptlang.org/tsconfig/#stripInternal
   internal: [],
 
+  // https://typedoc.org/documents/Tags.TypeScript_Tags.html
+  jsx: [],
+
   // https://devblogs.microsoft.com/typescript/announcing-typescript-5-0/#overload-support-in-jsdoc
   overload: [],
 
diff --git a/test/rules/assertions/checkTagNames.js b/test/rules/assertions/checkTagNames.js
@@ -824,27 +824,48 @@ export default /** @type {import('../index.js').TestCases} */ ({
     {
       code: `${ALL_TYPESCRIPT_TAGS_COMMENT}\nfunction quux (foo) {}`,
       errors: [
-        {
-          line: lineCount(ALL_TYPESCRIPT_TAGS_COMMENT) - 4,
-          message: 'Invalid JSDoc tag name "import".',
-        },
-        {
-          line: lineCount(ALL_TYPESCRIPT_TAGS_COMMENT) - 3,
-          message: 'Invalid JSDoc tag name "internal".',
-        },
-        {
-          line: lineCount(ALL_TYPESCRIPT_TAGS_COMMENT) - 2,
-          message: 'Invalid JSDoc tag name "overload".',
-        },
-        {
-          line: lineCount(ALL_TYPESCRIPT_TAGS_COMMENT) - 1,
-          message: 'Invalid JSDoc tag name "satisfies".',
-        },
-        {
-          line: lineCount(ALL_TYPESCRIPT_TAGS_COMMENT),
-          message: 'Invalid JSDoc tag name "template".',
-        },
-      ],
+        // TSDoc
+        'alpha',
+        'beta',
+        'decorator',
+        'eventProperty',
+        'experimental',
+        'packageDocumentation',
+        'privateRemarks',
+        'remarks',
+        'sealed',
+
+        // TypeDoc
+        'category',
+        'categoryDescription',
+        'disableGroups',
+        'document',
+        'expand',
+        'expandType',
+        'group',
+        'groupDescription',
+        'hidden',
+        'hideCategories',
+        'hideGroups',
+        'inline',
+        'inlineType',
+        'mergeModuleWith',
+        'preventExpand',
+        'preventInline',
+        'primaryExport',
+        'showCategories',
+        'showGroups',
+        'sortStrategy',
+        'useDeclaredType',
+
+        // JSDoc/TypeScript
+        'import', 'internal', 'jsx', 'overload', 'satisfies', 'template',
+      ].map((tagName, idx, arr) => {
+        return {
+          line: lineCount(ALL_TYPESCRIPT_TAGS_COMMENT) - arr.length + idx + 1,
+          message: `Invalid JSDoc tag name "${tagName}".`,
+        };
+      }),
       settings: {
         jsdoc: {
           mode: 'jsdoc',
@@ -862,26 +883,21 @@ export default /** @type {import('../index.js').TestCases} */ ({
     },
     {
       code: `
-        /** @jsx h */
         /** @jsxFrag Fragment */
         /** @jsxImportSource preact */
         /** @jsxRuntime automatic */
       `,
       errors: [
         {
           line: 2,
-          message: 'Invalid JSDoc tag name "jsx".',
-        },
-        {
-          line: 3,
           message: 'Invalid JSDoc tag name "jsxFrag".',
         },
         {
-          line: 4,
+          line: 3,
           message: 'Invalid JSDoc tag name "jsxImportSource".',
         },
         {
-          line: 5,
+          line: 4,
           message: 'Invalid JSDoc tag name "jsxRuntime".',
         },
       ],

Original file line number	Diff line number	Diff line change
`@@ -267,7 +267,7 @@ export interface Rules {`
`267`	`267`	`/**`
`268`	`268`	`* List of tags to allow inline.`
`269`	`269`	`*`
`270`		- * Defaults to array of `'link', 'linkcode', 'linkplain', 'tutorial'`
	`270`	+ * Defaults to array of `'link', 'linkcode', 'linkplain', 'tutorial', 'inheritDoc', 'label', 'include', and 'includeCode'`
`271`	`271`	`*/`
`272`	`272`	`inlineTags?: string[];`
`273`	`273`	`/**`