Skip to content

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

Merged
manovotny merged 1 commit into
mainfrom
manovotny/derive-eslint-jsdoc-tags-from-typedoc
Jul 14, 2026
Merged

chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags#9128
manovotny merged 1 commit into
mainfrom
manovotny/derive-eslint-jsdoc-tags-from-typedoc

Conversation

@manovotny

@manovotnymanovotny commented Jul 10, 2026•
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

Description

jsdoc/check-tag-names's definedTags list in eslint.config.mjs was written when eslint-plugin-jsdoc was introduced (#5697) and never kept in sync as the Typedoc tooling grew new custom tags (#8276 and follow-ups). As a result, every use of @generateWithEmptyComment (135 in packages/shared/src), @extractMethods, @skipParametersSection, @standalonePage, and @expandProperties emits a warn-level Invalid JSDoc tag name lint warning even though the tags are real and required by the docs tooling.

This PR moves the custom tag lists into a small shared module so the two configs cannot drift again:

  • Adds .typedoc/custom-tags.mjs exporting CUSTOM_BLOCK_TAGS and CUSTOM_MODIFIER_TAGS (the per-tag doc comments move with them).
  • typedoc.config.mjs imports the lists instead of declaring them inline. The resolved Typedoc options are byte-for-byte identical (verified by importing the config and diffing blockTags/modifierTags before and after).
  • eslint.config.mjs derives definedTags from the same lists (stripping the leading @).

Verification:

  • eslint packages/shared/src/types/signInFuture.ts: 23 Invalid JSDoc tag name warnings before, 0 after; session.ts (uses @extractMethods/@skipParametersSection) also drops to 0.
  • Typo detection still works — the whitelist is exact-match, so a misspelled @generateWithEmptyComent is still flagged.
  • Prettier and ESLint pass on all touched files.

Tooling-only change; no published package is affected, so the changeset is empty.

Checklist

  • pnpm test runs as expected.
  • pnpm build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Improved recognition and handling of custom documentation tags.
    • Kept documentation generation and linting rules synchronized, reducing incorrect warnings for supported tags.
    • Centralized custom tag definitions to provide more consistent documentation output across the project.

  • Chores

    • Added release metadata for the documentation tooling improvements.

@manovotny@claude
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags
643f590
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@changeset-bot

changeset-botBot commented Jul 10, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 643f590

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@vercel

vercelBot commented Jul 10, 2026•
edited
Loading

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 10, 2026 8:39pm
swingsetReadyReadyPreview, CommentJul 10, 2026 8:39pm

Request Review

@coderabbitai

coderabbitaiBot commented Jul 10, 2026•
edited
Loading

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Repository UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 15913535-8a25-450e-83aa-384692367679

📥 Commits

Reviewing files that changed from the base of the PR and between 7b581aa and 643f590.

📒 Files selected for processing (4)
  • .changeset/eslint-typedoc-tag-sync.md
  • .typedoc/custom-tags.mjs
  • eslint.config.mjs
  • typedoc.config.mjs
📝 Walkthrough

Walkthrough

Centralizes custom Typedoc tags in a shared module, then derives ESLint JSDoc validation and Typedoc modifier configuration from those exports. A Changesets release note records the update.

Changes

Typedoc and ESLint tag synchronization

Layer / File(s)Summary
Shared custom tag definitions
.typedoc/custom-tags.mjs		Exports block-level and modifier-level Typedoc tag arrays for shared configuration use.
Typedoc and ESLint configuration wiring
eslint.config.mjs, typedoc.config.mjs, .changeset/eslint-typedoc-tag-sync.md		Derives ESLint’s defined JSDoc tags and Typedoc’s modifier tags from the shared exports, while recording the change in a Changeset.

Estimated code review effort: 2 (Simple) | ~10 minutes

Poem

A rabbit found tags in a neat little row,
Shared them where lint and docs both go.
No lists to repeat, no burrowed-up tune,
Typedoc and ESLint now hop in sync soon.
“Carrot-sized changes!” the rabbit sings bright.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately summarizes the main change: deriving ESLint JSDoc definedTags from shared Typedoc custom tags.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch

Comment @coderabbitai help to get the list of available commands.

@pkg-pr-new

pkg-pr-newBot commented Jul 10, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@9128

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@9128

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@9128

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@9128

@clerk/electron

npm i https://pkg.pr.new/@clerk/electron@9128

@clerk/electron-passkeys

npm i https://pkg.pr.new/@clerk/electron-passkeys@9128

@clerk/eslint-plugin

npm i https://pkg.pr.new/@clerk/eslint-plugin@9128

@clerk/expo

npm i https://pkg.pr.new/@clerk/expo@9128

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@9128

@clerk/express

npm i https://pkg.pr.new/@clerk/express@9128

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@9128

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@9128

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@9128

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@9128

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@9128

@clerk/react

npm i https://pkg.pr.new/@clerk/react@9128

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@9128

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@9128

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@9128

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@9128

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@9128

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@9128

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@9128

commit: 643f590

@manovotny
manovotny merged commit 1f72baa into mainJul 14, 2026
51 checks passed
@manovotny
manovotny deleted the manovotny/derive-eslint-jsdoc-tags-from-typedoc branch July 14, 2026 14:35
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@alexcarpenteralexcarpenteralexcarpenter approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@manovotny@alexcarpenter
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags by manovotny · Pull Request #9128 · clerk/javascript · GitHub
Skip to content
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags - #9128
Merged
manovotny merged 1 commit into
mainfrom 
manovotny/derive-eslint-jsdoc-tags-from-typedoc
Jul 14, 2026
Merged
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags#9128
manovotny merged 1 commit into
mainfrom 
manovotny/derive-eslint-jsdoc-tags-from-typedoc
Conversation
@manovotny
@manovotnymanovotny
commented
Jul 10, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
jsdoc/check-tag-names's definedTags list in eslint.config.mjs was written when eslint-plugin-jsdoc was introduced (#5697) and never kept in sync as the Typedoc tooling grew new custom tags (#8276 and follow-ups). As a result, every use of @generateWithEmptyComment (135 in packages/shared/src), @extractMethods, @skipParametersSection, @standalonePage, and @expandProperties emits a warn-level Invalid JSDoc tag name lint warning even though the tags are real and required by the docs tooling.
This PR moves the custom tag lists into a small shared module so the two configs cannot drift again:
  • Adds .typedoc/custom-tags.mjs exporting CUSTOM_BLOCK_TAGS and CUSTOM_MODIFIER_TAGS (the per-tag doc comments move with them).
  • typedoc.config.mjs imports the lists instead of declaring them inline. The resolved Typedoc options are byte-for-byte identical (verified by importing the config and diffing blockTags/modifierTags before and after).
  • eslint.config.mjs derives definedTags from the same lists (stripping the leading @).
Verification:
  • eslint packages/shared/src/types/signInFuture.ts: 23 Invalid JSDoc tag name warnings before, 0 after; session.ts (uses @extractMethods/@skipParametersSection) also drops to 0.
  • Typo detection still works — the whitelist is exact-match, so a misspelled @generateWithEmptyComent is still flagged.
  • Prettier and ESLint pass on all touched files.
Tooling-only change; no published package is affected, so the changeset is empty.
Checklist
  • pnpm test runs as expected.
  • pnpm build runs as expected.
  •  (If applicable) JSDoc comments have been added or updated for any package exports
  •  (If applicable) Documentation has been updated
Type of change
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
🤖 Generated with Claude Code
Summary by CodeRabbit
  • Documentation
    • Improved recognition and handling of custom documentation tags.
    • Kept documentation generation and linting rules synchronized, reducing incorrect warnings for supported tags.
    • Centralized custom tag definitions to provide more consistent documentation output across the project.
  • Chores
    • Added release metadata for the documentation tooling improvements.
@manovotny@claude
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags
643f590
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@changeset-bot
changeset-botBot
commented
Jul 10, 2026

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 643f590
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
@vercel
vercelBot
commented
Jul 10, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 10, 2026 8:39pm
swingsetReadyReadyPreview, CommentJul 10, 2026 8:39pm
Request Review
@coderabbitai
coderabbitaiBot
commented
Jul 10, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: 15913535-8a25-450e-83aa-384692367679
📥 Commits
Reviewing files that changed from the base of the PR and between 7b581aa and 643f590.
📒 Files selected for processing (4)
  • .changeset/eslint-typedoc-tag-sync.md
  • .typedoc/custom-tags.mjs
  • eslint.config.mjs
  • typedoc.config.mjs
📝 Walkthrough
Walkthrough
Centralizes custom Typedoc tags in a shared module, then derives ESLint JSDoc validation and Typedoc modifier configuration from those exports. A Changesets release note records the update.
Changes
Typedoc and ESLint tag synchronization
Layer / File(s)Summary
Shared custom tag definitions
.typedoc/custom-tags.mjs		Exports block-level and modifier-level Typedoc tag arrays for shared configuration use.
Typedoc and ESLint configuration wiring
eslint.config.mjs, typedoc.config.mjs, .changeset/eslint-typedoc-tag-sync.md		Derives ESLint’s defined JSDoc tags and Typedoc’s modifier tags from the shared exports, while recording the change in a Changeset.
Estimated code review effort: 2 (Simple) | ~10 minutes
Poem
A rabbit found tags in a neat little row,

Shared them where lint and docs both go.

No lists to repeat, no burrowed-up tune,

Typedoc and ESLint now hop in sync soon.

“Carrot-sized changes!” the rabbit sings bright.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately summarizes the main change: deriving ESLint JSDoc definedTags from shared Typedoc custom tags.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands.
@pkg-pr-new
pkg-pr-newBot
commented
Jul 10, 2026

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@9128

@clerk/backend
npm i https://pkg.pr.new/@clerk/backend@9128

@clerk/chrome-extension
npm i https://pkg.pr.new/@clerk/chrome-extension@9128

@clerk/clerk-js
npm i https://pkg.pr.new/@clerk/clerk-js@9128

@clerk/electron
npm i https://pkg.pr.new/@clerk/electron@9128

@clerk/electron-passkeys
npm i https://pkg.pr.new/@clerk/electron-passkeys@9128

@clerk/eslint-plugin
npm i https://pkg.pr.new/@clerk/eslint-plugin@9128

@clerk/expo
npm i https://pkg.pr.new/@clerk/expo@9128

@clerk/expo-passkeys
npm i https://pkg.pr.new/@clerk/expo-passkeys@9128

@clerk/express
npm i https://pkg.pr.new/@clerk/express@9128

@clerk/fastify
npm i https://pkg.pr.new/@clerk/fastify@9128

@clerk/hono
npm i https://pkg.pr.new/@clerk/hono@9128

@clerk/localizations
npm i https://pkg.pr.new/@clerk/localizations@9128

@clerk/nextjs
npm i https://pkg.pr.new/@clerk/nextjs@9128

@clerk/nuxt
npm i https://pkg.pr.new/@clerk/nuxt@9128

@clerk/react
npm i https://pkg.pr.new/@clerk/react@9128

@clerk/react-router
npm i https://pkg.pr.new/@clerk/react-router@9128

@clerk/shared
npm i https://pkg.pr.new/@clerk/shared@9128

@clerk/tanstack-react-start
npm i https://pkg.pr.new/@clerk/tanstack-react-start@9128

@clerk/testing
npm i https://pkg.pr.new/@clerk/testing@9128

@clerk/ui
npm i https://pkg.pr.new/@clerk/ui@9128

@clerk/upgrade
npm i https://pkg.pr.new/@clerk/upgrade@9128

@clerk/vue
npm i https://pkg.pr.new/@clerk/vue@9128

commit: 643f590
@manovotny
manovotny
merged commit 1f72baa
into
mainJul 14, 2026

51 checks passed

@manovotny
manovotny
deleted the

manovotny/derive-eslint-jsdoc-tags-from-typedoc

branch
July 14, 2026 14:35
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@alexcarpenteralexcarpenteralexcarpenter approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@manovotny@alexcarpenter

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags by manovotny · Pull Request #9128 · clerk/javascript · GitHub
Skip to content
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags - #9128
Merged
manovotny merged 1 commit into
mainfrom 
manovotny/derive-eslint-jsdoc-tags-from-typedoc
Jul 14, 2026
Merged
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags#9128
manovotny merged 1 commit into
mainfrom 
manovotny/derive-eslint-jsdoc-tags-from-typedoc
Conversation
@manovotny
@manovotnymanovotny
commented
Jul 10, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
jsdoc/check-tag-names's definedTags list in eslint.config.mjs was written when eslint-plugin-jsdoc was introduced (#5697) and never kept in sync as the Typedoc tooling grew new custom tags (#8276 and follow-ups). As a result, every use of @generateWithEmptyComment (135 in packages/shared/src), @extractMethods, @skipParametersSection, @standalonePage, and @expandProperties emits a warn-level Invalid JSDoc tag name lint warning even though the tags are real and required by the docs tooling.
This PR moves the custom tag lists into a small shared module so the two configs cannot drift again:
  • Adds .typedoc/custom-tags.mjs exporting CUSTOM_BLOCK_TAGS and CUSTOM_MODIFIER_TAGS (the per-tag doc comments move with them).
  • typedoc.config.mjs imports the lists instead of declaring them inline. The resolved Typedoc options are byte-for-byte identical (verified by importing the config and diffing blockTags/modifierTags before and after).
  • eslint.config.mjs derives definedTags from the same lists (stripping the leading @).
Verification:
  • eslint packages/shared/src/types/signInFuture.ts: 23 Invalid JSDoc tag name warnings before, 0 after; session.ts (uses @extractMethods/@skipParametersSection) also drops to 0.
  • Typo detection still works — the whitelist is exact-match, so a misspelled @generateWithEmptyComent is still flagged.
  • Prettier and ESLint pass on all touched files.
Tooling-only change; no published package is affected, so the changeset is empty.
Checklist
  • pnpm test runs as expected.
  • pnpm build runs as expected.
  •  (If applicable) JSDoc comments have been added or updated for any package exports
  •  (If applicable) Documentation has been updated
Type of change
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
🤖 Generated with Claude Code
Summary by CodeRabbit
  • Documentation
    • Improved recognition and handling of custom documentation tags.
    • Kept documentation generation and linting rules synchronized, reducing incorrect warnings for supported tags.
    • Centralized custom tag definitions to provide more consistent documentation output across the project.
  • Chores
    • Added release metadata for the documentation tooling improvements.
@manovotny@claude
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags
643f590
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@changeset-bot
changeset-botBot
commented
Jul 10, 2026

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 643f590
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
@vercel
vercelBot
commented
Jul 10, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 10, 2026 8:39pm
swingsetReadyReadyPreview, CommentJul 10, 2026 8:39pm
Request Review
@coderabbitai
coderabbitaiBot
commented
Jul 10, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: 15913535-8a25-450e-83aa-384692367679
📥 Commits
Reviewing files that changed from the base of the PR and between 7b581aa and 643f590.
📒 Files selected for processing (4)
  • .changeset/eslint-typedoc-tag-sync.md
  • .typedoc/custom-tags.mjs
  • eslint.config.mjs
  • typedoc.config.mjs
📝 Walkthrough
Walkthrough
Centralizes custom Typedoc tags in a shared module, then derives ESLint JSDoc validation and Typedoc modifier configuration from those exports. A Changesets release note records the update.
Changes
Typedoc and ESLint tag synchronization
Layer / File(s)Summary
Shared custom tag definitions
.typedoc/custom-tags.mjs		Exports block-level and modifier-level Typedoc tag arrays for shared configuration use.
Typedoc and ESLint configuration wiring
eslint.config.mjs, typedoc.config.mjs, .changeset/eslint-typedoc-tag-sync.md		Derives ESLint’s defined JSDoc tags and Typedoc’s modifier tags from the shared exports, while recording the change in a Changeset.
Estimated code review effort: 2 (Simple) | ~10 minutes
Poem
A rabbit found tags in a neat little row,

Shared them where lint and docs both go.

No lists to repeat, no burrowed-up tune,

Typedoc and ESLint now hop in sync soon.

“Carrot-sized changes!” the rabbit sings bright.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately summarizes the main change: deriving ESLint JSDoc definedTags from shared Typedoc custom tags.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands.
@pkg-pr-new
pkg-pr-newBot
commented
Jul 10, 2026

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@9128

@clerk/backend
npm i https://pkg.pr.new/@clerk/backend@9128

@clerk/chrome-extension
npm i https://pkg.pr.new/@clerk/chrome-extension@9128

@clerk/clerk-js
npm i https://pkg.pr.new/@clerk/clerk-js@9128

@clerk/electron
npm i https://pkg.pr.new/@clerk/electron@9128

@clerk/electron-passkeys
npm i https://pkg.pr.new/@clerk/electron-passkeys@9128

@clerk/eslint-plugin
npm i https://pkg.pr.new/@clerk/eslint-plugin@9128

@clerk/expo
npm i https://pkg.pr.new/@clerk/expo@9128

@clerk/expo-passkeys
npm i https://pkg.pr.new/@clerk/expo-passkeys@9128

@clerk/express
npm i https://pkg.pr.new/@clerk/express@9128

@clerk/fastify
npm i https://pkg.pr.new/@clerk/fastify@9128

@clerk/hono
npm i https://pkg.pr.new/@clerk/hono@9128

@clerk/localizations
npm i https://pkg.pr.new/@clerk/localizations@9128

@clerk/nextjs
npm i https://pkg.pr.new/@clerk/nextjs@9128

@clerk/nuxt
npm i https://pkg.pr.new/@clerk/nuxt@9128

@clerk/react
npm i https://pkg.pr.new/@clerk/react@9128

@clerk/react-router
npm i https://pkg.pr.new/@clerk/react-router@9128

@clerk/shared
npm i https://pkg.pr.new/@clerk/shared@9128

@clerk/tanstack-react-start
npm i https://pkg.pr.new/@clerk/tanstack-react-start@9128

@clerk/testing
npm i https://pkg.pr.new/@clerk/testing@9128

@clerk/ui
npm i https://pkg.pr.new/@clerk/ui@9128

@clerk/upgrade
npm i https://pkg.pr.new/@clerk/upgrade@9128

@clerk/vue
npm i https://pkg.pr.new/@clerk/vue@9128

commit: 643f590
@manovotny
manovotny
merged commit 1f72baa
into
mainJul 14, 2026

51 checks passed

@manovotny
manovotny
deleted the

manovotny/derive-eslint-jsdoc-tags-from-typedoc

branch
July 14, 2026 14:35
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@alexcarpenteralexcarpenteralexcarpenter approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@manovotny@alexcarpenter

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags by manovotny · Pull Request #9128 · clerk/javascript · GitHub
Skip to content
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags - #9128
Merged
manovotny merged 1 commit into
mainfrom 
manovotny/derive-eslint-jsdoc-tags-from-typedoc
Jul 14, 2026
Merged
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags#9128
manovotny merged 1 commit into
mainfrom 
manovotny/derive-eslint-jsdoc-tags-from-typedoc
Conversation
@manovotny
@manovotnymanovotny
commented
Jul 10, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
jsdoc/check-tag-names's definedTags list in eslint.config.mjs was written when eslint-plugin-jsdoc was introduced (#5697) and never kept in sync as the Typedoc tooling grew new custom tags (#8276 and follow-ups). As a result, every use of @generateWithEmptyComment (135 in packages/shared/src), @extractMethods, @skipParametersSection, @standalonePage, and @expandProperties emits a warn-level Invalid JSDoc tag name lint warning even though the tags are real and required by the docs tooling.
This PR moves the custom tag lists into a small shared module so the two configs cannot drift again:
  • Adds .typedoc/custom-tags.mjs exporting CUSTOM_BLOCK_TAGS and CUSTOM_MODIFIER_TAGS (the per-tag doc comments move with them).
  • typedoc.config.mjs imports the lists instead of declaring them inline. The resolved Typedoc options are byte-for-byte identical (verified by importing the config and diffing blockTags/modifierTags before and after).
  • eslint.config.mjs derives definedTags from the same lists (stripping the leading @).
Verification:
  • eslint packages/shared/src/types/signInFuture.ts: 23 Invalid JSDoc tag name warnings before, 0 after; session.ts (uses @extractMethods/@skipParametersSection) also drops to 0.
  • Typo detection still works — the whitelist is exact-match, so a misspelled @generateWithEmptyComent is still flagged.
  • Prettier and ESLint pass on all touched files.
Tooling-only change; no published package is affected, so the changeset is empty.
Checklist
  • pnpm test runs as expected.
  • pnpm build runs as expected.
  •  (If applicable) JSDoc comments have been added or updated for any package exports
  •  (If applicable) Documentation has been updated
Type of change
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
🤖 Generated with Claude Code
Summary by CodeRabbit
  • Documentation
    • Improved recognition and handling of custom documentation tags.
    • Kept documentation generation and linting rules synchronized, reducing incorrect warnings for supported tags.
    • Centralized custom tag definitions to provide more consistent documentation output across the project.
  • Chores
    • Added release metadata for the documentation tooling improvements.
@manovotny@claude
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags
643f590
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@changeset-bot
changeset-botBot
commented
Jul 10, 2026

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 643f590
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
@vercel
vercelBot
commented
Jul 10, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 10, 2026 8:39pm
swingsetReadyReadyPreview, CommentJul 10, 2026 8:39pm
Request Review
@coderabbitai
coderabbitaiBot
commented
Jul 10, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: 15913535-8a25-450e-83aa-384692367679
📥 Commits
Reviewing files that changed from the base of the PR and between 7b581aa and 643f590.
📒 Files selected for processing (4)
  • .changeset/eslint-typedoc-tag-sync.md
  • .typedoc/custom-tags.mjs
  • eslint.config.mjs
  • typedoc.config.mjs
📝 Walkthrough
Walkthrough
Centralizes custom Typedoc tags in a shared module, then derives ESLint JSDoc validation and Typedoc modifier configuration from those exports. A Changesets release note records the update.
Changes
Typedoc and ESLint tag synchronization
Layer / File(s)Summary
Shared custom tag definitions
.typedoc/custom-tags.mjs		Exports block-level and modifier-level Typedoc tag arrays for shared configuration use.
Typedoc and ESLint configuration wiring
eslint.config.mjs, typedoc.config.mjs, .changeset/eslint-typedoc-tag-sync.md		Derives ESLint’s defined JSDoc tags and Typedoc’s modifier tags from the shared exports, while recording the change in a Changeset.
Estimated code review effort: 2 (Simple) | ~10 minutes
Poem
A rabbit found tags in a neat little row,

Shared them where lint and docs both go.

No lists to repeat, no burrowed-up tune,

Typedoc and ESLint now hop in sync soon.

“Carrot-sized changes!” the rabbit sings bright.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately summarizes the main change: deriving ESLint JSDoc definedTags from shared Typedoc custom tags.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands.
@pkg-pr-new
pkg-pr-newBot
commented
Jul 10, 2026

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@9128

@clerk/backend
npm i https://pkg.pr.new/@clerk/backend@9128

@clerk/chrome-extension
npm i https://pkg.pr.new/@clerk/chrome-extension@9128

@clerk/clerk-js
npm i https://pkg.pr.new/@clerk/clerk-js@9128

@clerk/electron
npm i https://pkg.pr.new/@clerk/electron@9128

@clerk/electron-passkeys
npm i https://pkg.pr.new/@clerk/electron-passkeys@9128

@clerk/eslint-plugin
npm i https://pkg.pr.new/@clerk/eslint-plugin@9128

@clerk/expo
npm i https://pkg.pr.new/@clerk/expo@9128

@clerk/expo-passkeys
npm i https://pkg.pr.new/@clerk/expo-passkeys@9128

@clerk/express
npm i https://pkg.pr.new/@clerk/express@9128

@clerk/fastify
npm i https://pkg.pr.new/@clerk/fastify@9128

@clerk/hono
npm i https://pkg.pr.new/@clerk/hono@9128

@clerk/localizations
npm i https://pkg.pr.new/@clerk/localizations@9128

@clerk/nextjs
npm i https://pkg.pr.new/@clerk/nextjs@9128

@clerk/nuxt
npm i https://pkg.pr.new/@clerk/nuxt@9128

@clerk/react
npm i https://pkg.pr.new/@clerk/react@9128

@clerk/react-router
npm i https://pkg.pr.new/@clerk/react-router@9128

@clerk/shared
npm i https://pkg.pr.new/@clerk/shared@9128

@clerk/tanstack-react-start
npm i https://pkg.pr.new/@clerk/tanstack-react-start@9128

@clerk/testing
npm i https://pkg.pr.new/@clerk/testing@9128

@clerk/ui
npm i https://pkg.pr.new/@clerk/ui@9128

@clerk/upgrade
npm i https://pkg.pr.new/@clerk/upgrade@9128

@clerk/vue
npm i https://pkg.pr.new/@clerk/vue@9128

commit: 643f590
@manovotny
manovotny
merged commit 1f72baa
into
mainJul 14, 2026

51 checks passed

@manovotny
manovotny
deleted the

manovotny/derive-eslint-jsdoc-tags-from-typedoc

branch
July 14, 2026 14:35
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@alexcarpenteralexcarpenteralexcarpenter approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@manovotny@alexcarpenter

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags by manovotny · Pull Request #9128 · clerk/javascript · GitHub
Skip to content
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags - #9128
Merged
manovotny merged 1 commit into
mainfrom 
manovotny/derive-eslint-jsdoc-tags-from-typedoc
Jul 14, 2026
Merged
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags#9128
manovotny merged 1 commit into
mainfrom 
manovotny/derive-eslint-jsdoc-tags-from-typedoc
Conversation
@manovotny
@manovotnymanovotny
commented
Jul 10, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
jsdoc/check-tag-names's definedTags list in eslint.config.mjs was written when eslint-plugin-jsdoc was introduced (#5697) and never kept in sync as the Typedoc tooling grew new custom tags (#8276 and follow-ups). As a result, every use of @generateWithEmptyComment (135 in packages/shared/src), @extractMethods, @skipParametersSection, @standalonePage, and @expandProperties emits a warn-level Invalid JSDoc tag name lint warning even though the tags are real and required by the docs tooling.
This PR moves the custom tag lists into a small shared module so the two configs cannot drift again:
  • Adds .typedoc/custom-tags.mjs exporting CUSTOM_BLOCK_TAGS and CUSTOM_MODIFIER_TAGS (the per-tag doc comments move with them).
  • typedoc.config.mjs imports the lists instead of declaring them inline. The resolved Typedoc options are byte-for-byte identical (verified by importing the config and diffing blockTags/modifierTags before and after).
  • eslint.config.mjs derives definedTags from the same lists (stripping the leading @).
Verification:
  • eslint packages/shared/src/types/signInFuture.ts: 23 Invalid JSDoc tag name warnings before, 0 after; session.ts (uses @extractMethods/@skipParametersSection) also drops to 0.
  • Typo detection still works — the whitelist is exact-match, so a misspelled @generateWithEmptyComent is still flagged.
  • Prettier and ESLint pass on all touched files.
Tooling-only change; no published package is affected, so the changeset is empty.
Checklist
  • pnpm test runs as expected.
  • pnpm build runs as expected.
  •  (If applicable) JSDoc comments have been added or updated for any package exports
  •  (If applicable) Documentation has been updated
Type of change
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
🤖 Generated with Claude Code
Summary by CodeRabbit
  • Documentation
    • Improved recognition and handling of custom documentation tags.
    • Kept documentation generation and linting rules synchronized, reducing incorrect warnings for supported tags.
    • Centralized custom tag definitions to provide more consistent documentation output across the project.
  • Chores
    • Added release metadata for the documentation tooling improvements.
@manovotny@claude
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags
643f590
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@changeset-bot
changeset-botBot
commented
Jul 10, 2026

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 643f590
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
@vercel
vercelBot
commented
Jul 10, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 10, 2026 8:39pm
swingsetReadyReadyPreview, CommentJul 10, 2026 8:39pm
Request Review
@coderabbitai
coderabbitaiBot
commented
Jul 10, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: 15913535-8a25-450e-83aa-384692367679
📥 Commits
Reviewing files that changed from the base of the PR and between 7b581aa and 643f590.
📒 Files selected for processing (4)
  • .changeset/eslint-typedoc-tag-sync.md
  • .typedoc/custom-tags.mjs
  • eslint.config.mjs
  • typedoc.config.mjs
📝 Walkthrough
Walkthrough
Centralizes custom Typedoc tags in a shared module, then derives ESLint JSDoc validation and Typedoc modifier configuration from those exports. A Changesets release note records the update.
Changes
Typedoc and ESLint tag synchronization
Layer / File(s)Summary
Shared custom tag definitions
.typedoc/custom-tags.mjs		Exports block-level and modifier-level Typedoc tag arrays for shared configuration use.
Typedoc and ESLint configuration wiring
eslint.config.mjs, typedoc.config.mjs, .changeset/eslint-typedoc-tag-sync.md		Derives ESLint’s defined JSDoc tags and Typedoc’s modifier tags from the shared exports, while recording the change in a Changeset.
Estimated code review effort: 2 (Simple) | ~10 minutes
Poem
A rabbit found tags in a neat little row,

Shared them where lint and docs both go.

No lists to repeat, no burrowed-up tune,

Typedoc and ESLint now hop in sync soon.

“Carrot-sized changes!” the rabbit sings bright.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately summarizes the main change: deriving ESLint JSDoc definedTags from shared Typedoc custom tags.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands.
@pkg-pr-new
pkg-pr-newBot
commented
Jul 10, 2026

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@9128

@clerk/backend
npm i https://pkg.pr.new/@clerk/backend@9128

@clerk/chrome-extension
npm i https://pkg.pr.new/@clerk/chrome-extension@9128

@clerk/clerk-js
npm i https://pkg.pr.new/@clerk/clerk-js@9128

@clerk/electron
npm i https://pkg.pr.new/@clerk/electron@9128

@clerk/electron-passkeys
npm i https://pkg.pr.new/@clerk/electron-passkeys@9128

@clerk/eslint-plugin
npm i https://pkg.pr.new/@clerk/eslint-plugin@9128

@clerk/expo
npm i https://pkg.pr.new/@clerk/expo@9128

@clerk/expo-passkeys
npm i https://pkg.pr.new/@clerk/expo-passkeys@9128

@clerk/express
npm i https://pkg.pr.new/@clerk/express@9128

@clerk/fastify
npm i https://pkg.pr.new/@clerk/fastify@9128

@clerk/hono
npm i https://pkg.pr.new/@clerk/hono@9128

@clerk/localizations
npm i https://pkg.pr.new/@clerk/localizations@9128

@clerk/nextjs
npm i https://pkg.pr.new/@clerk/nextjs@9128

@clerk/nuxt
npm i https://pkg.pr.new/@clerk/nuxt@9128

@clerk/react
npm i https://pkg.pr.new/@clerk/react@9128

@clerk/react-router
npm i https://pkg.pr.new/@clerk/react-router@9128

@clerk/shared
npm i https://pkg.pr.new/@clerk/shared@9128

@clerk/tanstack-react-start
npm i https://pkg.pr.new/@clerk/tanstack-react-start@9128

@clerk/testing
npm i https://pkg.pr.new/@clerk/testing@9128

@clerk/ui
npm i https://pkg.pr.new/@clerk/ui@9128

@clerk/upgrade
npm i https://pkg.pr.new/@clerk/upgrade@9128

@clerk/vue
npm i https://pkg.pr.new/@clerk/vue@9128

commit: 643f590
@manovotny
manovotny
merged commit 1f72baa
into
mainJul 14, 2026

51 checks passed

@manovotny
manovotny
deleted the

manovotny/derive-eslint-jsdoc-tags-from-typedoc

branch
July 14, 2026 14:35
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@alexcarpenteralexcarpenteralexcarpenter approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@manovotny@alexcarpenter

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags by manovotny · Pull Request #9128 · clerk/javascript · GitHub
Skip to content
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags - #9128
Merged
manovotny merged 1 commit into
mainfrom 
manovotny/derive-eslint-jsdoc-tags-from-typedoc
Jul 14, 2026
Merged
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags#9128
manovotny merged 1 commit into
mainfrom 
manovotny/derive-eslint-jsdoc-tags-from-typedoc
Conversation
@manovotny
@manovotnymanovotny
commented
Jul 10, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
jsdoc/check-tag-names's definedTags list in eslint.config.mjs was written when eslint-plugin-jsdoc was introduced (#5697) and never kept in sync as the Typedoc tooling grew new custom tags (#8276 and follow-ups). As a result, every use of @generateWithEmptyComment (135 in packages/shared/src), @extractMethods, @skipParametersSection, @standalonePage, and @expandProperties emits a warn-level Invalid JSDoc tag name lint warning even though the tags are real and required by the docs tooling.
This PR moves the custom tag lists into a small shared module so the two configs cannot drift again:
  • Adds .typedoc/custom-tags.mjs exporting CUSTOM_BLOCK_TAGS and CUSTOM_MODIFIER_TAGS (the per-tag doc comments move with them).
  • typedoc.config.mjs imports the lists instead of declaring them inline. The resolved Typedoc options are byte-for-byte identical (verified by importing the config and diffing blockTags/modifierTags before and after).
  • eslint.config.mjs derives definedTags from the same lists (stripping the leading @).
Verification:
  • eslint packages/shared/src/types/signInFuture.ts: 23 Invalid JSDoc tag name warnings before, 0 after; session.ts (uses @extractMethods/@skipParametersSection) also drops to 0.
  • Typo detection still works — the whitelist is exact-match, so a misspelled @generateWithEmptyComent is still flagged.
  • Prettier and ESLint pass on all touched files.
Tooling-only change; no published package is affected, so the changeset is empty.
Checklist
  • pnpm test runs as expected.
  • pnpm build runs as expected.
  •  (If applicable) JSDoc comments have been added or updated for any package exports
  •  (If applicable) Documentation has been updated
Type of change
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
🤖 Generated with Claude Code
Summary by CodeRabbit
  • Documentation
    • Improved recognition and handling of custom documentation tags.
    • Kept documentation generation and linting rules synchronized, reducing incorrect warnings for supported tags.
    • Centralized custom tag definitions to provide more consistent documentation output across the project.
  • Chores
    • Added release metadata for the documentation tooling improvements.
@manovotny@claude
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags
643f590
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@changeset-bot
changeset-botBot
commented
Jul 10, 2026

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 643f590
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
@vercel
vercelBot
commented
Jul 10, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 10, 2026 8:39pm
swingsetReadyReadyPreview, CommentJul 10, 2026 8:39pm
Request Review
@coderabbitai
coderabbitaiBot
commented
Jul 10, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: 15913535-8a25-450e-83aa-384692367679
📥 Commits
Reviewing files that changed from the base of the PR and between 7b581aa and 643f590.
📒 Files selected for processing (4)
  • .changeset/eslint-typedoc-tag-sync.md
  • .typedoc/custom-tags.mjs
  • eslint.config.mjs
  • typedoc.config.mjs
📝 Walkthrough
Walkthrough
Centralizes custom Typedoc tags in a shared module, then derives ESLint JSDoc validation and Typedoc modifier configuration from those exports. A Changesets release note records the update.
Changes
Typedoc and ESLint tag synchronization
Layer / File(s)Summary
Shared custom tag definitions
.typedoc/custom-tags.mjs		Exports block-level and modifier-level Typedoc tag arrays for shared configuration use.
Typedoc and ESLint configuration wiring
eslint.config.mjs, typedoc.config.mjs, .changeset/eslint-typedoc-tag-sync.md		Derives ESLint’s defined JSDoc tags and Typedoc’s modifier tags from the shared exports, while recording the change in a Changeset.
Estimated code review effort: 2 (Simple) | ~10 minutes
Poem
A rabbit found tags in a neat little row,

Shared them where lint and docs both go.

No lists to repeat, no burrowed-up tune,

Typedoc and ESLint now hop in sync soon.

“Carrot-sized changes!” the rabbit sings bright.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately summarizes the main change: deriving ESLint JSDoc definedTags from shared Typedoc custom tags.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands.
@pkg-pr-new
pkg-pr-newBot
commented
Jul 10, 2026

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@9128

@clerk/backend
npm i https://pkg.pr.new/@clerk/backend@9128

@clerk/chrome-extension
npm i https://pkg.pr.new/@clerk/chrome-extension@9128

@clerk/clerk-js
npm i https://pkg.pr.new/@clerk/clerk-js@9128

@clerk/electron
npm i https://pkg.pr.new/@clerk/electron@9128

@clerk/electron-passkeys
npm i https://pkg.pr.new/@clerk/electron-passkeys@9128

@clerk/eslint-plugin
npm i https://pkg.pr.new/@clerk/eslint-plugin@9128

@clerk/expo
npm i https://pkg.pr.new/@clerk/expo@9128

@clerk/expo-passkeys
npm i https://pkg.pr.new/@clerk/expo-passkeys@9128

@clerk/express
npm i https://pkg.pr.new/@clerk/express@9128

@clerk/fastify
npm i https://pkg.pr.new/@clerk/fastify@9128

@clerk/hono
npm i https://pkg.pr.new/@clerk/hono@9128

@clerk/localizations
npm i https://pkg.pr.new/@clerk/localizations@9128

@clerk/nextjs
npm i https://pkg.pr.new/@clerk/nextjs@9128

@clerk/nuxt
npm i https://pkg.pr.new/@clerk/nuxt@9128

@clerk/react
npm i https://pkg.pr.new/@clerk/react@9128

@clerk/react-router
npm i https://pkg.pr.new/@clerk/react-router@9128

@clerk/shared
npm i https://pkg.pr.new/@clerk/shared@9128

@clerk/tanstack-react-start
npm i https://pkg.pr.new/@clerk/tanstack-react-start@9128

@clerk/testing
npm i https://pkg.pr.new/@clerk/testing@9128

@clerk/ui
npm i https://pkg.pr.new/@clerk/ui@9128

@clerk/upgrade
npm i https://pkg.pr.new/@clerk/upgrade@9128

@clerk/vue
npm i https://pkg.pr.new/@clerk/vue@9128

commit: 643f590
@manovotny
manovotny
merged commit 1f72baa
into
mainJul 14, 2026

51 checks passed

@manovotny
manovotny
deleted the

manovotny/derive-eslint-jsdoc-tags-from-typedoc

branch
July 14, 2026 14:35
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@alexcarpenteralexcarpenteralexcarpenter approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@manovotny@alexcarpenter

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags by manovotny · Pull Request #9128 · clerk/javascript · GitHub
Skip to content
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags - #9128
Merged
manovotny merged 1 commit into
mainfrom 
manovotny/derive-eslint-jsdoc-tags-from-typedoc
Jul 14, 2026
Merged
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags#9128
manovotny merged 1 commit into
mainfrom 
manovotny/derive-eslint-jsdoc-tags-from-typedoc
Conversation
@manovotny
@manovotnymanovotny
commented
Jul 10, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
jsdoc/check-tag-names's definedTags list in eslint.config.mjs was written when eslint-plugin-jsdoc was introduced (#5697) and never kept in sync as the Typedoc tooling grew new custom tags (#8276 and follow-ups). As a result, every use of @generateWithEmptyComment (135 in packages/shared/src), @extractMethods, @skipParametersSection, @standalonePage, and @expandProperties emits a warn-level Invalid JSDoc tag name lint warning even though the tags are real and required by the docs tooling.
This PR moves the custom tag lists into a small shared module so the two configs cannot drift again:
  • Adds .typedoc/custom-tags.mjs exporting CUSTOM_BLOCK_TAGS and CUSTOM_MODIFIER_TAGS (the per-tag doc comments move with them).
  • typedoc.config.mjs imports the lists instead of declaring them inline. The resolved Typedoc options are byte-for-byte identical (verified by importing the config and diffing blockTags/modifierTags before and after).
  • eslint.config.mjs derives definedTags from the same lists (stripping the leading @).
Verification:
  • eslint packages/shared/src/types/signInFuture.ts: 23 Invalid JSDoc tag name warnings before, 0 after; session.ts (uses @extractMethods/@skipParametersSection) also drops to 0.
  • Typo detection still works — the whitelist is exact-match, so a misspelled @generateWithEmptyComent is still flagged.
  • Prettier and ESLint pass on all touched files.
Tooling-only change; no published package is affected, so the changeset is empty.
Checklist
  • pnpm test runs as expected.
  • pnpm build runs as expected.
  •  (If applicable) JSDoc comments have been added or updated for any package exports
  •  (If applicable) Documentation has been updated
Type of change
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
🤖 Generated with Claude Code
Summary by CodeRabbit
  • Documentation
    • Improved recognition and handling of custom documentation tags.
    • Kept documentation generation and linting rules synchronized, reducing incorrect warnings for supported tags.
    • Centralized custom tag definitions to provide more consistent documentation output across the project.
  • Chores
    • Added release metadata for the documentation tooling improvements.
@manovotny@claude
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags
643f590
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@changeset-bot
changeset-botBot
commented
Jul 10, 2026

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 643f590
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
@vercel
vercelBot
commented
Jul 10, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 10, 2026 8:39pm
swingsetReadyReadyPreview, CommentJul 10, 2026 8:39pm
Request Review
@coderabbitai
coderabbitaiBot
commented
Jul 10, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: 15913535-8a25-450e-83aa-384692367679
📥 Commits
Reviewing files that changed from the base of the PR and between 7b581aa and 643f590.
📒 Files selected for processing (4)
  • .changeset/eslint-typedoc-tag-sync.md
  • .typedoc/custom-tags.mjs
  • eslint.config.mjs
  • typedoc.config.mjs
📝 Walkthrough
Walkthrough
Centralizes custom Typedoc tags in a shared module, then derives ESLint JSDoc validation and Typedoc modifier configuration from those exports. A Changesets release note records the update.
Changes
Typedoc and ESLint tag synchronization
Layer / File(s)Summary
Shared custom tag definitions
.typedoc/custom-tags.mjs		Exports block-level and modifier-level Typedoc tag arrays for shared configuration use.
Typedoc and ESLint configuration wiring
eslint.config.mjs, typedoc.config.mjs, .changeset/eslint-typedoc-tag-sync.md		Derives ESLint’s defined JSDoc tags and Typedoc’s modifier tags from the shared exports, while recording the change in a Changeset.
Estimated code review effort: 2 (Simple) | ~10 minutes
Poem
A rabbit found tags in a neat little row,

Shared them where lint and docs both go.

No lists to repeat, no burrowed-up tune,

Typedoc and ESLint now hop in sync soon.

“Carrot-sized changes!” the rabbit sings bright.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately summarizes the main change: deriving ESLint JSDoc definedTags from shared Typedoc custom tags.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands.
@pkg-pr-new
pkg-pr-newBot
commented
Jul 10, 2026

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@9128

@clerk/backend
npm i https://pkg.pr.new/@clerk/backend@9128

@clerk/chrome-extension
npm i https://pkg.pr.new/@clerk/chrome-extension@9128

@clerk/clerk-js
npm i https://pkg.pr.new/@clerk/clerk-js@9128

@clerk/electron
npm i https://pkg.pr.new/@clerk/electron@9128

@clerk/electron-passkeys
npm i https://pkg.pr.new/@clerk/electron-passkeys@9128

@clerk/eslint-plugin
npm i https://pkg.pr.new/@clerk/eslint-plugin@9128

@clerk/expo
npm i https://pkg.pr.new/@clerk/expo@9128

@clerk/expo-passkeys
npm i https://pkg.pr.new/@clerk/expo-passkeys@9128

@clerk/express
npm i https://pkg.pr.new/@clerk/express@9128

@clerk/fastify
npm i https://pkg.pr.new/@clerk/fastify@9128

@clerk/hono
npm i https://pkg.pr.new/@clerk/hono@9128

@clerk/localizations
npm i https://pkg.pr.new/@clerk/localizations@9128

@clerk/nextjs
npm i https://pkg.pr.new/@clerk/nextjs@9128

@clerk/nuxt
npm i https://pkg.pr.new/@clerk/nuxt@9128

@clerk/react
npm i https://pkg.pr.new/@clerk/react@9128

@clerk/react-router
npm i https://pkg.pr.new/@clerk/react-router@9128

@clerk/shared
npm i https://pkg.pr.new/@clerk/shared@9128

@clerk/tanstack-react-start
npm i https://pkg.pr.new/@clerk/tanstack-react-start@9128

@clerk/testing
npm i https://pkg.pr.new/@clerk/testing@9128

@clerk/ui
npm i https://pkg.pr.new/@clerk/ui@9128

@clerk/upgrade
npm i https://pkg.pr.new/@clerk/upgrade@9128

@clerk/vue
npm i https://pkg.pr.new/@clerk/vue@9128

commit: 643f590
@manovotny
manovotny
merged commit 1f72baa
into
mainJul 14, 2026

51 checks passed

@manovotny
manovotny
deleted the

manovotny/derive-eslint-jsdoc-tags-from-typedoc

branch
July 14, 2026 14:35
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@alexcarpenteralexcarpenteralexcarpenter approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@manovotny@alexcarpenter

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

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
jsdoc/check-tag-names's definedTags list in eslint.config.mjs was written when eslint-plugin-jsdoc was introduced (#5697) and never kept in sync as the Typedoc tooling grew new custom tags (#8276 and follow-ups). As a result, every use of @generateWithEmptyComment (135 in packages/shared/src), @extractMethods, @skipParametersSection, @standalonePage, and @expandProperties emits a warn-level Invalid JSDoc tag name lint warning even though the tags are real and required by the docs tooling.
This PR moves the custom tag lists into a small shared module so the two configs cannot drift again:
  • Adds .typedoc/custom-tags.mjs exporting CUSTOM_BLOCK_TAGS and CUSTOM_MODIFIER_TAGS (the per-tag doc comments move with them).
  • typedoc.config.mjs imports the lists instead of declaring them inline. The resolved Typedoc options are byte-for-byte identical (verified by importing the config and diffing blockTags/modifierTags before and after).
  • eslint.config.mjs derives definedTags from the same lists (stripping the leading @).
Verification:
  • eslint packages/shared/src/types/signInFuture.ts: 23 Invalid JSDoc tag name warnings before, 0 after; session.ts (uses @extractMethods/@skipParametersSection) also drops to 0.
  • Typo detection still works — the whitelist is exact-match, so a misspelled @generateWithEmptyComent is still flagged.
  • Prettier and ESLint pass on all touched files.
Tooling-only change; no published package is affected, so the changeset is empty.
Checklist
  • pnpm test runs as expected.
  • pnpm build runs as expected.
  •  (If applicable) JSDoc comments have been added or updated for any package exports
  •  (If applicable) Documentation has been updated
Type of change
  •  🐛 Bug fix
  •  🌟 New feature
  •  🔨 Breaking change
  •  📖 Refactoring / dependency upgrade / documentation
  •  other:
🤖 Generated with Claude Code
Summary by CodeRabbit
  • Documentation
    • Improved recognition and handling of custom documentation tags.
    • Kept documentation generation and linting rules synchronized, reducing incorrect warnings for supported tags.
    • Centralized custom tag definitions to provide more consistent documentation output across the project.
  • Chores
    • Added release metadata for the documentation tooling improvements.
@manovotny@claude
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags
643f590
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@changeset-bot
changeset-botBot
commented
Jul 10, 2026

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 643f590
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Not sure what this means? Click here to learn what changesets are.
Click here if you're a maintainer who wants to add another changeset to this PR
@vercel
vercelBot
commented
Jul 10, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 10, 2026 8:39pm
swingsetReadyReadyPreview, CommentJul 10, 2026 8:39pm
Request Review
@coderabbitai
coderabbitaiBot
commented
Jul 10, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: 15913535-8a25-450e-83aa-384692367679
📥 Commits
Reviewing files that changed from the base of the PR and between 7b581aa and 643f590.
📒 Files selected for processing (4)
  • .changeset/eslint-typedoc-tag-sync.md
  • .typedoc/custom-tags.mjs
  • eslint.config.mjs
  • typedoc.config.mjs
📝 Walkthrough
Walkthrough
Centralizes custom Typedoc tags in a shared module, then derives ESLint JSDoc validation and Typedoc modifier configuration from those exports. A Changesets release note records the update.
Changes
Typedoc and ESLint tag synchronization
Layer / File(s)Summary
Shared custom tag definitions
.typedoc/custom-tags.mjs		Exports block-level and modifier-level Typedoc tag arrays for shared configuration use.
Typedoc and ESLint configuration wiring
eslint.config.mjs, typedoc.config.mjs, .changeset/eslint-typedoc-tag-sync.md		Derives ESLint’s defined JSDoc tags and Typedoc’s modifier tags from the shared exports, while recording the change in a Changeset.
Estimated code review effort: 2 (Simple) | ~10 minutes
Poem
A rabbit found tags in a neat little row,

Shared them where lint and docs both go.

No lists to repeat, no burrowed-up tune,

Typedoc and ESLint now hop in sync soon.

“Carrot-sized changes!” the rabbit sings bright.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title accurately summarizes the main change: deriving ESLint JSDoc definedTags from shared Typedoc custom tags.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands.
@pkg-pr-new
pkg-pr-newBot
commented
Jul 10, 2026

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@9128

@clerk/backend
npm i https://pkg.pr.new/@clerk/backend@9128

@clerk/chrome-extension
npm i https://pkg.pr.new/@clerk/chrome-extension@9128

@clerk/clerk-js
npm i https://pkg.pr.new/@clerk/clerk-js@9128

@clerk/electron
npm i https://pkg.pr.new/@clerk/electron@9128

@clerk/electron-passkeys
npm i https://pkg.pr.new/@clerk/electron-passkeys@9128

@clerk/eslint-plugin
npm i https://pkg.pr.new/@clerk/eslint-plugin@9128

@clerk/expo
npm i https://pkg.pr.new/@clerk/expo@9128

@clerk/expo-passkeys
npm i https://pkg.pr.new/@clerk/expo-passkeys@9128

@clerk/express
npm i https://pkg.pr.new/@clerk/express@9128

@clerk/fastify
npm i https://pkg.pr.new/@clerk/fastify@9128

@clerk/hono
npm i https://pkg.pr.new/@clerk/hono@9128

@clerk/localizations
npm i https://pkg.pr.new/@clerk/localizations@9128

@clerk/nextjs
npm i https://pkg.pr.new/@clerk/nextjs@9128

@clerk/nuxt
npm i https://pkg.pr.new/@clerk/nuxt@9128

@clerk/react
npm i https://pkg.pr.new/@clerk/react@9128

@clerk/react-router
npm i https://pkg.pr.new/@clerk/react-router@9128

@clerk/shared
npm i https://pkg.pr.new/@clerk/shared@9128

@clerk/tanstack-react-start
npm i https://pkg.pr.new/@clerk/tanstack-react-start@9128

@clerk/testing
npm i https://pkg.pr.new/@clerk/testing@9128

@clerk/ui
npm i https://pkg.pr.new/@clerk/ui@9128

@clerk/upgrade
npm i https://pkg.pr.new/@clerk/upgrade@9128

@clerk/vue
npm i https://pkg.pr.new/@clerk/vue@9128

commit: 643f590
@manovotny
manovotny
merged commit 1f72baa
into
mainJul 14, 2026

51 checks passed

@manovotny
manovotny
deleted the

manovotny/derive-eslint-jsdoc-tags-from-typedoc

branch
July 14, 2026 14:35
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@alexcarpenteralexcarpenteralexcarpenter approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@manovotny@alexcarpenter