Development setup

The Triggery monorepo is a pnpm workspace. The full set of commands for a clean checkout is short — if pnpm test is green, you have a working environment.

Prerequisites

Node.js ≥ 20 (LTS recommended).
pnpm ≥ 9 — enable via corepack enable && corepack prepare pnpm@latest --activate.
git with a configured signing key (optional; signed commits are recommended but not required).

A .devcontainer/ is shipped at the repo root, so you can also open the workspace in GitHub Codespaces or VS Code Dev Containers and skip the local setup entirely.

Clone and bootstrap

git clone https://github.com/triggeryjs/triggery.git
cd triggery
pnpm install
pnpm build
pnpm test

pnpm build is required before the first test run because some packages import the built output of their dependencies.

Repository layout

triggery/
├── packages/
│   ├── core/                 # Runtime + createTrigger + middleware
│   ├── react/  solid/  vue/  # Framework bindings (same API surface)
│   ├── testing/              # createTestRuntime, mockCondition, mockAction
│   ├── vite/                 # Vite plugin (auto-discovery + HMR)
│   ├── zustand/  redux/  jotai/  mobx/  reatom/  signals/  query/
│   ├── dom/  socket/
│   ├── eslint-plugin/  codemod/  cli/
│   └── devtools-redux/  devtools-bridge/  devtools-panel/
├── extensions/
│   └── chrome-devtools/      # DevTools panel extension
├── apps/
│   └── docs/                 # This site (Astro Starlight)
├── benchmarks/
│   ├── bench/core/           # Triggery dispatch hot-path
│   └── bench/vs/             # Side-by-side comparisons
├── examples/                 # Runnable Vite/Next/RN demos
├── templates/                # Starter templates for `triggery create`
└── .changeset/               # Changeset files (one per merged feature/fix)

Running the docs site

cd apps/docs
pnpm dev

The Astro dev server runs at http://localhost:4321/triggery/ (the base path matches GitHub Pages). For a production-shape preview:

pnpm --filter @triggery/docs build
pnpm --filter @triggery/docs preview

The build step also runs the link checker and i18n fallback generator — keep an eye on its tail output if you add or rename pages.

Running benchmarks

pnpm bench

The bench/vs/ suites print side-by-side ops/sec against effector / rxjs / saga / xstate / reatom / mobx. CodSpeed picks up benches in CI; locally Vitest’s bench runner is enough.

Common workflows

pnpm lint            # Biome lint
pnpm format          # Biome write
pnpm typecheck       # tsc -b
pnpm test            # full test matrix
pnpm test:coverage   # Vitest coverage (core target ≥ 95%)
pnpm changeset       # add a changeset for a PR (only for packages/* changes)

Coding standards TypeScript strict, Biome, public API conventions.

Writing tests Vitest, fakeScheduler, contract tests.

Writing docs Style guide for this site.

RFC process How to propose a public-API change.