roast-my-design-system 5.3.0 → 5.4.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
|
@@ -2,11 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/roast-my-design-system) [](https://www.npmjs.com/package/roast-my-design-system) [](https://socket.dev/npm/package/roast-my-design-system) [](LICENSE) [](https://www.npmjs.com/package/roast-my-design-system?activeTab=dependencies) [](https://github.com/gregkozakiewicz/roast-my-design-system#what-makes-the-numbers-trustworthy)
|
|
4
4
|
|
|
5
|
+
[](#live-answers-over-mcp) [](#live-answers-over-mcp) [](#live-answers-over-mcp)
|
|
6
|
+
|
|
5
7
|
## Your AI can write the UI. This makes sure it writes *your* UI.
|
|
6
8
|
|
|
7
9
|
A free CLI tool (and Claude Code skill) that roasts your repo's design system with real data, then generates the rules that keep your AI agent on-system.
|
|
8
10
|
|
|
9
|
-
> **New in 5.
|
|
11
|
+
> **New in 5.4: the MCP server is verified in Cursor and Windsurf (now Devin Desktop), alongside Claude Code.** Each tested end to end in the editor itself: server connected, five tools listed, real answers in the chat. Setup for each lives in [Live answers over MCP](#live-answers-over-mcp).
|
|
10
12
|
|
|
11
13
|
> **New in 5.0: it runs as a local MCP server.** One command, and your agent asks the design system before writing UI, then gets the work checked after: which Button is canonical, which token holds that colour, review my changes. Local, deterministic, nothing leaves your machine. See [Live answers over MCP](#live-answers-over-mcp).
|
|
12
14
|
|
|
@@ -109,14 +111,30 @@ Add it to Claude Code:
|
|
|
109
111
|
claude mcp add roast -- npx roast-my-design-system --mcp
|
|
110
112
|
```
|
|
111
113
|
|
|
112
|
-
|
|
114
|
+
**Verified in Claude Code, Cursor, and Windsurf (now Devin Desktop)** — each tested end to end: server connected, all five tools listed, real answers in the editor's own chat. Same promise as the scan: local, read-only, one scan at startup, no port, no account, nothing about your code leaves your machine. And a clean answer reads "no measured violations found" with the list of checks attached, because a scanner can only certify what it can count.
|
|
115
|
+
|
|
116
|
+
**Cursor** — put this in `.cursor/mcp.json` inside the project (the project, not your home directory, so the scan sees one repo, not your whole disk):
|
|
117
|
+
|
|
118
|
+
```json
|
|
119
|
+
{ "mcpServers": { "roast": { "command": "npx", "args": ["roast-my-design-system", "--mcp"] } } }
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
Cursor holds workspace servers at arm's length until you approve them: open Settings → Tools & MCP and enable `roast` the first time. The first start takes a few seconds while npx fetches the package; Cursor retries on its own.
|
|
123
|
+
|
|
124
|
+
**Windsurf (Devin Desktop)** — its MCP config is global (`~/.codeium/windsurf/mcp_config.json`), so name the project folder in the entry to keep the scan scoped to one repo:
|
|
125
|
+
|
|
126
|
+
```json
|
|
127
|
+
{ "mcpServers": { "roast": { "command": "npx", "args": ["roast-my-design-system", "--mcp", "/path/to/your/repo"] } } }
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
Any other MCP client can register the same stdio command.
|
|
113
131
|
|
|
114
132
|
## In CI
|
|
115
133
|
|
|
116
134
|
The scanner already speaks SARIF, so wiring it into GitHub code scanning is six lines. Findings appear in the Security tab, annotated on the files themselves:
|
|
117
135
|
|
|
118
136
|
```yaml
|
|
119
|
-
- uses: actions/checkout@
|
|
137
|
+
- uses: actions/checkout@v5
|
|
120
138
|
- run: npx roast-my-design-system@latest . --sarif --no-open
|
|
121
139
|
- uses: github/codeql-action/upload-sarif@v3
|
|
122
140
|
with:
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "roast-my-design-system",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.4.0",
|
|
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, writes rules for Claude, Cursor, Copilot and Windsurf with --apply, and runs as a local MCP server with --mcp.",
|
|
6
6
|
"keywords": [
|