@mechris3/glassbox 0.1.48 → 0.1.49
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 +22 -14
- package/dist/bin/glassbox.js +5 -3
- package/dist/bin/glassbox.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,16 +12,19 @@ Features:
|
|
|
12
12
|
|
|
13
13
|
## Quick Start
|
|
14
14
|
|
|
15
|
+
> **Note:** There is an unrelated npm package also called `glassbox` (a code-review tool).
|
|
16
|
+
> Always use the full scoped name `@mechris3/glassbox` with `npx` to avoid resolving the wrong package.
|
|
17
|
+
|
|
15
18
|
```bash
|
|
16
19
|
# Install
|
|
17
20
|
npm install @mechris3/glassbox
|
|
18
21
|
|
|
19
22
|
# Scaffold a project (creates glassbox.config.ts + directories)
|
|
20
|
-
npx glassbox init
|
|
23
|
+
npx @mechris3/glassbox init
|
|
21
24
|
|
|
22
25
|
# Write journeys and page objects (see below), then:
|
|
23
|
-
npx glassbox serve # Dashboard UI at http://localhost:3001
|
|
24
|
-
npx glassbox run # Headless batch run (for CI)
|
|
26
|
+
npx @mechris3/glassbox serve # Dashboard UI at http://localhost:3001
|
|
27
|
+
npx @mechris3/glassbox run # Headless batch run (for CI)
|
|
25
28
|
```
|
|
26
29
|
|
|
27
30
|
`glassbox init` creates this structure in your current directory:
|
|
@@ -42,7 +45,7 @@ npm run run # Run all journeys headless (exit 0 = pass, 1 = fail)
|
|
|
42
45
|
npm run run:headed # Run with a visible browser window
|
|
43
46
|
```
|
|
44
47
|
|
|
45
|
-
After running `glassbox init`, install dependencies and you're ready:
|
|
48
|
+
After running `npx @mechris3/glassbox init`, install dependencies and you're ready:
|
|
46
49
|
|
|
47
50
|
```bash
|
|
48
51
|
npm install
|
|
@@ -69,7 +72,7 @@ my-app/
|
|
|
69
72
|
└── page-objects/
|
|
70
73
|
```
|
|
71
74
|
|
|
72
|
-
Either way, run
|
|
75
|
+
Either way, run `@mechris3/glassbox` commands from the directory containing your `glassbox.config.ts`.
|
|
73
76
|
|
|
74
77
|
## Prerequisites
|
|
75
78
|
|
|
@@ -341,25 +344,30 @@ Run all commands from the directory containing your `glassbox.config.ts`:
|
|
|
341
344
|
cd my-tests/ # where your glassbox.config.ts lives
|
|
342
345
|
```
|
|
343
346
|
|
|
347
|
+
> Once you've run `npm install` in your project, use `npm run serve` / `npm run run` — these
|
|
348
|
+
> resolve the local `node_modules/.bin/glassbox` (the right one) automatically.
|
|
349
|
+
> When running outside a project with `npx`, always use the full scoped name:
|
|
350
|
+
> `npx @mechris3/glassbox <command>`
|
|
351
|
+
|
|
344
352
|
**Dashboard (visual UI):**
|
|
345
353
|
```bash
|
|
346
|
-
npx glassbox serve # Start dashboard at http://localhost:3001
|
|
354
|
+
npx @mechris3/glassbox serve # Start dashboard at http://localhost:3001
|
|
347
355
|
```
|
|
348
356
|
Open the URL in your browser to see journeys, run them, set breakpoints, pause/step, and inspect results visually.
|
|
349
357
|
|
|
350
358
|
**Headless runner (CI / terminal):**
|
|
351
359
|
```bash
|
|
352
|
-
npx glassbox run # Run all journeys, exit 0/1
|
|
353
|
-
npx glassbox run login # Only journeys matching "login"
|
|
354
|
-
npx glassbox run --url http://localhost:3000 # Specify app URL
|
|
355
|
-
npx glassbox run --headed # Show the browser while running
|
|
356
|
-
npx glassbox run --no-fail-fast # Don't stop at first failure
|
|
360
|
+
npx @mechris3/glassbox run # Run all journeys, exit 0/1
|
|
361
|
+
npx @mechris3/glassbox run login # Only journeys matching "login"
|
|
362
|
+
npx @mechris3/glassbox run --url http://localhost:3000 # Specify app URL
|
|
363
|
+
npx @mechris3/glassbox run --headed # Show the browser while running
|
|
364
|
+
npx @mechris3/glassbox run --no-fail-fast # Don't stop at first failure
|
|
357
365
|
```
|
|
358
366
|
|
|
359
367
|
**Other:**
|
|
360
368
|
```bash
|
|
361
|
-
npx glassbox init # Scaffold config + directories in current dir
|
|
362
|
-
npx glassbox mcp # Start MCP server for AI agent integration
|
|
369
|
+
npx @mechris3/glassbox init # Scaffold config + directories in current dir
|
|
370
|
+
npx @mechris3/glassbox mcp # Start MCP server for AI agent integration
|
|
363
371
|
```
|
|
364
372
|
|
|
365
373
|
## MCP Server (AI Integration)
|
|
@@ -373,7 +381,7 @@ Add to your `.kiro/settings/mcp.json`:
|
|
|
373
381
|
"mcpServers": {
|
|
374
382
|
"glassbox": {
|
|
375
383
|
"command": "npx",
|
|
376
|
-
"args": ["glassbox", "mcp"],
|
|
384
|
+
"args": ["@mechris3/glassbox", "mcp"],
|
|
377
385
|
"env": { "GLASSBOX_URL": "http://localhost:3001" },
|
|
378
386
|
"cwd": "/absolute/path/to/your/glassbox-tests"
|
|
379
387
|
}
|
package/dist/bin/glassbox.js
CHANGED
|
@@ -130,9 +130,11 @@ export default defineConfig({
|
|
|
130
130
|
private: true,
|
|
131
131
|
type: 'module',
|
|
132
132
|
scripts: {
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
133
|
+
// Use the full scoped name so these work before/after npm install,
|
|
134
|
+
// and to avoid resolving the unrelated 'glassbox' package on npm.
|
|
135
|
+
serve: 'npx @mechris3/glassbox serve',
|
|
136
|
+
run: 'npx @mechris3/glassbox run',
|
|
137
|
+
'run:headed': 'npx @mechris3/glassbox run --headed',
|
|
136
138
|
},
|
|
137
139
|
dependencies: {
|
|
138
140
|
'@mechris3/glassbox': '^0.1.0',
|
package/dist/bin/glassbox.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"glassbox.js","sourceRoot":"","sources":["../../bin/glassbox.ts"],"names":[],"mappings":";;AAEA;;;;;;;;;;GAUG;;AAEH,yCAAoC;AACpC,gDAA8C;AAC9C,qDAA8D;AAE9D,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,UAAU,CAAC;KAChB,WAAW,CAAC,mFAAmF,CAAC;KAChG,OAAO,CAAC,OAAO,CAAC,CAAC;AAEpB;;;;;;;;;;GAUG;AACH,OAAO;KACJ,OAAO,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;KACrC,WAAW,CAAC,+BAA+B,CAAC;KAC5C,MAAM,CAAC,mBAAmB,EAAE,gCAAgC,CAAC;KAC7D,MAAM,CAAC,qBAAqB,EAAE,4BAA4B,CAAC;KAC3D,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;IACxB,MAAM,MAAM,GAAG,MAAM,IAAA,sBAAU,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAChD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;IAC5E,MAAM,EAAE,MAAM,EAAE,GAAG,IAAA,+BAAoB,EAAC,MAAM,CAAC,CAAC;IAEhD,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE;QACvB,OAAO,CAAC,GAAG,CAAC,8CAA8C,IAAI,IAAI,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEL;;;;;;;;GAQG;AACH,OAAO;KACJ,OAAO,CAAC,mBAAmB,CAAC;KAC5B,WAAW,CAAC,yDAAyD,CAAC;KACtE,MAAM,CAAC,qBAAqB,EAAE,4BAA4B,CAAC;KAC3D,MAAM,CAAC,UAAU,EAAE,sCAAsC,CAAC;KAC1D,MAAM,CAAC,iBAAiB,EAAE,kCAAkC,CAAC;KAC7D,MAAM,CAAC,gBAAgB,EAAE,wCAAwC,CAAC;KAClE,MAAM,CAAC,KAAK,EAAE,QAAkB,EAAE,OAAO,EAAE,EAAE;IAC5C,MAAM,MAAM,GAAG,MAAM,IAAA,sBAAU,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAChD,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,MAAM,CAAC,mCAAmC,CAAC,CAAC;IAC7E,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,cAAc,CAAC,MAAM,EAAE;QAChD,aAAa,EAAE,QAAQ;QACvB,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,KAAK;QAC/B,SAAS,EAAE,OAAO,CAAC,GAAG,IAAI,EAAE;QAC5B,UAAU,EAAE,OAAO,CAAC,QAAQ,KAAK,KAAK;KACvC,CAAC,CAAC;IACH,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AACzB,CAAC,CAAC,CAAC;AAEL;;;;;;;;GAQG;AACH,OAAO;KACJ,OAAO,CAAC,KAAK,CAAC;KACd,WAAW,CAAC,+CAA+C,CAAC;KAC5D,MAAM,CAAC,aAAa,EAAE,sDAAsD,CAAC;KAC7E,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;IACxB,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;QAChB,OAAO,CAAC,GAAG,CAAC,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC;IACzC,CAAC;IACD,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,MAAM,CAAC,sBAAsB,CAAC,CAAC;IAChE,MAAM,cAAc,EAAE,CAAC;AACzB,CAAC,CAAC,CAAC;AAEL;;;;;;GAMG;AACH,OAAO;KACJ,OAAO,CAAC,MAAM,CAAC;KACf,WAAW,CAAC,wDAAwD,CAAC;KACrE,MAAM,CAAC,KAAK,IAAI,EAAE;IACjB,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC;IAEpE,IAAI,UAAU,CAAC,oBAAoB,CAAC,EAAE,CAAC;QACrC,OAAO,CAAC,GAAG,CAAC,mDAAmD,CAAC,CAAC;QACjE,OAAO;IACT,CAAC;IAED,MAAM,aAAa,GAAG;;;;;;;;;;;;;;;;CAgBzB,CAAC;IAEE,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC;QACpC,IAAI,EAAE,mBAAmB;QACzB,OAAO,EAAE,OAAO;QAChB,OAAO,EAAE,IAAI;QACb,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"glassbox.js","sourceRoot":"","sources":["../../bin/glassbox.ts"],"names":[],"mappings":";;AAEA;;;;;;;;;;GAUG;;AAEH,yCAAoC;AACpC,gDAA8C;AAC9C,qDAA8D;AAE9D,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,UAAU,CAAC;KAChB,WAAW,CAAC,mFAAmF,CAAC;KAChG,OAAO,CAAC,OAAO,CAAC,CAAC;AAEpB;;;;;;;;;;GAUG;AACH,OAAO;KACJ,OAAO,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;KACrC,WAAW,CAAC,+BAA+B,CAAC;KAC5C,MAAM,CAAC,mBAAmB,EAAE,gCAAgC,CAAC;KAC7D,MAAM,CAAC,qBAAqB,EAAE,4BAA4B,CAAC;KAC3D,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;IACxB,MAAM,MAAM,GAAG,MAAM,IAAA,sBAAU,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAChD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;IAC5E,MAAM,EAAE,MAAM,EAAE,GAAG,IAAA,+BAAoB,EAAC,MAAM,CAAC,CAAC;IAEhD,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE;QACvB,OAAO,CAAC,GAAG,CAAC,8CAA8C,IAAI,IAAI,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEL;;;;;;;;GAQG;AACH,OAAO;KACJ,OAAO,CAAC,mBAAmB,CAAC;KAC5B,WAAW,CAAC,yDAAyD,CAAC;KACtE,MAAM,CAAC,qBAAqB,EAAE,4BAA4B,CAAC;KAC3D,MAAM,CAAC,UAAU,EAAE,sCAAsC,CAAC;KAC1D,MAAM,CAAC,iBAAiB,EAAE,kCAAkC,CAAC;KAC7D,MAAM,CAAC,gBAAgB,EAAE,wCAAwC,CAAC;KAClE,MAAM,CAAC,KAAK,EAAE,QAAkB,EAAE,OAAO,EAAE,EAAE;IAC5C,MAAM,MAAM,GAAG,MAAM,IAAA,sBAAU,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAChD,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,MAAM,CAAC,mCAAmC,CAAC,CAAC;IAC7E,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,cAAc,CAAC,MAAM,EAAE;QAChD,aAAa,EAAE,QAAQ;QACvB,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,KAAK;QAC/B,SAAS,EAAE,OAAO,CAAC,GAAG,IAAI,EAAE;QAC5B,UAAU,EAAE,OAAO,CAAC,QAAQ,KAAK,KAAK;KACvC,CAAC,CAAC;IACH,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AACzB,CAAC,CAAC,CAAC;AAEL;;;;;;;;GAQG;AACH,OAAO;KACJ,OAAO,CAAC,KAAK,CAAC;KACd,WAAW,CAAC,+CAA+C,CAAC;KAC5D,MAAM,CAAC,aAAa,EAAE,sDAAsD,CAAC;KAC7E,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;IACxB,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;QAChB,OAAO,CAAC,GAAG,CAAC,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC;IACzC,CAAC;IACD,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,MAAM,CAAC,sBAAsB,CAAC,CAAC;IAChE,MAAM,cAAc,EAAE,CAAC;AACzB,CAAC,CAAC,CAAC;AAEL;;;;;;GAMG;AACH,OAAO;KACJ,OAAO,CAAC,MAAM,CAAC;KACf,WAAW,CAAC,wDAAwD,CAAC;KACrE,MAAM,CAAC,KAAK,IAAI,EAAE;IACjB,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC;IAEpE,IAAI,UAAU,CAAC,oBAAoB,CAAC,EAAE,CAAC;QACrC,OAAO,CAAC,GAAG,CAAC,mDAAmD,CAAC,CAAC;QACjE,OAAO;IACT,CAAC;IAED,MAAM,aAAa,GAAG;;;;;;;;;;;;;;;;CAgBzB,CAAC;IAEE,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC;QACpC,IAAI,EAAE,mBAAmB;QACzB,OAAO,EAAE,OAAO;QAChB,OAAO,EAAE,IAAI;QACb,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,mEAAmE;YACnE,kEAAkE;YAClE,KAAK,EAAE,8BAA8B;YACrC,GAAG,EAAE,4BAA4B;YACjC,YAAY,EAAE,qCAAqC;SACpD;QACD,YAAY,EAAE;YACZ,oBAAoB,EAAE,QAAQ;SAC/B;KACF,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAEZ,aAAa,CAAC,oBAAoB,EAAE,aAAa,CAAC,CAAC;IACnD,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;IAE9C,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;QAChC,aAAa,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;QAC9C,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC5B,SAAS,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC3C,OAAO,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC;IACjD,CAAC;IAED,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;QAChC,SAAS,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/C,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC;IACrD,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAC/B,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;IAClC,OAAO,CAAC,GAAG,CAAC,4CAA4C,CAAC,CAAC;IAC1D,OAAO,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC;IAClD,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;AACxC,CAAC,CAAC,CAAC;AAEL,OAAO,CAAC,KAAK,EAAE,CAAC"}
|
package/package.json
CHANGED