prb-effect: Instructions file for Codex

prb-effect Development Guidelines

Bun workspace of Effect 4 libraries published to npm as @prb/effect-*: evm (viem), evm-safe (Safe Apps; depends on evm), next (Next.js), solana, and xstate (xState v5). Declare shared dependency versions in the root package.json workspace catalogs and reference them with catalog: specifiers.

Prerequisites and Setup

Install Node.js v24.15+ or v26+, Bun, Just, and Ni (na, ni, nr), then run bun install at the repository root.

Commands

Root recipes:

just type-check <package>  # tsgo --noEmit in one package directory; no argument checks all packages
just tu [files]            # Unit tests across all packages (excludes *.test.integration.ts)
just ti [files]            # Integration tests, with .env decrypted by dotenvx
just full-check            # Biome, Prettier, and type checks
just full-write            # Biome and Prettier fixes
just build <package>       # Build one package; `just build-all` builds every package

Package recipes come from recipes.just. Run them inside a package directory or as just <module>::<recipe> from the root; the evm-safe module is named evm_safe (for example, just evm_safe::test-unit). In a package, just test runs unit and integration tests; use just test-unit for unit tests only.

Lint Rules

After generating code, run these commands in order. If any command fails, fix errors before continuing.

1. Biome lint — if JS/TS/JSON files changed: na biome lint <files>
2. TypeScript check — if TS files changed: just type-check <package> for one package, just type-check-all for changes across packages
3. Related tests — if test files or test-related files changed: na vitest run <test-files>; do not run the entire suite

The pre-commit hook runs lint-staged, which formats staged files with Biome (JS/TS/JSON) and Prettier (MD/YAML).