Skip to content

getting-started.md

Latest commit

 

History

History
64 lines (47 loc) · 2.03 KB

getting-started.md

File metadata and controls

64 lines (47 loc) · 2.03 KB

Getting Started

Guide for new SDK contributors.

Prerequisites

  • Node.js >= 22.14.0
  • pnpm 10.28.0 (see packageManager in root package.json)
  • GPG key for commit signing (enforced by Lefthook post-commit hook)

Setup

git clone https://github.com/tailor-platform/sdk.git
cd sdk
pnpm install
pnpm exec turbo run build

Key Commands

Command Description
pnpm exec turbo run build Build all packages
pnpm exec turbo run test Run all tests
pnpm exec turbo run check Format, lint, typecheck, knip
pnpm exec turbo run generate Run code generation

In packages/sdk/:

Command Description
pnpm test Run all tests
pnpm test path/to/test.ts Run specific test file
pnpm test -t "pattern" Run tests matching pattern
pnpm build Build SDK
pnpm docs:check Verify CLI docs match commands
pnpm docs:update Regenerate CLI docs

Example App

example/ is used for development testing and CI validation.

cd example
pnpm generate        # Generate types
pnpm apply           # Deploy to platform (requires workspace)
pnpm test            # Run generator tests
pnpm test:e2e        # Run E2E tests (requires deployed workspace)

Pre-commit Hooks

Lefthook runs on every commit (see lefthook.yml):

  1. Build — Rebuild SDK if .ts files changed
  2. Format — Check formatting with oxfmt
  3. Lint — Run oxlint + ESLint
  4. Typecheck — Run tsgo
  5. Knip — Detect unused dependencies and exports

Post-commit verifies GPG signature.

To customize hooks locally, create lefthook-local.yml (gitignored).