Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ coverage/
build/
test-results/
playwright-report/
skills/react-ui/references/
6 changes: 5 additions & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,11 @@ arrives as props.
- `src/theme.css`, `src/styles.css`: tokens and keyframes; the prebuilt sheet
entry.
- `stories/`: Storybook stories, kept out of `src/` so they never ship in `dist/`.
- `scripts/dep-guard.mjs`, `scripts/contrast-test.mjs`: the CI gates.
- `scripts/dep-guard.mjs`, `scripts/contrast-test.mjs`, `scripts/agent-references.mjs`:
the CI gates; the last is the build step that generates
`skills/react-ui/references/` and fails on a public module no group lists.
- `skills/react-ui/`: the agent skill that ships in the package. `SKILL.md` and
`AGENTS.md` are hand-written; `references/` is generated and git-ignored.
- `scripts/test-dom-setup.ts`: happy-dom preload for unit tests (`bunfig.toml`).
- `e2e/`: checks against the built package.

Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,10 @@ Everything imports from `@corbits/react-ui`, except rows marked "optional peer",
| `ThemeProvider` | Persists light, dark or system mode and presets |
| `ThemeToggle` | Light, dark or system switch |

## For coding agents

The package ships an agent skill: a short guide, usage rules and a props reference for every component. Point your agent at `node_modules/@corbits/react-ui/skills/react-ui` (start with `SKILL.md`), or copy that folder into your agent's skills directory.

## Using with Interchange

The host app owns the connection to the hub; components only take props.
Expand Down
2 changes: 1 addition & 1 deletion bun.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 4 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
},
"files": [
"dist",
"skills",
"README.md",
"LICENSE"
],
Expand Down Expand Up @@ -72,7 +73,7 @@
"access": "public"
},
"scripts": {
"build": "rm -rf dist && tsc -p tsconfig.build.json && bun run build:css",
"build": "rm -rf dist && tsc -p tsconfig.build.json && bun run build:css && bun run build:references",
"prepack": "bun run build",
"typecheck": "tsc --noEmit",
"lint": "oxlint",
Expand All @@ -82,6 +83,7 @@
"test:e2e": "bun test ./e2e/exports.test.ts ./e2e/contrast.test.ts && playwright test",
"check": "bun run typecheck && bun run lint && bun run format:check && bun run test",
"build:css": "tailwindcss -i src/styles.css -o dist/styles.css && cp src/theme.css dist/theme.css",
"build:references": "node scripts/agent-references.mjs",
"dep-guard": "node scripts/dep-guard.mjs",
"contrast-test": "node scripts/contrast-test.mjs",
"stories": "storybook dev -p 6006 --host 127.0.0.1 --no-open",
Expand Down Expand Up @@ -115,7 +117,7 @@
"sonner": "^2.0.7",
"storybook": "10.6.2",
"tailwindcss": "^4.3.3",
"typescript": "^5.9.3",
"typescript": "5.9.3",
"vite": "^7"
},
"peerDependencies": {
Expand Down
Loading
Loading