@movable/ui 3.19.1 → 3.20.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 +47 -0
- package/package.json +3 -5
package/README.md
CHANGED
|
@@ -70,6 +70,16 @@ View all available versions at: https://www.npmjs.com/package/@movable/ui?active
|
|
|
70
70
|
|
|
71
71
|
This repo includes an MCP (Model Context Protocol) server that exposes component information to AI assistants like Claude Code. See [mcp-server/README.md](./mcp-server/README.md) for setup instructions.
|
|
72
72
|
|
|
73
|
+
## Visual Regression Testing
|
|
74
|
+
|
|
75
|
+
Visual regression testing is handled via **Percy with Storybook** (Storybook-only approach):
|
|
76
|
+
|
|
77
|
+
- **Storybook Stories**: All visual states must be captured in Storybook stories
|
|
78
|
+
- **Percy Integration**: `npm run percy:storybook` runs Percy snapshots on built Storybook
|
|
79
|
+
- **Cypress Tests**: Focus on functional/integration testing only (no Percy snapshots)
|
|
80
|
+
|
|
81
|
+
This consolidated approach reduces duplicate snapshots and CI runtime while maintaining comprehensive visual coverage.
|
|
82
|
+
|
|
73
83
|
## Conventional Commits
|
|
74
84
|
|
|
75
85
|
This repo has [conventional-commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) We lint for this both pre-commit and on PR actions. It is **required** and will not pass without it.
|
|
@@ -83,3 +93,40 @@ fix(percy): added percy snapshots for all component states
|
|
|
83
93
|
- disabled
|
|
84
94
|
- focused
|
|
85
95
|
```
|
|
96
|
+
|
|
97
|
+
## GitHub Issue to Shortcut Sync
|
|
98
|
+
|
|
99
|
+
This repository automatically syncs GitHub issues to Shortcut stories on the Designer Team board. **GitHub Issues are the source of truth** - all work should start and be managed here.
|
|
100
|
+
|
|
101
|
+
### For Engineers
|
|
102
|
+
|
|
103
|
+
📖 **See [.github/SHORTCUT_SYNC.md](.github/SHORTCUT_SYNC.md) for the complete workflow guide**, including:
|
|
104
|
+
- How the automation works (automatic + manual triggers)
|
|
105
|
+
- Recommended workflow for working through issues
|
|
106
|
+
- Issue types and state transitions
|
|
107
|
+
- Troubleshooting common scenarios
|
|
108
|
+
|
|
109
|
+
**Quick summary:** When you open an issue, it automatically creates a Shortcut story. When you open a PR that fixes the issue, it moves the story to "In Development". When you close the issue, it completes the story.
|
|
110
|
+
|
|
111
|
+
### Updating the Shortcut API Token
|
|
112
|
+
|
|
113
|
+
If the Shortcut API token needs to be rotated or updated:
|
|
114
|
+
|
|
115
|
+
1. **Create a new token in Shortcut:**
|
|
116
|
+
- Go to [Shortcut Settings → API Tokens](https://app.shortcut.com/settings/account/api-tokens)
|
|
117
|
+
- Create new token with description "GitHub Issue Sync"
|
|
118
|
+
- Copy the token value
|
|
119
|
+
|
|
120
|
+
2. **Update the GitHub secret:**
|
|
121
|
+
|
|
122
|
+
Via GitHub CLI:
|
|
123
|
+
```bash
|
|
124
|
+
gh secret set SHORTCUT_API_TOKEN
|
|
125
|
+
# Paste the new token when prompted
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
Or via GitHub web UI:
|
|
129
|
+
- Go to Settings → Secrets and variables → Actions
|
|
130
|
+
- Click on `SHORTCUT_API_TOKEN` and update the value
|
|
131
|
+
|
|
132
|
+
3. **Test the automation** by creating a test issue to verify the sync is working
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@movable/ui",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.20.0",
|
|
4
4
|
"description": "Movable Ink's shared MUI components and MUI theme for our vite applications",
|
|
5
5
|
"module": "lib/index.mjs",
|
|
6
6
|
"types": "lib/index.d.ts",
|
|
@@ -20,11 +20,10 @@
|
|
|
20
20
|
"lint:cypress": "tsc --project ./cypress/tsconfig.json && eslint -c ./cypress/.eslintrc.json ./cypress --resolve-plugins-relative-to ./cypress --report-unused-disable-directives --max-warnings 0 --no-error-on-unmatched-pattern",
|
|
21
21
|
"lint:stories": "tsc --project ./tsconfig.json && eslint -c ./.eslintrc.json ./stories --report-unused-disable-directives --max-warnings 0",
|
|
22
22
|
"prepare": "husky install",
|
|
23
|
-
"percy:storybook": "PERCY_TOKEN=$PERCY_TOKEN percy exec --
|
|
24
|
-
"percy:upload": "PERCY_TOKEN=$PERCY_TOKEN percy build:finalize",
|
|
23
|
+
"percy:storybook": "PERCY_TOKEN=$PERCY_TOKEN percy exec -- percy storybook ./storybook-static",
|
|
25
24
|
"storybook": "storybook dev -p 6006",
|
|
26
25
|
"test": "cypress run --component -q",
|
|
27
|
-
"test:ci": "
|
|
26
|
+
"test:ci": "cypress run --component -q",
|
|
28
27
|
"test:dev": "cypress open --component",
|
|
29
28
|
"watch": "vite build --watch"
|
|
30
29
|
},
|
|
@@ -55,7 +54,6 @@
|
|
|
55
54
|
"@mui/x-data-grid-generator": "^7.29.8",
|
|
56
55
|
"@mui/x-data-grid-premium": "^7.29.8",
|
|
57
56
|
"@percy/cli": "^1.31.0",
|
|
58
|
-
"@percy/cypress": "^3.1.2",
|
|
59
57
|
"@percy/storybook": "^6.0.0",
|
|
60
58
|
"@release-it/conventional-changelog": "^7.0.1",
|
|
61
59
|
"@rollup/plugin-typescript": "^11.1.5",
|