ui-ux-master 1.2.0 → 1.2.1
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 +39 -2
- package/SKILL.md +1 -1
- package/docs/package-publishing.md +82 -0
- package/index.cjs +37 -0
- package/index.d.ts +17 -0
- package/index.mjs +27 -0
- package/package.json +85 -11
package/README.md
CHANGED
|
@@ -1,7 +1,10 @@
|
|
|
1
1
|
# UI/UX Master 🎨✨
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/ui-ux-master)
|
|
4
|
+
[](https://www.npmjs.com/package/ui-ux-master)
|
|
5
|
+
[](https://github.com/Seance1723/UI-UX-Skills/blob/main/LICENSE)
|
|
6
|
+
[](https://github.com/Seance1723/UI-UX-Skills/stargazers)
|
|
7
|
+
[](https://github.com/Seance1723/UI-UX-Skills/commits/main)
|
|
5
8
|
[](http://makeapullrequest.com)
|
|
6
9
|
|
|
7
10
|
**The ultimate UI/UX skill for AI coding agents.** Turn your AI into a Senior Product Designer, UX Researcher, and Frontend Lead in seconds.
|
|
@@ -107,6 +110,25 @@ Dry run:
|
|
|
107
110
|
npx ui-ux-master install --project --dry-run
|
|
108
111
|
```
|
|
109
112
|
|
|
113
|
+
## Package
|
|
114
|
+
|
|
115
|
+
| Channel | Package | Purpose |
|
|
116
|
+
|---|---|---|
|
|
117
|
+
| npmjs | [`ui-ux-master`](https://www.npmjs.com/package/ui-ux-master) | Primary public package for normal installs and `npx` usage |
|
|
118
|
+
| GitHub | [`Seance1723/UI-UX-Skills`](https://github.com/Seance1723/UI-UX-Skills) | Source, issues, releases, workflows, and open-source collaboration |
|
|
119
|
+
| GitHub Packages | Optional scoped mirror | Use only if you want the repository Packages section to show a package |
|
|
120
|
+
|
|
121
|
+
The canonical npm package is intentionally unscoped as `ui-ux-master`. GitHub Packages requires npm packages to be scoped, so a GitHub Packages mirror should use `@seance1723/ui-ux-master` while the public npmjs package remains `ui-ux-master`.
|
|
122
|
+
|
|
123
|
+
Package entrypoints:
|
|
124
|
+
|
|
125
|
+
- `ui-ux-master` - CLI installer and project integration tool.
|
|
126
|
+
- `ui-ux-master-mcp` - local MCP server for tools, resources, and prompts.
|
|
127
|
+
- `import { assets, bins, trigger } from "ui-ux-master"` - lightweight ESM metadata API.
|
|
128
|
+
- `require("ui-ux-master")` - CommonJS metadata API.
|
|
129
|
+
|
|
130
|
+
Package metadata is connected to GitHub through `repository`, `homepage`, `bugs`, license, funding, exports, engines, and npm provenance-ready publish settings in `package.json`.
|
|
131
|
+
|
|
110
132
|
## Supported Agents
|
|
111
133
|
|
|
112
134
|
| Agent | Install target | Trigger |
|
|
@@ -194,6 +216,7 @@ ui-ux-master uninstall --project
|
|
|
194
216
|
## Package Structure
|
|
195
217
|
|
|
196
218
|
- `SKILL.md` — main orchestration skill.
|
|
219
|
+
- `index.mjs`, `index.cjs`, `index.d.ts` — ESM, CommonJS, and TypeScript metadata entrypoints.
|
|
197
220
|
- `references/` — advanced playbooks and standards-aligned checklists.
|
|
198
221
|
- `templates/` — briefs, audits, component specs, design-system specs, and project UI/UX memory template.
|
|
199
222
|
- `agent-templates/` — Claude, Codex, Windsurf, Antigravity, Gemini, Cursor, and universal `/ui-ux-master` activation rules.
|
|
@@ -207,6 +230,20 @@ ui-ux-master uninstall --project
|
|
|
207
230
|
- `scripts/build_deployment_zip.py` — clean deployment zip builder.
|
|
208
231
|
- `tests/` — npm installer and package smoke tests.
|
|
209
232
|
|
|
233
|
+
## GitHub Repository Setup
|
|
234
|
+
|
|
235
|
+
Recommended About section:
|
|
236
|
+
|
|
237
|
+
- Description: `Opt-in UI/UX master skill, CLI, and MCP server for AI coding agents. Accessibility, design systems, UX research, and frontend handoff in one workflow.`
|
|
238
|
+
- Website: `https://www.npmjs.com/package/ui-ux-master`
|
|
239
|
+
- Enable releases and issues. Enable discussions when you are ready to support community questions.
|
|
240
|
+
|
|
241
|
+
Recommended GitHub topics:
|
|
242
|
+
|
|
243
|
+
`ai-agent`, `ai-coding`, `ui-ux`, `ux-research`, `product-design`, `design-system`, `accessibility`, `wcag`, `mcp`, `model-context-protocol`, `claude-code`, `codex`, `windsurf`, `cursor`, `gemini-cli`, `npm-package`, `cli`, `prompt-engineering`, `frontend`, `llms-txt`
|
|
244
|
+
|
|
245
|
+
For publishing and registry details, see `docs/package-publishing.md`.
|
|
246
|
+
|
|
210
247
|
## Validation and Testing
|
|
211
248
|
|
|
212
249
|
Run from this folder:
|
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.2.
|
|
4
|
+
version: 1.2.1
|
|
5
5
|
author: Rupak Biswas
|
|
6
6
|
license: MIT
|
|
7
7
|
platforms: [linux, macos, windows]
|
|
@@ -0,0 +1,82 @@
|
|
|
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
|
+
Do not add a root `.npmrc` that changes the default registry, because that can accidentally route normal installs away from npmjs.
|
|
25
|
+
|
|
26
|
+
Use this scoped configuration only when publishing or installing the GitHub Packages mirror:
|
|
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
|
+
## Secrets
|
|
40
|
+
|
|
41
|
+
Add these repository secrets:
|
|
42
|
+
|
|
43
|
+
- `NPM_TOKEN` - npm automation token with publish access to `ui-ux-master`.
|
|
44
|
+
|
|
45
|
+
GitHub Packages publishing uses the built-in `GITHUB_TOKEN` in Actions.
|
|
46
|
+
|
|
47
|
+
## Release Strategy
|
|
48
|
+
|
|
49
|
+
Use semantic versioning:
|
|
50
|
+
|
|
51
|
+
- Patch: documentation fixes, metadata improvements, bug fixes that preserve behavior.
|
|
52
|
+
- Minor: new agent templates, new MCP resources, new commands, backward-compatible workflow improvements.
|
|
53
|
+
- Major: breaking CLI behavior, changed trigger contract, removed assets, changed package entrypoint semantics.
|
|
54
|
+
|
|
55
|
+
Recommended flow:
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
npm run release:check
|
|
59
|
+
npm version patch
|
|
60
|
+
git push origin main --follow-tags
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Create a GitHub release for the new tag, for example `v1.2.1`. The publish workflow will validate and publish.
|
|
64
|
+
|
|
65
|
+
## npm Optimization Checklist
|
|
66
|
+
|
|
67
|
+
- Keep `repository`, `homepage`, `bugs`, `license`, `author`, `funding`, and keywords current.
|
|
68
|
+
- Keep `files` tight so generated assets and local graph/cache files stay out of the package.
|
|
69
|
+
- Run `npm pack --dry-run` before publishing.
|
|
70
|
+
- Prefer provenance publishing through GitHub Actions.
|
|
71
|
+
- Keep README install examples short and copyable.
|
|
72
|
+
- Keep `exports` stable once published.
|
|
73
|
+
- Avoid runtime dependencies unless they clearly improve the CLI or MCP server.
|
|
74
|
+
|
|
75
|
+
## GitHub Presentation Checklist
|
|
76
|
+
|
|
77
|
+
- Add a concise About description and npm link.
|
|
78
|
+
- Add SEO topics listed in README.
|
|
79
|
+
- Use releases with human-written notes.
|
|
80
|
+
- Keep Issues enabled and use issue templates.
|
|
81
|
+
- Pin the repository on the maintainer profile.
|
|
82
|
+
- Add screenshots or a short terminal GIF later if the CLI becomes more visual.
|
package/index.cjs
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
const path = require('node:path');
|
|
4
|
+
|
|
5
|
+
const packageRoot = __dirname;
|
|
6
|
+
|
|
7
|
+
const name = 'ui-ux-master';
|
|
8
|
+
const version = '1.2.1';
|
|
9
|
+
const trigger = '/ui-ux-master';
|
|
10
|
+
|
|
11
|
+
const bins = Object.freeze({
|
|
12
|
+
cli: path.join(packageRoot, 'bin', 'ui-ux-master.mjs'),
|
|
13
|
+
mcp: path.join(packageRoot, 'bin', 'ui-ux-master-mcp.mjs'),
|
|
14
|
+
});
|
|
15
|
+
|
|
16
|
+
const assets = Object.freeze({
|
|
17
|
+
skill: path.join(packageRoot, 'SKILL.md'),
|
|
18
|
+
readme: path.join(packageRoot, 'README.md'),
|
|
19
|
+
llms: path.join(packageRoot, 'llms.txt'),
|
|
20
|
+
manifest: path.join(packageRoot, 'ai-discovery', 'ui-ux-master.manifest.json'),
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
function assetPath(name) {
|
|
24
|
+
if (!Object.hasOwn(assets, name)) {
|
|
25
|
+
throw new Error(`Unknown ui-ux-master asset: ${name}`);
|
|
26
|
+
}
|
|
27
|
+
return assets[name];
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
module.exports = {
|
|
31
|
+
assetPath,
|
|
32
|
+
assets,
|
|
33
|
+
bins,
|
|
34
|
+
name,
|
|
35
|
+
trigger,
|
|
36
|
+
version,
|
|
37
|
+
};
|
package/index.d.ts
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
export declare const name = "ui-ux-master";
|
|
2
|
+
export declare const version = "1.2.1";
|
|
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,27 @@
|
|
|
1
|
+
import path from 'node:path';
|
|
2
|
+
import { fileURLToPath } from 'node:url';
|
|
3
|
+
|
|
4
|
+
const packageRoot = path.dirname(fileURLToPath(import.meta.url));
|
|
5
|
+
|
|
6
|
+
export const name = 'ui-ux-master';
|
|
7
|
+
export const version = '1.2.1';
|
|
8
|
+
export const trigger = '/ui-ux-master';
|
|
9
|
+
|
|
10
|
+
export const bins = Object.freeze({
|
|
11
|
+
cli: path.join(packageRoot, 'bin', 'ui-ux-master.mjs'),
|
|
12
|
+
mcp: path.join(packageRoot, 'bin', 'ui-ux-master-mcp.mjs'),
|
|
13
|
+
});
|
|
14
|
+
|
|
15
|
+
export const assets = Object.freeze({
|
|
16
|
+
skill: path.join(packageRoot, 'SKILL.md'),
|
|
17
|
+
readme: path.join(packageRoot, 'README.md'),
|
|
18
|
+
llms: path.join(packageRoot, 'llms.txt'),
|
|
19
|
+
manifest: path.join(packageRoot, 'ai-discovery', 'ui-ux-master.manifest.json'),
|
|
20
|
+
});
|
|
21
|
+
|
|
22
|
+
export function assetPath(name) {
|
|
23
|
+
if (!Object.hasOwn(assets, name)) {
|
|
24
|
+
throw new Error(`Unknown ui-ux-master asset: ${name}`);
|
|
25
|
+
}
|
|
26
|
+
return assets[name];
|
|
27
|
+
}
|
package/package.json
CHANGED
|
@@ -1,17 +1,38 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ui-ux-master",
|
|
3
|
-
"version": "1.2.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "1.2.1",
|
|
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@11.14.0",
|
|
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,91 @@
|
|
|
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
|
+
"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",
|
|
51
|
+
"doctor": "node bin/ui-ux-master.mjs doctor --dry-run",
|
|
52
|
+
"test": "npm run test:smoke",
|
|
53
|
+
"test:smoke": "npm run check:syntax && npm run doctor",
|
|
54
|
+
"test:node": "node --test tests/*.test.mjs",
|
|
55
|
+
"ci": "npm run validate && npm run test:smoke && npm run test:node",
|
|
56
|
+
"release:check": "npm run ci && npm run pack:dry-run",
|
|
57
|
+
"pack:dry-run": "npm pack --dry-run",
|
|
29
58
|
"prepack": "npm run validate && npm test",
|
|
30
59
|
"build:zip": "python scripts/build_deployment_zip.py"
|
|
31
60
|
},
|
|
32
61
|
"keywords": [
|
|
62
|
+
"ai",
|
|
33
63
|
"ai-agent",
|
|
64
|
+
"ai-agents",
|
|
65
|
+
"ai-coding",
|
|
66
|
+
"agent",
|
|
34
67
|
"ui",
|
|
35
68
|
"ux",
|
|
36
69
|
"ui-ux",
|
|
70
|
+
"user-experience",
|
|
71
|
+
"product-design",
|
|
72
|
+
"ux-research",
|
|
73
|
+
"frontend",
|
|
74
|
+
"frontend-development",
|
|
37
75
|
"design-system",
|
|
76
|
+
"design-systems",
|
|
38
77
|
"accessibility",
|
|
39
78
|
"wcag",
|
|
79
|
+
"wcag-2-2",
|
|
80
|
+
"aria",
|
|
81
|
+
"a11y",
|
|
82
|
+
"mcp",
|
|
83
|
+
"model-context-protocol",
|
|
84
|
+
"mcp-server",
|
|
85
|
+
"cli",
|
|
86
|
+
"npx",
|
|
87
|
+
"prompt-engineering",
|
|
88
|
+
"system-prompt",
|
|
89
|
+
"ai-discovery",
|
|
90
|
+
"llms-txt",
|
|
40
91
|
"claude-code",
|
|
92
|
+
"claude",
|
|
41
93
|
"codex",
|
|
42
94
|
"windsurf",
|
|
43
95
|
"antigravity",
|
|
44
96
|
"gemini-cli",
|
|
97
|
+
"gemini",
|
|
45
98
|
"cursor",
|
|
46
99
|
"slash-command",
|
|
47
|
-
"agent-skill"
|
|
48
|
-
"frontend",
|
|
49
|
-
"mcp",
|
|
50
|
-
"model-context-protocol",
|
|
51
|
-
"system-prompt",
|
|
52
|
-
"ai-discovery",
|
|
53
|
-
"llms-txt"
|
|
100
|
+
"agent-skill"
|
|
54
101
|
],
|
|
55
102
|
"license": "MIT",
|
|
56
103
|
"author": "Rupak Biswas",
|
|
104
|
+
"contributors": [
|
|
105
|
+
{
|
|
106
|
+
"name": "Rupak Biswas"
|
|
107
|
+
}
|
|
108
|
+
],
|
|
109
|
+
"homepage": "https://github.com/Seance1723/UI-UX-Skills#readme",
|
|
110
|
+
"repository": {
|
|
111
|
+
"type": "git",
|
|
112
|
+
"url": "git+https://github.com/Seance1723/UI-UX-Skills.git"
|
|
113
|
+
},
|
|
114
|
+
"bugs": {
|
|
115
|
+
"url": "https://github.com/Seance1723/UI-UX-Skills/issues"
|
|
116
|
+
},
|
|
117
|
+
"funding": {
|
|
118
|
+
"type": "github",
|
|
119
|
+
"url": "https://github.com/sponsors/Seance1723"
|
|
120
|
+
},
|
|
57
121
|
"engines": {
|
|
58
|
-
"node": ">=18"
|
|
122
|
+
"node": ">=18.18"
|
|
59
123
|
},
|
|
124
|
+
"directories": {
|
|
125
|
+
"bin": "bin",
|
|
126
|
+
"doc": "docs",
|
|
127
|
+
"test": "tests"
|
|
128
|
+
},
|
|
129
|
+
"os": [
|
|
130
|
+
"darwin",
|
|
131
|
+
"linux",
|
|
132
|
+
"win32"
|
|
133
|
+
],
|
|
60
134
|
"preferGlobal": true,
|
|
61
135
|
"publishConfig": {
|
|
62
136
|
"access": "public"
|