choreography-ts

Choreographic Programming in TypeScript

Repository Structure

This repository is a monorepo managed with pnpm workspace. It contains the following packages:

• @choreography-ts/core: Core library for choreographic programming.
• @choreography-ts/eslint-plugin-choreography-ts: ESLint plugin for choreography-ts.
• @choreography-ts/examples: Example projects demonstrating the usage of choreography-ts.
• @choreography-ts/transport-express: Express (HTTP) transport layer for choreography-ts.
• @choreography-ts/transport-socketio: Socket.IO transport layer for choreography-ts.

Development

Requirements

You will need Node.js (v18+) and pnpm (v8) installed.

Setup

This repository is a monorepo managed with pnpm workspace.

To install dependencies, run:

pnpm install

Building & Testing

We use turborepo as a build system. To build all packages, run:

pnpm build

at the root of the repository. Similarly, to run all tests, run:

pnpm test

Linting & Formatting

We use ESLint and Prettier to lint and format our code. To lint all packages, run:

pnpm check