create-krispya 0.5.3 → 0.6.0

package/README.md

@@ -19,6 +19,7 @@ yarn create krispya
 - **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
+- **Config strategy** — Choose between stealth (`.config/`) or root placement
 
 ## Project Types
 
@@ -46,7 +47,8 @@ yarn create krispya
 Generate a monorepo with shared configuration packages:
 
 ```bash
-pnpm create krispya my-workspace --monorepo
+pnpm create krispya
+# Select "Monorepo" when prompted for project type
 ```
 
 This creates:
@@ -113,18 +115,68 @@ if pnpm create krispya --check; then
 fi
 ```
 
-### AI Instruction Files
+### Updating a Workspace
+
+Update an existing monorepo to the latest template:
+
+```bash
+pnpm create krispya --update
+```
+
+This compares your workspace against the latest template and offers to:
+
+- Add new files (AI instructions, VS Code settings, etc.)
+- Update config packages to latest versions
+- Merge workspace config changes
+
+Files are grouped by category. For each category with changes:
+
+- `+` indicates new files (safe to add)
+- `~` indicates changed files (will overwrite your customizations)
+
+Use `--yes` for non-interactive mode (adds new files only, skips modified).
+
+### Migrating Linter/Formatter
+
+Switch between linters or formatters:
+
+```bash
+# Migrate linter
+pnpm create krispya --update --linter eslint
+
+# Migrate formatter
+pnpm create krispya --update --formatter prettier
+
+# Migrate both
+pnpm create krispya --update --linter biome --formatter biome
+```
+
+Migration automatically:
+
+- Removes old config packages (e.g., `.config/oxlint/`)
+- Generates new config packages (e.g., `.config/eslint/`)
+- Updates root `package.json` (devDependencies, scripts)
+- Updates all sub-package devDependencies
+- Regenerates VS Code settings and AI files
+
+Run `pnpm install` after migration to update dependencies.
+
+### AI Rules
 
-When creating a monorepo, you can generate AI instruction files to help AI assistants understand the workspace:
+Optionally generate AI instruction files to help coding assistants understand the project:
 
-| File                              | Tool                    |
-| --------------------------------- | ----------------------- |
-| `.cursor/rules`                   | Cursor                  |
-| `AGENTS.md`                       | GitHub Copilot, general |
-| `CLAUDE.md`                       | Claude                  |
-| `.github/copilot-instructions.md` | GitHub Copilot          |
+| File        | Supported by                      |
+| ----------- | --------------------------------- |
+| `AGENTS.md` | OpenAI, Cursor, Windsurf, Copilot |
+| `CLAUDE.md` | Claude Code                       |
 
-Select which files to generate during monorepo creation. Your selection can be saved as a default.
+These are pointer files that reference `.ai/workspace.md`, which contains:
+
+- Project type and tooling (linter, formatter, package manager)
+- Common commands (`pnpm test`, `pnpm build`, etc.)
+- Project structure documentation
+
+Select which files to generate during project creation. Your selection can be saved as a default.
 
 ## Tooling Options
 
@@ -137,6 +189,50 @@ Select which files to generate during monorepo creation. Your selection can be s
 
 \*Testing defaults to `vitest` for libraries, `none` for applications (configurable via prompts).
 
+## Config Strategy
+
+Control where configuration files are placed in single-package projects:
+
+| Strategy  | Description                                    |
+| --------- | ---------------------------------------------- |
+| `stealth` | Configs in `.config/` directory (default)      |
+| `root`    | Configs at project root (traditional approach) |
+
+**Stealth mode** keeps your project root clean:
+
+```
+my-project/
+├── .config/
+│   ├── oxlint.json
+│   ├── prettier.json
+│   ├── tsconfig.app.json
+│   └── tsconfig.node.json
+├── src/
+├── package.json
+└── tsconfig.json
+```
+
+**Root mode** uses traditional config placement:
+
+```
+my-project/
+├── src/
+├── oxlint.json
+├── .prettierrc
+├── tsconfig.json
+├── tsconfig.app.json
+├── tsconfig.node.json
+└── package.json
+```
+
+Set your default via the global config file (`~/.config/create-krispya/config.json`):
+
+```json
+{
+  "configStrategy": "root"
+}
+```
+
 ## CLI Options
 
 ```
@@ -161,6 +257,8 @@ Utility Options:
   --check                     Validate current monorepo workspace (exit 0/1)
   --fix                       Fix monorepo by generating missing config packages
                               (use with --linter and --formatter for non-interactive)
+  --update                    Update monorepo to latest template (add new files, update configs)
+  --yes                       Accept defaults for prompts (non-interactive mode)
   --clear-config              Clear saved preferences (editor, window reuse)
   --config-path               Print path to config file
 ```
@@ -221,6 +319,12 @@ pnpm create krispya --fix
 # Fix monorepo (non-interactive)
 pnpm create krispya --fix --linter oxlint --formatter oxfmt
 
+# Update monorepo to latest template
+pnpm create krispya --update
+
+# Update monorepo (non-interactive - adds new files only)
+pnpm create krispya --update --yes
+
 # Clear saved preferences
 pnpm create krispya --clear-config
 ```
@@ -231,7 +335,7 @@ The CLI saves preferences for:
 
 - **Editor** — Cursor, VS Code, WebStorm, or skip
 - **Window reuse** — Open in current window or new window
-- **AI files** — Which AI instruction files to generate for monorepos
+- **AI platforms** — Which AI rule files to generate (AGENTS.md, CLAUDE.md)
 
 Clear saved preferences: