zidane-gui 8.0.4 → 8.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -4,7 +4,7 @@
4
4
  <img src="resources/icon.png" alt="Zizou" width="500" />
5
5
  </p>
6
6
 
7
- Standalone Electron app — a Claude Code-style chat shell using `zidane`.
7
+ Standalone Electron app. It is a Claude Code-style chat shell that uses `zidane`.
8
8
 
9
9
  ## Install
10
10
 
@@ -12,15 +12,15 @@ Standalone Electron app — a Claude Code-style chat shell using `zidane`.
12
12
  npm install -g zidane-gui
13
13
  ```
14
14
 
15
- A global install also registers a launcher app — `~/Applications/Zidane.app`
16
- on macOS (Spotlight, Raycast, Launchpad), a `.desktop` entry on Linux — via
17
- postinstall. If you installed with `--ignore-scripts` or as root, run
18
- `zidane-gui install-app` as your regular user. Plain `zidane-gui` launches
19
- the GUI from a terminal.
15
+ A global install also registers a launcher app via postinstall. On macOS
16
+ the launcher is `~/Applications/Zidane.app` (Spotlight, Raycast,
17
+ Launchpad). On Linux it is a `.desktop` entry. If you installed with
18
+ `--ignore-scripts` or as root, run `zidane-gui install-app` as your regular
19
+ user. Plain `zidane-gui` launches the GUI from a terminal.
20
20
 
21
- **Uninstalling:** npm ≥ 7 does not run `preuninstall` scripts, so remove the
22
- launcher app _before_ removing the package — otherwise it lingers in your
23
- launcher pointing at a deleted install:
21
+ To uninstall, remove the launcher app before you remove the package. npm 7
22
+ and later does not run `preuninstall` scripts. So if you remove the package
23
+ first, the app stays in your launcher and points at a deleted install:
24
24
 
25
25
  ```sh
26
26
  zidane-gui uninstall-app
@@ -34,43 +34,43 @@ bun install # from the monorepo root — gui is a workspace member
34
34
  bun --cwd=gui run dev
35
35
  ```
36
36
 
37
- Renderer runs on `http://localhost:21200` (loaded into the Electron window automatically).
37
+ The renderer runs on `http://localhost:21200`. Electron loads it into the window automatically.
38
38
 
39
39
  ## Scripts
40
40
 
41
- Run from `gui/` (or via `bun --cwd=gui run <script>` from the root).
41
+ Run these from `gui/`, or run `bun --cwd=gui run <script>` from the root.
42
42
 
43
- - `bun run dev` — electron-vite dev server with HMR
44
- - `bun run build` — bundle main / preload / renderer into `out/`
45
- - `bun run start` — preview a built bundle (`electron-vite preview`)
46
- - `bun run typecheck` — `tsc --noEmit` on both node and web projects
47
- - `bun run test` — vitest unit suite (pure logic — pairing, collapse, rehydrator, attachment ingest)
48
- - `bun run test:watch` — vitest in watch mode
49
- - `bun run test:e2e` — Playwright end-to-end (runs `build` first)
50
- - `bun run test:visual` — Playwright visual regression suite
43
+ - `bun run dev` starts the electron-vite dev server with HMR.
44
+ - `bun run build` bundles main, preload and renderer into `out/`.
45
+ - `bun run start` previews a built bundle (`electron-vite preview`).
46
+ - `bun run typecheck` runs `tsc --noEmit` on both node and web projects.
47
+ - `bun run test` runs the vitest unit suite. It covers pure logic: pairing, collapse, rehydrator and attachment ingest.
48
+ - `bun run test:watch` runs vitest in watch mode.
49
+ - `bun run test:e2e` runs Playwright end-to-end tests. It runs `build` first.
50
+ - `bun run test:visual` runs the Playwright visual regression suite.
51
51
 
52
52
  ## Stack
53
53
 
54
- - Electron 41 + electron-vite 5 (Vite 7 under the hood)
54
+ - Electron 41 and electron-vite 5 (which uses Vite 7)
55
55
  - React 19 renderer, UnoCSS for styling
56
56
  - TipTap 3 for the chatbox editor
57
57
  - Shiki 4 for syntax highlighting
58
- - `react-markdown` 10 + `remark-gfm` for transcript rendering
58
+ - `react-markdown` 10 and `remark-gfm` for transcript rendering
59
59
  - Radix `@radix-ui/react-tooltip` for tooltips
60
60
  - TypeScript 6
61
- - SQLite via Electron's built-in `node:sqlite` (no native modules) at `app.getPath('userData')/zidane-gui.db`
61
+ - SQLite through Electron's built-in `node:sqlite` (no native modules), stored at `app.getPath('userData')/zidane-gui.db`
62
62
  - Numbered SQL migrations in `migrations/` applied at startup
63
- - Vitest 4 for unit tests on pure logic (no Electron / no React mount)
63
+ - Vitest 4 for unit tests on pure logic (no Electron and no React mount)
64
64
 
65
65
  ## Notes
66
66
 
67
- - `vite` is held at v7 (latest v8 isn't yet supported by `electron-vite`).
68
- - `@vitejs/plugin-react` is held at v5 for the same reason — v6 requires Vite 8.
69
- - This package lives in the `zidane` monorepo as the `gui/` bun workspace and consumes the in-repo `zidane` via `file:..` (build it with `bun run build` at the root first if `dist/` is stale).
70
- - No native modules — SQLite is Electron's built-in `node:sqlite`, so there is no ABI rebuild step. `trustedDependencies` (`electron`, `esbuild`) lets bun run their build scripts.
67
+ - `vite` is held at v7. The latest v8 is not yet supported by `electron-vite`.
68
+ - `@vitejs/plugin-react` is held at v5 for the same reason. v6 requires Vite 8.
69
+ - This package lives in the `zidane` monorepo as the `gui/` bun workspace. It consumes the in-repo `zidane` via `file:..`. If `dist/` is stale, run `bun run build` at the root first.
70
+ - There are no native modules. SQLite is Electron's built-in `node:sqlite`, so there is no ABI rebuild step. `trustedDependencies` (`electron`, `esbuild`) lets bun run their build scripts.
71
71
 
72
72
  ## v1 scope
73
73
 
74
74
  - Per-chat working folder (chosen before first send, remembered across launches)
75
- - Flat sidebar of chats sorted by `updated_at DESC`, rename + delete inline
76
- - Chatbox in the center; chat result rendering is intentionally deferred
75
+ - Flat sidebar of chats sorted by `updated_at DESC`, rename and delete inline
76
+ - Chatbox in the center. Chat result rendering is intentionally deferred.