Skip to content

Development Workflow

Christophe Babilotte edited this page Dec 6, 2025 · 1 revision

Development Workflow

Core scripts (Yarn)

  • yarn dev – run electron-vite (main, preload, renderer in watch mode)
  • yarn dev:electron – watch only Electron processes
  • yarn build – production bundle
  • yarn pack – electron-builder pack (no publish)
  • yarn lint – ESLint over src/**/*.{ts,tsx}
  • yarn typechecktsc --project tsconfig.tests.json --noEmit (includes tests)
  • yarn format – Prettier over the repo
  • yarn test – Vitest suite
  • yarn test:watch – Vitest in watch mode

Coding standards

  • TypeScript, strict mode, ESM ("type": "module").
  • Paths aliases: @main, @preload, @renderer, @shared.
  • UI: React + Tailwind; keep components small and typed.
  • Avoid Node globals in renderer; use preload APIs.

Linting & type safety

  • Run yarn lint and yarn typecheck before commits.
  • Tests are type-checked via tsconfig.tests.json.

Testing

  • Unit/UI tests: Vitest + Testing Library (jsdom).
  • Coverage via V8: yarn test -- --coverage.
  • See Testing-and-Quality for details.

Formatting

  • Prettier enforced via yarn format.

Data sources

Clone this wiki locally