chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags#9128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
manovotny merged 1 commit into from
Jul 14, 2026
Merged

chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags #9128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/eslint-typedoc-tag-sync.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
37 changes: 37 additions & 0 deletions .typedoc/custom-tags.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
/**
* The custom JSDoc tags our Typedoc tooling defines, in Typedoc form (leading `@`).
*
* `typedoc.config.mjs` registers these with Typedoc, and `eslint.config.mjs` derives
* `jsdoc/check-tag-names`'s `definedTags` from them, so adding a tag here keeps the docs
* tooling and the linter in sync.
*/

export const CUSTOM_BLOCK_TAGS = [
'@unionReturnHeadings',
'@displayFunctionSignature',
'@paramExtension',
'@experimental',
'@hideReturns',
];

export const CUSTOM_MODIFIER_TAGS = [
/** Suppresses the Parameters table in `.typedoc/extract-methods.mjs` method MDX. */
'@skipParametersSection',
/**
* On a reference-object property whose value is an inline object type: omit the parent from the main Properties table;
* extract each callable member as `methods/<parent>-<child>.mdx` and each non-callable object member as a nested heading + property table (see `.typedoc/extract-methods.mjs`).
*/
'@extractMethods',
/** Type-only / router hints; not user-facing prose (see `notRenderedTags` in `typedoc.config.mjs`). */
'@inline',
'@inlineType',
/** With `@inline`, still emit a standalone `.mdx` page (see `.typedoc/standalone-page-tag.mjs`). */
'@standalonePage',
/** Self-documenting placeholder for declarations intentionally left without a description. */
'@generateWithEmptyComment',
/**
* On a generic wrapper type (e.g. `ClerkPaginationRequest<T>`), opts every alias of the form `Foo<{...}>` into a single merged properties table that includes the wrapper's own properties. Without this, typedoc-plugin-markdown renders such aliases as empty pages because the resolved type is a ReferenceType with no inline declaration.
* Handled by `.typedoc/custom-plugin.mjs`.
*/
'@expandProperties',
];
8 changes: 7 additions & 1 deletion eslint.config.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,8 @@ import pluginYml from 'eslint-plugin-yml';
import globals from 'globals';
import tseslint from 'typescript-eslint';

import { CUSTOM_BLOCK_TAGS, CUSTOM_MODIFIER_TAGS } from './.typedoc/custom-tags.mjs';

const ECMA_VERSION = 2021,
JAVASCRIPT_FILES = ['**/*.cjs', '**/*.js', '**/*.jsx', '**/*.mjs'],
TEST_FILES = ['**/*.test.js', '**/*.test.jsx', '**/*.test.ts', '**/*.test.tsx', '**/test/**', '**/__tests__/**'],
Expand DownExpand Up@@ -663,7 +665,11 @@ export default tseslint.config([
'jsdoc/informative-docs': 'warn',
'jsdoc/check-tag-names': [
'warn',
{ definedTags: ['inline', 'unionReturnHeadings', 'displayFunctionSignature', 'paramExtension'], typed: false },
{
// Derived from the Typedoc tooling's custom tags (`.typedoc/custom-tags.mjs`) so the two cannot drift.
definedTags: [...CUSTOM_BLOCK_TAGS, ...CUSTOM_MODIFIER_TAGS].map(tag => tag.slice(1)),
typed: false,
},
],
'jsdoc/require-hyphen-before-param-description': 'warn',
'jsdoc/require-description': 'off',
Expand Down
32 changes: 3 additions & 29 deletions typedoc.config.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
import { OptionDefaults } from 'typedoc';

const CUSTOM_BLOCK_TAGS = [
'@unionReturnHeadings',
'@displayFunctionSignature',
'@paramExtension',
'@experimental',
'@hideReturns',
];
import { CUSTOM_BLOCK_TAGS, CUSTOM_MODIFIER_TAGS } from './.typedoc/custom-tags.mjs';

/** @type {import("typedoc-plugin-markdown").PluginOptions} */
const typedocPluginMarkdownOptions = {
Expand DownExpand Up@@ -106,28 +100,8 @@ const config = {
excludeNotDocumented: true,
gitRevision: 'main',
blockTags: [...OptionDefaults.blockTags, ...CUSTOM_BLOCK_TAGS],
modifierTags: [
...OptionDefaults.modifierTags.filter(tag => tag !== '@experimental'),
/** Suppresses the Parameters table in `.typedoc/extract-methods.mjs` method MDX. */
'@skipParametersSection',
/**
* On a reference-object property whose value is an inline object type: omit the parent from the main Properties table;
* extract each callable member as `methods/<parent>-<child>.mdx` and each non-callable object member as a nested heading + property table (see `.typedoc/extract-methods.mjs`).
*/
'@extractMethods',
/** Type-only / router hints; not user-facing prose (see `notRenderedTags`). */
'@inline',
'@inlineType',
/** With `@inline`, still emit a standalone `.mdx` page (see `.typedoc/standalone-page-tag.mjs`). */
'@standalonePage',
/** Self-documenting placeholder for declarations intentionally left without a description. */
'@generateWithEmptyComment',
/**
* On a generic wrapper type (e.g. `ClerkPaginationRequest<T>`), opts every alias of the form `Foo<{...}>` into a single merged properties table that includes the wrapper's own properties. Without this, typedoc-plugin-markdown renders such aliases as empty pages because the resolved type is a ReferenceType with no inline declaration.
* Handled by `.typedoc/custom-plugin.mjs`.
*/
'@expandProperties',
],
// `@experimental` ships as a default modifier tag; we re-classify it as a block tag via CUSTOM_BLOCK_TAGS.
modifierTags: [...OptionDefaults.modifierTags.filter(tag => tag !== '@experimental'), ...CUSTOM_MODIFIER_TAGS],
/**
* Keep `@inline` / `@inlineType` / `@standalonePage` in the model so the custom router and theme can read them.
*/
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags#9128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

manovotny
merged 1 commit into

from

Jul 14, 2026
 Merged


chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags
#9128
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/eslint-typedoc-tag-sync.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

37 changes: 37 additions & 0 deletions
.typedoc/custom-tags.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
/**
 * The custom JSDoc tags our Typedoc tooling defines, in Typedoc form (leading `@`).
 *
 * `typedoc.config.mjs` registers these with Typedoc, and `eslint.config.mjs` derives
 * `jsdoc/check-tag-names`'s `definedTags` from them, so adding a tag here keeps the docs
 * tooling and the linter in sync.
 */

export const CUSTOM_BLOCK_TAGS = [
 '@unionReturnHeadings',
 '@displayFunctionSignature',
 '@paramExtension',
 '@experimental',
 '@hideReturns',
];

export const CUSTOM_MODIFIER_TAGS = [
 /** Suppresses the Parameters table in `.typedoc/extract-methods.mjs` method MDX. */
 '@skipParametersSection',
 /**
 * On a reference-object property whose value is an inline object type: omit the parent from the main Properties table;
 * extract each callable member as `methods/<parent>-<child>.mdx` and each non-callable object member as a nested heading + property table (see `.typedoc/extract-methods.mjs`).
 */
 '@extractMethods',
 /** Type-only / router hints; not user-facing prose (see `notRenderedTags` in `typedoc.config.mjs`). */
 '@inline',
 '@inlineType',
 /** With `@inline`, still emit a standalone `.mdx` page (see `.typedoc/standalone-page-tag.mjs`). */
 '@standalonePage',
 /** Self-documenting placeholder for declarations intentionally left without a description. */
 '@generateWithEmptyComment',
 /**
 * On a generic wrapper type (e.g. `ClerkPaginationRequest<T>`), opts every alias of the form `Foo<{...}>` into a single merged properties table that includes the wrapper's own properties. Without this, typedoc-plugin-markdown renders such aliases as empty pages because the resolved type is a ReferenceType with no inline declaration.
 * Handled by `.typedoc/custom-plugin.mjs`.
 */
 '@expandProperties',
];

8 changes: 7 additions & 1 deletion
eslint.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,8 @@ import pluginYml from 'eslint-plugin-yml';
import globals from 'globals';
import tseslint from 'typescript-eslint';

import { CUSTOM_BLOCK_TAGS, CUSTOM_MODIFIER_TAGS } from './.typedoc/custom-tags.mjs';

const ECMA_VERSION = 2021,
 JAVASCRIPT_FILES = ['**/*.cjs', '**/*.js', '**/*.jsx', '**/*.mjs'],
 TEST_FILES = ['**/*.test.js', '**/*.test.jsx', '**/*.test.ts', '**/*.test.tsx', '**/test/**', '**/__tests__/**'],
Expand DownExpand Up@@ -663,7 +665,11 @@ export default tseslint.config([
 'jsdoc/informative-docs': 'warn',
 'jsdoc/check-tag-names': [
 'warn',
 { definedTags: ['inline', 'unionReturnHeadings', 'displayFunctionSignature', 'paramExtension'], typed: false },
 {
 // Derived from the Typedoc tooling's custom tags (`.typedoc/custom-tags.mjs`) so the two cannot drift.
 definedTags: [...CUSTOM_BLOCK_TAGS, ...CUSTOM_MODIFIER_TAGS].map(tag => tag.slice(1)),
 typed: false,
 },
 ],
 'jsdoc/require-hyphen-before-param-description': 'warn',
 'jsdoc/require-description': 'off',
Expand Down

32 changes: 3 additions & 29 deletions
typedoc.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
import { OptionDefaults } from 'typedoc';

const CUSTOM_BLOCK_TAGS = [
 '@unionReturnHeadings',
 '@displayFunctionSignature',
 '@paramExtension',
 '@experimental',
 '@hideReturns',
];
import { CUSTOM_BLOCK_TAGS, CUSTOM_MODIFIER_TAGS } from './.typedoc/custom-tags.mjs';

/** @type {import("typedoc-plugin-markdown").PluginOptions} */
const typedocPluginMarkdownOptions = {
Expand DownExpand Up@@ -106,28 +100,8 @@ const config = {
 excludeNotDocumented: true,
 gitRevision: 'main',
 blockTags: [...OptionDefaults.blockTags, ...CUSTOM_BLOCK_TAGS],
 modifierTags: [
 ...OptionDefaults.modifierTags.filter(tag => tag !== '@experimental'),
 /** Suppresses the Parameters table in `.typedoc/extract-methods.mjs` method MDX. */
 '@skipParametersSection',
 /**
 * On a reference-object property whose value is an inline object type: omit the parent from the main Properties table;
 * extract each callable member as `methods/<parent>-<child>.mdx` and each non-callable object member as a nested heading + property table (see `.typedoc/extract-methods.mjs`).
 */
 '@extractMethods',
 /** Type-only / router hints; not user-facing prose (see `notRenderedTags`). */
 '@inline',
 '@inlineType',
 /** With `@inline`, still emit a standalone `.mdx` page (see `.typedoc/standalone-page-tag.mjs`). */
 '@standalonePage',
 /** Self-documenting placeholder for declarations intentionally left without a description. */
 '@generateWithEmptyComment',
 /**
 * On a generic wrapper type (e.g. `ClerkPaginationRequest<T>`), opts every alias of the form `Foo<{...}>` into a single merged properties table that includes the wrapper's own properties. Without this, typedoc-plugin-markdown renders such aliases as empty pages because the resolved type is a ReferenceType with no inline declaration.
 * Handled by `.typedoc/custom-plugin.mjs`.
 */
 '@expandProperties',
 ],
 // `@experimental` ships as a default modifier tag; we re-classify it as a block tag via CUSTOM_BLOCK_TAGS.
 modifierTags: [...OptionDefaults.modifierTags.filter(tag => tag !== '@experimental'), ...CUSTOM_MODIFIER_TAGS],
 /**
 * Keep `@inline` / `@inlineType` / `@standalonePage` in the model so the custom router and theme can read them.
 */
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags#9128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

manovotny
merged 1 commit into

from

Jul 14, 2026
 Merged


chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags
#9128
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/eslint-typedoc-tag-sync.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

37 changes: 37 additions & 0 deletions
.typedoc/custom-tags.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
/**
 * The custom JSDoc tags our Typedoc tooling defines, in Typedoc form (leading `@`).
 *
 * `typedoc.config.mjs` registers these with Typedoc, and `eslint.config.mjs` derives
 * `jsdoc/check-tag-names`'s `definedTags` from them, so adding a tag here keeps the docs
 * tooling and the linter in sync.
 */

export const CUSTOM_BLOCK_TAGS = [
 '@unionReturnHeadings',
 '@displayFunctionSignature',
 '@paramExtension',
 '@experimental',
 '@hideReturns',
];

export const CUSTOM_MODIFIER_TAGS = [
 /** Suppresses the Parameters table in `.typedoc/extract-methods.mjs` method MDX. */
 '@skipParametersSection',
 /**
 * On a reference-object property whose value is an inline object type: omit the parent from the main Properties table;
 * extract each callable member as `methods/<parent>-<child>.mdx` and each non-callable object member as a nested heading + property table (see `.typedoc/extract-methods.mjs`).
 */
 '@extractMethods',
 /** Type-only / router hints; not user-facing prose (see `notRenderedTags` in `typedoc.config.mjs`). */
 '@inline',
 '@inlineType',
 /** With `@inline`, still emit a standalone `.mdx` page (see `.typedoc/standalone-page-tag.mjs`). */
 '@standalonePage',
 /** Self-documenting placeholder for declarations intentionally left without a description. */
 '@generateWithEmptyComment',
 /**
 * On a generic wrapper type (e.g. `ClerkPaginationRequest<T>`), opts every alias of the form `Foo<{...}>` into a single merged properties table that includes the wrapper's own properties. Without this, typedoc-plugin-markdown renders such aliases as empty pages because the resolved type is a ReferenceType with no inline declaration.
 * Handled by `.typedoc/custom-plugin.mjs`.
 */
 '@expandProperties',
];

8 changes: 7 additions & 1 deletion
eslint.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,8 @@ import pluginYml from 'eslint-plugin-yml';
import globals from 'globals';
import tseslint from 'typescript-eslint';

import { CUSTOM_BLOCK_TAGS, CUSTOM_MODIFIER_TAGS } from './.typedoc/custom-tags.mjs';

const ECMA_VERSION = 2021,
 JAVASCRIPT_FILES = ['**/*.cjs', '**/*.js', '**/*.jsx', '**/*.mjs'],
 TEST_FILES = ['**/*.test.js', '**/*.test.jsx', '**/*.test.ts', '**/*.test.tsx', '**/test/**', '**/__tests__/**'],
Expand DownExpand Up@@ -663,7 +665,11 @@ export default tseslint.config([
 'jsdoc/informative-docs': 'warn',
 'jsdoc/check-tag-names': [
 'warn',
 { definedTags: ['inline', 'unionReturnHeadings', 'displayFunctionSignature', 'paramExtension'], typed: false },
 {
 // Derived from the Typedoc tooling's custom tags (`.typedoc/custom-tags.mjs`) so the two cannot drift.
 definedTags: [...CUSTOM_BLOCK_TAGS, ...CUSTOM_MODIFIER_TAGS].map(tag => tag.slice(1)),
 typed: false,
 },
 ],
 'jsdoc/require-hyphen-before-param-description': 'warn',
 'jsdoc/require-description': 'off',
Expand Down

32 changes: 3 additions & 29 deletions
typedoc.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
import { OptionDefaults } from 'typedoc';

const CUSTOM_BLOCK_TAGS = [
 '@unionReturnHeadings',
 '@displayFunctionSignature',
 '@paramExtension',
 '@experimental',
 '@hideReturns',
];
import { CUSTOM_BLOCK_TAGS, CUSTOM_MODIFIER_TAGS } from './.typedoc/custom-tags.mjs';

/** @type {import("typedoc-plugin-markdown").PluginOptions} */
const typedocPluginMarkdownOptions = {
Expand DownExpand Up@@ -106,28 +100,8 @@ const config = {
 excludeNotDocumented: true,
 gitRevision: 'main',
 blockTags: [...OptionDefaults.blockTags, ...CUSTOM_BLOCK_TAGS],
 modifierTags: [
 ...OptionDefaults.modifierTags.filter(tag => tag !== '@experimental'),
 /** Suppresses the Parameters table in `.typedoc/extract-methods.mjs` method MDX. */
 '@skipParametersSection',
 /**
 * On a reference-object property whose value is an inline object type: omit the parent from the main Properties table;
 * extract each callable member as `methods/<parent>-<child>.mdx` and each non-callable object member as a nested heading + property table (see `.typedoc/extract-methods.mjs`).
 */
 '@extractMethods',
 /** Type-only / router hints; not user-facing prose (see `notRenderedTags`). */
 '@inline',
 '@inlineType',
 /** With `@inline`, still emit a standalone `.mdx` page (see `.typedoc/standalone-page-tag.mjs`). */
 '@standalonePage',
 /** Self-documenting placeholder for declarations intentionally left without a description. */
 '@generateWithEmptyComment',
 /**
 * On a generic wrapper type (e.g. `ClerkPaginationRequest<T>`), opts every alias of the form `Foo<{...}>` into a single merged properties table that includes the wrapper's own properties. Without this, typedoc-plugin-markdown renders such aliases as empty pages because the resolved type is a ReferenceType with no inline declaration.
 * Handled by `.typedoc/custom-plugin.mjs`.
 */
 '@expandProperties',
 ],
 // `@experimental` ships as a default modifier tag; we re-classify it as a block tag via CUSTOM_BLOCK_TAGS.
 modifierTags: [...OptionDefaults.modifierTags.filter(tag => tag !== '@experimental'), ...CUSTOM_MODIFIER_TAGS],
 /**
 * Keep `@inline` / `@inlineType` / `@standalonePage` in the model so the custom router and theme can read them.
 */
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags#9128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

manovotny
merged 1 commit into

from

Jul 14, 2026
 Merged


chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags
#9128
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/eslint-typedoc-tag-sync.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

37 changes: 37 additions & 0 deletions
.typedoc/custom-tags.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
/**
 * The custom JSDoc tags our Typedoc tooling defines, in Typedoc form (leading `@`).
 *
 * `typedoc.config.mjs` registers these with Typedoc, and `eslint.config.mjs` derives
 * `jsdoc/check-tag-names`'s `definedTags` from them, so adding a tag here keeps the docs
 * tooling and the linter in sync.
 */

export const CUSTOM_BLOCK_TAGS = [
 '@unionReturnHeadings',
 '@displayFunctionSignature',
 '@paramExtension',
 '@experimental',
 '@hideReturns',
];

export const CUSTOM_MODIFIER_TAGS = [
 /** Suppresses the Parameters table in `.typedoc/extract-methods.mjs` method MDX. */
 '@skipParametersSection',
 /**
 * On a reference-object property whose value is an inline object type: omit the parent from the main Properties table;
 * extract each callable member as `methods/<parent>-<child>.mdx` and each non-callable object member as a nested heading + property table (see `.typedoc/extract-methods.mjs`).
 */
 '@extractMethods',
 /** Type-only / router hints; not user-facing prose (see `notRenderedTags` in `typedoc.config.mjs`). */
 '@inline',
 '@inlineType',
 /** With `@inline`, still emit a standalone `.mdx` page (see `.typedoc/standalone-page-tag.mjs`). */
 '@standalonePage',
 /** Self-documenting placeholder for declarations intentionally left without a description. */
 '@generateWithEmptyComment',
 /**
 * On a generic wrapper type (e.g. `ClerkPaginationRequest<T>`), opts every alias of the form `Foo<{...}>` into a single merged properties table that includes the wrapper's own properties. Without this, typedoc-plugin-markdown renders such aliases as empty pages because the resolved type is a ReferenceType with no inline declaration.
 * Handled by `.typedoc/custom-plugin.mjs`.
 */
 '@expandProperties',
];

8 changes: 7 additions & 1 deletion
eslint.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,8 @@ import pluginYml from 'eslint-plugin-yml';
import globals from 'globals';
import tseslint from 'typescript-eslint';

import { CUSTOM_BLOCK_TAGS, CUSTOM_MODIFIER_TAGS } from './.typedoc/custom-tags.mjs';

const ECMA_VERSION = 2021,
 JAVASCRIPT_FILES = ['**/*.cjs', '**/*.js', '**/*.jsx', '**/*.mjs'],
 TEST_FILES = ['**/*.test.js', '**/*.test.jsx', '**/*.test.ts', '**/*.test.tsx', '**/test/**', '**/__tests__/**'],
Expand DownExpand Up@@ -663,7 +665,11 @@ export default tseslint.config([
 'jsdoc/informative-docs': 'warn',
 'jsdoc/check-tag-names': [
 'warn',
 { definedTags: ['inline', 'unionReturnHeadings', 'displayFunctionSignature', 'paramExtension'], typed: false },
 {
 // Derived from the Typedoc tooling's custom tags (`.typedoc/custom-tags.mjs`) so the two cannot drift.
 definedTags: [...CUSTOM_BLOCK_TAGS, ...CUSTOM_MODIFIER_TAGS].map(tag => tag.slice(1)),
 typed: false,
 },
 ],
 'jsdoc/require-hyphen-before-param-description': 'warn',
 'jsdoc/require-description': 'off',
Expand Down

32 changes: 3 additions & 29 deletions
typedoc.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
import { OptionDefaults } from 'typedoc';

const CUSTOM_BLOCK_TAGS = [
 '@unionReturnHeadings',
 '@displayFunctionSignature',
 '@paramExtension',
 '@experimental',
 '@hideReturns',
];
import { CUSTOM_BLOCK_TAGS, CUSTOM_MODIFIER_TAGS } from './.typedoc/custom-tags.mjs';

/** @type {import("typedoc-plugin-markdown").PluginOptions} */
const typedocPluginMarkdownOptions = {
Expand DownExpand Up@@ -106,28 +100,8 @@ const config = {
 excludeNotDocumented: true,
 gitRevision: 'main',
 blockTags: [...OptionDefaults.blockTags, ...CUSTOM_BLOCK_TAGS],
 modifierTags: [
 ...OptionDefaults.modifierTags.filter(tag => tag !== '@experimental'),
 /** Suppresses the Parameters table in `.typedoc/extract-methods.mjs` method MDX. */
 '@skipParametersSection',
 /**
 * On a reference-object property whose value is an inline object type: omit the parent from the main Properties table;
 * extract each callable member as `methods/<parent>-<child>.mdx` and each non-callable object member as a nested heading + property table (see `.typedoc/extract-methods.mjs`).
 */
 '@extractMethods',
 /** Type-only / router hints; not user-facing prose (see `notRenderedTags`). */
 '@inline',
 '@inlineType',
 /** With `@inline`, still emit a standalone `.mdx` page (see `.typedoc/standalone-page-tag.mjs`). */
 '@standalonePage',
 /** Self-documenting placeholder for declarations intentionally left without a description. */
 '@generateWithEmptyComment',
 /**
 * On a generic wrapper type (e.g. `ClerkPaginationRequest<T>`), opts every alias of the form `Foo<{...}>` into a single merged properties table that includes the wrapper's own properties. Without this, typedoc-plugin-markdown renders such aliases as empty pages because the resolved type is a ReferenceType with no inline declaration.
 * Handled by `.typedoc/custom-plugin.mjs`.
 */
 '@expandProperties',
 ],
 // `@experimental` ships as a default modifier tag; we re-classify it as a block tag via CUSTOM_BLOCK_TAGS.
 modifierTags: [...OptionDefaults.modifierTags.filter(tag => tag !== '@experimental'), ...CUSTOM_MODIFIER_TAGS],
 /**
 * Keep `@inline` / `@inlineType` / `@standalonePage` in the model so the custom router and theme can read them.
 */
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags#9128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

manovotny
merged 1 commit into

from

Jul 14, 2026
 Merged


chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags
#9128
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/eslint-typedoc-tag-sync.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

37 changes: 37 additions & 0 deletions
.typedoc/custom-tags.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
/**
 * The custom JSDoc tags our Typedoc tooling defines, in Typedoc form (leading `@`).
 *
 * `typedoc.config.mjs` registers these with Typedoc, and `eslint.config.mjs` derives
 * `jsdoc/check-tag-names`'s `definedTags` from them, so adding a tag here keeps the docs
 * tooling and the linter in sync.
 */

export const CUSTOM_BLOCK_TAGS = [
 '@unionReturnHeadings',
 '@displayFunctionSignature',
 '@paramExtension',
 '@experimental',
 '@hideReturns',
];

export const CUSTOM_MODIFIER_TAGS = [
 /** Suppresses the Parameters table in `.typedoc/extract-methods.mjs` method MDX. */
 '@skipParametersSection',
 /**
 * On a reference-object property whose value is an inline object type: omit the parent from the main Properties table;
 * extract each callable member as `methods/<parent>-<child>.mdx` and each non-callable object member as a nested heading + property table (see `.typedoc/extract-methods.mjs`).
 */
 '@extractMethods',
 /** Type-only / router hints; not user-facing prose (see `notRenderedTags` in `typedoc.config.mjs`). */
 '@inline',
 '@inlineType',
 /** With `@inline`, still emit a standalone `.mdx` page (see `.typedoc/standalone-page-tag.mjs`). */
 '@standalonePage',
 /** Self-documenting placeholder for declarations intentionally left without a description. */
 '@generateWithEmptyComment',
 /**
 * On a generic wrapper type (e.g. `ClerkPaginationRequest<T>`), opts every alias of the form `Foo<{...}>` into a single merged properties table that includes the wrapper's own properties. Without this, typedoc-plugin-markdown renders such aliases as empty pages because the resolved type is a ReferenceType with no inline declaration.
 * Handled by `.typedoc/custom-plugin.mjs`.
 */
 '@expandProperties',
];

8 changes: 7 additions & 1 deletion
eslint.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,8 @@ import pluginYml from 'eslint-plugin-yml';
import globals from 'globals';
import tseslint from 'typescript-eslint';

import { CUSTOM_BLOCK_TAGS, CUSTOM_MODIFIER_TAGS } from './.typedoc/custom-tags.mjs';

const ECMA_VERSION = 2021,
 JAVASCRIPT_FILES = ['**/*.cjs', '**/*.js', '**/*.jsx', '**/*.mjs'],
 TEST_FILES = ['**/*.test.js', '**/*.test.jsx', '**/*.test.ts', '**/*.test.tsx', '**/test/**', '**/__tests__/**'],
Expand DownExpand Up@@ -663,7 +665,11 @@ export default tseslint.config([
 'jsdoc/informative-docs': 'warn',
 'jsdoc/check-tag-names': [
 'warn',
 { definedTags: ['inline', 'unionReturnHeadings', 'displayFunctionSignature', 'paramExtension'], typed: false },
 {
 // Derived from the Typedoc tooling's custom tags (`.typedoc/custom-tags.mjs`) so the two cannot drift.
 definedTags: [...CUSTOM_BLOCK_TAGS, ...CUSTOM_MODIFIER_TAGS].map(tag => tag.slice(1)),
 typed: false,
 },
 ],
 'jsdoc/require-hyphen-before-param-description': 'warn',
 'jsdoc/require-description': 'off',
Expand Down

32 changes: 3 additions & 29 deletions
typedoc.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
import { OptionDefaults } from 'typedoc';

const CUSTOM_BLOCK_TAGS = [
 '@unionReturnHeadings',
 '@displayFunctionSignature',
 '@paramExtension',
 '@experimental',
 '@hideReturns',
];
import { CUSTOM_BLOCK_TAGS, CUSTOM_MODIFIER_TAGS } from './.typedoc/custom-tags.mjs';

/** @type {import("typedoc-plugin-markdown").PluginOptions} */
const typedocPluginMarkdownOptions = {
Expand DownExpand Up@@ -106,28 +100,8 @@ const config = {
 excludeNotDocumented: true,
 gitRevision: 'main',
 blockTags: [...OptionDefaults.blockTags, ...CUSTOM_BLOCK_TAGS],
 modifierTags: [
 ...OptionDefaults.modifierTags.filter(tag => tag !== '@experimental'),
 /** Suppresses the Parameters table in `.typedoc/extract-methods.mjs` method MDX. */
 '@skipParametersSection',
 /**
 * On a reference-object property whose value is an inline object type: omit the parent from the main Properties table;
 * extract each callable member as `methods/<parent>-<child>.mdx` and each non-callable object member as a nested heading + property table (see `.typedoc/extract-methods.mjs`).
 */
 '@extractMethods',
 /** Type-only / router hints; not user-facing prose (see `notRenderedTags`). */
 '@inline',
 '@inlineType',
 /** With `@inline`, still emit a standalone `.mdx` page (see `.typedoc/standalone-page-tag.mjs`). */
 '@standalonePage',
 /** Self-documenting placeholder for declarations intentionally left without a description. */
 '@generateWithEmptyComment',
 /**
 * On a generic wrapper type (e.g. `ClerkPaginationRequest<T>`), opts every alias of the form `Foo<{...}>` into a single merged properties table that includes the wrapper's own properties. Without this, typedoc-plugin-markdown renders such aliases as empty pages because the resolved type is a ReferenceType with no inline declaration.
 * Handled by `.typedoc/custom-plugin.mjs`.
 */
 '@expandProperties',
 ],
 // `@experimental` ships as a default modifier tag; we re-classify it as a block tag via CUSTOM_BLOCK_TAGS.
 modifierTags: [...OptionDefaults.modifierTags.filter(tag => tag !== '@experimental'), ...CUSTOM_MODIFIER_TAGS],
 /**
 * Keep `@inline` / `@inlineType` / `@standalonePage` in the model so the custom router and theme can read them.
 */
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags#9128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

manovotny
merged 1 commit into

from

Jul 14, 2026
 Merged


chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags
#9128
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/eslint-typedoc-tag-sync.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

37 changes: 37 additions & 0 deletions
.typedoc/custom-tags.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
/**
 * The custom JSDoc tags our Typedoc tooling defines, in Typedoc form (leading `@`).
 *
 * `typedoc.config.mjs` registers these with Typedoc, and `eslint.config.mjs` derives
 * `jsdoc/check-tag-names`'s `definedTags` from them, so adding a tag here keeps the docs
 * tooling and the linter in sync.
 */

export const CUSTOM_BLOCK_TAGS = [
 '@unionReturnHeadings',
 '@displayFunctionSignature',
 '@paramExtension',
 '@experimental',
 '@hideReturns',
];

export const CUSTOM_MODIFIER_TAGS = [
 /** Suppresses the Parameters table in `.typedoc/extract-methods.mjs` method MDX. */
 '@skipParametersSection',
 /**
 * On a reference-object property whose value is an inline object type: omit the parent from the main Properties table;
 * extract each callable member as `methods/<parent>-<child>.mdx` and each non-callable object member as a nested heading + property table (see `.typedoc/extract-methods.mjs`).
 */
 '@extractMethods',
 /** Type-only / router hints; not user-facing prose (see `notRenderedTags` in `typedoc.config.mjs`). */
 '@inline',
 '@inlineType',
 /** With `@inline`, still emit a standalone `.mdx` page (see `.typedoc/standalone-page-tag.mjs`). */
 '@standalonePage',
 /** Self-documenting placeholder for declarations intentionally left without a description. */
 '@generateWithEmptyComment',
 /**
 * On a generic wrapper type (e.g. `ClerkPaginationRequest<T>`), opts every alias of the form `Foo<{...}>` into a single merged properties table that includes the wrapper's own properties. Without this, typedoc-plugin-markdown renders such aliases as empty pages because the resolved type is a ReferenceType with no inline declaration.
 * Handled by `.typedoc/custom-plugin.mjs`.
 */
 '@expandProperties',
];

8 changes: 7 additions & 1 deletion
eslint.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,8 @@ import pluginYml from 'eslint-plugin-yml';
import globals from 'globals';
import tseslint from 'typescript-eslint';

import { CUSTOM_BLOCK_TAGS, CUSTOM_MODIFIER_TAGS } from './.typedoc/custom-tags.mjs';

const ECMA_VERSION = 2021,
 JAVASCRIPT_FILES = ['**/*.cjs', '**/*.js', '**/*.jsx', '**/*.mjs'],
 TEST_FILES = ['**/*.test.js', '**/*.test.jsx', '**/*.test.ts', '**/*.test.tsx', '**/test/**', '**/__tests__/**'],
Expand DownExpand Up@@ -663,7 +665,11 @@ export default tseslint.config([
 'jsdoc/informative-docs': 'warn',
 'jsdoc/check-tag-names': [
 'warn',
 { definedTags: ['inline', 'unionReturnHeadings', 'displayFunctionSignature', 'paramExtension'], typed: false },
 {
 // Derived from the Typedoc tooling's custom tags (`.typedoc/custom-tags.mjs`) so the two cannot drift.
 definedTags: [...CUSTOM_BLOCK_TAGS, ...CUSTOM_MODIFIER_TAGS].map(tag => tag.slice(1)),
 typed: false,
 },
 ],
 'jsdoc/require-hyphen-before-param-description': 'warn',
 'jsdoc/require-description': 'off',
Expand Down

32 changes: 3 additions & 29 deletions
typedoc.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
import { OptionDefaults } from 'typedoc';

const CUSTOM_BLOCK_TAGS = [
 '@unionReturnHeadings',
 '@displayFunctionSignature',
 '@paramExtension',
 '@experimental',
 '@hideReturns',
];
import { CUSTOM_BLOCK_TAGS, CUSTOM_MODIFIER_TAGS } from './.typedoc/custom-tags.mjs';

/** @type {import("typedoc-plugin-markdown").PluginOptions} */
const typedocPluginMarkdownOptions = {
Expand DownExpand Up@@ -106,28 +100,8 @@ const config = {
 excludeNotDocumented: true,
 gitRevision: 'main',
 blockTags: [...OptionDefaults.blockTags, ...CUSTOM_BLOCK_TAGS],
 modifierTags: [
 ...OptionDefaults.modifierTags.filter(tag => tag !== '@experimental'),
 /** Suppresses the Parameters table in `.typedoc/extract-methods.mjs` method MDX. */
 '@skipParametersSection',
 /**
 * On a reference-object property whose value is an inline object type: omit the parent from the main Properties table;
 * extract each callable member as `methods/<parent>-<child>.mdx` and each non-callable object member as a nested heading + property table (see `.typedoc/extract-methods.mjs`).
 */
 '@extractMethods',
 /** Type-only / router hints; not user-facing prose (see `notRenderedTags`). */
 '@inline',
 '@inlineType',
 /** With `@inline`, still emit a standalone `.mdx` page (see `.typedoc/standalone-page-tag.mjs`). */
 '@standalonePage',
 /** Self-documenting placeholder for declarations intentionally left without a description. */
 '@generateWithEmptyComment',
 /**
 * On a generic wrapper type (e.g. `ClerkPaginationRequest<T>`), opts every alias of the form `Foo<{...}>` into a single merged properties table that includes the wrapper's own properties. Without this, typedoc-plugin-markdown renders such aliases as empty pages because the resolved type is a ReferenceType with no inline declaration.
 * Handled by `.typedoc/custom-plugin.mjs`.
 */
 '@expandProperties',
 ],
 // `@experimental` ships as a default modifier tag; we re-classify it as a block tag via CUSTOM_BLOCK_TAGS.
 modifierTags: [...OptionDefaults.modifierTags.filter(tag => tag !== '@experimental'), ...CUSTOM_MODIFIER_TAGS],
 /**
 * Keep `@inline` / `@inlineType` / `@standalonePage` in the model so the custom router and theme can read them.
 */
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags#9128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

manovotny
merged 1 commit into

from

Jul 14, 2026
 Merged


chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags
#9128
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/eslint-typedoc-tag-sync.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

37 changes: 37 additions & 0 deletions
.typedoc/custom-tags.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
/**
 * The custom JSDoc tags our Typedoc tooling defines, in Typedoc form (leading `@`).
 *
 * `typedoc.config.mjs` registers these with Typedoc, and `eslint.config.mjs` derives
 * `jsdoc/check-tag-names`'s `definedTags` from them, so adding a tag here keeps the docs
 * tooling and the linter in sync.
 */

export const CUSTOM_BLOCK_TAGS = [
 '@unionReturnHeadings',
 '@displayFunctionSignature',
 '@paramExtension',
 '@experimental',
 '@hideReturns',
];

export const CUSTOM_MODIFIER_TAGS = [
 /** Suppresses the Parameters table in `.typedoc/extract-methods.mjs` method MDX. */
 '@skipParametersSection',
 /**
 * On a reference-object property whose value is an inline object type: omit the parent from the main Properties table;
 * extract each callable member as `methods/<parent>-<child>.mdx` and each non-callable object member as a nested heading + property table (see `.typedoc/extract-methods.mjs`).
 */
 '@extractMethods',
 /** Type-only / router hints; not user-facing prose (see `notRenderedTags` in `typedoc.config.mjs`). */
 '@inline',
 '@inlineType',
 /** With `@inline`, still emit a standalone `.mdx` page (see `.typedoc/standalone-page-tag.mjs`). */
 '@standalonePage',
 /** Self-documenting placeholder for declarations intentionally left without a description. */
 '@generateWithEmptyComment',
 /**
 * On a generic wrapper type (e.g. `ClerkPaginationRequest<T>`), opts every alias of the form `Foo<{...}>` into a single merged properties table that includes the wrapper's own properties. Without this, typedoc-plugin-markdown renders such aliases as empty pages because the resolved type is a ReferenceType with no inline declaration.
 * Handled by `.typedoc/custom-plugin.mjs`.
 */
 '@expandProperties',
];

8 changes: 7 additions & 1 deletion
eslint.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,8 @@ import pluginYml from 'eslint-plugin-yml';
import globals from 'globals';
import tseslint from 'typescript-eslint';

import { CUSTOM_BLOCK_TAGS, CUSTOM_MODIFIER_TAGS } from './.typedoc/custom-tags.mjs';

const ECMA_VERSION = 2021,
 JAVASCRIPT_FILES = ['**/*.cjs', '**/*.js', '**/*.jsx', '**/*.mjs'],
 TEST_FILES = ['**/*.test.js', '**/*.test.jsx', '**/*.test.ts', '**/*.test.tsx', '**/test/**', '**/__tests__/**'],
Expand DownExpand Up@@ -663,7 +665,11 @@ export default tseslint.config([
 'jsdoc/informative-docs': 'warn',
 'jsdoc/check-tag-names': [
 'warn',
 { definedTags: ['inline', 'unionReturnHeadings', 'displayFunctionSignature', 'paramExtension'], typed: false },
 {
 // Derived from the Typedoc tooling's custom tags (`.typedoc/custom-tags.mjs`) so the two cannot drift.
 definedTags: [...CUSTOM_BLOCK_TAGS, ...CUSTOM_MODIFIER_TAGS].map(tag => tag.slice(1)),
 typed: false,
 },
 ],
 'jsdoc/require-hyphen-before-param-description': 'warn',
 'jsdoc/require-description': 'off',
Expand Down

32 changes: 3 additions & 29 deletions
typedoc.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
import { OptionDefaults } from 'typedoc';

const CUSTOM_BLOCK_TAGS = [
 '@unionReturnHeadings',
 '@displayFunctionSignature',
 '@paramExtension',
 '@experimental',
 '@hideReturns',
];
import { CUSTOM_BLOCK_TAGS, CUSTOM_MODIFIER_TAGS } from './.typedoc/custom-tags.mjs';

/** @type {import("typedoc-plugin-markdown").PluginOptions} */
const typedocPluginMarkdownOptions = {
Expand DownExpand Up@@ -106,28 +100,8 @@ const config = {
 excludeNotDocumented: true,
 gitRevision: 'main',
 blockTags: [...OptionDefaults.blockTags, ...CUSTOM_BLOCK_TAGS],
 modifierTags: [
 ...OptionDefaults.modifierTags.filter(tag => tag !== '@experimental'),
 /** Suppresses the Parameters table in `.typedoc/extract-methods.mjs` method MDX. */
 '@skipParametersSection',
 /**
 * On a reference-object property whose value is an inline object type: omit the parent from the main Properties table;
 * extract each callable member as `methods/<parent>-<child>.mdx` and each non-callable object member as a nested heading + property table (see `.typedoc/extract-methods.mjs`).
 */
 '@extractMethods',
 /** Type-only / router hints; not user-facing prose (see `notRenderedTags`). */
 '@inline',
 '@inlineType',
 /** With `@inline`, still emit a standalone `.mdx` page (see `.typedoc/standalone-page-tag.mjs`). */
 '@standalonePage',
 /** Self-documenting placeholder for declarations intentionally left without a description. */
 '@generateWithEmptyComment',
 /**
 * On a generic wrapper type (e.g. `ClerkPaginationRequest<T>`), opts every alias of the form `Foo<{...}>` into a single merged properties table that includes the wrapper's own properties. Without this, typedoc-plugin-markdown renders such aliases as empty pages because the resolved type is a ReferenceType with no inline declaration.
 * Handled by `.typedoc/custom-plugin.mjs`.
 */
 '@expandProperties',
 ],
 // `@experimental` ships as a default modifier tag; we re-classify it as a block tag via CUSTOM_BLOCK_TAGS.
 modifierTags: [...OptionDefaults.modifierTags.filter(tag => tag !== '@experimental'), ...CUSTOM_MODIFIER_TAGS],
 /**
 * Keep `@inline` / `@inlineType` / `@standalonePage` in the model so the custom router and theme can read them.
 */
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags#9128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

manovotny
merged 1 commit into

from

Jul 14, 2026
 Merged


chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags
#9128
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/eslint-typedoc-tag-sync.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

37 changes: 37 additions & 0 deletions
.typedoc/custom-tags.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
/**
 * The custom JSDoc tags our Typedoc tooling defines, in Typedoc form (leading `@`).
 *
 * `typedoc.config.mjs` registers these with Typedoc, and `eslint.config.mjs` derives
 * `jsdoc/check-tag-names`'s `definedTags` from them, so adding a tag here keeps the docs
 * tooling and the linter in sync.
 */

export const CUSTOM_BLOCK_TAGS = [
 '@unionReturnHeadings',
 '@displayFunctionSignature',
 '@paramExtension',
 '@experimental',
 '@hideReturns',
];

export const CUSTOM_MODIFIER_TAGS = [
 /** Suppresses the Parameters table in `.typedoc/extract-methods.mjs` method MDX. */
 '@skipParametersSection',
 /**
 * On a reference-object property whose value is an inline object type: omit the parent from the main Properties table;
 * extract each callable member as `methods/<parent>-<child>.mdx` and each non-callable object member as a nested heading + property table (see `.typedoc/extract-methods.mjs`).
 */
 '@extractMethods',
 /** Type-only / router hints; not user-facing prose (see `notRenderedTags` in `typedoc.config.mjs`). */
 '@inline',
 '@inlineType',
 /** With `@inline`, still emit a standalone `.mdx` page (see `.typedoc/standalone-page-tag.mjs`). */
 '@standalonePage',
 /** Self-documenting placeholder for declarations intentionally left without a description. */
 '@generateWithEmptyComment',
 /**
 * On a generic wrapper type (e.g. `ClerkPaginationRequest<T>`), opts every alias of the form `Foo<{...}>` into a single merged properties table that includes the wrapper's own properties. Without this, typedoc-plugin-markdown renders such aliases as empty pages because the resolved type is a ReferenceType with no inline declaration.
 * Handled by `.typedoc/custom-plugin.mjs`.
 */
 '@expandProperties',
];

8 changes: 7 additions & 1 deletion
eslint.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,8 @@ import pluginYml from 'eslint-plugin-yml';
import globals from 'globals';
import tseslint from 'typescript-eslint';

import { CUSTOM_BLOCK_TAGS, CUSTOM_MODIFIER_TAGS } from './.typedoc/custom-tags.mjs';

const ECMA_VERSION = 2021,
 JAVASCRIPT_FILES = ['**/*.cjs', '**/*.js', '**/*.jsx', '**/*.mjs'],
 TEST_FILES = ['**/*.test.js', '**/*.test.jsx', '**/*.test.ts', '**/*.test.tsx', '**/test/**', '**/__tests__/**'],
Expand DownExpand Up@@ -663,7 +665,11 @@ export default tseslint.config([
 'jsdoc/informative-docs': 'warn',
 'jsdoc/check-tag-names': [
 'warn',
 { definedTags: ['inline', 'unionReturnHeadings', 'displayFunctionSignature', 'paramExtension'], typed: false },
 {
 // Derived from the Typedoc tooling's custom tags (`.typedoc/custom-tags.mjs`) so the two cannot drift.
 definedTags: [...CUSTOM_BLOCK_TAGS, ...CUSTOM_MODIFIER_TAGS].map(tag => tag.slice(1)),
 typed: false,
 },
 ],
 'jsdoc/require-hyphen-before-param-description': 'warn',
 'jsdoc/require-description': 'off',
Expand Down

32 changes: 3 additions & 29 deletions
typedoc.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
import { OptionDefaults } from 'typedoc';

const CUSTOM_BLOCK_TAGS = [
 '@unionReturnHeadings',
 '@displayFunctionSignature',
 '@paramExtension',
 '@experimental',
 '@hideReturns',
];
import { CUSTOM_BLOCK_TAGS, CUSTOM_MODIFIER_TAGS } from './.typedoc/custom-tags.mjs';

/** @type {import("typedoc-plugin-markdown").PluginOptions} */
const typedocPluginMarkdownOptions = {
Expand DownExpand Up@@ -106,28 +100,8 @@ const config = {
 excludeNotDocumented: true,
 gitRevision: 'main',
 blockTags: [...OptionDefaults.blockTags, ...CUSTOM_BLOCK_TAGS],
 modifierTags: [
 ...OptionDefaults.modifierTags.filter(tag => tag !== '@experimental'),
 /** Suppresses the Parameters table in `.typedoc/extract-methods.mjs` method MDX. */
 '@skipParametersSection',
 /**
 * On a reference-object property whose value is an inline object type: omit the parent from the main Properties table;
 * extract each callable member as `methods/<parent>-<child>.mdx` and each non-callable object member as a nested heading + property table (see `.typedoc/extract-methods.mjs`).
 */
 '@extractMethods',
 /** Type-only / router hints; not user-facing prose (see `notRenderedTags`). */
 '@inline',
 '@inlineType',
 /** With `@inline`, still emit a standalone `.mdx` page (see `.typedoc/standalone-page-tag.mjs`). */
 '@standalonePage',
 /** Self-documenting placeholder for declarations intentionally left without a description. */
 '@generateWithEmptyComment',
 /**
 * On a generic wrapper type (e.g. `ClerkPaginationRequest<T>`), opts every alias of the form `Foo<{...}>` into a single merged properties table that includes the wrapper's own properties. Without this, typedoc-plugin-markdown renders such aliases as empty pages because the resolved type is a ReferenceType with no inline declaration.
 * Handled by `.typedoc/custom-plugin.mjs`.
 */
 '@expandProperties',
 ],
 // `@experimental` ships as a default modifier tag; we re-classify it as a block tag via CUSTOM_BLOCK_TAGS.
 modifierTags: [...OptionDefaults.modifierTags.filter(tag => tag !== '@experimental'), ...CUSTOM_MODIFIER_TAGS],
 /**
 * Keep `@inline` / `@inlineType` / `@standalonePage` in the model so the custom router and theme can read them.
 */
Expand Down
Loading