@askewly/design 0.5.1 → 0.6.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 CHANGED
@@ -1,31 +1,34 @@
1
- # @askewly/design
2
-
3
- Query, inject, and verify the [Askewly Design](https://ui.askewly.com) system from your terminal or coding agent.
4
-
5
- ```bash
6
- npx @askewly/design verify src
7
- ```
8
-
9
- ## Commands
10
-
11
- | Command | What it does |
12
- |---|---|
13
- | `verify [dir]` | Scan for color values that bypass the token system — hex literals and raw `rgb()`/`hsl()`/`oklch()`. Comments and SVG markup are exempt. |
14
- | `terms search <query>` | Search the UI vocabulary (562 terms, Korean + English). |
15
- | `terms show <id>` | Definition, aliases, visual anatomy, anti-use cases, prompt phrases. |
16
- | `tokens` | Print the design token set. |
17
- | `init [dir]` | Drop token CSS into a project. |
18
- | `add <recipe>` | Add a component recipe. |
19
- | `recipes list` / `recipes show <id>` | Agent-ready implementation contracts (45 recipes). |
20
-
21
- ## Why `verify` exists
22
-
23
- A screenshot cannot tell `#3B82F6` from `var(--color-accent)` — they render identically. Whether a screen actually uses the token system is a question for a machine, not an eye.
24
-
25
- `verify` exits `1` on violations and prints `file:line [rule] excerpt`, so a coding agent can read the list, fix, and re-measure.
26
-
27
- Exempt by design: generated token files (`tokens.css`, `askewly.css`), build directories, comments, and SVG markup.
28
-
29
- ## License
30
-
31
- MIT
1
+ # @askewly/design
2
+
3
+ Query, inject, and verify the [Askewly Design](https://ui.askewly.com) system from your terminal or coding agent.
4
+
5
+ ```bash
6
+ npx @askewly/design verify src
7
+ ```
8
+
9
+ ## Commands
10
+
11
+ | Command | What it does |
12
+ |---|---|
13
+ | `verify [dir]` | Scan for color values that bypass the token system — hex literals and raw `rgb()`/`hsl()`/`oklch()`. Comments and SVG markup are exempt. |
14
+ | `terms search <query>` | Search the UI vocabulary (562 terms, Korean + English). |
15
+ | `terms show <id>` | Definition, aliases, visual anatomy, anti-use cases, prompt phrases. |
16
+ | `tokens` | Print the design token set. |
17
+ | `init [dir]` | Drop token CSS into a project. |
18
+ | `add <recipe>` | Add a component recipe. |
19
+ | `recipes list` / `recipes show <id>` | Agent-ready implementation contracts (45 recipes). |
20
+ | `assets search <query>` / `assets show <id>` | One md per asset (registry + recipes): definition, usage rules, install command. Bundled, works offline. `show` on an unknown id exits `1` with 3 closest ids (0.6.0). |
21
+ | `site list` / `site get <slug> [dir]` | Download a reproduced-site bundle: structure only (code, layout, motion, text). Images are same-size blank placeholders; video, audio and fonts are left out (originals stay with their owners). Verifies sha256, refuses a non-empty dir, unknown slug exits `1` with closest slugs. Base URL override: `ASKEWLY_SITE_BUNDLE_URL`. |
22
+ | `prompt <id>` | Paste-ready agent prompt: asset md URL + install command + usage rules + one-line instruction (0.6.0). |
23
+
24
+ ## Why `verify` exists
25
+
26
+ A screenshot cannot tell `#3B82F6` from `var(--color-accent)` — they render identically. Whether a screen actually uses the token system is a question for a machine, not an eye.
27
+
28
+ `verify` exits `1` on violations and prints `file:line [rule] excerpt`, so a coding agent can read the list, fix, and re-measure.
29
+
30
+ Exempt by design: generated token files (`tokens.css`, `askewly.css`), build directories, comments, and SVG markup.
31
+
32
+ ## License
33
+
34
+ MIT