Skip to content

Commit a99275a

Browse files
committed
fix(create-rezi): resolve starship review feedback
1 parent a2a5627 commit a99275a

File tree

26 files changed

+258
-136
lines changed

26 files changed

+258
-136
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ cd my-app
132132
bun start
133133
```
134134

135-
Starter templates: **dashboard**, **stress-test**, **cli-tool**, **animation-lab**, and **minimal**.
135+
Starter templates: **dashboard**, **stress-test**, **cli-tool**, **animation-lab**, **minimal**, and **starship** (command console).
136136

137137
---
138138

docs/dev/repo-layout.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ terminal.
9393

9494
CLI scaffolding tool. Running `npm create rezi` generates a new Rezi project
9595
from built-in templates with proper `package.json`, `tsconfig.json`, and example
96-
code. Current templates: `dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`.
96+
code. Current templates: `dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`, `starship`.
9797

9898
### bench -- `@rezi-ui/bench` (private)
9999

docs/getting-started/create-rezi.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@ If `--template` is omitted, the CLI prompts you to choose (default: `dashboard`)
3434
- `minimal`: Single-screen utility starter for focused tooling.
3535
Highlights: lean reducer flow, keybindings (`q`, `?`, `+/-`, `t`), theme cycling, and signal-safe shutdown pattern.
3636
Aliases: `mini`, `basic`, `utility`.
37+
- `starship`: Multi-deck command console integration showcase.
38+
Highlights: routed six-screen bridge, live telemetry/charts, crew and cargo operations, overlays, and theme cycling.
39+
Aliases: `ship`, `bridge`, `command`.
3740

3841
Choose directly with `--template`:
3942

@@ -43,11 +46,13 @@ npm create rezi my-app -- --template stress-test
4346
npm create rezi my-app -- --template cli-tool
4447
npm create rezi my-app -- --template animation-lab
4548
npm create rezi my-app -- --template minimal
49+
npm create rezi my-app -- --template starship
4650
bun create rezi my-app -- --template dashboard
4751
bun create rezi my-app -- --template stress-test
4852
bun create rezi my-app -- --template cli-tool
4953
bun create rezi my-app -- --template animation-lab
5054
bun create rezi my-app -- --template minimal
55+
bun create rezi my-app -- --template starship
5156
```
5257

5358
Inspect all templates and highlights from the CLI:
@@ -61,7 +66,7 @@ bun create rezi -- --list-templates
6166
## Options
6267

6368
- `--template, -t <name>`:
64-
Select a template (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`; aliases: `dash`, `stress`, `chaos`, `bench`, `cli`, `tool`, `multiscreen`, `animation`, `anim`, `lab`, `motion`, `mini`, `basic`, `utility`).
69+
Select a template (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`, `starship`; aliases: `dash`, `stress`, `chaos`, `bench`, `cli`, `tool`, `multiscreen`, `animation`, `anim`, `lab`, `motion`, `mini`, `basic`, `utility`, `ship`, `bridge`, `command`).
6570
- `--no-install, --skip-install`: Skip dependency installation.
6671
- `--pm, --package-manager <npm|pnpm|yarn|bun>`: Choose a package manager.
6772
- `--list-templates, --templates`: Print available templates and highlights.
@@ -85,13 +90,13 @@ Each template includes example tests for reducer logic, widget rendering, and ke
8590

8691
## Dev Loop (HSR)
8792

88-
`minimal`, `dashboard`, and `cli-tool` templates ship with hot state-preserving reload enabled in
93+
`minimal`, `dashboard`, `cli-tool`, and `starship` templates ship with hot state-preserving reload enabled in
8994
`npm run dev` / `bun run dev`:
9095

9196
- dev script runs `tsx src/main.ts --hsr`
9297
- source changes hot-swap through `createNodeApp({ hotReload: ... })` via:
9398
- `app.replaceView(...)` in widget-view templates (`minimal`, `dashboard`)
94-
- `app.replaceRoutes(...)` in route-managed template (`cli-tool`)
99+
- `app.replaceRoutes(...)` in route-managed templates (`cli-tool`, `starship`)
95100
- app state, focus, and stable widget local state are preserved across edits
96101

97102
For package-level CLI reference (invocation forms and options), see [packages/create-rezi](../packages/create-rezi.md).

docs/getting-started/examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ node examples/raw-draw-demo/dist/index.js
2929

3030
## Looking for Larger App Examples?
3131

32-
Use `create-rezi` templates (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`) for full starter apps:
32+
Use `create-rezi` templates (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`, `starship`) for full starter apps:
3333

3434
- [Create Rezi (canonical template overview)](create-rezi.md)
3535
- [create-rezi package reference](../packages/create-rezi.md)

docs/getting-started/quickstart.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,16 @@ cd my-tui-app
2020
bun start
2121
```
2222

23-
Select a template when prompted (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, or `minimal`), or pass `--template` to choose directly:
23+
Select a template when prompted (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`, or `starship`), or pass `--template` to choose directly:
2424

2525
```bash
2626
npm create rezi my-tui-app -- --template dashboard
2727
npm create rezi my-tui-app -- --template animation-lab
2828
npm create rezi my-tui-app -- --template minimal
29+
npm create rezi my-tui-app -- --template starship
2930
```
3031

31-
The templates demonstrate the recommended project structure and patterns. Start with `minimal` to learn the basics, `dashboard` for operations workflows, or `animation-lab` for declarative motion patterns.
32+
The templates demonstrate the recommended project structure and patterns. Start with `minimal` to learn the basics, `dashboard` for operations workflows, `animation-lab` for declarative motion patterns, or `starship` for an end-to-end command console showcase.
3233

3334
### Option 2: Manual setup
3435

docs/packages/create-rezi.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Canonical template names:
2929
- `cli-tool` (aliases: `cli`, `tool`, `multiscreen`)
3030
- `animation-lab` (aliases: `animation`, `anim`, `lab`, `motion`)
3131
- `minimal` (aliases: `mini`, `basic`, `utility`)
32+
- `starship` (aliases: `ship`, `bridge`, `command`)
3233

3334
`animation-lab` is the canonical reference for Rezi's declarative motion APIs (`useTransition`, `useSpring`, `useSequence`, `useStagger`) plus `ui.box` transition props.
3435

@@ -39,12 +40,14 @@ npm create rezi my-app -- --template dashboard
3940
npm create rezi my-app -- --template cli-tool
4041
npm create rezi my-app -- --template animation-lab
4142
npm create rezi my-app -- --template minimal
43+
npm create rezi my-app -- --template starship
4244

4345
# Bun
4446
bun create rezi my-app -- --template dashboard
4547
bun create rezi my-app -- --template cli-tool
4648
bun create rezi my-app -- --template animation-lab
4749
bun create rezi my-app -- --template minimal
50+
bun create rezi my-app -- --template starship
4851
```
4952

5053
List templates and highlights:
@@ -59,12 +62,12 @@ For full template descriptions and highlights, use: [Getting Started -> Create R
5962

6063
Template dev workflow notes:
6164

62-
- `minimal`, `dashboard`, and `cli-tool` templates run `tsx src/main.ts --hsr` for `npm run dev` / `bun run dev`.
65+
- `minimal`, `dashboard`, `cli-tool`, and `starship` templates run `tsx src/main.ts --hsr` for `npm run dev` / `bun run dev`.
6366
- This enables in-process hot state-preserving reload through `@rezi-ui/node` `createNodeApp({ hotReload: ... })`.
6467

6568
## Options
6669

67-
- `--template, -t <name>`: Select a template (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`, plus aliases).
70+
- `--template, -t <name>`: Select a template (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`, `starship`, plus aliases).
6871
- `--no-install, --skip-install`: Skip dependency installation.
6972
- `--pm, --package-manager <npm|pnpm|yarn|bun>`: Choose a package manager.
7073
- `--list-templates, --templates`: Print available templates and highlights.

docs/packages/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ bun add -d @rezi-ui/testkit
114114

115115
**Project scaffolding CLI**
116116

117-
Generate a ready-to-run Rezi app with TypeScript configured and polished starter templates (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`):
117+
Generate a ready-to-run Rezi app with TypeScript configured and polished starter templates (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`, `starship`):
118118

119119
```bash
120120
npm create rezi my-app

packages/create-rezi/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,16 @@ Currently available templates:
2929
- Aliases: `animation`, `anim`, `lab`, `motion`
3030
- `minimal` - Single-screen utility starter for small tools
3131
- Aliases: `mini`, `basic`, `utility`
32+
- `starship` - Starship command console starter with routed multi-deck operations
33+
- Aliases: `ship`, `bridge`, `command`
3234

3335
```bash
3436
npm create rezi my-app -- --template dashboard
3537
npm create rezi my-app -- --template stress-test
3638
npm create rezi my-app -- --template cli-tool
3739
npm create rezi my-app -- --template animation-lab
3840
npm create rezi my-app -- --template minimal
41+
npm create rezi my-app -- --template starship
3942
```
4043

4144
List templates and highlights from the CLI:
@@ -46,7 +49,7 @@ npm create rezi -- --list-templates
4649

4750
## Options
4851

49-
- `--template, -t <name>`: Select a template (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`, plus aliases).
52+
- `--template, -t <name>`: Select a template (`dashboard`, `stress-test`, `cli-tool`, `animation-lab`, `minimal`, `starship`, plus aliases).
5053
- `--no-install, --skip-install`: Skip dependency installation.
5154
- `--pm, --package-manager <npm|pnpm|yarn|bun>`: Choose a package manager.
5255
- `--list-templates, --templates`: Print available templates and highlights.

packages/create-rezi/src/scaffold.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,6 @@ TEMPLATE_ALIASES.set("motion", "animation-lab");
118118
TEMPLATE_ALIASES.set("mini", "minimal");
119119
TEMPLATE_ALIASES.set("basic", "minimal");
120120
TEMPLATE_ALIASES.set("utility", "minimal");
121-
TEMPLATE_ALIASES.set("starship", "starship");
122121
TEMPLATE_ALIASES.set("ship", "starship");
123122
TEMPLATE_ALIASES.set("bridge", "starship");
124123
TEMPLATE_ALIASES.set("command", "starship");

packages/create-rezi/templates/starship/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"@rezi-ui/node": "^0.1.0-alpha.17"
1616
},
1717
"devDependencies": {
18-
"@types/node": "^22.13.1",
18+
"@types/node": "^18.0.0",
1919
"tsx": "^4.20.0",
2020
"typescript": "^5.6.3"
2121
},

0 commit comments

Comments
 (0)