@stackable-labs/cli-app-extension 1.0.1 → 1.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 -7
- package/dist/index.js +586 -418
- package/package.json +9 -9
package/README.md
CHANGED
|
@@ -20,11 +20,11 @@ When run without all required flags, the CLI guides you through a step-by-step p
|
|
|
20
20
|
|
|
21
21
|
| Step | Prompt | Description |
|
|
22
22
|
|---|---|---|
|
|
23
|
-
| 1 | **
|
|
24
|
-
| 2 | **
|
|
25
|
-
| 3 | **Targets** | Multiselect
|
|
26
|
-
| 4 | **Extension Port** | Dev server port for the
|
|
27
|
-
| 5 | **Preview Port** | Dev server port for the
|
|
23
|
+
| 1 | **App** | Select the App you are building an Extension for (fetched live from the API) |
|
|
24
|
+
| 2 | **Name** | Display name for your Extension (e.g. `My Commerce Extension`) |
|
|
25
|
+
| 3 | **Targets** | Multiselect from the Surface targets/slots exposed by the selected app |
|
|
26
|
+
| 4 | **Extension Port** | Dev server port for the Extension (default: `5173`) |
|
|
27
|
+
| 5 | **Preview Port** | Dev server port for the Preview host (default: `5174`) |
|
|
28
28
|
| 6 | **Directory** | Output directory path (default: kebab-case of name) |
|
|
29
29
|
| 7 | **Confirm** | Review all selections before scaffolding |
|
|
30
30
|
|
|
@@ -34,8 +34,6 @@ When run without all required flags, the CLI guides you through a step-by-step p
|
|
|
34
34
|
Usage: create-extension [name] [options]
|
|
35
35
|
|
|
36
36
|
Options:
|
|
37
|
-
--id <id> Extension ID (skips ID prompt)
|
|
38
|
-
--targets <targets> Comma-separated slot targets (skips targets prompt)
|
|
39
37
|
--extension-port <port> Extension dev server port (skips port prompt)
|
|
40
38
|
--preview-port <port> Preview host dev server port (skips port prompt)
|
|
41
39
|
--skip-install Skip package manager install after scaffolding
|
|
@@ -43,6 +41,21 @@ Options:
|
|
|
43
41
|
-h, --help Display help
|
|
44
42
|
```
|
|
45
43
|
|
|
44
|
+
## Local Development
|
|
45
|
+
|
|
46
|
+
To run the CLI locally from source against the live API:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
pnpm build
|
|
50
|
+
pnpm cli
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Or pass flags directly:
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
pnpm cli -- --skip-install --skip-git
|
|
57
|
+
```
|
|
58
|
+
|
|
46
59
|
## Scaffolded Project Structure
|
|
47
60
|
|
|
48
61
|
```
|