Skip to content

Latest commit

 

History

History
97 lines (79 loc) · 2.51 KB

commands.md

File metadata and controls

97 lines (79 loc) · 2.51 KB

Command Quick Reference

Root-Level Commands (run from repository root)

Installation & Setup

pnpm install           # Install all dependencies

Testing

pnpm test              # Run all tests (all packages + schema-to-ts)
pnpm smoke-test        # Run smoke tests (cli, core, schema only)
pnpm validate          # Full validation (test + smoke-test + lint)

Code Quality

pnpm lint              # Lint all packages
pnpm lint:fix          # Fix linting issues

Build & Release

pnpm generate-types    # Generate TypeScript declarations
pnpm bump     # Bump versions across packages

Package-Specific Commands (cd into package first)

CLI (packages/cli/)

pnpm test              # Unit tests
pnpm smoke-test        # Smoke tests  
pnpm validate          # test + smoke-test + lint

Core (packages/core/)

pnpm main-tests        # Unit tests only
pnpm type-tests        # TypeScript definition tests
pnpm test              # main-tests + solo test + type-tests
pnpm integration-test  # Integration tests
pnpm smoke-test        # Smoke tests
pnpm validate          # Full validation

Schema (packages/schema/)

pnpm test              # Unit tests
pnpm smoke-test        # Smoke tests
pnpm validate          # test + smoke-test + lint

Schema-to-ts (schema-to-ts/)

pnpm test              # Uses vitest (not mocha)

Development Workflow Tips

  • Individual package testing: Always cd into package directory first
  • Full validation: Use pnpm validate at root for comprehensive checking
  • Focused testing: Use .only in Mocha for specific test cases
  • TypeScript types: Generated automatically via husky precommit hooks

Package Linking for Integration Development

When developing integrations, you may want to link to your local development versions of core and schema instead of the published npm packages.

Setup Links

# Register the packages for linking
cd packages/core && pnpm link
cd packages/schema && pnpm link

Use in Integration Project

# In your integration project directory
pnpm link zapier-platform-core
pnpm link zapier-platform-schema

Verify Linking

# Check that packages are symlinked
ls -hl node_modules/zapier-platform-*
# Should show: node_modules/zapier-platform-core -> .../pnpm/global/5/node_modules/zapier-platform-core

Unlink

# Return to npm packages
pnpm unlink zapier-platform-core
pnpm unlink zapier-platform-schema