@quoreadmin/ui 1.10.23 → 1.10.25

package/README.md

@@ -4,17 +4,13 @@ This project utilizes Vue 3 with Vite & Typescript. See IDE recommendations & pr
 
 ## Project Setup
 
-We have included a .nvmrc file so we are all on the same node version.
+We have included a .nvmrc file so we are all on the same node version. This project uses pnpm as its package manager (activated via Corepack).
 
 ```
-// Get the correct version of node
-$ nvm use
-
-// Install all of the packages needed for the project
-$ npm install
-
-// Serve up on local
-$ npm run dev
+nvm use
+corepack enable
+pnpm install
+pnpm dev
 ```
 
 ## Storybook
@@ -22,27 +18,37 @@ $ npm run dev
 We have all of our components in Storybook. When making an update to a component, check Storybook to see if anything needs to be added to the component story file.
 
 ```
-// Serve up Storybook
-$ npm run storybook
+pnpm storybook
+pnpm build-storybook
+```
+
+## Testing
+
+See [TESTING_PLAN.md](TESTING_PLAN.md) for the full strategy and [TESTING_CHECKLIST.md](TESTING_CHECKLIST.md) for per-component coverage tracking.
 
-// To test static storybook site
-$ npm run build-storybook
+### Unit Tests (Vitest + Vue Test Utils)
 
-// Serve up static generated site
-npx serve storybook-static
+Component-level tests that validate props, emits, slots, and conditional rendering. Tests are co-located with their component (`*.test.ts` alongside `*.vue`).
+
+```
+pnpm test              # run all unit tests once
+pnpm test:watch        # run in watch mode during development
+pnpm test:coverage     # run with v8 coverage report
 ```
 
-## Recommended IDE Setup
+### Visual Regression Tests (Storybook Test Runner + Playwright)
 
--   [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
+Screenshots every Storybook story and diffs against committed baselines in `__visual_snapshots__/`. Catches CSS regressions, layout shifts, and unintended visual changes.
 
-### Type Support For `.vue` Imports in TS
+Requires Playwright Chromium to be installed (`pnpm dlx playwright install --with-deps chromium`) and Docker for baseline generation.
 
-TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
+```
+pnpm test:visual               # run against a running Storybook instance
+pnpm test:visual:update        # regenerate baselines locally (macOS -- not for CI baselines)
+pnpm test:visual:ci            # build Storybook, serve it, then run visual tests
+pnpm test:visual:docker-update # regenerate baselines inside Docker (matches CI)
+```
 
-If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
+**Updating baselines:** Baselines must be generated inside the same `node:24.4.1` Docker image used by CI to avoid cross-OS font rendering differences. Run `pnpm test:visual:docker-update`, then commit the updated `.png` files in `__visual_snapshots__/`. Do **not** use `pnpm test:visual:update` on macOS for baselines that will be verified in CI.
 
-1. Disable the built-in TypeScript Extension
-2. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
-3. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
-4. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
+**Reviewing failures:** Diff images are written to `__visual_snapshots__/__diff_output__/` (gitignored). In CI (Bitbucket Pipelines), diff images are exported as step artifacts and can be downloaded from the pipeline UI.