@worldresources/wri-design-systems 2.191.10-alpha-ds-cli.1 → 2.191.10
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/agents/AGENTS.md +14 -0
- package/agents/setup-ai.mjs +2 -2
- package/package.json +1 -1
package/agents/AGENTS.md
CHANGED
|
@@ -75,6 +75,20 @@ Use it as fallback when a component is not in the WRI DS.
|
|
|
75
75
|
3. Custom code — last resort; add justification comment
|
|
76
76
|
```
|
|
77
77
|
|
|
78
|
+
## Component APIs — Do Not Invent Props or Options
|
|
79
|
+
|
|
80
|
+
When using any WRI DS or Chakra component, you must **confirm** the component’s API (types, props, valid options, variants, sizes, etc.) from a trusted source before coding. **Never** guess or invent prop names or allowed values.
|
|
81
|
+
|
|
82
|
+
Use one (or more) of the following, in order:
|
|
83
|
+
|
|
84
|
+
1. **Library `index.d.ts`** — check the exported types first (source of truth for public APIs).
|
|
85
|
+
2. **Storybook MCP** — preferred for WRI DS components (authoritative props + usage patterns).
|
|
86
|
+
3. **Component README** — `src/components/<Category>/<ComponentName>/README.md` for WRI DS details.
|
|
87
|
+
4. **TypeScript types in this repo** — rely on exported types and TS errors as the source of truth.
|
|
88
|
+
5. **Chakra MCP** — preferred for Chakra-only components and Chakra v3 migration-safe props.
|
|
89
|
+
|
|
90
|
+
If you can’t confirm an API, stop and ask for clarification rather than guessing.
|
|
91
|
+
|
|
78
92
|
### Level 1 — WRI Design System
|
|
79
93
|
|
|
80
94
|
Check the [Storybook](https://wri.github.io/wri-design-systems/) or query the Storybook MCP first. For detailed props and usage notes, also check the component's individual README in the [GitHub repo](https://github.com/wri/wri-design-systems) at `src/components/<Category>/<ComponentName>/README.md` — for example: [`Panel/README.md`](https://github.com/wri/wri-design-systems/blob/main/src/components/Containers/Panel/README.md).
|
package/agents/setup-ai.mjs
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
//
|
|
2
|
+
// agents/setup-ai.mjs — WRI Design System AI Setup
|
|
3
3
|
// Distributes AGENTS.md to the correct location for each detected IDE.
|
|
4
|
-
// Usage:
|
|
4
|
+
// Usage: npx ds setup-ai
|
|
5
5
|
|
|
6
6
|
import {
|
|
7
7
|
existsSync,
|