roast-my-design-system 5.12.2 → 5.12.3
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
|
@@ -33,30 +33,34 @@ Your AI agent (Claude, Cursor, Copilot) builds UI by imitating what's already in
|
|
|
33
33
|
|
|
34
34
|
One scan powers all of it; the flags decide what lands on disk. Combine freely.
|
|
35
35
|
|
|
36
|
-
|
|
36
|
+
### Run it yourself
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
Type these in a terminal and you get a result.
|
|
39
|
+
|
|
40
|
+
| Command | What you get |
|
|
39
41
|
|---|---|
|
|
40
|
-
|
|
|
41
|
-
|
|
|
42
|
+
| <code>npx roast-my-design-system@latest</code> | The scan and `design-system-roast.html`, opened in your browser |
|
|
43
|
+
| <code>... <path></code> | Scan a different repo than the current directory |
|
|
42
44
|
| `... --apply` | The generated agent rules injected straight into every agent file you have: `CLAUDE.md`, `AGENTS.md`, `.cursorrules`, `.cursor/rules/`, `.windsurfrules` and `.github/copilot-instructions.md`, inside a marked block. Re-running replaces only that block, never your own text. Windsurf and Copilot get a compact variant sized for their limits |
|
|
43
45
|
| `... --rules` | The same rules written to `design-system-rules.md` instead, for pasting by hand |
|
|
44
46
|
| `... --card` | `roast-card.svg`: a shareable 1200x630 card with the score and worst findings. Pure SVG, embeds in a README |
|
|
45
47
|
| `... --sarif` | `design-system-roast.sarif` for GitHub code scanning: upload it in CI and findings appear in the Security tab, annotated on files |
|
|
46
48
|
| `... --check` | The working tree's changed files checked against the design system, in the terminal. Exits 1 on findings, so it slots into scripts |
|
|
47
|
-
|
|
|
49
|
+
| <code>... --exclude lab/</code> | Leave a folder out of the scan (repeat the flag or comma-separate). Or list folders in a `.roastignore` file at the repo root. Either way the report says so in the header; see [Scoping the scan](#scoping-the-scan) |
|
|
48
50
|
| `... --json` | The scan summary as JSON on stdout, for scripts and pipelines |
|
|
49
|
-
|
|
|
50
|
-
|
|
|
51
|
+
| <code>... --by "Dwayne Hicks"</code> | Puts a name in the report header, for when you ran it for someone else |
|
|
52
|
+
| <code>... --theme light</code> / <code>--out <file></code> / <code>--no-open</code> / <code>--open</code> | Light report, custom report path, never open the browser, always open it |
|
|
53
|
+
|
|
54
|
+
### For your agent
|
|
51
55
|
|
|
52
|
-
|
|
56
|
+
These need an agent.
|
|
53
57
|
|
|
54
|
-
| Command | What you get |
|
|
58
|
+
| Command | What you get |
|
|
55
59
|
|---|---|
|
|
56
|
-
|
|
|
57
|
-
|
|
|
60
|
+
| <code>... --notes <file.md></code> | The agent's read of this scan, embedded in the report as **"What the numbers mean"**: which findings matter, which good numbers are accidents, what to fix first. Labelled as written by AI and kept apart from the measured numbers. The Claude Code skill writes and passes it automatically; the flag is here so any agent can |
|
|
61
|
+
| <code>... --section "Title" <file.md></code> | A further agent-written chapter after the notes, same styling, same label, sub-headings allowed. Repeatable, so analysis that outgrows the notes still lives inside the report instead of a hand-built page |
|
|
58
62
|
| `... --mcp` | The scan as a local MCP server: 5 tools your agent calls while writing UI, from "is there a Button already?" to "review my changes", plus the `roast-fix` prompt that serves the top fix from a fresh scan. See [Live answers over MCP](#live-answers-over-mcp) |
|
|
59
|
-
|
|
|
63
|
+
| <code>/roast-my-design-system</code> (in Claude Code) | The full experience: the roast in chat *and* embedded in the report as "What the numbers mean", the rules offer, and the fix loop with Claude on your own numbers |
|
|
60
64
|
|
|
61
65
|
Not to be confused with each other: **"Why this matters"** is generic, ships with the tool and reads the same in every report. **"What the numbers mean"** is your agent's read of your repo, and only appears when an agent passed it.
|
|
62
66
|
|
|
@@ -71,11 +75,11 @@ Not to be confused with each other: **"Why this matters"** is generic, ships wit
|
|
|
71
75
|
|
|
72
76
|
The full report for vercel/ai-chatbot, top to bottom, including "What the numbers mean", Claude's read of the scan, embedded right under the verdict:
|
|
73
77
|
|
|
74
|
-
|
|
75
79
|
|
|
76
80
|
The same report in light mode (one file, built-in toggle):
|
|
77
81
|
|
|
78
|
-
|
|
79
83
|
|
|
80
84
|
## What makes the numbers trustworthy
|
|
81
85
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "roast-my-design-system",
|
|
3
|
-
"version": "5.12.
|
|
3
|
+
"version": "5.12.3",
|
|
4
4
|
"mcpName": "io.github.gregkozakiewicz/roast-my-design-system",
|
|
5
5
|
"description": "Your AI can write the UI. This makes sure it writes your UI. A deterministic scanner scores your design system 0-100 against 34 public repos, reads React and web components (Stencil, Lit), hands you a copy-paste fix prompt for each top finding, writes rules for Claude, Cursor, Copilot and Windsurf with --apply, and runs as a local MCP server with --mcp.",
|
|
6
6
|
"keywords": [
|