Uh oh!
There was an error while loading. Please reload this page.
feat(swingset): proptable badges, inline variables reset, folder source links - #8822
Conversation
🦋 Changeset detectedLatest commit: 78a1d8b 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.
1 Skipped Deployment
|
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 Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughRefactors VariablesPanel control into StoryPreview (controlled Collapsible and conditional reset), adds a reusable Badge and uses it in PropTable prop names, updates sourceUrl to prefer tree for index files and normalize paths, tweaks ClientRoot header stacking, and adds a changeset. ChangesSwingSet UI and Utilities Improvements
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
Comment |
@clerk/astro@clerk/backend@clerk/chrome-extension@clerk/clerk-js@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/vuecommit: |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
packages/swingset/src/lib/source.ts (1)
3-4: ⚡ Quick winMove repository config out of hardcoded constants.
REPO_BASEandBRANCHare configuration values and should be sourced from environment/config instead of literals (Line 3-4), then defaulted safely where needed.Proposed change
-const REPO_BASE = 'https://github.com/clerk/javascript';-const BRANCH = 'main';+const REPO_BASE = process.env.SWINGSET_REPO_BASE ?? 'https://github.com/clerk/javascript';+const BRANCH = process.env.SWINGSET_REPO_BRANCH ?? 'main';As per coding guidelines, “
packages/swingset/**/*.{ts,tsx,js}: Use environment variables for configuration instead of hardcoded values.”🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/swingset/src/lib/source.ts` around lines 3 - 4, REPO_BASE and BRANCH are hardcoded constants in source.ts; replace them with configuration-sourced values (e.g., read from process.env or a central config module) and provide safe defaults where used. Update the symbols REPO_BASE and BRANCH in source.ts to be initialized from process.env.REPO_BASE and process.env.REPO_BRANCH (or via a config.get('repoBase', ...) / config.get('branch', ...)) and ensure any code that imports or references REPO_BASE/BRANCH still gets the same exported names or switch to exported getters so defaulting is applied consistently.Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.changeset/swingset-proptable-badges.md:
- Around line 1-2: The changeset file .changeset/swingset-proptable-badges.md is
empty but the package `@clerk/swingset` is marked "private": true, so remove the
empty changeset file or replace it with a valid changeset payload (e.g., a short
summary and no release entries) only if some internal tooling requires its
presence; locate .changeset/swingset-proptable-badges.md and either delete the
file or populate it with appropriate non-empty changeset content consistent with
private packages.
---
Nitpick comments:
In `@packages/swingset/src/lib/source.ts`:
- Around line 3-4: REPO_BASE and BRANCH are hardcoded constants in source.ts;
replace them with configuration-sourced values (e.g., read from process.env or a
central config module) and provide safe defaults where used. Update the symbols
REPO_BASE and BRANCH in source.ts to be initialized from process.env.REPO_BASE
and process.env.REPO_BRANCH (or via a config.get('repoBase', ...) /
config.get('branch', ...)) and ensure any code that imports or references
REPO_BASE/BRANCH still gets the same exported names or switch to exported
getters so defaulting is applied consistently.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro
Run ID: 57c0cd9a-8845-4b49-9c07-ca9560c7fa0a
📒 Files selected for processing (5)
.changeset/swingset-proptable-badges.mdpackages/swingset/src/components/PropTable.tsxpackages/swingset/src/components/StoryPreview.tsxpackages/swingset/src/components/VariablesPanel.tsxpackages/swingset/src/lib/source.ts
💤 Files with no reviewable changes (1)
- packages/swingset/src/components/VariablesPanel.tsx
| --- | ||
| --- |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash# Check if `@clerk/swingset` is a published package# Look for package.json and check private field
fd -t f '^package\.json$' packages/swingset -x cat {} \;| jq -r '{name: .name, private: .private, version: .version}'# Check if there are other non-empty changesets for swingset
rg -l '`@clerk/swingset`' .changeset/ -g '*.md'| head -5 | xargs -I {} sh -c 'echo "=== {} ===" && cat {}'Repository: clerk/javascript
Length of output: 133
Remove/fill the empty changeset for private @clerk/swingset
@clerk/swingset is marked "private": true, so it doesn’t need a version-bump/changelog entry. The file .changeset/swingset-proptable-badges.md is currently just --- (lines 1-2); either delete it or add real content if some internal tooling relies on it.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.changeset/swingset-proptable-badges.md around lines 1 - 2, The changeset
file .changeset/swingset-proptable-badges.md is empty but the package
`@clerk/swingset` is marked "private": true, so remove the empty changeset file or
replace it with a valid changeset payload (e.g., a short summary and no release
entries) only if some internal tooling requires its presence; locate
.changeset/swingset-proptable-badges.md and either delete the file or populate
it with appropriate non-empty changeset content consistent with private
packages.
Source: Learnings
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
TLDR
polish stuff
Description
Polishes the
@clerk/swingsetcomponent explorer UI (private/unpublished package, no user-facing impact):VariablesPanel(label + reset) was removed.sourceUrlnow resolves index/barrel files (index.ts, etc.) to their containing GitHub folder (treeview) instead of the re-export file, while other paths still link straight to the file (blobview).To test: run
pnpm run dev:swingsetand open a component overview — check the prop badges, the Variables panel reset, and that a primitive whose source is anindex.ts(e.g. Collapsible) opens its folder.Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
New Features
UI / Style