AGENTS.md

Tech Stack

UI: React with React Router (loaders/actions pattern)
Components: React Aria Components
Desktop Shell: Electron (main + renderer processes)
Styling: TailwindCSS
Language: TypeScript
Database: NeDB (@seald-io/nedb) — embedded NoSQL
Build/Dev: Vite, npm workspaces monorepo

See package.json for current versions and .nvmrc for the Node version.

Strict Rules

No unsolicited formatting. Rely on ESLint/Prettier. Do not reformat existing code.
Strict scoping. Only modify code directly related to the prompt. Do not refactor adjacent code unless asked.

Validation Commands

Run from repo root before considering work complete:

npm run lint          # ESLint all workspaces
npm run type-check    # TypeScript check all workspaces
npm test              # Tests all workspaces (or: npm test -w packages/insomnia)

Repository Structure

packages/ insomnia/ ← Main Electron app src/ common/ ← Shared utils, settings types models/ ← Data model definitions insomnia-data/ ← Model defaults, init(), NeDB db implementation, business logic routes/ ← React Router files (clientLoader/clientAction) ui/ ← React components, hooks, insomnia-fetch.ts main/ ← Electron IPC handlers, preload.ts account/ ← Auth, session, encryption sync/ ← Git/VCS sync network/ ← Request execution engine templating/ ← Nunjucks rendering (Web Worker) insomnia-api/ ← Cloud API client insomnia-inso/ ← CLI tool insomnia-testing/ ← Test framework

Data Model Hierarchy

Organization → Project (local | remote/cloud | git-backed) → Workspace (scope: 'collection' | 'design') → Base Environment (auto-created: use models.environment.getOrCreateForParentId(workspaceId)) → Sub-Environments → Cookie Jar (auto-created) → Request Group (folders) → Request (HTTP, GraphQL, gRPC, WebSocket, Socket.IO) → Request (can be direct child of workspace) Note: A Workspace with scope: 'collection' IS the collection.

Key Patterns

Route-Based Actions: Mutations use React Router's clientAction (src/routes/).
- CRITICAL: clientAction blocks navigation. For long-running UI operations, use plain async functions instead.
Database Buffering: Always buffer bulk writes (database.bufferChangesIndefinitely(), then flushChanges()). Unbuffered writes fire UI revalidation per operation, causing severe lag.
State Management: Use Router loaders/actions and NeDB for persistent state. Use React useState/context for ephemeral UI state (No Redux/Zustand).
Electron IPC: For main↔renderer communication, define handlers in src/main/ipc/, expose in src/main/preload.ts, and update window.main in src/global.d.ts.
Templates: Nunjucks runs in a Web Worker (src/templating/). Use {{ _.variable_name }}.
Models: Follow CRUD via models.<type> (e.g., create(), update()).
HTTP Calls: Use insomniaFetch() for Insomnia backend APIs. Use plain fetch() for external/third-party APIs.
Styling: Tailwind utility classes only. Use clsx/tailwind-merge for conditionals. Use React Aria for interactive HTML elements.
Testing: Use Vitest (unit) and Playwright (E2E). Co-locate unit tests as filename.test.ts. Use vi.mock(). Prefer testing logic via loaders over mounting components.

Sensitive Data

Vault system (AES-GCM): For environment secrets (EnvironmentKvPairDataType.SECRET).
Electron safeStorage: Platform-native encryption (window.main.secretStorage).

3.8 KiB Raw Permalink Blame History