Skip to content

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

Open
manovotny wants to merge 1 commit into
mainfrom
manovotny/derive-eslint-jsdoc-tags-from-typedoc
Open

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

Conversation

@manovotny

@manovotny manovotny commented Jul 10, 2026

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.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@changeset-bot

changeset-bot Bot 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

vercel Bot commented Jul 10, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
clerk-js-sandbox Ready Ready Preview, Comment Jul 10, 2026 8:39pm
swingset Ready Ready Preview, Comment Jul 10, 2026 8:39pm

Request Review

@coderabbitai

coderabbitai Bot commented Jul 10, 2026

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 name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: deriving ESLint JSDoc definedTags from shared Typedoc custom tags.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check 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-new Bot 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant