@tour-kit/studio 0.1.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 +20 -0
- package/dist/index.js +1743 -0
- package/package.json +35 -0
package/README.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# @tour-kit/studio (`tourkit` bin)
|
|
2
|
+
|
|
3
|
+
The User Tour Kit Studio **CLI**. Reads a Tour Recipe and emits owned source into the user's repo.
|
|
4
|
+
|
|
5
|
+
| Command | Does |
|
|
6
|
+
|---|---|
|
|
7
|
+
| `tourkit add <recipe>` | fetch recipe → detect framework + pm → install exact pinned pkgs → scaffold `tours/<id>.tsx` → AST-patch root layout (idempotent). Pro → write empty framework-specific client license env; claim/checkout is v0.2. |
|
|
8
|
+
| `tourkit pull <recipe>` | re-sync; 3-way diff if the generated file was edited |
|
|
9
|
+
| `tourkit verify [recipe...]` | boot dev server, Playwright-check selectors; CI gate on dead ones |
|
|
10
|
+
| `tourkit harden [recipe...]` | codemod: inject `data-tour-id` on referenced elements |
|
|
11
|
+
| `tourkit init` | create `tourkit.config.json` manifest |
|
|
12
|
+
|
|
13
|
+
**Stack** (confirmed in the spec): citty (commands) · ts-morph (idempotent JSX provider-wrapping;
|
|
14
|
+
use `node.replaceWithText()`, no structural `.wrap()`) · Playwright as a **lazy/optional** dep
|
|
15
|
+
(only `verify` needs it) · execa · pkg-types · semver · consola. Validates recipes with
|
|
16
|
+
`@usetourkit/recipe`.
|
|
17
|
+
|
|
18
|
+
Fetches recipes from the Studio's recipe API (`GET /api/recipes/:id`). Pro `claim`/`checkout` are
|
|
19
|
+
v0.2-only calls to `tourkit-dash`. Status: not scaffolded — see
|
|
20
|
+
[`../../plan/roadmap.md`](../../plan/roadmap.md) and the spec §4b.
|