Skip to content

Conversation

@alexisintech
Copy link
Member

@alexisintech alexisintech commented Oct 30, 2025

Description

Types were moved from @clerk/types to @clerk/shared/types (PR)
We need to export the typedoc output from the new shared/types folder

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:

Summary by CodeRabbit

  • Chores
    • Updated documentation configuration to include generated type definitions in documentation build.

@changeset-bot
Copy link

changeset-bot bot commented Oct 30, 2025

⚠️ No Changeset found

Latest commit: ba46df6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

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

Click here to learn what changesets are, and how to add one.

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

@vercel
Copy link

vercel bot commented Oct 30, 2025

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

Project Deployment Preview Comments Updated (UTC)
clerk-js-sandbox Ready Ready Preview Comment Oct 30, 2025 7:15pm

@alexisintech alexisintech requested a review from NWylynko October 30, 2025 19:13
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 30, 2025

Walkthrough

The TypeDoc configuration for the shared package was updated to include generated types from the src/types directory in documentation generation by adding a new glob pattern entry point.

Changes

Cohort / File(s) Change Summary
TypeDoc Configuration
packages/shared/typedoc.json
Added "./src/types/*.ts" to the entryPoints array to include generated types in TypeDoc documentation generation

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Verify the glob pattern correctly targets the intended generated types directory
  • Confirm TypeDoc recognizes and processes the new entry point without errors

Poem

A rabbit hops through TypeDoc's halls,
Documenting types both large and small,
With src/types now in the light,
The generated docs shine bright! 📚✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The pull request title "fix(shared): Export new types folder for typedoc output" directly and accurately describes the main change in the changeset. The modification to the TypeDoc configuration in packages/shared/typedoc.json adds the new types folder (./src/types/*.ts) to the entryPoints array, which aligns precisely with the title's claim of exporting the new types folder for typedoc output. The title is concise, clear, uses the conventional commit format appropriately, and provides sufficient context for a teammate to understand the primary change without needing to inspect the full diff.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch aa/fix-typedoc

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 3e0ef92 and ba46df6.

📒 Files selected for processing (1)
  • packages/shared/typedoc.json (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.{js,jsx,ts,tsx,json,css,scss,md,yaml,yml}

📄 CodeRabbit inference engine (.cursor/rules/development.mdc)

Use Prettier for consistent code formatting

Files:

  • packages/shared/typedoc.json
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (28)
  • GitHub Check: Integration Tests (quickstart, chrome, 16)
  • GitHub Check: Integration Tests (nuxt, chrome)
  • GitHub Check: Integration Tests (nextjs, chrome, 14)
  • GitHub Check: Integration Tests (quickstart, chrome, 15)
  • GitHub Check: Integration Tests (nextjs, chrome, 15)
  • GitHub Check: Integration Tests (custom, chrome)
  • GitHub Check: Integration Tests (handshake, chrome)
  • GitHub Check: Integration Tests (machine, chrome)
  • GitHub Check: Integration Tests (nextjs, chrome, 16)
  • GitHub Check: Integration Tests (billing, chrome)
  • GitHub Check: Integration Tests (handshake:staging, chrome)
  • GitHub Check: Integration Tests (vue, chrome)
  • GitHub Check: Integration Tests (sessions, chrome)
  • GitHub Check: Integration Tests (expo-web, chrome)
  • GitHub Check: Integration Tests (sessions:staging, chrome)
  • GitHub Check: Integration Tests (react-router, chrome)
  • GitHub Check: Integration Tests (tanstack-react-start, chrome)
  • GitHub Check: Integration Tests (astro, chrome)
  • GitHub Check: Integration Tests (ap-flows, chrome)
  • GitHub Check: Integration Tests (localhost, chrome)
  • GitHub Check: Integration Tests (express, chrome)
  • GitHub Check: Integration Tests (elements, chrome)
  • GitHub Check: Integration Tests (generic, chrome)
  • GitHub Check: Static analysis
  • GitHub Check: Publish with pkg-pr-new
  • GitHub Check: Unit Tests (22, **)
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (1)
packages/shared/typedoc.json (1)

3-3: ✅ Correct alignment with PR objectives.

The addition of "./src/types/*.ts" to the entryPoints array correctly exposes the relocated types directory for TypeDoc generation. The glob pattern is consistent with existing entry points and matches the format suggested in the prior review.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@pkg-pr-new
Copy link

pkg-pr-new bot commented Oct 30, 2025

Open in StackBlitz

@clerk/agent-toolkit

npm i https://pkg.pr.new/@clerk/agent-toolkit@7106

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

npm i https://pkg.pr.new/@clerk/dev-cli@7106

@clerk/elements

npm i https://pkg.pr.new/@clerk/elements@7106

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

npm i https://pkg.pr.new/@clerk/remix@7106

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

npm i https://pkg.pr.new/@clerk/themes@7106

@clerk/types

npm i https://pkg.pr.new/@clerk/types@7106

@clerk/upgrade

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

@clerk/vue

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

commit: ba46df6

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.

2 participants