chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags#9128
chore(repo): Derive ESLint jsdoc definedTags from Typedoc custom tags#9128manovotny wants to merge 1 commit into
Conversation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
🦋 Changeset detectedLatest commit: 643f590 The changes in this PR will be included in the next version bump. This PR includes changesets to release 0 packagesWhen 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 |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository YAML (base), Repository UI (inherited) Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughCentralizes 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. ChangesTypedoc and ESLint tag synchronization
Estimated code review effort: 2 (Simple) | ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
Comment |
@clerk/astro
@clerk/backend
@clerk/chrome-extension
@clerk/clerk-js
@clerk/electron
@clerk/electron-passkeys
@clerk/eslint-plugin
@clerk/expo
@clerk/expo-passkeys
@clerk/express
@clerk/fastify
@clerk/hono
@clerk/localizations
@clerk/nextjs
@clerk/nuxt
@clerk/react
@clerk/react-router
@clerk/shared
@clerk/tanstack-react-start
@clerk/testing
@clerk/ui
@clerk/upgrade
@clerk/vue
commit: |
Description
jsdoc/check-tag-names'sdefinedTagslist ineslint.config.mjswas written wheneslint-plugin-jsdocwas 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 inpackages/shared/src),@extractMethods,@skipParametersSection,@standalonePage, and@expandPropertiesemits a warn-levelInvalid JSDoc tag namelint 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:
.typedoc/custom-tags.mjsexportingCUSTOM_BLOCK_TAGSandCUSTOM_MODIFIER_TAGS(the per-tag doc comments move with them).typedoc.config.mjsimports the lists instead of declaring them inline. The resolved Typedoc options are byte-for-byte identical (verified by importing the config and diffingblockTags/modifierTagsbefore and after).eslint.config.mjsderivesdefinedTagsfrom the same lists (stripping the leading@).Verification:
eslint packages/shared/src/types/signInFuture.ts: 23Invalid JSDoc tag namewarnings before, 0 after;session.ts(uses@extractMethods/@skipParametersSection) also drops to 0.@generateWithEmptyComentis still flagged.Tooling-only change; no published package is affected, so the changeset is empty.
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation
Chores