@openwarelabs/ui 0.6.0 → 0.7.0

package/README.md

@@ -69,6 +69,23 @@ import { Button, Field, Input, Toaster, toast } from "@openwarelabs/ui";
 
 Hooks for your own components: `useControllableState`, `useFloating` (top-layer positioning that flips), `usePresence` (keeps a layer mounted while it animates out), `useDismiss`, `useModalDialog`, `useMenuKeyboard`. Every prop is typed and described, so your editor explains it on hover.
 
+## Blocks as components
+
+Blocks are becoming components in their own package, `@openwarelabs/blocks`, that take their content as props, so you don't copy their code. The heroes are first, `Hero01` to `Hero06`:
+
+```sh
+npm install @openwarelabs/blocks
+```
+
+```tsx
+import "@openwarelabs/blocks/styles.css"; // after @openwarelabs/ui/styles.css
+import { Hero01 } from "@openwarelabs/blocks";
+
+<Hero01 title="The workspace for shipping software" description="…" primaryAction={{ label: "Start for free", href: "/signup" }} />;
+```
+
+Each block's page in the docs shows its props under the preview. The source is `blocks/src/<category>/<Name>/` (the component, its `.types.ts` and its `.css`); `npm run blocks:build` builds the package, and `npm run release` publishes it with the library at the same version.
+
 ## Use with AI
 
 The MCP server, `@openwarelabs/ui-mcp`, gives Claude Code, Codex, Cursor and other AI tools the setup, every component's examples and props, every block's code and the tokens, so they build with the real components:
@@ -104,6 +121,18 @@ The docs' header has a colour picker that does this live, and the Theming page s
 
 **No bundler?** `dist/openware-ui.iife.js` sets `window.OpenwareUI`, reading React from `window.React`. A CDN serves it straight from npm: `https://cdn.jsdelivr.net/npm/@openwarelabs/ui/dist/openware-ui.iife.js`, with `dist/styles.css` beside it.
 
+## Contributing
+
+`main` takes changes only through pull requests, squash-merged, so each one lands as a single commit named after the PR. The PR title follows [Conventional Commits](https://www.conventionalcommits.org) because `npm run release` reads it: `feat: add a date range picker`, `fix(Menu): close on Escape`, `feat!: rename Stack's gap sizes`. Put `BREAKING CHANGE: …` in the PR description for a breaking change.
+
+Three checks have to pass to merge:
+
+- **Checks**: types, contrast, blocks, the library, the MCP server and the docs.
+- **PR title**: the title follows the convention (`npm run commits:check -- --title "feat: …"` locally).
+- **Cleaner**: [openwarelabs/cleaner](https://github.com/openwarelabs/cleaner) on the `.ts` and `.tsx` files the PR changes. Types go in a `<name>.types.ts` beside the component, and imports from another folder use the aliases instead of `../`: `@/…` for `src/` (in the library and the docs), `@docs/…` for `docs/` (`?highlight` imports too) and `@build/…` in `mcp/`. Files that haven't been touched yet don't follow it; they catch up as they change.
+
+`scripts/setup-github.sh` sets this up on GitHub (squash merges only, the PR title as the commit, the ruleset for `main`). Repository admins can bypass the ruleset, which `npm run release` uses to push its version commit and tag.
+
 ## Releasing
 
 ```sh
@@ -114,7 +143,7 @@ npm run release -- minor     # forces patch, minor, major or an exact version
 
 The version comes from the commit subjects since the last release, written as [Conventional Commits](https://www.conventionalcommits.org): `feat:` makes a minor release, `fix:` and `perf:` a patch, and `feat!:` or a `BREAKING CHANGE:` line a major one (a minor one before 1.0). `chore:`, `docs:`, `refactor:`, `test:`, `ci:`, `build:` and `style:` don't release on their own. The command checks that `main` is clean and up to date, runs every check and build, bumps both packages, writes `CHANGELOG.md`, commits, tags `vX.Y.Z` and pushes.
 
-The tag starts `.github/workflows/release.yml`, which runs the checks again, publishes `@openwarelabs/ui` and `@openwarelabs/ui-mcp` to npm with trusted publishing (no token, with provenance), and makes the GitHub release from the changelog. CI checks every pull request's commit subjects against the convention; `npm run commits:check` does the same locally.
+The tag starts `.github/workflows/release.yml`, which runs the checks again, publishes `@openwarelabs/ui` and `@openwarelabs/ui-mcp` to npm with trusted publishing (no token, with provenance), and makes the GitHub release from the changelog. Pull requests are squash-merged with their title as the commit, so the titles are what it reads.
 
 ## Rules worth keeping
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openwarelabs/ui",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Openware UI: React components and design tokens — midnight and brass, tactile buttons and Inter, in light and dark.",
   "license": "MIT",
   "author": "Alexander Silver",
@@ -43,9 +43,10 @@
   "scripts": {
     "dev": "node scripts/docs.mjs dev",
     "build": "node scripts/build-tokens.mjs && node scripts/build.mjs && tsc -p tsconfig.build.json && node scripts/build-types.mjs",
+    "blocks:build": "node scripts/build-blocks.mjs",
     "docs:build": "node scripts/docs.mjs build",
     "tokens": "node scripts/build-tokens.mjs",
-    "typecheck": "tsc --noEmit && tsc -p docs/tsconfig.json",
+    "typecheck": "tsc --noEmit && tsc -p docs/tsconfig.json && tsc -p blocks/tsconfig.json",
     "contrast": "node scripts/check-contrast.mjs",
     "blocks:check": "node scripts/check-blocks.mjs",
     "prepare": "npm run build",
@@ -80,7 +81,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/openwarelabs/ui"
+    "url": "git+https://github.com/openwarelabs/ui.git"
   },
   "keywords": [
     "react",