@vizzly-testing/cli 0.13.0 → 0.13.2
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 +552 -88
- package/claude-plugin/.claude-plugin/README.md +4 -0
- package/claude-plugin/.mcp.json +4 -0
- package/claude-plugin/CHANGELOG.md +27 -0
- package/claude-plugin/mcp/vizzly-docs-server/README.md +95 -0
- package/claude-plugin/mcp/vizzly-docs-server/docs-fetcher.js +110 -0
- package/claude-plugin/mcp/vizzly-docs-server/index.js +283 -0
- package/claude-plugin/mcp/vizzly-server/cloud-api-provider.js +26 -10
- package/claude-plugin/mcp/vizzly-server/index.js +14 -1
- package/claude-plugin/mcp/vizzly-server/local-tdd-provider.js +61 -28
- package/dist/cli.js +4 -4
- package/dist/commands/run.js +1 -1
- package/dist/commands/tdd-daemon.js +54 -8
- package/dist/commands/tdd.js +8 -8
- package/dist/container/index.js +34 -3
- package/dist/reporter/reporter-bundle.css +1 -1
- package/dist/reporter/reporter-bundle.iife.js +29 -59
- package/dist/server/handlers/tdd-handler.js +28 -63
- package/dist/server/http-server.js +473 -4
- package/dist/services/config-service.js +371 -0
- package/dist/services/project-service.js +245 -0
- package/dist/services/server-manager.js +4 -5
- package/dist/services/static-report-generator.js +208 -0
- package/dist/services/tdd-service.js +14 -6
- package/dist/types/reporter/src/components/ui/form-field.d.ts +16 -0
- package/dist/types/reporter/src/components/views/projects-view.d.ts +1 -0
- package/dist/types/reporter/src/components/views/settings-view.d.ts +1 -0
- package/dist/types/reporter/src/hooks/use-auth.d.ts +10 -0
- package/dist/types/reporter/src/hooks/use-config.d.ts +9 -0
- package/dist/types/reporter/src/hooks/use-projects.d.ts +10 -0
- package/dist/types/reporter/src/services/api-client.d.ts +7 -0
- package/dist/types/server/http-server.d.ts +1 -1
- package/dist/types/services/config-service.d.ts +98 -0
- package/dist/types/services/project-service.d.ts +103 -0
- package/dist/types/services/server-manager.d.ts +2 -1
- package/dist/types/services/static-report-generator.d.ts +25 -0
- package/dist/types/services/tdd-service.d.ts +2 -2
- package/dist/utils/console-ui.js +26 -2
- package/docs/tdd-mode.md +31 -15
- package/package.json +4 -4
package/docs/tdd-mode.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# TDD Mode Guide
|
|
2
2
|
|
|
3
|
-
TDD
|
|
3
|
+
TDD Mode enables test-driven visual development with an interactive dashboard for rapid iteration.
|
|
4
4
|
|
|
5
5
|
## What is TDD Mode?
|
|
6
6
|
|
|
@@ -10,23 +10,26 @@ TDD Mode transforms your visual testing workflow with:
|
|
|
10
10
|
- **Local Comparison** - Compares screenshots on your machine using `honeydiff`
|
|
11
11
|
- **Live Updates** - See comparisons instantly in the browser
|
|
12
12
|
- **Baseline Management** - Accept/reject changes directly from the UI
|
|
13
|
+
- **Settings Editor** - Adjust comparison threshold, ports, and more without touching config files
|
|
14
|
+
- **Project Tools** - Login and link directories to cloud projects from the dashboard
|
|
13
15
|
- **Fast Feedback** - No network uploads during development
|
|
14
|
-
- **No Token Required** -
|
|
16
|
+
- **No Token Required** - Visual testing works entirely offline for local development
|
|
15
17
|
|
|
16
18
|
## Quick Start
|
|
17
19
|
|
|
18
|
-
### 1. Start the TDD
|
|
20
|
+
### 1. Start the TDD Server
|
|
19
21
|
|
|
20
|
-
Start the interactive
|
|
22
|
+
Start the interactive TDD server:
|
|
21
23
|
|
|
22
24
|
```bash
|
|
23
25
|
npx vizzly tdd start
|
|
24
26
|
```
|
|
25
27
|
|
|
26
|
-
🐻 **
|
|
28
|
+
🐻 **TDD server starts:**
|
|
27
29
|
- Opens at `http://localhost:47392` (or custom `--port`)
|
|
28
|
-
-
|
|
30
|
+
- Dashboard shows empty state ready for comparisons
|
|
29
31
|
- Runs in the background and returns your terminal immediately
|
|
32
|
+
- Settings and Projects tabs available for convenient configuration
|
|
30
33
|
|
|
31
34
|
### 2. Run Your Tests in Watch Mode
|
|
32
35
|
|
|
@@ -65,7 +68,18 @@ npx vizzly tdd run "npm test" --set-baseline
|
|
|
65
68
|
- All tests pass (baseline accepted)
|
|
66
69
|
- Future runs use updated baselines
|
|
67
70
|
|
|
68
|
-
### 5.
|
|
71
|
+
### 5. Manage Settings & Projects (Optional)
|
|
72
|
+
|
|
73
|
+
Use the dashboard tabs for convenient configuration:
|
|
74
|
+
|
|
75
|
+
- **Settings** - Edit comparison thresholds, ports, and build settings without touching files
|
|
76
|
+
- **Projects** - Login to Vizzly cloud and link directories to projects
|
|
77
|
+
- **Comparisons** - View visual diffs (main view)
|
|
78
|
+
- **Stats** - See test metrics and trends
|
|
79
|
+
|
|
80
|
+
These tools are conveniences - you can always edit `vizzly.config.js` directly or use `vizzly login`/`vizzly project:select` CLI commands instead.
|
|
81
|
+
|
|
82
|
+
### 6. Stop the TDD Server
|
|
69
83
|
|
|
70
84
|
When done developing:
|
|
71
85
|
|
|
@@ -79,20 +93,22 @@ Or press `Ctrl+C` if running in foreground.
|
|
|
79
93
|
|
|
80
94
|
TDD Mode provides two workflows:
|
|
81
95
|
|
|
82
|
-
### Interactive
|
|
96
|
+
### Interactive TDD Workflow
|
|
83
97
|
|
|
84
|
-
1. **Start
|
|
98
|
+
1. **Start TDD server** - `vizzly tdd start` launches persistent server with dashboard
|
|
85
99
|
2. **Run tests in watch** - Tests run continuously as you code
|
|
86
100
|
3. **Live updates** - Screenshots compared and displayed in real-time
|
|
87
101
|
4. **Review in browser** - Visual diff modes help analyze changes
|
|
88
|
-
5. **
|
|
102
|
+
5. **Manage settings (optional)** - Use Settings/Projects tabs for quick config changes
|
|
103
|
+
6. **Accept baselines** - Click to update baselines from UI
|
|
89
104
|
|
|
90
105
|
### Single-Shot Workflow
|
|
91
106
|
|
|
92
107
|
1. **Run tests** - `vizzly tdd run "npm test"` executes once
|
|
93
108
|
2. **Compares locally** - Uses `honeydiff` for high-performance comparison
|
|
94
|
-
3. **Generates report** - Creates HTML report with
|
|
109
|
+
3. **Generates report** - Creates self-contained HTML report with React UI
|
|
95
110
|
4. **Exit with status** - Fails if differences exceed threshold
|
|
111
|
+
5. **Server auto-stops** - Ephemeral server cleans up automatically
|
|
96
112
|
|
|
97
113
|
## Directory Structure
|
|
98
114
|
|
|
@@ -237,9 +253,9 @@ The legacy command format is still supported:
|
|
|
237
253
|
vizzly tdd "npm test" # Equivalent to: vizzly tdd run "npm test"
|
|
238
254
|
```
|
|
239
255
|
|
|
240
|
-
##
|
|
256
|
+
## TDD Workflow
|
|
241
257
|
|
|
242
|
-
### Interactive
|
|
258
|
+
### Interactive TDD (Recommended)
|
|
243
259
|
|
|
244
260
|
```bash
|
|
245
261
|
# Start dashboard (runs in background)
|
|
@@ -268,7 +284,7 @@ npx vizzly tdd run "npm test" --set-baseline
|
|
|
268
284
|
npx vizzly run "npm test" --wait
|
|
269
285
|
```
|
|
270
286
|
|
|
271
|
-
### Feature
|
|
287
|
+
### Feature TDD Workflow
|
|
272
288
|
|
|
273
289
|
```bash
|
|
274
290
|
# Start interactive dashboard (runs in background)
|
|
@@ -405,7 +421,7 @@ jobs:
|
|
|
405
421
|
- **Immediate feedback** - See results in seconds
|
|
406
422
|
- **No API rate limits** - Test as often as needed
|
|
407
423
|
|
|
408
|
-
###
|
|
424
|
+
### TDD Experience
|
|
409
425
|
- **Fast iteration** - Make changes and test immediately
|
|
410
426
|
- **Visual debugging** - See exact pixel differences
|
|
411
427
|
- **Offline capable** - Works without internet (after initial baseline download)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vizzly-testing/cli",
|
|
3
|
-
"version": "0.13.
|
|
3
|
+
"version": "0.13.2",
|
|
4
4
|
"description": "Visual review platform for UI developers and designers",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"visual-testing",
|
|
@@ -79,7 +79,7 @@
|
|
|
79
79
|
"registry": "https://registry.npmjs.org/"
|
|
80
80
|
},
|
|
81
81
|
"dependencies": {
|
|
82
|
-
"@vizzly-testing/honeydiff": "^0.1
|
|
82
|
+
"@vizzly-testing/honeydiff": "^0.3.1",
|
|
83
83
|
"commander": "^14.0.0",
|
|
84
84
|
"cosmiconfig": "^9.0.0",
|
|
85
85
|
"dotenv": "^17.2.1",
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
"@playwright/test": "^1.55.1",
|
|
100
100
|
"@tailwindcss/postcss": "^4.1.13",
|
|
101
101
|
"@vitejs/plugin-react": "^5.0.3",
|
|
102
|
-
"@vitest/coverage-v8": "^
|
|
102
|
+
"@vitest/coverage-v8": "^4.0.3",
|
|
103
103
|
"autoprefixer": "^10.4.21",
|
|
104
104
|
"babel-plugin-transform-remove-console": "^6.9.4",
|
|
105
105
|
"eslint": "^9.31.0",
|
|
@@ -115,7 +115,7 @@
|
|
|
115
115
|
"tailwindcss": "^4.1.13",
|
|
116
116
|
"typescript": "^5.0.4",
|
|
117
117
|
"vite": "^7.1.7",
|
|
118
|
-
"vitest": "^
|
|
118
|
+
"vitest": "^4.0.3",
|
|
119
119
|
"wouter": "^3.7.1"
|
|
120
120
|
}
|
|
121
121
|
}
|