create-supaslidev 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 +91 -0
- package/dist/cli.d.ts +6 -0
- package/dist/cli.js +1279 -0
- package/dist/index.d.ts +241 -0
- package/dist/index.js +1675 -0
- package/package.json +62 -0
- package/templates/default/.supaslidev/state.json.ejs +6 -0
- package/templates/default/gitignore.ejs +7 -0
- package/templates/default/npmrc.ejs +1 -0
- package/templates/default/package.json.ejs +21 -0
- package/templates/default/pnpm-workspace.yaml.ejs +13 -0
- package/templates/default/tsconfig.json.ejs +17 -0
- package/templates/default/turbo.json.ejs +24 -0
package/README.md
ADDED
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# create-supaslidev
|
|
2
|
+
|
|
3
|
+
Scaffold and manage [Supaslidev](../../README.md) workspaces from the command line.
|
|
4
|
+
|
|
5
|
+
Supaslidev is a monorepo toolkit for managing multiple [Slidev](https://sli.dev/) presentations. This CLI handles the initial workspace setup and keeps it up to date as Supaslidev evolves.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
The recommended way to use this CLI is via `pnpm create`, which downloads and runs the latest version:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
pnpm create supaslidev
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
You can also install it globally if you prefer:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
pnpm add -g create-supaslidev
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Commands
|
|
22
|
+
|
|
23
|
+
### create
|
|
24
|
+
|
|
25
|
+
Scaffolds a new Supaslidev workspace with everything you need to start managing presentations.
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
# Interactive mode (recommended)
|
|
29
|
+
pnpm create supaslidev
|
|
30
|
+
|
|
31
|
+
# Or with options
|
|
32
|
+
pnpm create supaslidev --name my-slides --presentation intro-deck
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
**Options:**
|
|
36
|
+
|
|
37
|
+
| Option | Description | Default |
|
|
38
|
+
| ---------------------------- | ------------------------- | --------------------- |
|
|
39
|
+
| `-n, --name <name>` | Workspace directory name | Prompts interactively |
|
|
40
|
+
| `-p, --presentation <name>` | First presentation name | `my-first-deck` |
|
|
41
|
+
| `-t, --template <template>` | Template to use | `default` |
|
|
42
|
+
| `--git` / `--no-git` | Initialize git repository | `true` |
|
|
43
|
+
| `--install` / `--no-install` | Run pnpm install | `true` |
|
|
44
|
+
|
|
45
|
+
The wizard creates a pnpm workspace with:
|
|
46
|
+
- A `presentations/` directory for your decks
|
|
47
|
+
- A `packages/shared/` directory with reusable components, layouts, and styles (configured as a Slidev addon)
|
|
48
|
+
- Shared dependency management via pnpm catalog
|
|
49
|
+
- Scripts for common tasks
|
|
50
|
+
|
|
51
|
+
### status
|
|
52
|
+
|
|
53
|
+
Shows the current state of your workspace, including the CLI version, pending migrations, and any available updates.
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
create-supaslidev status
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Run this from inside a Supaslidev workspace to see what version you're on and whether any migrations are waiting to be applied.
|
|
60
|
+
|
|
61
|
+
### migrate
|
|
62
|
+
|
|
63
|
+
Updates your workspace structure when a new version of Supaslidev introduces changes.
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
# Preview what would change (dry-run)
|
|
67
|
+
create-supaslidev migrate
|
|
68
|
+
|
|
69
|
+
# Apply the migrations
|
|
70
|
+
create-supaslidev migrate --apply
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Always preview first. Migrations modify files in your workspace, so it's good practice to review what will change before applying.
|
|
74
|
+
|
|
75
|
+
### update
|
|
76
|
+
|
|
77
|
+
Checks whether a newer version of the CLI is available.
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
create-supaslidev update
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
If an update exists, you'll see the current and latest versions along with instructions to upgrade.
|
|
84
|
+
|
|
85
|
+
## Documentation
|
|
86
|
+
|
|
87
|
+
For detailed guides on workspace structure, the dashboard UI, and presentation management, see the [full documentation](../../docs/).
|
|
88
|
+
|
|
89
|
+
## License
|
|
90
|
+
|
|
91
|
+
[MIT](../../LICENSE)
|