ui-ux-master 1.1.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.
Files changed (39) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +198 -0
  3. package/SKILL.md +717 -0
  4. package/agent-templates/antigravity/AGENTS.append.md +15 -0
  5. package/agent-templates/claude/commands/ui-ux-master.md +25 -0
  6. package/agent-templates/codex/AGENTS.append.md +15 -0
  7. package/agent-templates/cursor/rules/ui-ux-master.mdc +10 -0
  8. package/agent-templates/gemini/GEMINI.append.md +9 -0
  9. package/agent-templates/universal/ui-ux-master-trigger.md +18 -0
  10. package/agent-templates/windsurf/rules/ui-ux-master.md +17 -0
  11. package/bin/ui-ux-master.mjs +192 -0
  12. package/docs/slash-command-compatibility.md +58 -0
  13. package/package.json +55 -0
  14. package/references/accessibility-advanced-patterns.md +43 -0
  15. package/references/competitive-landscape.md +47 -0
  16. package/references/content-design-and-i18n.md +53 -0
  17. package/references/data-visualization-dashboard-ux.md +46 -0
  18. package/references/design-system-playbook.md +133 -0
  19. package/references/ethical-inclusive-design.md +52 -0
  20. package/references/platform-guidelines.md +59 -0
  21. package/references/service-design-journey-mapping.md +39 -0
  22. package/references/top-100-brand-website-analysis.md +302 -0
  23. package/references/ui-ux-complete-checklist.md +214 -0
  24. package/references/ui-ux-curriculum-and-standards.md +40 -0
  25. package/references/ui-ux-frontend-implementation-rules.md +378 -0
  26. package/references/ui-ux-memory-workflow.md +175 -0
  27. package/references/usability-heuristics.md +65 -0
  28. package/references/ux-measurement-quality-gates.md +58 -0
  29. package/references/ux-research-methods.md +99 -0
  30. package/references/wcag-aa-quick-reference.md +85 -0
  31. package/scripts/build_deployment_zip.py +42 -0
  32. package/scripts/validate_skill.py +303 -0
  33. package/templates/component-spec.md +127 -0
  34. package/templates/design-system-spec.md +121 -0
  35. package/templates/top-brand-frontend-spec.md +133 -0
  36. package/templates/ui-ux-audit-report.md +146 -0
  37. package/templates/ui-ux-brief.md +86 -0
  38. package/templates/ui-ux-memory.md +204 -0
  39. package/tests/install-smoke.test.mjs +71 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Rupak Biswas
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,198 @@
1
+ # UI/UX Master
2
+
3
+ The one-stop UI/UX skill for AI coding agents.
4
+
5
+ Use it with a normal prompt plus one trigger:
6
+
7
+ ```text
8
+ /ui-ux-master audit this dashboard and give me implementation-ready fixes
9
+ ```
10
+
11
+ If `/ui-ux-master` is not present, the installed rules tell agents not to use the skill. That keeps your normal coding workflow clean and makes UI/UX mode explicit.
12
+
13
+ ## Why Use UI/UX Master?
14
+
15
+ Most AI UI prompts produce pretty screens but miss the hard parts: research assumptions, information architecture, accessibility, responsive states, design-system consistency, platform conventions, localization, ethics, and developer handoff.
16
+
17
+ UI/UX Master is built to make agents behave like a senior product designer, UX researcher, accessibility reviewer, design-system lead, and frontend handoff partner in one workflow.
18
+
19
+ ## What Makes It Different
20
+
21
+ | Common open-source prompt/skill | UI/UX Master |
22
+ |---|---|
23
+ | Focuses on visual polish only | Covers research, UX strategy, IA, flows, UI, accessibility, content, metrics, and handoff |
24
+ | Always-on rules that interfere with normal coding | Opt-in `/ui-ux-master` trigger only |
25
+ | One agent or editor only | Cross-agent templates for Claude, Codex, Windsurf, Antigravity, Gemini, Cursor, and universal agents |
26
+ | Generic design advice | Concrete templates, checklists, quality gates, and implementation rules |
27
+ | No persistent design memory | Project `.ui-ux-memory.md` workflow keeps brand/design decisions consistent |
28
+ | Weak accessibility coverage | WCAG 2.2 AA plus advanced ARIA/widget patterns and test matrix |
29
+ | No deployment validation | Release validator, npm package metadata, tests, and deployment zip builder |
30
+ | No product-risk coverage | Ethics, privacy, dark-pattern, high-risk domain, AI-interface, and inclusive-design checks |
31
+
32
+ ## Capabilities
33
+
34
+ UI/UX Master can help agents produce:
35
+
36
+ - Product UX strategy and user goals
37
+ - UX research plans, evidence confidence, and research synthesis
38
+ - Information architecture, navigation, taxonomy, and search/filter models
39
+ - User flows, task flows, journey maps, and service blueprints
40
+ - Wireframes, layout specs, visual direction, and interaction design
41
+ - Accessibility audits and WCAG 2.2 AA remediation guidance
42
+ - Advanced component accessibility patterns for dialogs, tabs, comboboxes, menus, grids, live regions, and drag/drop alternatives
43
+ - Design systems, tokens, component specs, governance, and usage rules
44
+ - Content design, UX writing, error copy, empty states, localization, RTL, and i18n checks
45
+ - Platform-specific guidance for web, iOS, Android/Material, Windows/desktop, kiosk, email, TV, and universal agents
46
+ - SaaS dashboards, data visualization, tables, alerts, ecommerce, checkout, onboarding, settings, auth, forms, and landing pages
47
+ - Ethical UX, privacy, consent, dark-pattern detection, AI transparency, and high-risk domain safeguards
48
+ - Developer handoff with states, tokens, responsive behavior, analytics events, QA, and acceptance criteria
49
+
50
+ ## Install with npm
51
+
52
+ Global install:
53
+
54
+ ```bash
55
+ npm install -g ui-ux-master
56
+ ui-ux-master install --global
57
+ ```
58
+
59
+ Project-local install, recommended:
60
+
61
+ ```bash
62
+ npm install --save-dev ui-ux-master
63
+ npx ui-ux-master install --project
64
+ ```
65
+
66
+ No-save project install (copies reusable skill files into `.ui-ux-master/` so agents can still read the source after npx exits):
67
+
68
+ ```bash
69
+ npx ui-ux-master install --project
70
+ ```
71
+
72
+ Install only selected agents:
73
+
74
+ ```bash
75
+ npx ui-ux-master install --project --agents claude,codex,windsurf,gemini,cursor
76
+ ```
77
+
78
+ Dry run:
79
+
80
+ ```bash
81
+ npx ui-ux-master install --project --dry-run
82
+ ```
83
+
84
+ ## Supported Agents
85
+
86
+ | Agent | Install target | Trigger |
87
+ |---|---|---|
88
+ | Claude Code | `.claude/commands/ui-ux-master.md` | native `/ui-ux-master` command |
89
+ | Codex | `AGENTS.md` marked section | type `/ui-ux-master` |
90
+ | Windsurf/Cascade | `.windsurf/rules/ui-ux-master.md` and `.windsurfrules` fallback | type `/ui-ux-master` |
91
+ | Antigravity | `AGENTS.md` plus `.antigravity/rules/ui-ux-master.md` fallback | type `/ui-ux-master` |
92
+ | Gemini CLI | `GEMINI.md` marked section | type `/ui-ux-master` |
93
+ | Cursor | `.cursor/rules/ui-ux-master.mdc` | type `/ui-ux-master` |
94
+ | Other agents | `agent-templates/universal/ui-ux-master-trigger.md` | copy trigger into instruction file |
95
+
96
+ See `docs/slash-command-compatibility.md` for details.
97
+
98
+ ## Usage Examples
99
+
100
+ ```text
101
+ /ui-ux-master redesign this SaaS onboarding flow for faster activation and create dev handoff specs
102
+ ```
103
+
104
+ ```text
105
+ /ui-ux-master audit the checkout flow for accessibility, trust, conversion, and mobile UX
106
+ ```
107
+
108
+ ```text
109
+ /ui-ux-master create a design system starter for this app using the existing components and tokens
110
+ ```
111
+
112
+ ```text
113
+ /ui-ux-master inspect this dashboard and improve hierarchy, data visualization, empty states, and responsive behavior
114
+ ```
115
+
116
+ ```text
117
+ /ui-ux-master turn this rough product idea into IA, user flows, wireframes, content, metrics, and implementation tasks
118
+ ```
119
+
120
+ ## CLI Commands
121
+
122
+ ```bash
123
+ ui-ux-master install --project
124
+ ui-ux-master install --global
125
+ ui-ux-master install --project --agents claude,codex,windsurf,antigravity,gemini,cursor
126
+ ui-ux-master install --project --dry-run
127
+ ui-ux-master doctor
128
+ ui-ux-master where
129
+ ui-ux-master uninstall --project
130
+ ```
131
+
132
+ ## Package Structure
133
+
134
+ - `SKILL.md` — main orchestration skill.
135
+ - `references/` — advanced playbooks and standards-aligned checklists.
136
+ - `templates/` — briefs, audits, component specs, design-system specs, and project UI/UX memory template.
137
+ - `agent-templates/` — Claude, Codex, Windsurf, Antigravity, Gemini, Cursor, and universal `/ui-ux-master` activation rules.
138
+ - `docs/` — cross-agent slash-command compatibility docs.
139
+ - `bin/ui-ux-master.mjs` — npm CLI installer.
140
+ - `scripts/validate_skill.py` — dependency-free release validator.
141
+ - `scripts/build_deployment_zip.py` — clean deployment zip builder.
142
+ - `tests/` — npm installer and package smoke tests.
143
+
144
+ ## Validation and Testing
145
+
146
+ Run from this folder:
147
+
148
+ ```bash
149
+ python scripts/validate_skill.py --release
150
+ npm test
151
+ npm pack --dry-run
152
+ ```
153
+
154
+ Build a clean deployment zip:
155
+
156
+ ```bash
157
+ python scripts/build_deployment_zip.py
158
+ ```
159
+
160
+ Expected validation result:
161
+
162
+ ```text
163
+ PASS: UI/UX skill package is valid
164
+ Release mode: PASS
165
+ ```
166
+
167
+ ## Competitive Positioning
168
+
169
+ UI/UX Master is designed to outperform narrow UI prompt packs and simple design rules by combining:
170
+
171
+ 1. Opt-in activation: no pollution of normal coding prompts.
172
+ 2. Cross-agent portability: one package for Claude, Codex, Windsurf, Antigravity, Gemini, Cursor, and generic agents.
173
+ 3. Full lifecycle coverage: discovery to deployment handoff.
174
+ 4. Standards alignment: WCAG, WAI-ARIA patterns, GOV.UK, NN/g, Material, Apple HIG, Microsoft, Baymard-style ecommerce practice, ISO human-centered design concepts.
175
+ 5. Project memory: durable brand/design consistency via `.ui-ux-memory.md`.
176
+ 6. Release engineering: npm packaging, CLI installer, validation, tests, and deployment zip.
177
+ 7. Advanced risk coverage: ethics, privacy, dark patterns, localization, platform conventions, high-risk domains, and AI UX transparency.
178
+
179
+ ## Deployment Readiness Checklist
180
+
181
+ - [ ] `python scripts/validate_skill.py --release` passes.
182
+ - [ ] `npm test` passes.
183
+ - [ ] `npm pack --dry-run` contains only intended files.
184
+ - [ ] `ui-ux-master install --project --dry-run` works.
185
+ - [ ] Agent templates contain `/ui-ux-master` and do not include local absolute paths.
186
+ - [ ] No `node_modules`, `__pycache__`, `.pyc`, graphify cache, coverage, logs, secrets, or local credentials are included.
187
+
188
+ ## Known Limitations
189
+
190
+ - It guides research planning but does not replace real users.
191
+ - It helps accessibility review but does not replace expert assistive-technology testing for high-risk products.
192
+ - It flags legal/privacy/health/finance risks but does not replace legal or domain-expert review.
193
+ - Brand and competitor sites change; verify live claims before citing them as facts.
194
+ - Agents without native slash commands use `/ui-ux-master` as a text trigger through installed instruction files.
195
+
196
+ ## License
197
+
198
+ MIT.