docs(swingset): Add agent guidance files (CLAUDE.md and AGENTS.md)#8805

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.

Sign up for GitHub

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

Merged
kylemac merged 1 commit into from
Jun 10, 2026
Merged

docs(swingset): Add agent guidance files (CLAUDE.md and AGENTS.md) #8805

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/swingset-agent-docs.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
1 change: 1 addition & 0 deletions packages/swingset/AGENTS.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
@CLAUDE.md
35 changes: 35 additions & 0 deletions packages/swingset/CLAUDE.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
# CLAUDE.md

This file provides guidance to Coding Agents when working with code in this repository.

`@clerk/swingset` is a private (unpublished) component explorer — a Storybook-like app — for the **Mosaic** design system that lives in `@clerk/ui`. It is a Next.js App Router app that renders Mosaic components interactively with live knobs and design-token overrides.

## Commands

Run from the monorepo root or scope with `--filter @clerk/swingset`:

```
pnpm run dev:swingset. # next dev on port 6006
pnpm build --filter @clerk/swingset # next build
pnpm format --filter @clerk/swingset # format-package.mjs (--check for CI)
```
Comment on lines +11 to +15

@coderabbitaicoderabbitaiBotJun 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add language specifier to code block.

The fenced code block should specify a language (e.g., bash or shell) for proper syntax highlighting and tooling compatibility.

📝 Proposed fix
-```+```bash
pnpm run dev:swingset. # next dev on port 6006
pnpm build --filter `@clerk/swingset` # next build
pnpm format --filter `@clerk/swingset` # format-package.mjs (--check for CI)
</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 11-11: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 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/CLAUDE.md` around lines 11 - 15, The fenced code block in
CLAUDE.md currently lacks a language specifier; update the opening
triple-backtick for the block containing the pnpm commands (the lines starting
with "pnpm run dev:swingset.", "pnpm build --filter `@clerk/swingset`", and "pnpm
format --filter `@clerk/swingset`") to include a language such as bash (e.g.,
change ``` to ```bash) so tooling and syntax highlighting correctly recognize
the shell commands.

Source: Linters/SAST tools


There are no tests or lint scripts in this package, yet.

## Key architecture facts

These require reading several files together; the `README.md` covers the step-by-step "add a component" workflow.

- **Consumes Mosaic from source, not build.** `@clerk/ui/mosaic` is aliased to `../ui/src/mosaic` in *two* places that must stay in sync: `next.config.mjs` (webpack `resolve.alias`) and `tsconfig.json` (`paths`). Editing Mosaic source in `packages/ui` reflects live in swingset's dev server — no rebuild of `@clerk/ui` needed.

- **Knobs are generated from CVA metadata, not hand-written.** A story's `meta.styles` is a Mosaic CVA style object exposing `_variants` / `_defaultVariants`. `lib/generateKnobs.ts` turns each variant into a control: variants whose keys are only `true`/`false` become boolean toggles, everything else becomes a select. Knob values are passed as props straight into the story component. This is why story functions take `Record<string, unknown>` and cast to the real prop type.

- **`lib/registry.ts` is the single source of truth for stories**, and stories are imported *explicitly* (never `import *`) so sidebar order is deterministic. `getSidebarGroups`, `findStory`, and slugging (`lib/slug.ts`, from `meta.title` and export name) all read from it. Adding a component touches up to three wiring points: `registry.ts` (knobs/canvas), `DocsViewer.tsx`'s `docModules` map (MDX docs), and the hardcoded redirect in `app/page.tsx`.

- **Routing.** `/components/[component]` renders MDX docs via `DocsViewer`; `/components/[component]/[story]` renders the interactive `StoryCanvas`. `app/page.tsx` is a static redirect (currently to `/components/button`) because `registry.ts` eagerly imports story modules (Emotion / `createContext`), so registry-derived data can't be computed in a Server Component.

- **Every story renders inside `MosaicProvider`.** `StoryCanvas` (interactive route) wraps the component in `MosaicProvider` and exposes a `VariablesPanel` that overrides `MosaicVariables` (color, rounded, spacing) live. `StoryEmbed` (used inside MDX via `<Story>`) renders with default knob values and no variable panel.

- **MDX.** `mdx-components.tsx` injects custom components into all MDX: `<Story>` (→ `StoryEmbed`), `<PropTable>` (derives a props table from `meta.styles._variants`/`_defaultVariants`, always appends `sx`), and a `<pre>` override routing fenced code through Shiki (`CodeBlock`). `next.config.mjs` configures `remark-gfm` and `rehype-raw` (with MDX node pass-through) so raw HTML in tables works.

- **Two component layers.** `src/components/ui/*` are shadcn/ui primitives (`components.json`, `base-nova` style, neutral base) used for swingset's *own* chrome (sidebar, tabs, inputs). The components being *documented* come from `@clerk/ui/mosaic`. Don't confuse the two. Mosaic stories use Emotion (`/** @jsxImportSource @emotion/react */` pragma; `compiler.emotion` enabled in Next).
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
docs(swingset): Add agent guidance files (CLAUDE.md and AGENTS.md)#8805

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.

 Sign up for GitHub

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

 Merged

kylemac
merged 1 commit into

from

Jun 10, 2026
 Merged


docs(swingset): Add agent guidance files (CLAUDE.md and AGENTS.md)
#8805
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/swingset-agent-docs.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

1 change: 1 addition & 0 deletions
packages/swingset/AGENTS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
@CLAUDE.md

35 changes: 35 additions & 0 deletions
packages/swingset/CLAUDE.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
# CLAUDE.md

This file provides guidance to Coding Agents when working with code in this repository.

`@clerk/swingset` is a private (unpublished) component explorer — a Storybook-like app — for the **Mosaic** design system that lives in `@clerk/ui`. It is a Next.js App Router app that renders Mosaic components interactively with live knobs and design-token overrides.

## Commands

Run from the monorepo root or scope with `--filter @clerk/swingset`:

```
pnpm run dev:swingset. # next dev on port 6006
pnpm build --filter @clerk/swingset # next build
pnpm format --filter @clerk/swingset # format-package.mjs (--check for CI)
```

Comment on lines

+11
 to 
+15

@coderabbitaicoderabbitaiBotJun 10, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win
Add language specifier to code block.
The fenced code block should specify a language (e.g., bash or shell) for proper syntax highlighting and tooling compatibility.
📝 Proposed fix
-```+```bash
pnpm run dev:swingset. # next dev on port 6006
pnpm build --filter `@clerk/swingset` # next build
pnpm format --filter `@clerk/swingset` # format-package.mjs (--check for CI)
</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 11-11: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 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/CLAUDE.md` around lines 11 - 15, The fenced code block in
CLAUDE.md currently lacks a language specifier; update the opening
triple-backtick for the block containing the pnpm commands (the lines starting
with "pnpm run dev:swingset.", "pnpm build --filter `@clerk/swingset`", and "pnpm
format --filter `@clerk/swingset`") to include a language such as bash (e.g.,
change ``` to ```bash) so tooling and syntax highlighting correctly recognize
the shell commands.

Source: Linters/SAST tools

There are no tests or lint scripts in this package, yet.

## Key architecture facts

These require reading several files together; the `README.md` covers the step-by-step "add a component" workflow.

- **Consumes Mosaic from source, not build.** `@clerk/ui/mosaic` is aliased to `../ui/src/mosaic` in *two* places that must stay in sync: `next.config.mjs` (webpack `resolve.alias`) and `tsconfig.json` (`paths`). Editing Mosaic source in `packages/ui` reflects live in swingset's dev server — no rebuild of `@clerk/ui` needed.

- **Knobs are generated from CVA metadata, not hand-written.** A story's `meta.styles` is a Mosaic CVA style object exposing `_variants` / `_defaultVariants`. `lib/generateKnobs.ts` turns each variant into a control: variants whose keys are only `true`/`false` become boolean toggles, everything else becomes a select. Knob values are passed as props straight into the story component. This is why story functions take `Record<string, unknown>` and cast to the real prop type.

- **`lib/registry.ts` is the single source of truth for stories**, and stories are imported *explicitly* (never `import *`) so sidebar order is deterministic. `getSidebarGroups`, `findStory`, and slugging (`lib/slug.ts`, from `meta.title` and export name) all read from it. Adding a component touches up to three wiring points: `registry.ts` (knobs/canvas), `DocsViewer.tsx`'s `docModules` map (MDX docs), and the hardcoded redirect in `app/page.tsx`.

- **Routing.** `/components/[component]` renders MDX docs via `DocsViewer`; `/components/[component]/[story]` renders the interactive `StoryCanvas`. `app/page.tsx` is a static redirect (currently to `/components/button`) because `registry.ts` eagerly imports story modules (Emotion / `createContext`), so registry-derived data can't be computed in a Server Component.

- **Every story renders inside `MosaicProvider`.** `StoryCanvas` (interactive route) wraps the component in `MosaicProvider` and exposes a `VariablesPanel` that overrides `MosaicVariables` (color, rounded, spacing) live. `StoryEmbed` (used inside MDX via `<Story>`) renders with default knob values and no variable panel.

- **MDX.** `mdx-components.tsx` injects custom components into all MDX: `<Story>` (→ `StoryEmbed`), `<PropTable>` (derives a props table from `meta.styles._variants`/`_defaultVariants`, always appends `sx`), and a `<pre>` override routing fenced code through Shiki (`CodeBlock`). `next.config.mjs` configures `remark-gfm` and `rehype-raw` (with MDX node pass-through) so raw HTML in tables works.

- **Two component layers.** `src/components/ui/*` are shadcn/ui primitives (`components.json`, `base-nova` style, neutral base) used for swingset's *own* chrome (sidebar, tabs, inputs). The components being *documented* come from `@clerk/ui/mosaic`. Don't confuse the two. Mosaic stories use Emotion (`/** @jsxImportSource @emotion/react */` pragma; `compiler.emotion` enabled in Next).
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs(swingset): Add agent guidance files (CLAUDE.md and AGENTS.md)#8805

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.

 Sign up for GitHub

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

 Merged

kylemac
merged 1 commit into

from

Jun 10, 2026
 Merged


docs(swingset): Add agent guidance files (CLAUDE.md and AGENTS.md)
#8805
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/swingset-agent-docs.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

1 change: 1 addition & 0 deletions
packages/swingset/AGENTS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
@CLAUDE.md

35 changes: 35 additions & 0 deletions
packages/swingset/CLAUDE.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
# CLAUDE.md

This file provides guidance to Coding Agents when working with code in this repository.

`@clerk/swingset` is a private (unpublished) component explorer — a Storybook-like app — for the **Mosaic** design system that lives in `@clerk/ui`. It is a Next.js App Router app that renders Mosaic components interactively with live knobs and design-token overrides.

## Commands

Run from the monorepo root or scope with `--filter @clerk/swingset`:

```
pnpm run dev:swingset. # next dev on port 6006
pnpm build --filter @clerk/swingset # next build
pnpm format --filter @clerk/swingset # format-package.mjs (--check for CI)
```

Comment on lines

+11
 to 
+15

@coderabbitaicoderabbitaiBotJun 10, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win
Add language specifier to code block.
The fenced code block should specify a language (e.g., bash or shell) for proper syntax highlighting and tooling compatibility.
📝 Proposed fix
-```+```bash
pnpm run dev:swingset. # next dev on port 6006
pnpm build --filter `@clerk/swingset` # next build
pnpm format --filter `@clerk/swingset` # format-package.mjs (--check for CI)
</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 11-11: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 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/CLAUDE.md` around lines 11 - 15, The fenced code block in
CLAUDE.md currently lacks a language specifier; update the opening
triple-backtick for the block containing the pnpm commands (the lines starting
with "pnpm run dev:swingset.", "pnpm build --filter `@clerk/swingset`", and "pnpm
format --filter `@clerk/swingset`") to include a language such as bash (e.g.,
change ``` to ```bash) so tooling and syntax highlighting correctly recognize
the shell commands.

Source: Linters/SAST tools

There are no tests or lint scripts in this package, yet.

## Key architecture facts

These require reading several files together; the `README.md` covers the step-by-step "add a component" workflow.

- **Consumes Mosaic from source, not build.** `@clerk/ui/mosaic` is aliased to `../ui/src/mosaic` in *two* places that must stay in sync: `next.config.mjs` (webpack `resolve.alias`) and `tsconfig.json` (`paths`). Editing Mosaic source in `packages/ui` reflects live in swingset's dev server — no rebuild of `@clerk/ui` needed.

- **Knobs are generated from CVA metadata, not hand-written.** A story's `meta.styles` is a Mosaic CVA style object exposing `_variants` / `_defaultVariants`. `lib/generateKnobs.ts` turns each variant into a control: variants whose keys are only `true`/`false` become boolean toggles, everything else becomes a select. Knob values are passed as props straight into the story component. This is why story functions take `Record<string, unknown>` and cast to the real prop type.

- **`lib/registry.ts` is the single source of truth for stories**, and stories are imported *explicitly* (never `import *`) so sidebar order is deterministic. `getSidebarGroups`, `findStory`, and slugging (`lib/slug.ts`, from `meta.title` and export name) all read from it. Adding a component touches up to three wiring points: `registry.ts` (knobs/canvas), `DocsViewer.tsx`'s `docModules` map (MDX docs), and the hardcoded redirect in `app/page.tsx`.

- **Routing.** `/components/[component]` renders MDX docs via `DocsViewer`; `/components/[component]/[story]` renders the interactive `StoryCanvas`. `app/page.tsx` is a static redirect (currently to `/components/button`) because `registry.ts` eagerly imports story modules (Emotion / `createContext`), so registry-derived data can't be computed in a Server Component.

- **Every story renders inside `MosaicProvider`.** `StoryCanvas` (interactive route) wraps the component in `MosaicProvider` and exposes a `VariablesPanel` that overrides `MosaicVariables` (color, rounded, spacing) live. `StoryEmbed` (used inside MDX via `<Story>`) renders with default knob values and no variable panel.

- **MDX.** `mdx-components.tsx` injects custom components into all MDX: `<Story>` (→ `StoryEmbed`), `<PropTable>` (derives a props table from `meta.styles._variants`/`_defaultVariants`, always appends `sx`), and a `<pre>` override routing fenced code through Shiki (`CodeBlock`). `next.config.mjs` configures `remark-gfm` and `rehype-raw` (with MDX node pass-through) so raw HTML in tables works.

- **Two component layers.** `src/components/ui/*` are shadcn/ui primitives (`components.json`, `base-nova` style, neutral base) used for swingset's *own* chrome (sidebar, tabs, inputs). The components being *documented* come from `@clerk/ui/mosaic`. Don't confuse the two. Mosaic stories use Emotion (`/** @jsxImportSource @emotion/react */` pragma; `compiler.emotion` enabled in Next).
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs(swingset): Add agent guidance files (CLAUDE.md and AGENTS.md)#8805

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.

 Sign up for GitHub

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

 Merged

kylemac
merged 1 commit into

from

Jun 10, 2026
 Merged


docs(swingset): Add agent guidance files (CLAUDE.md and AGENTS.md)
#8805
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/swingset-agent-docs.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

1 change: 1 addition & 0 deletions
packages/swingset/AGENTS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
@CLAUDE.md

35 changes: 35 additions & 0 deletions
packages/swingset/CLAUDE.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
# CLAUDE.md

This file provides guidance to Coding Agents when working with code in this repository.

`@clerk/swingset` is a private (unpublished) component explorer — a Storybook-like app — for the **Mosaic** design system that lives in `@clerk/ui`. It is a Next.js App Router app that renders Mosaic components interactively with live knobs and design-token overrides.

## Commands

Run from the monorepo root or scope with `--filter @clerk/swingset`:

```
pnpm run dev:swingset. # next dev on port 6006
pnpm build --filter @clerk/swingset # next build
pnpm format --filter @clerk/swingset # format-package.mjs (--check for CI)
```

Comment on lines

+11
 to 
+15

@coderabbitaicoderabbitaiBotJun 10, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win
Add language specifier to code block.
The fenced code block should specify a language (e.g., bash or shell) for proper syntax highlighting and tooling compatibility.
📝 Proposed fix
-```+```bash
pnpm run dev:swingset. # next dev on port 6006
pnpm build --filter `@clerk/swingset` # next build
pnpm format --filter `@clerk/swingset` # format-package.mjs (--check for CI)
</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 11-11: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 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/CLAUDE.md` around lines 11 - 15, The fenced code block in
CLAUDE.md currently lacks a language specifier; update the opening
triple-backtick for the block containing the pnpm commands (the lines starting
with "pnpm run dev:swingset.", "pnpm build --filter `@clerk/swingset`", and "pnpm
format --filter `@clerk/swingset`") to include a language such as bash (e.g.,
change ``` to ```bash) so tooling and syntax highlighting correctly recognize
the shell commands.

Source: Linters/SAST tools

There are no tests or lint scripts in this package, yet.

## Key architecture facts

These require reading several files together; the `README.md` covers the step-by-step "add a component" workflow.

- **Consumes Mosaic from source, not build.** `@clerk/ui/mosaic` is aliased to `../ui/src/mosaic` in *two* places that must stay in sync: `next.config.mjs` (webpack `resolve.alias`) and `tsconfig.json` (`paths`). Editing Mosaic source in `packages/ui` reflects live in swingset's dev server — no rebuild of `@clerk/ui` needed.

- **Knobs are generated from CVA metadata, not hand-written.** A story's `meta.styles` is a Mosaic CVA style object exposing `_variants` / `_defaultVariants`. `lib/generateKnobs.ts` turns each variant into a control: variants whose keys are only `true`/`false` become boolean toggles, everything else becomes a select. Knob values are passed as props straight into the story component. This is why story functions take `Record<string, unknown>` and cast to the real prop type.

- **`lib/registry.ts` is the single source of truth for stories**, and stories are imported *explicitly* (never `import *`) so sidebar order is deterministic. `getSidebarGroups`, `findStory`, and slugging (`lib/slug.ts`, from `meta.title` and export name) all read from it. Adding a component touches up to three wiring points: `registry.ts` (knobs/canvas), `DocsViewer.tsx`'s `docModules` map (MDX docs), and the hardcoded redirect in `app/page.tsx`.

- **Routing.** `/components/[component]` renders MDX docs via `DocsViewer`; `/components/[component]/[story]` renders the interactive `StoryCanvas`. `app/page.tsx` is a static redirect (currently to `/components/button`) because `registry.ts` eagerly imports story modules (Emotion / `createContext`), so registry-derived data can't be computed in a Server Component.

- **Every story renders inside `MosaicProvider`.** `StoryCanvas` (interactive route) wraps the component in `MosaicProvider` and exposes a `VariablesPanel` that overrides `MosaicVariables` (color, rounded, spacing) live. `StoryEmbed` (used inside MDX via `<Story>`) renders with default knob values and no variable panel.

- **MDX.** `mdx-components.tsx` injects custom components into all MDX: `<Story>` (→ `StoryEmbed`), `<PropTable>` (derives a props table from `meta.styles._variants`/`_defaultVariants`, always appends `sx`), and a `<pre>` override routing fenced code through Shiki (`CodeBlock`). `next.config.mjs` configures `remark-gfm` and `rehype-raw` (with MDX node pass-through) so raw HTML in tables works.

- **Two component layers.** `src/components/ui/*` are shadcn/ui primitives (`components.json`, `base-nova` style, neutral base) used for swingset's *own* chrome (sidebar, tabs, inputs). The components being *documented* come from `@clerk/ui/mosaic`. Don't confuse the two. Mosaic stories use Emotion (`/** @jsxImportSource @emotion/react */` pragma; `compiler.emotion` enabled in Next).
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
docs(swingset): Add agent guidance files (CLAUDE.md and AGENTS.md)#8805

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.

 Sign up for GitHub

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

 Merged

kylemac
merged 1 commit into

from

Jun 10, 2026
 Merged


docs(swingset): Add agent guidance files (CLAUDE.md and AGENTS.md)
#8805
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/swingset-agent-docs.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

1 change: 1 addition & 0 deletions
packages/swingset/AGENTS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
@CLAUDE.md

35 changes: 35 additions & 0 deletions
packages/swingset/CLAUDE.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
# CLAUDE.md

This file provides guidance to Coding Agents when working with code in this repository.

`@clerk/swingset` is a private (unpublished) component explorer — a Storybook-like app — for the **Mosaic** design system that lives in `@clerk/ui`. It is a Next.js App Router app that renders Mosaic components interactively with live knobs and design-token overrides.

## Commands

Run from the monorepo root or scope with `--filter @clerk/swingset`:

```
pnpm run dev:swingset. # next dev on port 6006
pnpm build --filter @clerk/swingset # next build
pnpm format --filter @clerk/swingset # format-package.mjs (--check for CI)
```

Comment on lines

+11
 to 
+15

@coderabbitaicoderabbitaiBotJun 10, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win
Add language specifier to code block.
The fenced code block should specify a language (e.g., bash or shell) for proper syntax highlighting and tooling compatibility.
📝 Proposed fix
-```+```bash
pnpm run dev:swingset. # next dev on port 6006
pnpm build --filter `@clerk/swingset` # next build
pnpm format --filter `@clerk/swingset` # format-package.mjs (--check for CI)
</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 11-11: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 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/CLAUDE.md` around lines 11 - 15, The fenced code block in
CLAUDE.md currently lacks a language specifier; update the opening
triple-backtick for the block containing the pnpm commands (the lines starting
with "pnpm run dev:swingset.", "pnpm build --filter `@clerk/swingset`", and "pnpm
format --filter `@clerk/swingset`") to include a language such as bash (e.g.,
change ``` to ```bash) so tooling and syntax highlighting correctly recognize
the shell commands.

Source: Linters/SAST tools

There are no tests or lint scripts in this package, yet.

## Key architecture facts

These require reading several files together; the `README.md` covers the step-by-step "add a component" workflow.

- **Consumes Mosaic from source, not build.** `@clerk/ui/mosaic` is aliased to `../ui/src/mosaic` in *two* places that must stay in sync: `next.config.mjs` (webpack `resolve.alias`) and `tsconfig.json` (`paths`). Editing Mosaic source in `packages/ui` reflects live in swingset's dev server — no rebuild of `@clerk/ui` needed.

- **Knobs are generated from CVA metadata, not hand-written.** A story's `meta.styles` is a Mosaic CVA style object exposing `_variants` / `_defaultVariants`. `lib/generateKnobs.ts` turns each variant into a control: variants whose keys are only `true`/`false` become boolean toggles, everything else becomes a select. Knob values are passed as props straight into the story component. This is why story functions take `Record<string, unknown>` and cast to the real prop type.

- **`lib/registry.ts` is the single source of truth for stories**, and stories are imported *explicitly* (never `import *`) so sidebar order is deterministic. `getSidebarGroups`, `findStory`, and slugging (`lib/slug.ts`, from `meta.title` and export name) all read from it. Adding a component touches up to three wiring points: `registry.ts` (knobs/canvas), `DocsViewer.tsx`'s `docModules` map (MDX docs), and the hardcoded redirect in `app/page.tsx`.

- **Routing.** `/components/[component]` renders MDX docs via `DocsViewer`; `/components/[component]/[story]` renders the interactive `StoryCanvas`. `app/page.tsx` is a static redirect (currently to `/components/button`) because `registry.ts` eagerly imports story modules (Emotion / `createContext`), so registry-derived data can't be computed in a Server Component.

- **Every story renders inside `MosaicProvider`.** `StoryCanvas` (interactive route) wraps the component in `MosaicProvider` and exposes a `VariablesPanel` that overrides `MosaicVariables` (color, rounded, spacing) live. `StoryEmbed` (used inside MDX via `<Story>`) renders with default knob values and no variable panel.

- **MDX.** `mdx-components.tsx` injects custom components into all MDX: `<Story>` (→ `StoryEmbed`), `<PropTable>` (derives a props table from `meta.styles._variants`/`_defaultVariants`, always appends `sx`), and a `<pre>` override routing fenced code through Shiki (`CodeBlock`). `next.config.mjs` configures `remark-gfm` and `rehype-raw` (with MDX node pass-through) so raw HTML in tables works.

- **Two component layers.** `src/components/ui/*` are shadcn/ui primitives (`components.json`, `base-nova` style, neutral base) used for swingset's *own* chrome (sidebar, tabs, inputs). The components being *documented* come from `@clerk/ui/mosaic`. Don't confuse the two. Mosaic stories use Emotion (`/** @jsxImportSource @emotion/react */` pragma; `compiler.emotion` enabled in Next).
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs(swingset): Add agent guidance files (CLAUDE.md and AGENTS.md)#8805

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.

 Sign up for GitHub

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

 Merged

kylemac
merged 1 commit into

from

Jun 10, 2026
 Merged


docs(swingset): Add agent guidance files (CLAUDE.md and AGENTS.md)
#8805
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/swingset-agent-docs.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

1 change: 1 addition & 0 deletions
packages/swingset/AGENTS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
@CLAUDE.md

35 changes: 35 additions & 0 deletions
packages/swingset/CLAUDE.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
# CLAUDE.md

This file provides guidance to Coding Agents when working with code in this repository.

`@clerk/swingset` is a private (unpublished) component explorer — a Storybook-like app — for the **Mosaic** design system that lives in `@clerk/ui`. It is a Next.js App Router app that renders Mosaic components interactively with live knobs and design-token overrides.

## Commands

Run from the monorepo root or scope with `--filter @clerk/swingset`:

```
pnpm run dev:swingset. # next dev on port 6006
pnpm build --filter @clerk/swingset # next build
pnpm format --filter @clerk/swingset # format-package.mjs (--check for CI)
```

Comment on lines

+11
 to 
+15

@coderabbitaicoderabbitaiBotJun 10, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win
Add language specifier to code block.
The fenced code block should specify a language (e.g., bash or shell) for proper syntax highlighting and tooling compatibility.
📝 Proposed fix
-```+```bash
pnpm run dev:swingset. # next dev on port 6006
pnpm build --filter `@clerk/swingset` # next build
pnpm format --filter `@clerk/swingset` # format-package.mjs (--check for CI)
</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 11-11: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 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/CLAUDE.md` around lines 11 - 15, The fenced code block in
CLAUDE.md currently lacks a language specifier; update the opening
triple-backtick for the block containing the pnpm commands (the lines starting
with "pnpm run dev:swingset.", "pnpm build --filter `@clerk/swingset`", and "pnpm
format --filter `@clerk/swingset`") to include a language such as bash (e.g.,
change ``` to ```bash) so tooling and syntax highlighting correctly recognize
the shell commands.

Source: Linters/SAST tools

There are no tests or lint scripts in this package, yet.

## Key architecture facts

These require reading several files together; the `README.md` covers the step-by-step "add a component" workflow.

- **Consumes Mosaic from source, not build.** `@clerk/ui/mosaic` is aliased to `../ui/src/mosaic` in *two* places that must stay in sync: `next.config.mjs` (webpack `resolve.alias`) and `tsconfig.json` (`paths`). Editing Mosaic source in `packages/ui` reflects live in swingset's dev server — no rebuild of `@clerk/ui` needed.

- **Knobs are generated from CVA metadata, not hand-written.** A story's `meta.styles` is a Mosaic CVA style object exposing `_variants` / `_defaultVariants`. `lib/generateKnobs.ts` turns each variant into a control: variants whose keys are only `true`/`false` become boolean toggles, everything else becomes a select. Knob values are passed as props straight into the story component. This is why story functions take `Record<string, unknown>` and cast to the real prop type.

- **`lib/registry.ts` is the single source of truth for stories**, and stories are imported *explicitly* (never `import *`) so sidebar order is deterministic. `getSidebarGroups`, `findStory`, and slugging (`lib/slug.ts`, from `meta.title` and export name) all read from it. Adding a component touches up to three wiring points: `registry.ts` (knobs/canvas), `DocsViewer.tsx`'s `docModules` map (MDX docs), and the hardcoded redirect in `app/page.tsx`.

- **Routing.** `/components/[component]` renders MDX docs via `DocsViewer`; `/components/[component]/[story]` renders the interactive `StoryCanvas`. `app/page.tsx` is a static redirect (currently to `/components/button`) because `registry.ts` eagerly imports story modules (Emotion / `createContext`), so registry-derived data can't be computed in a Server Component.

- **Every story renders inside `MosaicProvider`.** `StoryCanvas` (interactive route) wraps the component in `MosaicProvider` and exposes a `VariablesPanel` that overrides `MosaicVariables` (color, rounded, spacing) live. `StoryEmbed` (used inside MDX via `<Story>`) renders with default knob values and no variable panel.

- **MDX.** `mdx-components.tsx` injects custom components into all MDX: `<Story>` (→ `StoryEmbed`), `<PropTable>` (derives a props table from `meta.styles._variants`/`_defaultVariants`, always appends `sx`), and a `<pre>` override routing fenced code through Shiki (`CodeBlock`). `next.config.mjs` configures `remark-gfm` and `rehype-raw` (with MDX node pass-through) so raw HTML in tables works.

- **Two component layers.** `src/components/ui/*` are shadcn/ui primitives (`components.json`, `base-nova` style, neutral base) used for swingset's *own* chrome (sidebar, tabs, inputs). The components being *documented* come from `@clerk/ui/mosaic`. Don't confuse the two. Mosaic stories use Emotion (`/** @jsxImportSource @emotion/react */` pragma; `compiler.emotion` enabled in Next).
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
docs(swingset): Add agent guidance files (CLAUDE.md and AGENTS.md)#8805

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.

 Sign up for GitHub

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

 Merged

kylemac
merged 1 commit into

from

Jun 10, 2026
 Merged


docs(swingset): Add agent guidance files (CLAUDE.md and AGENTS.md)
#8805
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/swingset-agent-docs.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

1 change: 1 addition & 0 deletions
packages/swingset/AGENTS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
@CLAUDE.md

35 changes: 35 additions & 0 deletions
packages/swingset/CLAUDE.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
# CLAUDE.md

This file provides guidance to Coding Agents when working with code in this repository.

`@clerk/swingset` is a private (unpublished) component explorer — a Storybook-like app — for the **Mosaic** design system that lives in `@clerk/ui`. It is a Next.js App Router app that renders Mosaic components interactively with live knobs and design-token overrides.

## Commands

Run from the monorepo root or scope with `--filter @clerk/swingset`:

```
pnpm run dev:swingset. # next dev on port 6006
pnpm build --filter @clerk/swingset # next build
pnpm format --filter @clerk/swingset # format-package.mjs (--check for CI)
```

Comment on lines

+11
 to 
+15

@coderabbitaicoderabbitaiBotJun 10, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win
Add language specifier to code block.
The fenced code block should specify a language (e.g., bash or shell) for proper syntax highlighting and tooling compatibility.
📝 Proposed fix
-```+```bash
pnpm run dev:swingset. # next dev on port 6006
pnpm build --filter `@clerk/swingset` # next build
pnpm format --filter `@clerk/swingset` # format-package.mjs (--check for CI)
</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 11-11: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 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/CLAUDE.md` around lines 11 - 15, The fenced code block in
CLAUDE.md currently lacks a language specifier; update the opening
triple-backtick for the block containing the pnpm commands (the lines starting
with "pnpm run dev:swingset.", "pnpm build --filter `@clerk/swingset`", and "pnpm
format --filter `@clerk/swingset`") to include a language such as bash (e.g.,
change ``` to ```bash) so tooling and syntax highlighting correctly recognize
the shell commands.

Source: Linters/SAST tools

There are no tests or lint scripts in this package, yet.

## Key architecture facts

These require reading several files together; the `README.md` covers the step-by-step "add a component" workflow.

- **Consumes Mosaic from source, not build.** `@clerk/ui/mosaic` is aliased to `../ui/src/mosaic` in *two* places that must stay in sync: `next.config.mjs` (webpack `resolve.alias`) and `tsconfig.json` (`paths`). Editing Mosaic source in `packages/ui` reflects live in swingset's dev server — no rebuild of `@clerk/ui` needed.

- **Knobs are generated from CVA metadata, not hand-written.** A story's `meta.styles` is a Mosaic CVA style object exposing `_variants` / `_defaultVariants`. `lib/generateKnobs.ts` turns each variant into a control: variants whose keys are only `true`/`false` become boolean toggles, everything else becomes a select. Knob values are passed as props straight into the story component. This is why story functions take `Record<string, unknown>` and cast to the real prop type.

- **`lib/registry.ts` is the single source of truth for stories**, and stories are imported *explicitly* (never `import *`) so sidebar order is deterministic. `getSidebarGroups`, `findStory`, and slugging (`lib/slug.ts`, from `meta.title` and export name) all read from it. Adding a component touches up to three wiring points: `registry.ts` (knobs/canvas), `DocsViewer.tsx`'s `docModules` map (MDX docs), and the hardcoded redirect in `app/page.tsx`.

- **Routing.** `/components/[component]` renders MDX docs via `DocsViewer`; `/components/[component]/[story]` renders the interactive `StoryCanvas`. `app/page.tsx` is a static redirect (currently to `/components/button`) because `registry.ts` eagerly imports story modules (Emotion / `createContext`), so registry-derived data can't be computed in a Server Component.

- **Every story renders inside `MosaicProvider`.** `StoryCanvas` (interactive route) wraps the component in `MosaicProvider` and exposes a `VariablesPanel` that overrides `MosaicVariables` (color, rounded, spacing) live. `StoryEmbed` (used inside MDX via `<Story>`) renders with default knob values and no variable panel.

- **MDX.** `mdx-components.tsx` injects custom components into all MDX: `<Story>` (→ `StoryEmbed`), `<PropTable>` (derives a props table from `meta.styles._variants`/`_defaultVariants`, always appends `sx`), and a `<pre>` override routing fenced code through Shiki (`CodeBlock`). `next.config.mjs` configures `remark-gfm` and `rehype-raw` (with MDX node pass-through) so raw HTML in tables works.

- **Two component layers.** `src/components/ui/*` are shadcn/ui primitives (`components.json`, `base-nova` style, neutral base) used for swingset's *own* chrome (sidebar, tabs, inputs). The components being *documented* come from `@clerk/ui/mosaic`. Don't confuse the two. Mosaic stories use Emotion (`/** @jsxImportSource @emotion/react */` pragma; `compiler.emotion` enabled in Next).
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
docs(swingset): Add agent guidance files (CLAUDE.md and AGENTS.md)#8805

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.

 Sign up for GitHub

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

 Merged

kylemac
merged 1 commit into

from

Jun 10, 2026
 Merged


docs(swingset): Add agent guidance files (CLAUDE.md and AGENTS.md)
#8805
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/swingset-agent-docs.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

1 change: 1 addition & 0 deletions
packages/swingset/AGENTS.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
@CLAUDE.md

35 changes: 35 additions & 0 deletions
packages/swingset/CLAUDE.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
# CLAUDE.md

This file provides guidance to Coding Agents when working with code in this repository.

`@clerk/swingset` is a private (unpublished) component explorer — a Storybook-like app — for the **Mosaic** design system that lives in `@clerk/ui`. It is a Next.js App Router app that renders Mosaic components interactively with live knobs and design-token overrides.

## Commands

Run from the monorepo root or scope with `--filter @clerk/swingset`:

```
pnpm run dev:swingset. # next dev on port 6006
pnpm build --filter @clerk/swingset # next build
pnpm format --filter @clerk/swingset # format-package.mjs (--check for CI)
```

Comment on lines

+11
 to 
+15

@coderabbitaicoderabbitaiBotJun 10, 2026

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win
Add language specifier to code block.
The fenced code block should specify a language (e.g., bash or shell) for proper syntax highlighting and tooling compatibility.
📝 Proposed fix
-```+```bash
pnpm run dev:swingset. # next dev on port 6006
pnpm build --filter `@clerk/swingset` # next build
pnpm format --filter `@clerk/swingset` # format-package.mjs (--check for CI)
</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 11-11: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 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/CLAUDE.md` around lines 11 - 15, The fenced code block in
CLAUDE.md currently lacks a language specifier; update the opening
triple-backtick for the block containing the pnpm commands (the lines starting
with "pnpm run dev:swingset.", "pnpm build --filter `@clerk/swingset`", and "pnpm
format --filter `@clerk/swingset`") to include a language such as bash (e.g.,
change ``` to ```bash) so tooling and syntax highlighting correctly recognize
the shell commands.

Source: Linters/SAST tools

There are no tests or lint scripts in this package, yet.

## Key architecture facts

These require reading several files together; the `README.md` covers the step-by-step "add a component" workflow.

- **Consumes Mosaic from source, not build.** `@clerk/ui/mosaic` is aliased to `../ui/src/mosaic` in *two* places that must stay in sync: `next.config.mjs` (webpack `resolve.alias`) and `tsconfig.json` (`paths`). Editing Mosaic source in `packages/ui` reflects live in swingset's dev server — no rebuild of `@clerk/ui` needed.

- **Knobs are generated from CVA metadata, not hand-written.** A story's `meta.styles` is a Mosaic CVA style object exposing `_variants` / `_defaultVariants`. `lib/generateKnobs.ts` turns each variant into a control: variants whose keys are only `true`/`false` become boolean toggles, everything else becomes a select. Knob values are passed as props straight into the story component. This is why story functions take `Record<string, unknown>` and cast to the real prop type.

- **`lib/registry.ts` is the single source of truth for stories**, and stories are imported *explicitly* (never `import *`) so sidebar order is deterministic. `getSidebarGroups`, `findStory`, and slugging (`lib/slug.ts`, from `meta.title` and export name) all read from it. Adding a component touches up to three wiring points: `registry.ts` (knobs/canvas), `DocsViewer.tsx`'s `docModules` map (MDX docs), and the hardcoded redirect in `app/page.tsx`.

- **Routing.** `/components/[component]` renders MDX docs via `DocsViewer`; `/components/[component]/[story]` renders the interactive `StoryCanvas`. `app/page.tsx` is a static redirect (currently to `/components/button`) because `registry.ts` eagerly imports story modules (Emotion / `createContext`), so registry-derived data can't be computed in a Server Component.

- **Every story renders inside `MosaicProvider`.** `StoryCanvas` (interactive route) wraps the component in `MosaicProvider` and exposes a `VariablesPanel` that overrides `MosaicVariables` (color, rounded, spacing) live. `StoryEmbed` (used inside MDX via `<Story>`) renders with default knob values and no variable panel.

- **MDX.** `mdx-components.tsx` injects custom components into all MDX: `<Story>` (→ `StoryEmbed`), `<PropTable>` (derives a props table from `meta.styles._variants`/`_defaultVariants`, always appends `sx`), and a `<pre>` override routing fenced code through Shiki (`CodeBlock`). `next.config.mjs` configures `remark-gfm` and `rehype-raw` (with MDX node pass-through) so raw HTML in tables works.

- **Two component layers.** `src/components/ui/*` are shadcn/ui primitives (`components.json`, `base-nova` style, neutral base) used for swingset's *own* chrome (sidebar, tabs, inputs). The components being *documented* come from `@clerk/ui/mosaic`. Don't confuse the two. Mosaic stories use Emotion (`/** @jsxImportSource @emotion/react */` pragma; `compiler.emotion` enabled in Next).
Loading