super-ux 0.18.0 → 0.19.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/CHANGELOG.md CHANGED
@@ -1,5 +1,26 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.19.0 — 2026-07-25
4
+
5
+ Review pass — the contracts were not reaching non-Claude agents.
6
+
7
+ - **FIX (distribution): shared contracts now ship with every skill.** The skills
8
+ CLI copies only a skill's OWN directory, so the sibling `skills/references/`
9
+ reached Claude Code plugins but arrived **dangling on Cursor / Codex / OpenCode /
10
+ OpenClaw / …** — `~/.agents/skills/ux-audit/` held nothing but `SKILL.md` while
11
+ its SKILL.md called `scenario-format.md` a contract to "never deviate" from.
12
+ Each skill now carries its own `references/` (the transitive closure of what it
13
+ links) and links them `references/…`. `skills/references/` stays the source of
14
+ truth; `test/sync_references.py` re-syncs; the validator fails on drift, on a
15
+ missing shipped contract, on any `../references/` link, and on dangling links
16
+ inside the copies.
17
+ - Cursor always-on rule gains the `screens.md` and linter bullets it was missing
18
+ (it was two canon versions behind the Claude rule).
19
+ - `ux-scenarios.mdc` contract stamp corrected `scenario-format v1` → `ux-contract v4`.
20
+ - `system-map.md` lists `/ux-init`; README fixes "both skills" → "all four",
21
+ "three agent-requested rules" → "four", and the release note now names
22
+ `package.json` in the version-sync set (the validator has always enforced it).
23
+
3
24
  All notable changes to this project are documented in this file. The format
4
25
  follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/); versions
5
26
  follow [SemVer](https://semver.org/spec/v2.0.0.html).
package/README.md CHANGED
@@ -41,7 +41,7 @@ flowchart LR
41
41
  | [system-map.md](plugins/super-ux/skills/references/system-map.md) | The whole system on one page — pipeline, files, skills, and the four sync rules; every skill points here |
42
42
  | `/ux-foundation` `/ux-flows` `/ux-init` `/ux-update` `/ux-audit` `/ux-rule` `/ux-lint` | Direct controls; `/ux-rule` installs the hard rule into the project's CLAUDE.md |
43
43
  | [ux-design-principles.md](plugins/super-ux/skills/references/ux-design-principles.md) | How the agent thinks: the design pipeline (forward + backwards), task analysis, flow rules, heuristics PRN-01..16, improvement procedure, anti-patterns |
44
- | `cursor/rules/*.mdc` | The same methodology for Cursor (always-on hard rule + three agent-requested rules) |
44
+ | `cursor/rules/*.mdc` | The same methodology for Cursor (always-on hard rule + four agent-requested rules) |
45
45
  | `templates/` | Skeletons for the foundation, scenario base, audit report, and the CLAUDE.md rule snippet |
46
46
  | [component-guidelines.md](plugins/super-ux/skills/references/component-guidelines.md) | When to use which control (radios/select/switch, sheet/alert, modal/disclosure, combobox, nav bar/rail, FAB, dates, toasts) + platform rules — from Apple HIG, Material 3, W3C ARIA APG, GOV.UK (BP-101..115) |
47
47
  | [best-practices.md](plugins/super-ux/skills/references/best-practices.md) | Living, tag-indexed catalog of 115 proven UX/growth practices — subscription-app laws, mobile/web/voice interface guidance (HIG 2025, M3 Expressive, NN/g, Baymard, WCAG 2.2), monetization economics (RevenueCat/PLG 2025 benchmarks, ASO, freemium boundaries, web2app), visual craft (typography, color, spacing, microcopy), Figma file structure (BP-091..100); selected deterministically via [practice-selection.md](plugins/super-ux/skills/references/practice-selection.md) |
@@ -94,7 +94,7 @@ npx skills add ssheleg/super-ux --skill ux-audit # one skill
94
94
 
95
95
  [vercel-labs/skills](https://github.com/vercel-labs/skills) discovers the
96
96
  skills through this repo's marketplace manifest and installs them for Claude
97
- Code, Cursor, Codex, OpenCode and others. Note: this installs the two skills
97
+ Code, Cursor, Codex, OpenCode and others. Note: this installs the skills
98
98
  only — the `/ux` commands and the Cursor always-on hard rule come with the
99
99
  methods below.
100
100
 
@@ -117,9 +117,31 @@ npx super-ux --cursor /path/to/your/project
117
117
 
118
118
  (also works: `npx github:ssheleg/super-ux --cursor <dir>` straight from the
119
119
  repo, or clone and run `./install.sh --cursor <dir>` — same behavior.) Copies the
120
- three rules into `.cursor/rules/` and seeds `docs/ux/scenarios.md`. An
121
- existing scenario base is never overwritten; re-run with `--force` to update
122
- rules after a new release.
120
+ rules into `.cursor/rules/` and seeds `docs/ux/`. An existing scenario base
121
+ is never overwritten; re-run with `--force` to update rules after a new
122
+ release.
123
+
124
+ ### Updating everything
125
+
126
+ Global channels (run after each release, then restart the Claude Code
127
+ session so the plugin reloads):
128
+
129
+ ```sh
130
+ claude plugin marketplace update super-ux && \
131
+ claude plugin update super-ux@super-ux && \
132
+ npx --yes skills update ux-audit ux-flows ux-foundation ux-scenarios --global --yes
133
+ ```
134
+
135
+ Cursor rules + the seeded `docs/ux/lint.py` are per-project (Cursor has no
136
+ global rules dir) — refresh each project you use:
137
+
138
+ ```sh
139
+ npx super-ux@latest --cursor /path/to/your/project --force
140
+ ```
141
+
142
+ `--force` overwrites the rule files and the linter; your scenario base
143
+ (`docs/ux/scenarios.md`) and the rest of `docs/ux/` are never touched.
144
+ Check the published version any time with `npm view super-ux version`.
123
145
 
124
146
  ## For the user: one command, plain words
125
147
 
@@ -8,6 +8,11 @@ alwaysApply: true
8
8
  - `docs/ux/scenarios.md` is the source of truth for all user-facing behavior;
9
9
  `docs/ux/foundation.md` (personas, JTBD, journeys, user stories) is the WHY
10
10
  layer scenarios trace to.
11
+ - `docs/ux/screens.md` is the UI map: every screen + state with its wireframe
12
+ and (Figma on) its frame link. A screen that changes in code changes here in
13
+ the SAME change.
14
+ - Run the linter after any UX change and before calling work done:
15
+ `python3 docs/ux/lint.py` (or `/ux-lint`). It must pass — drift must not merge.
11
16
  - Any change that touches user-facing behavior MUST update
12
17
  `docs/ux/scenarios.md` in the same change (add/adjust scenarios, statuses,
13
18
  coverage). New user-facing behavior with no scenario is a blocker, not a
@@ -8,7 +8,7 @@ alwaysApply: false
8
8
  `docs/ux/scenarios.md` describes everything the user can do, see, and hit —
9
9
  every feature, button, state, error, result. Keep it true.
10
10
 
11
- ## File structure (scenario-format v1)
11
+ ## File structure (ux-contract v4)
12
12
 
13
13
  Title, then header comment, then: **Index** table
14
14
  (`| ID | Title | Feature | Persona | Traces | Status | Last audit |`),
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "super-ux",
3
- "version": "0.18.0",
3
+ "version": "0.19.0",
4
4
  "description": "Scenario-driven UI development for AI agents (Claude Code + Cursor): scenario base, scenario-first hard rule, evidence-backed UX audits. This package is the installer CLI.",
5
5
  "bin": {
6
6
  "super-ux": "bin/super-ux.js"