@viliha/vui-ui 1.5.1 → 1.5.3

package/AGENT.md

@@ -86,6 +86,47 @@ dependencies** with the package manager it detects from the lockfile (npm / pnpm
 Other flags: `--yes` / `--force` / `--dry-run`. If you only need the components, pass
 `--theme-only` (or skip `init` entirely) and follow the setup below.
 
+### Inside a Turborepo / monorepo
+
+**Never scaffold into the repo root** — a monorepo root has no `app/` and no Next
+app. Target the specific application, e.g. `apps/web`. Two equivalent ways:
+
+```bash
+# A) from the repo root, name the app dir
+npx @viliha/vui-ui init --turbo --dir apps/web
+
+# B) from inside the app (simplest to reason about)
+cd apps/web
+npx @viliha/vui-ui init
+```
+
+In turbo mode the CLI **does not auto-install** (installs are workspace-specific),
+so finish the setup yourself, scoped to that app:
+
+```bash
+cd apps/web                 # be inside the app, not the root
+pnpm add @viliha/vui-ui …   # or: pnpm --filter <app-name> add @viliha/vui-ui …
+```
+
+Then confirm the app is in your workspace globs (`pnpm-workspace.yaml` /
+`package.json` `workspaces`) and run it with a filter: `pnpm --filter <app-name>
+dev`. The theme import, `transpilePackages`, and the `@/*` alias all belong in
+**that app's** `globals.css` / `next.config` / `tsconfig`, not the root.
+
+### End-to-end walkthroughs
+
+- **New standalone app** — `npx create-next-app@latest my-app --ts --tailwind
+  --app --no-src-dir --use-npm`, then `cd my-app && npx @viliha/vui-ui init`
+  (fresh + prebuilt). It scaffolds config + shell + demo, installs deps, and you
+  run `npm run dev` → `/dashboard`.
+- **New app in a monorepo** — scaffold your app under `apps/<name>` (e.g. with
+  `create-next-app`), then from that app dir run `npx @viliha/vui-ui init` (or
+  `--turbo --dir apps/<name>` from the root) and install deps in that app.
+- **Existing app** — run `npx @viliha/vui-ui init --existing`. It never
+  overwrites your config; wire up the four things it prints (`transpilePackages`,
+  the `theme.css` import, the `@/*` alias, `import "./globals.css"`). Prefer only
+  the components? Use `--theme-only` (copies nothing) and follow the setup below.
+
 VUI ships as TypeScript source.
 
 ## Next.js
@@ -109,6 +150,35 @@ Import the theme once. No extra transpilation needed.
 
 ---
 
+# Upgrading
+
+When you bump `@viliha/vui-ui`, follow these steps — the package version and the
+scaffolded files in the repo are two separate things.
+
+1. **Read the [CHANGELOG](./CHANGELOG.md) for the target version.** Note anything
+   under *Removed*, *Changed*, or *Breaking*, and any new peer dependency. The
+   project follows semver: patch/minor are backward-compatible, major may break.
+2. **Bump and install** with the project's package manager:
+   ```bash
+   npm i @viliha/vui-ui@latest      # or: pnpm up, yarn up, bun update
+   ```
+   In a monorepo, install in the specific app (or with a workspace filter, e.g.
+   `pnpm --filter <app> up @viliha/vui-ui`), never at the repo root.
+3. **No rebuild needed.** The package ships TypeScript source, so there's no
+   build/dts step — just restart the dev server. If a new version adds a peer
+   dependency, install it (the CHANGELOG and the "Module not found" error name it).
+4. **Scaffolded files are yours.** `init` copies the shell and demo pages into
+   the repo once; upgrading the package does **not** touch them. To pull
+   scaffolder improvements into an existing project, preview first with
+   `npx @viliha/vui-ui@latest init --dry-run`, then re-run with `--force` (commit
+   or stash your work first so you can review the diff) or copy in just the files
+   you want.
+5. **Re-check token overrides.** If you overrode any `theme.css` tokens, confirm
+   they still line up after the upgrade.
+6. **Verify** before you commit: run type-check, lint, and build.
+
+---
+
 # Design Tokens
 
 VUI is entirely token-driven. Never hardcode colors, spacing, radius, typography, shadows, or borders — reach for the semantic design token instead. For example: `--button-primary`, `--button-primary-hover`, `--background`, `--foreground`, `--border`, `--ring`, `--chart-1`, `--sidebar-primary`.

package/CHANGELOG.md

@@ -0,0 +1,107 @@
+# Changelog
+
+All notable changes to `@viliha/vui-ui` are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/), and the project uses
+[semantic versioning](https://semver.org/): **patch** for fixes, **minor** for
+backward-compatible features, **major** for breaking changes.
+
+To upgrade, see [Upgrading](./AGENT.md#upgrading) in the agent guide.
+
+## 1.5.3 — 2026-07-24
+
+### Added
+
+- The changelog and the **[Upgrading](./AGENT.md#upgrading)** guide now ship in
+  the npm package. (They were authored for 1.5.2 but missed that tarball, which
+  was published a moment before.)
+
+## 1.5.2 — 2026-07-24
+
+### Changed
+
+- **Turborepo guidance throughout.** `init`'s monorepo note now walks you through
+  `cd`-ing into the target app (e.g. `apps/web`), installing deps in that app (or
+  via a workspace filter), checking workspace globs, and running with a filter —
+  and states clearly that turbo mode does not auto-install.
+- **Fuller `AGENT.md`.** Added an "Inside a Turborepo / monorepo" section and
+  end-to-end walkthroughs for new-standalone, new-in-monorepo, and existing apps.
+
+## 1.5.1 — 2026-07-24
+
+### Changed
+
+- Rewrote the README and `AGENT.md` prose to a clearer, more natural voice. No
+  API changes.
+
+## 1.5.0 — 2026-07-24
+
+### Added
+
+- **`init` installs dependencies for you**, using the package manager it detects
+  from your lockfile (npm, pnpm, yarn, or bun). It prompts first; `--yes` skips
+  the prompt and `--no-install` opts out. This ends the "Module not found"
+  cascade from running `dev` before installing peers.
+
+## 1.4.3 — 2026-07-24
+
+### Fixed
+
+- The scaffolded `globals.css` no longer imports `tw-animate-css`, so the theme
+  is self-contained and needs no extra CSS dependency (VUI's own animations live
+  in `theme.css`).
+
+## 1.4.1 — 2026-07-24
+
+### Added
+
+- **Turborepo support in `init`** (`--turbo` + `--dir`) — scaffolds into a target
+  app directory.
+- A `tsconfig.json` in the scaffold (`@/*` → `./*`) so the shell's imports
+  resolve, and a TypeScript `next.config.ts` (so a fresh scaffold overwrites
+  create-next-app's config instead of leaving two).
+
+### Fixed
+
+- Scaffolding into a fresh Next.js app now works end to end.
+- Pinned a patched `postcss` (`^8.5.12`) via pnpm overrides to clear a
+  high-severity advisory (GHSA-6g55-p6wh-862q).
+
+> 1.4.1 shipped `next.config.mjs` and 1.4.2 was an interim republish; use **1.4.3
+> or later**, which ship `next.config.ts` and the self-contained theme.
+
+## 1.4.0 — 2026-07-24
+
+### Added
+
+- **`init` decision tree**: fresh vs. existing project, and pre-built (shell +
+  demo) vs. theme-only (`--fresh`/`--existing`, `--prebuilt`/`--theme-only`).
+
+## 1.3.0 — 2026-07-24
+
+### Added
+
+- **`RecordFormPanel`** — the standard Add/Edit/View slide-over as a standalone
+  export, for use outside a table (e.g. a Kanban board).
+- `RecordField` gains an `input` type (`number`/`date`) and renders a `Select`
+  for `options` fields in the Add/Edit form.
+
+## 1.2.0 — 2026-07-23
+
+### Added
+
+- **`npx @viliha/vui-ui init`** — a scaffolder that copies the app shell (layout,
+  sidebar, open tabs, command palette, nav config, logo) and demo pages into your
+  repo. Ships a `bin` and a bundled `template/` regenerated from the reference app
+  on publish.
+- Navigation & open-tabs documentation.
+
+## 1.1.8 — 2026-07-23
+
+### Fixed
+
+- The slide-over record form auto-sizes its width to the content, so long field
+  labels no longer wrap or overflow.
+
+## 1.1.7 — 2026-07-23
+
+Baseline release.

package/README.md

@@ -109,6 +109,26 @@ cd my-app && bunx @viliha/vui-ui init && bun dev
 the demo pages, overwriting the create-next-app boilerplate, and installs the
 dependencies. The demo then runs out of the box at `/dashboard`.
 
+### Turborepo / monorepo
+
+Scaffold **inside the target app** (e.g. `apps/web`), never at the repo root —
+the root has no `app/` and no Next.js app. Run `init` from the app, or name it
+from the root with `--dir`:
+
+```bash
+# from inside the app (simplest)
+cd apps/web && npx @viliha/vui-ui init
+
+# …or from the repo root
+npx @viliha/vui-ui init --turbo --dir apps/web
+```
+
+In monorepo mode `init` does **not** auto-install (installs are
+workspace-specific), so add the deps to that app afterward — `cd apps/web && pnpm
+add @viliha/vui-ui …`, or from the root `pnpm --filter web add @viliha/vui-ui …`.
+The `transpilePackages` entry, the `theme.css` import, and the `@/*` alias all
+belong to **that app**, not the root.
+
 ### ⚠️ Existing project — read this first
 
 Adding VUI to an app you already have takes a little care. **`init --existing`

package/bin/vui.mjs

@@ -306,11 +306,17 @@ The shell + demo were added under app/(app)/ and app/_components/ — review the
   }
 
   if (turbo) {
-    console.log(`Turborepo notes (target: ${appDir}):
-  • Add the deps to that app: ${ADD_CMD[pm]} ${installList}
-    (from the app dir, or with your PM's workspace filter).
-  • Ensure your workspace globs include this app (pnpm-workspace.yaml / workspaces).
-  • Run dev with a filter, e.g. ${pm} --filter <app-name> dev
+    console.log(`Turborepo — finish inside the target app (${appDir}):
+  1. cd ${appDir}
+  2. Install the deps in THIS app (not the repo root):
+       ${ADD_CMD[pm]} ${installList}
+     (or from the root with your workspace filter, e.g.
+       ${pm} --filter <app-name> add ${installList})
+  3. Make sure your workspace globs include this app
+     (pnpm-workspace.yaml \`packages:\` or package.json \`workspaces\`).
+  4. Run it: ${pm} --filter <app-name> dev   (or \`cd ${appDir} && ${pm} dev\`)
+
+Deps were NOT auto-installed for a monorepo — installs are workspace-specific.
 `);
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@viliha/vui-ui",
-  "version": "1.5.1",
+  "version": "1.5.3",
   "description": "Vui UI — a clean, token-driven React admin/CRM component library built on Tailwind CSS v4, shadcn-style patterns, and Radix Icons. Ships as TypeScript source (Just-in-Time), compiled by the consuming app.",
   "license": "MIT",
   "author": "Suman Bonakurthi",
@@ -36,6 +36,7 @@
     "bin",
     "template",
     "AGENT.md",
+    "CHANGELOG.md",
     "CLAUDE.template.md"
   ],
   "bin": {