ui-ux-master 1.2.0 → 1.5.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 +170 -182
- package/SKILL.md +89 -47
- package/docs/package-publishing.md +84 -0
- package/index.cjs +39 -0
- package/index.d.ts +17 -0
- package/index.mjs +30 -0
- package/package.json +86 -11
- package/references/brand-method-card-based-discovery.md +285 -0
- package/references/brand-method-conversion-simplicity.md +276 -0
- package/references/brand-method-ecosystem-bundling.md +263 -0
- package/references/brand-method-editorial-brand-world.md +265 -0
- package/references/brand-method-enterprise-trust-hub.md +298 -0
- package/references/brand-method-playful-familiarity.md +284 -0
- package/references/brand-method-premium-restraint.md +270 -0
- package/references/brand-method-product-cinema.md +258 -0
- package/references/brand-method-technical-authority.md +290 -0
- package/references/brand-method-utility-command-center.md +278 -0
- package/references/color-psychology-branding.md +286 -0
- package/references/color-scale-system.md +347 -0
- package/references/competitive-landscape.md +32 -6
- package/references/design-discovery-protocol.md +171 -0
- package/references/design-system-schema.md +407 -0
- package/references/industry-reasoning-rules.md +504 -0
- package/references/landing-page-patterns.md +327 -0
- package/references/output-quality-gates.md +246 -0
- package/references/tech-stack-guidelines.md +636 -0
- package/references/ui-styles-catalog.md +552 -0
- package/references/visual-directions.md +362 -0
- package/tests/install-smoke.test.mjs +93 -12
package/SKILL.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: ui-ux-master
|
|
3
3
|
description: "Use when an agent must design, audit, improve, prototype, specify, or hand off any UI/UX work end-to-end. Provides one-stop UX strategy, research, IA, flows, wireframes, visual design, design systems, accessibility, usability testing, conversion, and engineering handoff workflows."
|
|
4
|
-
version: 1.
|
|
4
|
+
version: 1.5.0
|
|
5
5
|
author: Rupak Biswas
|
|
6
6
|
license: MIT
|
|
7
7
|
platforms: [linux, macos, windows]
|
|
@@ -23,32 +23,38 @@ The job is not only to make screens look good. The job is to solve the user's go
|
|
|
23
23
|
|
|
24
24
|
This skill is opt-in. In Codex, Claude, Windsurf, Antigravity, Gemini, Cursor, and other agents, activate it only when the user includes `/ui-ux-master` in the prompt or invokes the installed native slash command. If the user does not mention `/ui-ux-master`, do not apply this skill automatically.
|
|
25
25
|
|
|
26
|
-
When activated, the user can write naturally, for example: `/ui-ux-master audit this checkout flow` or `/ui-ux-master design a premium SaaS landing page`. Treat the rest of the prompt as the task and follow this SKILL.md plus the referenced files.
|
|
27
|
-
|
|
28
|
-
## AI Discovery and MCP
|
|
29
|
-
|
|
30
|
-
This package exposes the workflow through human-readable instructions and machine-readable discovery assets:
|
|
31
|
-
|
|
32
|
-
- `llms.txt` gives AI agents a short map of the package.
|
|
33
|
-
- `ai-discovery/ui-ux-master.manifest.json` describes activation, entrypoints, tools, resources, prompts, and supported agents.
|
|
34
|
-
- `system-prompts/` contains full, compact, and MCP-focused system prompt add-ons.
|
|
35
|
-
- `bin/ui-ux-master-mcp.mjs` runs a local read-only MCP server that exposes UI/UX Master tools, resources, and prompts.
|
|
36
|
-
|
|
26
|
+
When activated, the user can write naturally, for example: `/ui-ux-master audit this checkout flow` or `/ui-ux-master design a premium SaaS landing page`. Treat the rest of the prompt as the task and follow this SKILL.md plus the referenced files.
|
|
27
|
+
|
|
28
|
+
## AI Discovery and MCP
|
|
29
|
+
|
|
30
|
+
This package exposes the workflow through human-readable instructions and machine-readable discovery assets:
|
|
31
|
+
|
|
32
|
+
- `llms.txt` gives AI agents a short map of the package.
|
|
33
|
+
- `ai-discovery/ui-ux-master.manifest.json` describes activation, entrypoints, tools, resources, prompts, and supported agents.
|
|
34
|
+
- `system-prompts/` contains full, compact, and MCP-focused system prompt add-ons.
|
|
35
|
+
- `bin/ui-ux-master-mcp.mjs` runs a local read-only MCP server that exposes UI/UX Master tools, resources, and prompts.
|
|
36
|
+
|
|
37
37
|
Use MCP and system prompt add-ons only as discovery/activation layers. The workflow remains opt-in and should still require `/ui-ux-master` unless the user explicitly asks to use UI/UX Master.
|
|
38
38
|
|
|
39
39
|
## Core Operating Rule
|
|
40
40
|
|
|
41
41
|
Do not jump directly to visuals. Work in this order unless the user explicitly asks for a narrow task:
|
|
42
42
|
|
|
43
|
-
1.
|
|
44
|
-
2.
|
|
45
|
-
3.
|
|
46
|
-
4.
|
|
47
|
-
5.
|
|
48
|
-
6.
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
43
|
+
1. **Discovery first.** Load `references/design-discovery-protocol.md`. For any new design task, run the 6-question discovery form before producing any visual output. Lock down: surface, audience, tone, brand context, fidelity, and constraints.
|
|
44
|
+
2. **Brand extraction or visual direction.** If the user provides brand assets (URL, screenshot, hex codes), run the 5-step brand extraction protocol from `references/design-discovery-protocol.md` and write a brand-spec summary. If there is no brand, load `references/visual-directions.md`, present the 5 directions, and bind the selected direction's token block as the baseline. Never invent or guess brand colors from a company name alone.
|
|
45
|
+
3. **Check project memory.** Look for `.ui-ux-memory.md` at the project root. If it exists, read all 9 sections (schema defined in `references/design-system-schema.md`) before designing. If it does not exist, create it using the schema after discovery completes.
|
|
46
|
+
4. Understand the product, users, goal, platform, constraints, evidence available, research confidence, and success metric.
|
|
47
|
+
5. Define the UX model: audience, jobs-to-be-done, journeys, service touchpoints, information architecture, flows, states, and content.
|
|
48
|
+
6. **Industry reasoning.** Load `references/industry-reasoning-rules.md`. Match the user's product to an industry category and output the full Design System Block (pattern + style + colors + typography + effects + anti-patterns) in one step before designing.
|
|
49
|
+
6a. Select an appropriate top-brand design method when frontend polish is requested. Load the corresponding brand-method skill file from references/: `references/brand-method-product-cinema.md`, `references/brand-method-utility-command-center.md`, `references/brand-method-editorial-brand-world.md`, `references/brand-method-enterprise-trust-hub.md`, `references/brand-method-card-based-discovery.md`, `references/brand-method-conversion-simplicity.md`, `references/brand-method-ecosystem-bundling.md`, `references/brand-method-premium-restraint.md`, `references/brand-method-playful-familiarity.md`, or `references/brand-method-technical-authority.md`.
|
|
50
|
+
6b. Apply color psychology: load `references/color-psychology-branding.md`, identify the industry and sentiment, prescribe a complete palette with contrast ratios and rationale before any visual design begins. Use `references/color-scale-system.md` to generate full 11-step (50–950) OKLch color scales for the brand primary, neutral, and all semantic colors.
|
|
51
|
+
6c. Select a UI style from `references/ui-styles-catalog.md`. Apply the style's token overrides on top of the visual direction baseline.
|
|
52
|
+
7. **Junior designer warm-up.** For high-fidelity requests, show a wireframe sketch (grey blocks, real layout) first. Confirm direction before applying brand and polish. Skip if the user explicitly requests final output or provides a detailed reference.
|
|
53
|
+
8. Design the interface by extending the established brand/direction baseline. Apply only tokens from the schema — no ad-hoc magic values. Apply stack-specific rules from `references/tech-stack-guidelines.md` for the user's chosen framework. For landing pages and marketing pages, follow the appropriate conversion pattern from `references/landing-page-patterns.md`. For dashboards, use the chart type guide in that same file.
|
|
54
|
+
9. **Quality gates before any emit.** Load `references/output-quality-gates.md`. Run the 5-dimensional self-critique (philosophy/hierarchy/execution/specificity/restraint), pass all P0 hard gates, and clear the anti-slop blacklist. Fix and rescore until all dimensions ≥ 3. Do not emit output until all gates pass.
|
|
55
|
+
10. Validate: consistency with memory, research evidence, heuristics, WCAG, platform conventions, usability risks, i18n, ethics/privacy, edge cases, technical feasibility, metrics, and brand-fit.
|
|
56
|
+
11. Update `.ui-ux-memory.md` with any new durable design decisions before handoff.
|
|
57
|
+
12. Hand off: exact specs, tokens, component behavior, copy, states, QA checklist, implementation notes.
|
|
52
58
|
|
|
53
59
|
## When to Use
|
|
54
60
|
|
|
@@ -456,36 +462,52 @@ Must include:
|
|
|
456
462
|
|
|
457
463
|
### Top-Brand Frontend Method
|
|
458
464
|
|
|
459
|
-
When the user asks for a frontend that looks polished, premium, world-class, or similar to top brands, use `references/top-100-brand-website-analysis.md` before designing.
|
|
465
|
+
When the user asks for a frontend that looks polished, premium, world-class, or similar to top brands, use `references/top-100-brand-website-analysis.md` before designing. Then load the dedicated skill file for the selected method.
|
|
460
466
|
|
|
461
467
|
Process:
|
|
462
468
|
|
|
463
469
|
1. Identify the product category and user task.
|
|
464
|
-
2. Pick one primary method and one or two supporting methods:
|
|
465
|
-
- Product Cinema
|
|
466
|
-
- Utility Command Center
|
|
467
|
-
- Editorial Brand World
|
|
468
|
-
- Enterprise Trust Hub
|
|
469
|
-
- Card-Based Discovery
|
|
470
|
-
- Conversion Simplicity
|
|
471
|
-
- Ecosystem Bundling
|
|
472
|
-
- Premium Restraint
|
|
473
|
-
- Playful Familiarity
|
|
474
|
-
- Technical Authority
|
|
475
|
-
3.
|
|
476
|
-
4.
|
|
477
|
-
5.
|
|
470
|
+
2. Pick one primary method and one or two supporting methods. Load the corresponding brand-method skill file for full layout, color, typography, spacing, motion, accessibility, and component specs:
|
|
471
|
+
- **Product Cinema** → `references/brand-method-product-cinema.md` — premium products, hardware, automotive, luxury.
|
|
472
|
+
- **Utility Command Center** → `references/brand-method-utility-command-center.md` — ecommerce, logistics, booking, dashboards.
|
|
473
|
+
- **Editorial Brand World** → `references/brand-method-editorial-brand-world.md` — fashion, sports, beverage, entertainment.
|
|
474
|
+
- **Enterprise Trust Hub** → `references/brand-method-enterprise-trust-hub.md` — B2B SaaS, finance, healthcare, industrial.
|
|
475
|
+
- **Card-Based Discovery** → `references/brand-method-card-based-discovery.md` — marketplaces, media, travel, catalogs.
|
|
476
|
+
- **Conversion Simplicity** → `references/brand-method-conversion-simplicity.md` — signup, trial, subscription, fintech flows.
|
|
477
|
+
- **Ecosystem Bundling** → `references/brand-method-ecosystem-bundling.md` — multi-product suites, plan comparison.
|
|
478
|
+
- **Premium Restraint** → `references/brand-method-premium-restraint.md` — ultra-luxury, high-end finance, premium services.
|
|
479
|
+
- **Playful Familiarity** → `references/brand-method-playful-familiarity.md` — food, toys, family, consumer brands.
|
|
480
|
+
- **Technical Authority** → `references/brand-method-technical-authority.md` — AI, developer tools, semiconductors, infra.
|
|
481
|
+
3. Apply color psychology: load `references/color-psychology-branding.md` to validate and prescribe the palette for the business type and emotional goal. Output the full palette before any visual design.
|
|
482
|
+
4. Translate the selected methods into original tokens, layout rules, components, states, and copy.
|
|
483
|
+
5. Never copy a brand exactly unless the user owns that brand. Avoid logos, proprietary images, exact trademark color combinations, and pixel-for-pixel layouts.
|
|
484
|
+
6. Preserve accessibility and usability even when using cinematic, luxury, or experimental layouts.
|
|
478
485
|
|
|
479
486
|
Deliverable additions:
|
|
480
487
|
|
|
488
|
+
- Brand method selected (with rationale).
|
|
489
|
+
- Color psychology palette (business type, emotional goal, full hex palette, contrast ratios).
|
|
481
490
|
- Brand-inspiration blend.
|
|
482
|
-
- Selected method rationale.
|
|
483
491
|
- Layout archetype.
|
|
484
492
|
- Token direction.
|
|
485
493
|
- Component behavior.
|
|
486
494
|
- Accessibility safeguards.
|
|
487
495
|
- Anti-copy/IP safety note.
|
|
488
496
|
|
|
497
|
+
### Color Psychology and Branding
|
|
498
|
+
|
|
499
|
+
When a user describes a product, business type, UI feel, or audience, load `references/color-psychology-branding.md` before prescribing any colors.
|
|
500
|
+
|
|
501
|
+
Process:
|
|
502
|
+
|
|
503
|
+
1. Identify: business category, emotional goal (trust/energy/calm/luxury/health/play/authority/innovation), positioning (mass/premium/luxury).
|
|
504
|
+
2. Look up the industry prescription and sentiment mapping in the reference file.
|
|
505
|
+
3. Output the complete palette: primary, secondary, accent/CTA, background, surface, text primary, text secondary, border, semantic success/warning/error/info, and dark mode variant if needed.
|
|
506
|
+
4. State the psychological rationale for each choice.
|
|
507
|
+
5. Warn of anti-patterns for this category.
|
|
508
|
+
6. Verify all text-on-background combinations against WCAG 2.2 AA (4.5:1 body, 3:1 large text/UI).
|
|
509
|
+
7. Include this palette in the `.ui-ux-memory.md` and all handoff specs.
|
|
510
|
+
|
|
489
511
|
### Frontend Implementation UX
|
|
490
512
|
|
|
491
513
|
When implementing UI, first load and follow `references/ui-ux-frontend-implementation-rules.md`. Treat it as the non-negotiable frontend implementation checklist.
|
|
@@ -704,7 +726,27 @@ Use the supporting files in this skill folder when useful:
|
|
|
704
726
|
- `references/ui-ux-frontend-implementation-rules.md` — mandatory frontend implementation rules so agents do not miss stack inspection, states, accessibility, responsiveness, tokens, QA, or handoff.
|
|
705
727
|
- `references/wcag-aa-quick-reference.md` — practical WCAG 2.2 AA reference for agents.
|
|
706
728
|
- `references/design-system-playbook.md` — how to create or extend a design system.
|
|
729
|
+
- `references/ui-styles-catalog.md` — 20+ named UI styles (Glassmorphism, Liquid Glass, Data Brutalism, Aurora Borealis, AI-Native UI, Spatial UI, Cyberpunk, Claymorphism, Bento Grid, Soft UI Evolution, and more) with token overrides, required effects, forbidden patterns, and a style selection decision tree.
|
|
730
|
+
- `references/color-scale-system.md` — 11-step (50–950) OKLch architectural color scales for all brand hue families and semantic states. Semantic role-to-step mapping and dark mode overrides. Full px+rem typography scale.
|
|
731
|
+
- `references/industry-reasoning-rules.md` — one-step reasoning engine: input a product description, output a complete Design System Block (pattern, style, colors, typography, effects, anti-patterns, pre-delivery checklist) for 15+ industry categories.
|
|
732
|
+
- `references/tech-stack-guidelines.md` — stack-specific component patterns, rules, and common AI mistakes for 16 frameworks: React, Next.js, Vue, Nuxt, Angular, Svelte, Astro, Remix, SolidJS, React Native, Flutter, SwiftUI, shadcn/ui, Jetpack Compose, Laravel, HTML+Tailwind.
|
|
733
|
+
- `references/landing-page-patterns.md` — 12 named conversion patterns (Hero-Centric, Problem-Solution, Product Demo First, Comparison, etc.) with section-by-section structure. Plus 25-type chart selection guide with dashboard layout rules and data visualization anti-patterns.
|
|
734
|
+
- `references/design-discovery-protocol.md` — 6-question discovery form, brand extraction 5-step protocol, junior designer warm-up, and discovery checklist. Load at the start of every new design task.
|
|
735
|
+
- `references/output-quality-gates.md` — 5-dimensional self-critique (philosophy/hierarchy/execution/specificity/restraint), P0/P1/P2 hard gates, anti-AI-slop blacklist, and honest placeholder protocol. Run before every design emit.
|
|
736
|
+
- `references/visual-directions.md` — 5 fully-specified OKLch token directions (Neutral Modern, Dark Technical, Warm Editorial, Bold Energetic, Calm Trust) for projects with no brand. Each direction includes complete CSS token block ready to bind.
|
|
737
|
+
- `references/design-system-schema.md` — portable 9-section design system schema (color, typography, spacing, layout, components, motion, voice, brand, anti-patterns). Use as the template for all `.ui-ux-memory.md` files.
|
|
707
738
|
- `references/top-100-brand-website-analysis.md` — top global brand website patterns and reusable frontend methods.
|
|
739
|
+
- `references/brand-method-product-cinema.md` — full layout, color, typography, spacing, motion, accessibility, and component spec for the Product Cinema design method.
|
|
740
|
+
- `references/brand-method-utility-command-center.md` — full spec for the Utility Command Center design method.
|
|
741
|
+
- `references/brand-method-editorial-brand-world.md` — full spec for the Editorial Brand World design method.
|
|
742
|
+
- `references/brand-method-enterprise-trust-hub.md` — full spec for the Enterprise Trust Hub design method.
|
|
743
|
+
- `references/brand-method-card-based-discovery.md` — full spec for the Card-Based Discovery design method.
|
|
744
|
+
- `references/brand-method-conversion-simplicity.md` — full spec for the Conversion Simplicity design method.
|
|
745
|
+
- `references/brand-method-ecosystem-bundling.md` — full spec for the Ecosystem Bundling design method.
|
|
746
|
+
- `references/brand-method-premium-restraint.md` — full spec for the Premium Restraint design method.
|
|
747
|
+
- `references/brand-method-playful-familiarity.md` — full spec for the Playful Familiarity design method.
|
|
748
|
+
- `references/brand-method-technical-authority.md` — full spec for the Technical Authority design method.
|
|
749
|
+
- `references/color-psychology-branding.md` — color psychology, industry palette prescriptions, sentiment-to-palette mapping, contrast verification, and dark mode adaptation rules.
|
|
708
750
|
- `references/ux-research-methods.md` — research planning, method selection, evidence confidence, and ethical research rules.
|
|
709
751
|
- `references/usability-heuristics.md` — heuristic review, cognitive rules, and severity scoring.
|
|
710
752
|
- `references/platform-guidelines.md` — web, iOS, Android/Material, Windows, desktop, kiosk, email, TV, and cross-platform rules.
|
|
@@ -716,16 +758,16 @@ Use the supporting files in this skill folder when useful:
|
|
|
716
758
|
- `references/accessibility-advanced-patterns.md` — complex widget accessibility and screen-reader test matrix.
|
|
717
759
|
- `references/ui-ux-curriculum-and-standards.md` — basic-to-advanced UI/UX curriculum and standards map.
|
|
718
760
|
- `references/competitive-landscape.md` — competitor gaps and strategy for staying ahead.
|
|
719
|
-
- `docs/slash-command-compatibility.md` — cross-agent `/ui-ux-master` trigger compatibility.
|
|
720
|
-
- `docs/mcp-server.md` — MCP tools, resources, prompts, client configs, and smoke testing.
|
|
721
|
-
- `llms.txt` — AI-readable package map for discovery by agents and indexing tools.
|
|
722
|
-
- `ai-discovery/ui-ux-master.manifest.json` — machine-readable manifest for activation, entrypoints, MCP, and capabilities.
|
|
723
|
-
- `system-prompts/ui-ux-master-system-add-on.md` — full system prompt add-on.
|
|
724
|
-
- `system-prompts/ui-ux-master-compact.md` — compact system prompt add-on.
|
|
725
|
-
- `system-prompts/ui-ux-master-mcp-add-on.md` — MCP-focused system prompt add-on.
|
|
726
|
-
- `agent-templates/` — Claude, Codex, Windsurf, Antigravity, Gemini, Cursor, and universal installer templates.
|
|
727
|
-
- `bin/ui-ux-master.mjs` — npm CLI installer.
|
|
728
|
-
- `bin/ui-ux-master-mcp.mjs` — local read-only MCP server.
|
|
761
|
+
- `docs/slash-command-compatibility.md` — cross-agent `/ui-ux-master` trigger compatibility.
|
|
762
|
+
- `docs/mcp-server.md` — MCP tools, resources, prompts, client configs, and smoke testing.
|
|
763
|
+
- `llms.txt` — AI-readable package map for discovery by agents and indexing tools.
|
|
764
|
+
- `ai-discovery/ui-ux-master.manifest.json` — machine-readable manifest for activation, entrypoints, MCP, and capabilities.
|
|
765
|
+
- `system-prompts/ui-ux-master-system-add-on.md` — full system prompt add-on.
|
|
766
|
+
- `system-prompts/ui-ux-master-compact.md` — compact system prompt add-on.
|
|
767
|
+
- `system-prompts/ui-ux-master-mcp-add-on.md` — MCP-focused system prompt add-on.
|
|
768
|
+
- `agent-templates/` — Claude, Codex, Windsurf, Antigravity, Gemini, Cursor, and universal installer templates.
|
|
769
|
+
- `bin/ui-ux-master.mjs` — npm CLI installer.
|
|
770
|
+
- `bin/ui-ux-master-mcp.mjs` — local read-only MCP server.
|
|
729
771
|
- `templates/ui-ux-brief.md` — intake and requirements template.
|
|
730
772
|
- `templates/ui-ux-memory.md` — project UI/UX memory file template to copy into an application root as `.ui-ux-memory.md`.
|
|
731
773
|
- `templates/ui-ux-audit-report.md` — audit output template.
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# Package Publishing
|
|
2
|
+
|
|
3
|
+
UI/UX Master uses npmjs as the primary public registry and GitHub as the source of truth for code, issues, releases, and automation.
|
|
4
|
+
|
|
5
|
+
## Registry Strategy
|
|
6
|
+
|
|
7
|
+
| Registry | Package name | Role |
|
|
8
|
+
|---|---|---|
|
|
9
|
+
| npmjs | `ui-ux-master` | Primary public package for `npm install`, `npx`, and discoverability |
|
|
10
|
+
| GitHub Packages | `@seance1723/ui-ux-master` | Optional scoped mirror to populate the GitHub repository Packages section |
|
|
11
|
+
|
|
12
|
+
Keep the npmjs package as `ui-ux-master`. If you also publish to GitHub Packages, publish a scoped mirror from CI so the source package name does not need to change.
|
|
13
|
+
|
|
14
|
+
## npmjs vs GitHub Packages
|
|
15
|
+
|
|
16
|
+
npmjs is the default npm registry. It is where most developers expect public JavaScript packages to live, and it is the best place for public discoverability, downloads, search, and normal `npx` usage.
|
|
17
|
+
|
|
18
|
+
GitHub Packages is GitHub's package registry. It is useful for packages tied tightly to a repository or organization, private packages, and showing a package in the repository Packages section. For npm packages, GitHub Packages expects scoped package names such as `@seance1723/ui-ux-master`.
|
|
19
|
+
|
|
20
|
+
The GitHub "No packages published" message does not mean the npmjs package is broken. It only means nothing has been published to GitHub Packages for that repository.
|
|
21
|
+
|
|
22
|
+
## GitHub Packages Setup
|
|
23
|
+
|
|
24
|
+
The root `.npmrc` intentionally configures only the `@seance1723` scope. It does not change the default registry, so normal `npm install ui-ux-master` and `npm publish` for the unscoped npmjs package still use npmjs.
|
|
25
|
+
|
|
26
|
+
Scoped GitHub Packages configuration:
|
|
27
|
+
|
|
28
|
+
```ini
|
|
29
|
+
@seance1723:registry=https://npm.pkg.github.com
|
|
30
|
+
//npm.pkg.github.com/:_authToken=${NODE_AUTH_TOKEN}
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Local install from GitHub Packages:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
npm install @seance1723/ui-ux-master --registry=https://npm.pkg.github.com
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Many GitHub Packages installs require authentication. Use a token with `read:packages` for installs and `write:packages` for publishing.
|
|
40
|
+
|
|
41
|
+
## Secrets
|
|
42
|
+
|
|
43
|
+
Add these repository secrets:
|
|
44
|
+
|
|
45
|
+
- `NPM_TOKEN` - npm automation token with publish access to `ui-ux-master`.
|
|
46
|
+
|
|
47
|
+
GitHub Packages publishing uses the built-in `GITHUB_TOKEN` in Actions. The workflow temporarily changes the package name to `@seance1723/ui-ux-master` only for that publish job, then publishes to `https://npm.pkg.github.com/`. Do not permanently rename the root package unless you intentionally want to migrate away from the public unscoped npmjs package.
|
|
48
|
+
|
|
49
|
+
## Release Strategy
|
|
50
|
+
|
|
51
|
+
Use semantic versioning:
|
|
52
|
+
|
|
53
|
+
- Patch: documentation fixes, metadata improvements, bug fixes that preserve behavior.
|
|
54
|
+
- Minor: new agent templates, new MCP resources, new commands, backward-compatible workflow improvements.
|
|
55
|
+
- Major: breaking CLI behavior, changed trigger contract, removed assets, changed package entrypoint semantics.
|
|
56
|
+
|
|
57
|
+
Recommended flow:
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
npm run release:check
|
|
61
|
+
npm version patch
|
|
62
|
+
git push origin main --follow-tags
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Create a GitHub release for the new tag, for example `v1.2.1`. The publish workflow will validate and publish.
|
|
66
|
+
|
|
67
|
+
## npm Optimization Checklist
|
|
68
|
+
|
|
69
|
+
- Keep `repository`, `homepage`, `bugs`, `license`, `author`, `funding`, and keywords current.
|
|
70
|
+
- Keep `files` tight so generated assets and local graph/cache files stay out of the package.
|
|
71
|
+
- Run `npm pack --dry-run` before publishing.
|
|
72
|
+
- Prefer provenance publishing through GitHub Actions.
|
|
73
|
+
- Keep README install examples short and copyable.
|
|
74
|
+
- Keep `exports` stable once published.
|
|
75
|
+
- Avoid runtime dependencies unless they clearly improve the CLI or MCP server.
|
|
76
|
+
|
|
77
|
+
## GitHub Presentation Checklist
|
|
78
|
+
|
|
79
|
+
- Add a concise About description and npm link.
|
|
80
|
+
- Add SEO topics listed in README.
|
|
81
|
+
- Use releases with human-written notes.
|
|
82
|
+
- Keep Issues enabled and use issue templates.
|
|
83
|
+
- Pin the repository on the maintainer profile.
|
|
84
|
+
- Add screenshots or a short terminal GIF later if the CLI becomes more visual.
|
package/index.cjs
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
const path = require('node:path');
|
|
4
|
+
|
|
5
|
+
const packageRoot = __dirname;
|
|
6
|
+
|
|
7
|
+
const _pkg = require('./package.json');
|
|
8
|
+
|
|
9
|
+
const name = 'ui-ux-master';
|
|
10
|
+
const version = _pkg.version;
|
|
11
|
+
const trigger = '/ui-ux-master';
|
|
12
|
+
|
|
13
|
+
const bins = Object.freeze({
|
|
14
|
+
cli: path.join(packageRoot, 'bin', 'ui-ux-master.mjs'),
|
|
15
|
+
mcp: path.join(packageRoot, 'bin', 'ui-ux-master-mcp.mjs'),
|
|
16
|
+
});
|
|
17
|
+
|
|
18
|
+
const assets = Object.freeze({
|
|
19
|
+
skill: path.join(packageRoot, 'SKILL.md'),
|
|
20
|
+
readme: path.join(packageRoot, 'README.md'),
|
|
21
|
+
llms: path.join(packageRoot, 'llms.txt'),
|
|
22
|
+
manifest: path.join(packageRoot, 'ai-discovery', 'ui-ux-master.manifest.json'),
|
|
23
|
+
});
|
|
24
|
+
|
|
25
|
+
function assetPath(name) {
|
|
26
|
+
if (!Object.hasOwn(assets, name)) {
|
|
27
|
+
throw new Error(`Unknown ui-ux-master asset: ${name}`);
|
|
28
|
+
}
|
|
29
|
+
return assets[name];
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
module.exports = {
|
|
33
|
+
assetPath,
|
|
34
|
+
assets,
|
|
35
|
+
bins,
|
|
36
|
+
name,
|
|
37
|
+
trigger,
|
|
38
|
+
version,
|
|
39
|
+
};
|
package/index.d.ts
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
export declare const name = "ui-ux-master";
|
|
2
|
+
export declare const version: string;
|
|
3
|
+
export declare const trigger = "/ui-ux-master";
|
|
4
|
+
|
|
5
|
+
export declare const bins: Readonly<{
|
|
6
|
+
cli: string;
|
|
7
|
+
mcp: string;
|
|
8
|
+
}>;
|
|
9
|
+
|
|
10
|
+
export declare const assets: Readonly<{
|
|
11
|
+
skill: string;
|
|
12
|
+
readme: string;
|
|
13
|
+
llms: string;
|
|
14
|
+
manifest: string;
|
|
15
|
+
}>;
|
|
16
|
+
|
|
17
|
+
export declare function assetPath(name: keyof typeof assets): string;
|
package/index.mjs
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import path from 'node:path';
|
|
2
|
+
import { fileURLToPath } from 'node:url';
|
|
3
|
+
import { createRequire } from 'node:module';
|
|
4
|
+
|
|
5
|
+
const packageRoot = path.dirname(fileURLToPath(import.meta.url));
|
|
6
|
+
const _require = createRequire(import.meta.url);
|
|
7
|
+
const _pkg = _require('./package.json');
|
|
8
|
+
|
|
9
|
+
export const name = 'ui-ux-master';
|
|
10
|
+
export const version = _pkg.version;
|
|
11
|
+
export const trigger = '/ui-ux-master';
|
|
12
|
+
|
|
13
|
+
export const bins = Object.freeze({
|
|
14
|
+
cli: path.join(packageRoot, 'bin', 'ui-ux-master.mjs'),
|
|
15
|
+
mcp: path.join(packageRoot, 'bin', 'ui-ux-master-mcp.mjs'),
|
|
16
|
+
});
|
|
17
|
+
|
|
18
|
+
export const assets = Object.freeze({
|
|
19
|
+
skill: path.join(packageRoot, 'SKILL.md'),
|
|
20
|
+
readme: path.join(packageRoot, 'README.md'),
|
|
21
|
+
llms: path.join(packageRoot, 'llms.txt'),
|
|
22
|
+
manifest: path.join(packageRoot, 'ai-discovery', 'ui-ux-master.manifest.json'),
|
|
23
|
+
});
|
|
24
|
+
|
|
25
|
+
export function assetPath(name) {
|
|
26
|
+
if (!Object.hasOwn(assets, name)) {
|
|
27
|
+
throw new Error(`Unknown ui-ux-master asset: ${name}`);
|
|
28
|
+
}
|
|
29
|
+
return assets[name];
|
|
30
|
+
}
|
package/package.json
CHANGED
|
@@ -1,17 +1,38 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ui-ux-master",
|
|
3
|
-
"version": "1.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "1.5.0",
|
|
4
|
+
"description": "Opt-in UI/UX master skill, CLI, and MCP server for AI coding agents, with accessibility, design-system, UX research, and frontend handoff workflows.",
|
|
5
5
|
"type": "module",
|
|
6
|
+
"packageManager": "npm@10.9.2",
|
|
7
|
+
"main": "./index.cjs",
|
|
8
|
+
"module": "./index.mjs",
|
|
9
|
+
"types": "./index.d.ts",
|
|
10
|
+
"exports": {
|
|
11
|
+
".": {
|
|
12
|
+
"types": "./index.d.ts",
|
|
13
|
+
"import": "./index.mjs",
|
|
14
|
+
"require": "./index.cjs"
|
|
15
|
+
},
|
|
16
|
+
"./package.json": "./package.json",
|
|
17
|
+
"./skill": "./SKILL.md",
|
|
18
|
+
"./llms": "./llms.txt",
|
|
19
|
+
"./manifest": "./ai-discovery/ui-ux-master.manifest.json",
|
|
20
|
+
"./cli": "./bin/ui-ux-master.mjs",
|
|
21
|
+
"./mcp": "./bin/ui-ux-master-mcp.mjs"
|
|
22
|
+
},
|
|
6
23
|
"bin": {
|
|
7
24
|
"ui-ux-master": "./bin/ui-ux-master.mjs",
|
|
8
25
|
"ui-ux-master-mcp": "./bin/ui-ux-master-mcp.mjs"
|
|
9
26
|
},
|
|
27
|
+
"sideEffects": false,
|
|
10
28
|
"files": [
|
|
11
29
|
"SKILL.md",
|
|
12
30
|
"README.md",
|
|
13
31
|
"LICENSE",
|
|
14
32
|
"package.json",
|
|
33
|
+
"index.cjs",
|
|
34
|
+
"index.d.ts",
|
|
35
|
+
"index.mjs",
|
|
15
36
|
"references/",
|
|
16
37
|
"templates/",
|
|
17
38
|
"agent-templates/",
|
|
@@ -25,38 +46,92 @@
|
|
|
25
46
|
],
|
|
26
47
|
"scripts": {
|
|
27
48
|
"validate": "python scripts/validate_skill.py --release",
|
|
28
|
-
"
|
|
49
|
+
"validate:release": "python scripts/validate_skill.py --release",
|
|
50
|
+
"build": "npm run check:syntax",
|
|
51
|
+
"check:syntax": "node --check index.mjs && node --check index.cjs && node --check bin/ui-ux-master.mjs && node --check bin/ui-ux-master-mcp.mjs",
|
|
52
|
+
"doctor": "node bin/ui-ux-master.mjs doctor --dry-run",
|
|
53
|
+
"test": "npm run test:smoke",
|
|
54
|
+
"test:smoke": "npm run check:syntax && npm run doctor",
|
|
55
|
+
"test:node": "node --test tests/*.test.mjs",
|
|
56
|
+
"ci": "npm run validate && npm run build && npm run test:smoke && npm run test:node",
|
|
57
|
+
"release:check": "npm run ci && npm run pack:dry-run",
|
|
58
|
+
"pack:dry-run": "npm pack --dry-run",
|
|
29
59
|
"prepack": "npm run validate && npm test",
|
|
30
60
|
"build:zip": "python scripts/build_deployment_zip.py"
|
|
31
61
|
},
|
|
32
62
|
"keywords": [
|
|
63
|
+
"ai",
|
|
33
64
|
"ai-agent",
|
|
65
|
+
"ai-agents",
|
|
66
|
+
"ai-coding",
|
|
67
|
+
"agent",
|
|
34
68
|
"ui",
|
|
35
69
|
"ux",
|
|
36
70
|
"ui-ux",
|
|
71
|
+
"user-experience",
|
|
72
|
+
"product-design",
|
|
73
|
+
"ux-research",
|
|
74
|
+
"frontend",
|
|
75
|
+
"frontend-development",
|
|
37
76
|
"design-system",
|
|
77
|
+
"design-systems",
|
|
38
78
|
"accessibility",
|
|
39
79
|
"wcag",
|
|
80
|
+
"wcag-2-2",
|
|
81
|
+
"aria",
|
|
82
|
+
"a11y",
|
|
83
|
+
"mcp",
|
|
84
|
+
"model-context-protocol",
|
|
85
|
+
"mcp-server",
|
|
86
|
+
"cli",
|
|
87
|
+
"npx",
|
|
88
|
+
"prompt-engineering",
|
|
89
|
+
"system-prompt",
|
|
90
|
+
"ai-discovery",
|
|
91
|
+
"llms-txt",
|
|
40
92
|
"claude-code",
|
|
93
|
+
"claude",
|
|
41
94
|
"codex",
|
|
42
95
|
"windsurf",
|
|
43
96
|
"antigravity",
|
|
44
97
|
"gemini-cli",
|
|
98
|
+
"gemini",
|
|
45
99
|
"cursor",
|
|
46
100
|
"slash-command",
|
|
47
|
-
"agent-skill"
|
|
48
|
-
"frontend",
|
|
49
|
-
"mcp",
|
|
50
|
-
"model-context-protocol",
|
|
51
|
-
"system-prompt",
|
|
52
|
-
"ai-discovery",
|
|
53
|
-
"llms-txt"
|
|
101
|
+
"agent-skill"
|
|
54
102
|
],
|
|
55
103
|
"license": "MIT",
|
|
56
104
|
"author": "Rupak Biswas",
|
|
105
|
+
"contributors": [
|
|
106
|
+
{
|
|
107
|
+
"name": "Rupak Biswas"
|
|
108
|
+
}
|
|
109
|
+
],
|
|
110
|
+
"homepage": "https://github.com/Seance1723/UI-UX-Skills#readme",
|
|
111
|
+
"repository": {
|
|
112
|
+
"type": "git",
|
|
113
|
+
"url": "git+https://github.com/Seance1723/UI-UX-Skills.git"
|
|
114
|
+
},
|
|
115
|
+
"bugs": {
|
|
116
|
+
"url": "https://github.com/Seance1723/UI-UX-Skills/issues"
|
|
117
|
+
},
|
|
118
|
+
"funding": {
|
|
119
|
+
"type": "github",
|
|
120
|
+
"url": "https://github.com/sponsors/Seance1723"
|
|
121
|
+
},
|
|
57
122
|
"engines": {
|
|
58
|
-
"node": ">=18"
|
|
123
|
+
"node": ">=18.18"
|
|
59
124
|
},
|
|
125
|
+
"directories": {
|
|
126
|
+
"bin": "bin",
|
|
127
|
+
"doc": "docs",
|
|
128
|
+
"test": "tests"
|
|
129
|
+
},
|
|
130
|
+
"os": [
|
|
131
|
+
"darwin",
|
|
132
|
+
"linux",
|
|
133
|
+
"win32"
|
|
134
|
+
],
|
|
60
135
|
"preferGlobal": true,
|
|
61
136
|
"publishConfig": {
|
|
62
137
|
"access": "public"
|