@crvy/rprtr 0.0.3

package/CHANGELOG.md

@@ -0,0 +1,95 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.0.3] - 2026-04-10
+
+### Fixed
+
+- Update repository URLs to match renamed GitHub repo
+## [0.0.2] - 2026-04-10
+## [0.0.1] - 2026-04-10
+
+### Added
+
+- Migrate UI from React to Svelte 5
+- **reporter:** Implement offline mode for reporter
+- **server:** Add offline report loading on startup
+- Migrate React client to Svelte 5 with Tailwind CSS v4
+- Improve server logging and add new view components
+- Approve without page reload, update local state optimistically
+- Rework slide view with per-side card frames and clip-path clipping
+- Attach baseline screenshots for passing toHaveScreenshot tests
+- Extract startServer function, add CLI entry point, fix static asset paths
+- Build pipeline produces reporter, server, CLI, and type declarations
+- Configure package.json for npm publishing
+- Add live UI updates and Git LFS for screenshots
+- Add packaged offline reporter UI
+
+### Changed
+
+- Consolidate into single package, fix Svelte build
+- Remove CreeveyContext dependency, use local state for suite UI
+- Replace Storybook naming with Playwright conventions
+- Fix all lint errors, add zod schemas, modularize codebase
+- Make CreeveySuite children optional and add helper functions
+- Rename reporter to crvy rprtr
+- Rename offline report files to shorter pattern
+
+### Documentation
+
+- Add offline mode documentation
+- Rewrite README for package consumers
+
+### Fixed
+
+- Reporter WS queuing, treeify path, attachments→images mapping
+- Type data field in OfflineEvent for type safety
+- Address race condition and offline event persistence issues
+- Correct assertion logic and rename misleading test
+- Use fs/promises.writeFile instead of Bun.write in reporter
+- Remove unused import and document offline mode limitations
+- UI/UX polish — accessibility, responsive, visual design, build warning
+- UI/UX polish — layout, accessibility, contrast, focus, counters
+- Use CSS grid stacking in SwapView to fix image size mismatch
+- Correct approve navigation, status update, baseline copy, and view fallback
+- Update test selectors and refresh screenshot baselines
+- Show successful screenshot tests in sidebar
+- Show passing screenshot tests in report UI
+- Remove stale tests on run-end and fix diff count log
+- Remove incorrect baseline snapshot association and preserve images correctly
+- Attach passing baseline as expected, not actual
+- Reset approved flag when test fails with new diffs
+- Show passing screenshot baselines after rerun
+- Attach baselines for passing toHaveScreenshot tests via reporter
+- Address publint and arethetypeswrong findings
+- Use p-limit for concurrent file operations and fix eqeqeq errors
+- Stabilize bun tests and offline fallback
+- Resolve dist paths relative to test file in runtime-smoke tests
+- Treat oxfmt exit code 2 as success in staged checks
+
+### Miscellaneous
+
+- Add MIT LICENSE
+- Add advanced linting and code quality tools from papai
+- Exclude CHANGELOG.md from oxfmt formatting
+
+### Styling
+
+- Format README, package.json, and tsconfig.build.json
+
+### Testing
+
+- Add offline mode tests
+- Rewrite offline tests with meaningful behavior validation
+- Add matrix CI integration test with worker-specific offline reports
+- Remove offline report files test
+
+### Ci
+
+- Add GitHub Actions workflow for automated checks
+## [Unreleased]
+# test

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Crvy Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,130 @@
+# @crvy/rprtr
+
+Playwright reporter with a visual regression UI for comparing and approving screenshot test diffs.
+
+> **Pronunciation:** `crvy` sounds like "creevey," not "curvy."
+
+## Installation
+
+```bash
+npm install --save-dev @crvy/rprtr
+```
+
+> **Requires:** Playwright ≥1.40, plus **Node 22+ or Bun** for the live UI server/CLI. You can install the package with npm, pnpm, yarn, or Bun.
+
+## Setup
+
+Add the reporter to your `playwright.config.ts`:
+
+```ts
+import { defineConfig } from '@playwright/test'
+
+export default defineConfig({
+  reporter: [['@crvy/rprtr', { screenshotDir: './screenshots' }]],
+})
+```
+
+## Viewing Results
+
+Start the UI server to view and approve screenshot diffs:
+
+```bash
+npx crvy-rprtr
+```
+
+Other package-manager launchers work too: `pnpm dlx crvy-rprtr`, `yarn dlx crvy-rprtr`, and `bunx crvy-rprtr`.
+
+Open http://localhost:3000 in your browser.
+
+Every test run also writes a browser-openable static artifact:
+
+- `./crvy-rprtr.html`
+
+Open `crvy-rprtr.html` directly from CI artifacts or your filesystem to review results without starting a server. The static artifact is self-contained except for screenshot image files, and it is read-only; use the server-backed UI to approve screenshots.
+
+To open downloaded CI artifacts with the full approval UI, point the CLI at the artifact directory:
+
+```bash
+npx crvy-rprtr ./artifacts
+```
+
+## Reporter Options
+
+| Option              | Type     | Default                        | Description                                        |
+| ------------------- | -------- | ------------------------------ | -------------------------------------------------- |
+| `serverUrl`         | `string` | `"ws://localhost:3000"`        | WebSocket URL of the Crvy Rprtr server             |
+| `screenshotDir`     | `string` | `"./screenshots"`              | Directory for saving screenshot artifacts          |
+| `offlineReportPath` | `string` | `"./crvy-rprtr-{worker}.json"` | Path for offline report when server is unavailable |
+| `reportHtmlPath`    | `string` | `"./crvy-rprtr.html"`          | Path for the browser-openable static report HTML   |
+
+## Server CLI Options
+
+```bash
+npx crvy-rprtr [artifact-dir] [options]
+```
+
+If `artifact-dir` is provided, the CLI treats it as the directory containing:
+
+- `report.json`
+- `screenshots/`
+- `crvy-rprtr-*.json`
+
+Explicit flags override the paths derived from `artifact-dir`.
+
+| Option             | Short | Default         | Description                                                                               |
+| ------------------ | ----- | --------------- | ----------------------------------------------------------------------------------------- |
+| `--port`           | `-p`  | `3000`          | Server port                                                                               |
+| `--screenshot-dir` | `-s`  | `./screenshots` | Screenshot directory path                                                                 |
+| `--report-path`    | `-r`  | `./report.json` | Report JSON file path or directory containing `report.json` and `crvy-rprtr-*.json` files |
+
+## How It Works
+
+1. **During test runs:** The Playwright reporter sends test results to the server via WebSocket in real-time and records the same run for artifact export.
+2. **After tests complete:** A static `crvy-rprtr.html` artifact is written for direct browser viewing, and offline report JSON is also written if the server was unavailable.
+3. **In the browser:** The UI shows all screenshot tests with side-by-side, swap, slide, and blend diff views.
+4. **Approving changes:** Start the UI server and click "Approve" to accept a new screenshot as the baseline. The server copies the actual image to the expected snapshot location.
+
+## Offline Mode
+
+When the server isn't running during tests, the reporter automatically falls back to offline mode:
+
+- Test events are queued in memory
+- On test completion, events are written to `crvy-rprtr-{index}.json`
+- On test completion, a self-contained `crvy-rprtr.html` is written for direct browser review
+- When the server starts, it loads and merges all `crvy-rprtr-*.json` files from the offline report directory
+
+## Programmatic API
+
+```ts
+import { startServer } from '@crvy/rprtr/server'
+
+// reportPath can be a directory (will use report.json inside)
+await startServer({
+  port: 3000,
+  screenshotDir: './screenshots',
+  reportPath: './artifacts',
+})
+
+// Or a specific file path
+await startServer({
+  port: 3000,
+  screenshotDir: './screenshots',
+  reportPath: './artifacts/report.json',
+})
+```
+
+The programmatic server API works in both Node 22+ and Bun.
+
+## Development
+
+```bash
+bun install
+bun run dev      # Start dev server with HMR
+bun run build    # Build for production
+bun run test     # Run tests
+bun run lint     # Lint with oxlint
+```
+
+## License
+
+MIT