@grum-os/cli 0.3.43 → 0.3.47
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 +14 -12
- package/content.md5 +1 -1
- package/grum.mjs +581 -295
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<img src="https://cdn.jsdelivr.net/npm/@grum-os/cli/brand.png" alt="Grum" width="224" height="59" />
|
|
1
|
+
<img src="https://cdn.jsdelivr.net/npm/@grum-os/cli/brand.png?v=43346b25a840" alt="Grum" width="224" height="59" />
|
|
2
2
|
|
|
3
3
|
# Grum
|
|
4
4
|
|
|
@@ -62,7 +62,7 @@ The menu and the commands above stay as they are. `--agent` is an extra way in,
|
|
|
62
62
|
|
|
63
63
|
Accepting Cursor in the menu puts Grum inside the agent. The agent follows the same contract a person sees in Grum, and it can ask the owners to allow something the contract does not have.
|
|
64
64
|
|
|
65
|
-
**Before it writes UI**, it reads the contract: color, typography, spacing, and radius tokens, plus button components and looks, approved text inputs, and the rules for using them.
|
|
65
|
+
**Before it writes UI**, it reads the contract: color, typography, spacing, and radius tokens, plus button components and looks, approved text inputs and checkboxes, and the rules for using them.
|
|
66
66
|
|
|
67
67
|
**Before it finishes**, it checks what it changed. Drift already on the default branch stays off the list. New drift comes back with a fix.
|
|
68
68
|
|
|
@@ -151,14 +151,15 @@ A check prints the report and exits 0, including when you are signed out, offlin
|
|
|
151
151
|
|
|
152
152
|
### What it looks for
|
|
153
153
|
|
|
154
|
-
| Area | New drift
|
|
155
|
-
| ---------- |
|
|
156
|
-
| Color | A hard-coded color, a color nearly identical to a contract color, or a color token the contract does not have
|
|
157
|
-
| Typography | A size, weight, or line height off the contract scale
|
|
158
|
-
| Spacing | A margin, padding, or gap off the scale
|
|
159
|
-
| Radius | A radius off the scale
|
|
160
|
-
| Buttons | A look the contract does not have, a look whose state changed, a missing state, a raw `<button>` outside the button component, or a variant the component lacks
|
|
161
|
-
| Inputs | A text input that does not match an approved input, or differs from one in structure, appearance, or states
|
|
154
|
+
| Area | New drift |
|
|
155
|
+
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
156
|
+
| Color | A hard-coded color, a color nearly identical to a contract color, or a color token the contract does not have |
|
|
157
|
+
| Typography | A size, weight, or line height off the contract scale |
|
|
158
|
+
| Spacing | A margin, padding, or gap off the scale |
|
|
159
|
+
| Radius | A radius off the scale |
|
|
160
|
+
| Buttons | A look the contract does not have, a look whose state changed, a missing state, a raw `<button>` outside the button component, or a variant the component lacks |
|
|
161
|
+
| Inputs | A text input that does not match an approved input, or differs from one in structure, appearance, or states |
|
|
162
|
+
| Checkboxes | A checkbox that overrides an approved checkbox (its box, mark, label, or a checked, indeterminate, disabled, or focus state), or one whose approved state is gone |
|
|
162
163
|
|
|
163
164
|
## Review one item yourself
|
|
164
165
|
|
|
@@ -186,7 +187,7 @@ Clears the capture-browser sign-in saved for this repository.
|
|
|
186
187
|
grum contract
|
|
187
188
|
```
|
|
188
189
|
|
|
189
|
-
Prints the contract packet agents read before writing UI: tokens by category (with a separate dark value when there is one), button components and looks, approved text inputs, team guidelines, and review decisions.
|
|
190
|
+
Prints the contract packet agents read before writing UI: tokens by category (with a separate dark value when there is one), button components and looks, approved text inputs and checkboxes, team guidelines, and review decisions.
|
|
190
191
|
|
|
191
192
|
## Fail the check
|
|
192
193
|
|
|
@@ -254,6 +255,7 @@ The menu covers check, setup, and sign-in. These are the same actions as flags,
|
|
|
254
255
|
| `grum check [flags]` | Check the working tree. See the flags below. |
|
|
255
256
|
| `grum request <key> [<key>...] [--reason "..."] [--url <page>] [--live] [--browser chrome | safari] [--no-capture]` | Ask the owners to allow drift items; items on one page capture together. |
|
|
256
257
|
| `grum add-token ...` / `grum add-button ...` | For owners, add a token or approved button design to the contract. |
|
|
258
|
+
| `grum add-icon <ref> [--name <name>]` | For owners, add an icon `grum check --json` lists under `discovered.icons`, from this checkout's source. |
|
|
257
259
|
| `grum snooze <key> [<key>...]` | Pause questions about existing drift on this branch for the configured period. |
|
|
258
260
|
| `grum uninstall [--yes]` | Remove Grum from this repository and this computer. See [Uninstall](#uninstall). |
|
|
259
261
|
| `grum capture reset` | Clear this repository's saved capture-browser sign-ins. |
|
|
@@ -265,7 +267,7 @@ The menu covers check, setup, and sign-in. These are the same actions as flags,
|
|
|
265
267
|
```sh
|
|
266
268
|
grum check --staged # drift in the blocks staged for commit
|
|
267
269
|
grum check --files src/Hero.tsx # only these paths
|
|
268
|
-
grum check --json # project, cache time, known count, findings
|
|
270
|
+
grum check --json # project, cache time, known count, findings, discovered icons
|
|
269
271
|
grum check --no-review # print the report and do not ask
|
|
270
272
|
grum check --cursor # open the findings in Cursor
|
|
271
273
|
grum check --offline # the cached contract, no network
|
package/content.md5
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
f03e59d1d79bf929cfa937fa5fea5794
|