-
Notifications
You must be signed in to change notification settings - Fork 381
fix(elements): Correctly specify dependency on type-fest
package
#6711
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
🦋 Changeset detectedLatest commit: 3e8c706 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
WalkthroughIntroduces a new changeset file for a patch release and updates dependency management by moving type-fest from devDependencies to dependencies in packages/elements/package.json. No source code or public API changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
@clerk/agent-toolkit
@clerk/astro
@clerk/backend
@clerk/chrome-extension
@clerk/clerk-js
@clerk/dev-cli
@clerk/elements
@clerk/clerk-expo
@clerk/expo-passkeys
@clerk/express
@clerk/fastify
@clerk/localizations
@clerk/nextjs
@clerk/nuxt
@clerk/clerk-react
@clerk/react-router
@clerk/remix
@clerk/shared
@clerk/tanstack-react-start
@clerk/testing
@clerk/themes
@clerk/types
@clerk/upgrade
@clerk/vue
commit: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
.changeset/silent-women-dance.md (1)
5-5
: Polish the wording.Consider “Correctly specify dependency on the
type-fest
package.” (add “the”) and briefly note the reason: moved from devDependencies to dependencies to fix downstream type resolution.packages/elements/package.json (1)
74-86
: Optionally align with repo-wide version management.If you standardize deps via a “catalog” (e.g.,
catalog:repo
liketslib
), consider addingtype-fest
there to keep versions consistent across packages.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
⛔ Files ignored due to path filters (1)
pnpm-lock.yaml
is excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (2)
.changeset/silent-women-dance.md
(1 hunks)packages/elements/package.json
(1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
.changeset/**
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Automated releases must use Changesets.
Files:
.changeset/silent-women-dance.md
**/*.{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/elements/package.json
packages/*/package.json
📄 CodeRabbit inference engine (.cursor/rules/global.mdc)
All publishable packages should be placed under the packages/ directory
packages/*/package.json
: All publishable packages must be located in the 'packages/' directory.
All packages must be published under the @clerk namespace on npm.
Semantic versioning must be used across all packages.
Files:
packages/elements/package.json
🪛 LanguageTool
.changeset/silent-women-dance.md
[grammar] ~5-~5: There might be a mistake here.
Context: ...ecify dependency on type-fest
package.
(QB_NEW_EN)
⏰ 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). (6)
- GitHub Check: Formatting | Dedupe | Changeset
- GitHub Check: Build Packages
- GitHub Check: semgrep/ci
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (3)
.changeset/silent-women-dance.md (1)
1-3
: Changeset scope and bump look correct.Patch release targeted at @clerk/elements is appropriate for a dependency classification fix.
packages/elements/package.json (2)
84-86
: Good fix: maketype-fest
a runtime dependency.This ensures consumers install the types referenced by published d.ts files. No other runtime surface changes—LGTM.
74-86
: Confirm published declarations import type-fest. Versions are aligned across the workspace (both @clerk/elements and @clerk/chrome-extension use ^4.41.0) and all TS imports areimport type
. I couldn’t build the.d.ts
locally—please verify thatpackages/elements/dist/*.d.ts
containsimport type {…} from 'type-fest'
to justify keeping it independencies
, otherwise move it todevDependencies
.
Description
@clerk/elements
references types from thetype-fest
package in its generated output, but it only specifiestype-fest
as adevDependency
. This results in the package not being installed when@clerk/elements
is installed, resulting in broken types.This PR fixes the issue by moving
type-fest
todependencies
.Checklist
pnpm test
runs as expected.pnpm build
runs as expected.Type of change
Summary by CodeRabbit
Bug Fixes
Chores