create-krispya 0.4.7 → 0.5.0

package/README.md

@@ -1,17 +1,33 @@
 # create-krispya
 
-A CLI for scaffolding modern web projects with sensible defaults.
+A CLI for scaffolding modern web projects and monorepos with sensible defaults.
 
-## Usage
+## Quick Start
 
 ```bash
-npm create krispya
-# or
 pnpm create krispya
 # or
+npm create krispya
+# or
 yarn create krispya
 ```
 
+## Features
+
+- **Monorepo support** — Generate pnpm workspaces with shared configs
+- **Modern tooling** — Oxlint, Oxfmt, Vite, Vitest out of the box
+- **TypeScript first** — Full type safety with JavaScript fallback
+- **Library ready** — ESM/CJS dual output with proper exports
+- **React & R3F** — First-class support with optional integrations
+
+## Project Types
+
+| Type        | Description                                              |
+| ----------- | -------------------------------------------------------- |
+| Application | Web app with Vite dev server and bundling                |
+| Library     | Publishable npm package with ESM/CJS output              |
+| Monorepo    | pnpm workspace with shared configs and multiple packages |
+
 ## Templates
 
 | Template     | Description                       |
@@ -23,19 +39,54 @@ yarn create krispya
 | `r3f`        | React Three Fiber with TypeScript |
 | `r3f-js`     | React Three Fiber with JavaScript |
 
-## Project Types
+## Monorepo
+
+Generate a monorepo with shared configuration packages:
+
+```bash
+pnpm create krispya my-workspace --monorepo
+```
+
+This creates:
 
-- **Application** (default): Web app with Vite for dev/bundling
-- **Library**: Publishable npm package with ESM/CJS output, proper exports, and peer dependencies
+```
+my-workspace/
+├── .config/
+│   ├── typescript/    # @config/typescript - shared tsconfigs
+│   ├── oxlint/        # @config/oxlint - shared lint rules
+│   └── oxfmt/         # @config/oxfmt - shared format rules
+├── apps/              # Application packages
+├── packages/          # Library packages
+├── package.json
+└── pnpm-workspace.yaml
+```
+
+### Adding Packages
+
+Run the CLI from within a monorepo to add new packages:
+
+```bash
+cd my-workspace
+pnpm create krispya
+# Select "Add new package to this workspace"
+```
+
+Sub-packages automatically:
+
+- Extend shared configs via `@config/*` workspace dependencies
+- Skip redundant files (`.gitignore`, `.vscode/`, etc.)
+- Use root-level dev tools (oxlint, oxfmt)
 
 ## Tooling Options
 
-| Category  | Options                              | Default   |
-| --------- | ------------------------------------ | --------- |
-| Linter    | `oxlint`, `eslint`, `biome`          | `oxlint`  |
-| Formatter | `oxfmt`, `prettier`, `biome`         | `oxfmt`   |
-| Bundler   | `unbuild`, `tsdown` (libraries only) | `unbuild` |
-| Testing   | `vitest`                             | always    |
+| Category  | Options                      | Default   |
+| --------- | ---------------------------- | --------- |
+| Linter    | `oxlint`, `eslint`, `biome`  | `oxlint`  |
+| Formatter | `oxfmt`, `prettier`, `biome` | `oxfmt`   |
+| Bundler   | `unbuild`, `tsdown`          | `unbuild` |
+| Testing   | `vitest`, `none`             | varies\*  |
+
+\*Testing defaults to `vitest` for libraries, `none` for applications (configurable via prompts).
 
 ## CLI Options
 
@@ -45,6 +96,7 @@ create-krispya [name] [options]
 Options:
   --type <type>               app | library (default: app)
   --template <type>           vanilla | react | r3f (+ -js variants)
+  --monorepo                  Create a pnpm monorepo workspace
   --linter <type>             eslint | oxlint | biome
   --formatter <type>          prettier | oxfmt | biome
   --bundler <bundler>         unbuild | tsdown (libraries only)
@@ -59,39 +111,46 @@ Options:
 For `r3f`/`r3f-js` templates:
 
 ```
---drei          @react-three/drei helpers
---handle        @react-three/handle events
---leva          leva controls
+--drei            @react-three/drei helpers
+--handle          @react-three/handle events
+--leva            leva controls
 --postprocessing  @react-three/postprocessing effects
---rapier        @react-three/rapier physics
---xr            @react-three/xr VR/AR
---uikit         @react-three/uikit UI
---offscreen     @react-three/offscreen rendering
---zustand       zustand state
---koota         koota ECS
---triplex       Triplex dev environment
---viverse       Viverse deployment
+--rapier          @react-three/rapier physics
+--xr              @react-three/xr VR/AR
+--uikit           @react-three/uikit UI
+--offscreen       @react-three/offscreen rendering
+--zustand         zustand state
+--koota           koota ECS
+--triplex         Triplex dev environment
+--viverse         Viverse deployment
 ```
 
 ## Examples
 
 ```bash
 # Interactive mode
-npm create krispya
+pnpm create krispya
 
 # React app with defaults
-npm create krispya my-app --template react -y
+pnpm create krispya my-app --template react -y
+
+# Monorepo workspace
+pnpm create krispya my-workspace --monorepo
 
 # R3F with integrations
-npm create krispya my-3d-app --template r3f --drei --rapier --leva
+pnpm create krispya my-3d-app --template r3f --drei --rapier --leva
 
 # Library with tsdown
-npm create krispya my-lib --type library --template react --bundler tsdown
+pnpm create krispya my-lib --type library --template react --bundler tsdown
 
 # Custom tooling
-npm create krispya my-app --linter eslint --formatter prettier
+pnpm create krispya my-app --linter eslint --formatter prettier
 ```
 
 ## Post-Creation
 
-After scaffolding, you'll be prompted to open the project in your editor (Cursor, VS Code, or WebStorm).
+After scaffolding:
+
+1. Install dependencies: `pnpm install`
+2. Start development: `pnpm dev`
+3. Optionally open in your editor (Cursor, VS Code, or WebStorm)