Skip to content

README.md

Latest commit

 

History

History
64 lines (45 loc) · 1.22 KB

README.md

File metadata and controls

64 lines (45 loc) · 1.22 KB
Raw

Tailor Platform SDK

Monorepo for Tailor Platform SDK development.

Prerequisites

See package.json for required Node.js and pnpm versions.

Installation

pnpm install

Development

# Run all tests
pnpm test

# Build all packages
pnpm build

# Type checking
pnpm typecheck

# Linting
pnpm lint
pnpm lint:fix

# Format code
pnpm format
pnpm format:check

# Run all checks (build, generate, format, and every check:* script in package.json)
pnpm check

# Check CLI documentation matches command definitions
pnpm -C packages/sdk docs:check

# Update CLI documentation from command definitions
pnpm -C packages/sdk docs:update

Structure

├── packages/
│   ├── sdk/           # Main Tailor Platform SDK package
│   ├── create-sdk/    # Project scaffolding CLI
│   ├── eslint-plugin-sdk/ # Lint rules for SDK applications
│   ├── sdk-codemod/       # Codemod runner for SDK upgrades
│   └── tailor-proto/      # Protocol buffer definitions
└── example/           # Development and testing example

Release

Releases are managed by Changesets and automated through CI/CD.

# Create a changeset for your changes
pnpm changeset