@tomny-dev/uzi 0.3.0-pr.42.127.1.c4510f3 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -0
- package/package.json +9 -1
package/README.md
CHANGED
|
@@ -20,6 +20,34 @@ If you want the packaged component styles, import the exported stylesheet once i
|
|
|
20
20
|
@import "@tomny-dev/uzi/styles.css";
|
|
21
21
|
```
|
|
22
22
|
|
|
23
|
+
## Storybook
|
|
24
|
+
|
|
25
|
+
Uzi includes Storybook as the interactive component catalog for exploring components, variants, states, and composition patterns.
|
|
26
|
+
|
|
27
|
+
To run Storybook locally:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
pnpm install
|
|
31
|
+
pnpm storybook
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Then open `http://localhost:6006`.
|
|
35
|
+
|
|
36
|
+
To verify the production Storybook build:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
pnpm build-storybook
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
The static output is written to `storybook-static/`. Story files live beside their components under `src/components/**` using the `*.stories.tsx` naming convention.
|
|
43
|
+
|
|
44
|
+
CI builds Storybook on every pull request and push to `main`. After changes land on `main`, the Storybook deployment workflow publishes `storybook-static/` to the `uzi-storybook` Cloudflare Pages project. The deployment workflow requires these repository secrets:
|
|
45
|
+
|
|
46
|
+
- `CLOUDFLARE_API_TOKEN` — API token with Pages Write permission.
|
|
47
|
+
- `CLOUDFLARE_ACCOUNT_ID` — Cloudflare account identifier.
|
|
48
|
+
|
|
49
|
+
The Cloudflare Pages project should use `main` as its production branch. A custom domain such as `uzi.tomny.dev` can be attached to that Pages project after the project exists.
|
|
50
|
+
|
|
23
51
|
## Using With Coding Agents
|
|
24
52
|
|
|
25
53
|
Installing `@tomny-dev/uzi` in an app does not by itself cause Claude Code, Codex, or similar agents to prefer `uzi` components. You should add that policy to the consumer repo's agent guidance.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tomny-dev/uzi",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.0",
|
|
4
4
|
"description": "Rapid-fire React UI components. Ship faster, build more.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"repository": {
|
|
@@ -48,6 +48,8 @@
|
|
|
48
48
|
"dev": "vite build --watch",
|
|
49
49
|
"lint": "tsc --noEmit",
|
|
50
50
|
"test": "vitest run",
|
|
51
|
+
"storybook": "storybook dev -p 6006",
|
|
52
|
+
"build-storybook": "storybook build",
|
|
51
53
|
"verify:package": "node scripts/verify-client-boundary.mjs"
|
|
52
54
|
},
|
|
53
55
|
"peerDependencies": {
|
|
@@ -63,12 +65,18 @@
|
|
|
63
65
|
"@radix-ui/react-toast": "^1.2.15"
|
|
64
66
|
},
|
|
65
67
|
"devDependencies": {
|
|
68
|
+
"@storybook/addon-essentials": "^8.6.14",
|
|
69
|
+
"@storybook/addon-links": "^8.6.18",
|
|
70
|
+
"@storybook/addon-storysource": "^8.6.14",
|
|
71
|
+
"@storybook/react": "8",
|
|
72
|
+
"@storybook/react-vite": "^8.6.18",
|
|
66
73
|
"@testing-library/jest-dom": "^6.9.1",
|
|
67
74
|
"@testing-library/react": "^16.3.2",
|
|
68
75
|
"@types/react": "^18.2.0",
|
|
69
76
|
"@types/react-dom": "^18.2.0",
|
|
70
77
|
"@vitejs/plugin-react": "^5.2.0",
|
|
71
78
|
"jsdom": "^29.1.1",
|
|
79
|
+
"storybook": "^8.6.18",
|
|
72
80
|
"typescript": "^5.4.3",
|
|
73
81
|
"vite": "^8.0.0",
|
|
74
82
|
"vite-plugin-css-injected-by-js": "^5.0.1",
|