create-tauri-ui 1.0.4 → 1.0.6

package/README.md

@@ -1,141 +1,142 @@
 # create-tauri-ui
 
-Create modern Tauri desktop apps with `shadcn/ui` in a few steps.
+CLI to scaffold Tauri desktop apps with `shadcn/ui`. Drives the upstream `shadcn` and `create-tauri-app` CLIs — no local template tree to maintain.
 
-This package scaffolds a frontend with the upstream `shadcn` CLI, generates a native shell with `create-tauri-app`, and merges the result into a Tauri-ready project. It is designed to avoid maintaining a large local template directory.
-
-## Quick Start
-
-Primary commands:
-
-```bash
-npm create tauri-ui@latest my-app
-```
+## Install & run
 
 ```bash
+# bun
 bun create tauri-ui my-app
-```
-
-Equivalent direct binary commands:
+bunx create-tauri-ui@latest my-app
 
-```bash
+# npm
+npm create tauri-ui@latest my-app
 npx create-tauri-ui@latest my-app
 ```
 
+## After generation
+
 ```bash
-bunx create-tauri-ui@latest my-app
+cd my-app
+bun install
+bun run tauri dev
 ```
 
-## Supported Templates
-
-- `vite`
-- `next`
-- `start`
-- `react-router`
-- `astro`
-
-## Batteries Included
-
-Every generated project gets:
-
-- a Tauri `src-tauri` native layer
-- a frontend scaffold generated by the upstream `shadcn` CLI
-- template adapters for `vite`, `next`, `start`, `react-router`, and `astro`
-- Tauri config patches for desktop dev/build output
-- centered desktop window defaults with a `1400x918` main window
-- startup flash prevention by hiding the main window until the first page load finishes
-- external link guarding so internal links stay in-app and external links open in the system browser
-- a dev-only debug panel with Tauri runtime info, tracked invokes, runtime events, and log stream wiring
-- desktop scroll-container defaults that disable overscroll and rubber-band scrolling
-- desktop selection defaults with global `select-none`, an intrinsic selectable allowlist, and a `.ui-selectable` utility
-- a branded `app-icon.png` source asset
+To regenerate the Tauri icon set from the included source image:
 
-Optional batteries:
+```bash
+bunx tauri icon app-icon.png
+```
 
-- a starter dashboard based on `dashboard-01`
-- a small Rust invoke example
-- a GitHub release workflow
+> Bun is required in generated projects.
 
-## Example Commands
+## CLI reference
 
-Generate a Vite app with defaults:
+```
+Usage: create-tauri-ui [target-dir] [options]
 
+Options:
+  -t, --template <name>     vite | next | start | react-router | astro
+      --identifier <value>  Tauri app identifier (e.g. com.example.myapp)
+      --preset <value>      shadcn preset (default: b0)
+      --size-optimize       optimize release binaries for size
+      --no-size-optimize    skip size optimization
+      --starter             include the starter dashboard
+      --no-starter          skip the starter dashboard
+      --invoke-example      include the Rust invoke example
+      --no-invoke-example   skip the Rust invoke example
+      --workflow            include the GitHub release workflow
+      --no-workflow         skip the GitHub release workflow
+  -f, --force               overwrite an existing target directory
+  -y, --yes                 accept all defaults
+  -v, --version             display version
+  -h, --help                display help
+```
+
+## Examples
+
+**Vite app with all defaults:**
 ```bash
 npm create tauri-ui@latest my-app -- --template vite --yes
 ```
 
-Generate a Next.js app without the starter dashboard or workflow:
-
+**Next.js app, no dashboard, no workflow:**
 ```bash
 npm create tauri-ui@latest my-app -- --template next --yes --no-starter --no-workflow
 ```
 
-Generate an Astro app with a custom identifier:
-
+**Astro app with a custom bundle identifier:**
 ```bash
 bun create tauri-ui my-app --template astro --identifier com.example.astroapp --yes
 ```
 
-## CLI Options
+**Vite app with size-optimized release binary:**
+```bash
+bun create tauri-ui my-app --template vite --size-optimize --yes
+```
 
-```text
-Usage: create-tauri-ui [target-dir] [options]
+## Batteries included
 
-Options:
-  -t, --template <name>         vite | next | start | react-router | astro
-      --identifier <value>      set the Tauri app identifier
-      --preset <value>          set the shadcn preset (default: b0)
-      --starter                 include the starter dashboard
-      --no-starter              skip the starter dashboard
-      --invoke-example          include the Rust invoke example
-      --no-invoke-example       skip the Rust invoke example
-      --workflow                include the GitHub release workflow
-      --no-workflow             skip the GitHub release workflow
-  -f, --force                   overwrite an existing target directory
-  -y, --yes                     accept defaults
-  -h, --help                    display help
-```
+Every generated project gets:
 
-## After Generation
+- `src-tauri` native layer (from `create-tauri-app`)
+- shadcn frontend scaffold (from the upstream `shadcn` CLI)
+- framework adapters for `vite`, `next`, `start`, `react-router`, `astro`
+- Tauri config patches for desktop dev and build output
+- centered `1400×918` main window
+- startup flash prevention (window hidden until first paint)
+- external link guard — internal links stay in-app, external links open in the system browser
+- overscroll / rubber-band scroll disabled
+- desktop selection defaults — global `select-none`, intrinsic selectable allowlist, `.ui-selectable` utility class
+- dev-only debug panel with runtime info, tracked invokes, runtime events, and log stream
+- `app-icon.png` source asset
 
-In the generated project:
+**Optional** (prompted during scaffolding, or passed as flags):
 
-```bash
-cd my-app
-bun install
-bun run build
-bun run tauri dev
-```
+| Battery | Flag | Notes |
+|---|---|---|
+| Starter dashboard | `--starter` / `--no-starter` | based on `dashboard-01` |
+| Rust invoke example | `--invoke-example` / `--no-invoke-example` | |
+| Size optimization | `--size-optimize` / `--no-size-optimize` | ~65% smaller release binary (9 MB → 3.1 MB) |
+| GitHub release workflow | `--workflow` / `--no-workflow` | |
 
-To generate the Tauri icon set from the included source image:
+## Template status
 
-```bash
-bunx tauri icon app-icon.png
-```
+| Template | Status |
+|---|---|
+| `vite` | smoke-tested end to end |
+| `next` | stable |
+| `react-router` | stable |
+| `astro` | stable |
+| `start` (TanStack) | experimental — validate carefully after changes |
+
+Scaffolding into `.` (current directory) is not supported yet.
 
-## How It Works
+## How it works
 
-```text
-prompts -> shadcn init -> create-tauri-app (temp) -> merge src-tauri -> apply framework patches -> add batteries
+```
+prompts → shadcn init → create-tauri-app (temp dir) → merge src-tauri → apply framework patches → add batteries
 ```
 
-The package keeps only a small local asset surface:
+Local asset surface is intentionally small:
 
-- `assets/app-icon.png`
-- `assets/release.yml.tmpl`
+```
+assets/app-icon.png
+assets/release.yml.tmpl
+```
 
-It does not ship full frontend templates.
+No full frontend templates are shipped. The upstream CLIs do the heavy lifting; this package handles the merge, patching, and battery injection.
 
 ## Development
 
-Run these from the monorepo root:
+Run from the monorepo root:
 
 ```bash
 bun run --cwd packages/create-tauri-ui check-types
 bun run --cwd packages/create-tauri-ui build
 ```
 
-Run the local CLI build:
+Run the local build directly:
 
 ```bash
 bun run --cwd packages/create-tauri-ui start -- --help
@@ -143,46 +144,29 @@ bun run --cwd packages/create-tauri-ui start -- --help
 
 ## Testing
 
-Quick validation:
-
+**Type check + build:**
 ```bash
 bun run --cwd packages/create-tauri-ui check-types
 bun run --cwd packages/create-tauri-ui build
 ```
 
-End-to-end smoke test from the monorepo root:
-
+**Single template smoke test:**
 ```bash
 rm -rf /tmp/ctui-vite
 node packages/create-tauri-ui/index.js /tmp/ctui-vite --template vite --yes --no-workflow
-cd /tmp/ctui-vite
-bun install
-bun run build
+cd /tmp/ctui-vite && bun install && bun run build
 ```
 
-Smoke test all templates:
-
+**All templates:**
 ```bash
 for template in vite next start react-router astro; do
   dir="/tmp/create-tauri-ui-$template"
   rm -rf "$dir"
   node packages/create-tauri-ui/index.js "$dir" --template "$template" --yes --no-workflow
-  (
-    cd "$dir" &&
-    bun install &&
-    bun run build
-  ) || exit 1
+  (cd "$dir" && bun install && bun run build) || exit 1
 done
 ```
 
-## Current Notes
-
-- Bun is required in generated projects.
-- Scaffolding into `.` is not supported yet.
-- Vite has already been smoke-tested end to end.
-- The other adapters are implemented, but they still need broader end-to-end verification coverage.
-- `TanStack Start` is the highest-risk adapter and should be validated carefully after changes.
-
 ## License
 
 MIT