@zeroxsolutions/zaku 0.1.0 → 0.2.1
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 +9 -1
- package/dist/zaku.mjs +1443 -842
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @zeroxsolutions/zaku
|
|
2
2
|
|
|
3
|
-
The `zaku` command: checks
|
|
3
|
+
The `zaku` command: checks each product's committed design data against its code, and
|
|
4
4
|
prints the rules script a Figma write runs through Figma's MCP server. The zaku plugin in
|
|
5
5
|
[agent-plugins](https://github.com/zeroxsolutions/agent-plugins/tree/master/plugins/zaku) runs this
|
|
6
6
|
package through `npx`, pinned to one version, and so can CI or a harness without the plugin.
|
|
@@ -10,8 +10,16 @@ Published as `@zeroxsolutions/zaku-cli` up to 0.0.1.
|
|
|
10
10
|
npx -y @zeroxsolutions/zaku check
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
+
zaku reads `zaku.config.yaml` in the directory it runs in, or the file `--config <path>` names, and
|
|
14
|
+
never a parent's. The file lists the products and the keys they share, or is one product's config,
|
|
15
|
+
with its design in `design/` beside it. A command runs over every product, or over the one
|
|
16
|
+
`--product <name>` names; `library script`, `library save` and `rules script` act on one product's
|
|
17
|
+
file, so they need `--product` when the config lists several. With no `zaku.config.yaml`, zaku reads
|
|
18
|
+
`docs/design/zaku.yaml` for one more minor version, and says so on stderr.
|
|
19
|
+
|
|
13
20
|
| Command | What it does |
|
|
14
21
|
| --------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
|
|
22
|
+
| `zaku products` | prints each product the config lists, with its design directory; `--json` for a list |
|
|
15
23
|
| `zaku check` | runs every check over the committed design files; exits 0, 1 on a finding, 2 on an error |
|
|
16
24
|
| `zaku rules script --page <page>` | prints a `use_figma` body that runs the rules over one page |
|
|
17
25
|
| `zaku rules script --page <page> --after <f>` | prints one body that runs the write in `<f>`, then the rules, answering `{ value, rules }` |
|