MaxMsp TypeScript Library Template

This is a template for building MaxMsp-compatible TypeScript libraries.

Table of Contents

• Getting Started
• Structure
• Publishing

Getting Started

1. Click the Use this template button on the top right of this page.
2. Clone your new repository:

   git clone https://github.com/your-username/your-repo.git
   

3. Install dependencies:

   pnpm install
   

4. Compile the code:

   pnpm build
   

5. Run tests:

   pnpm test
   

6. Initialize changesets:

   pnpm changesets init
   

Structure

This is a turborepo monorepo template with the following structure:

├── apps
│   └── maxmsp-test
└── packages
    └── my-library

• my-library: Contains your TypeScript library
• maxmsp-test: Contains an instance of this template with my-library as a dependency.

Publishing

This template uses changesets to manage versioning and changelogs, and GitHub Actions to publish new versions.

To create a new changeset:

1. Run pnpm changeset
2. Follow the prompts

When you're ready to publish to npm you can do it manually or with the GitHub Action.

Manual

To publish manually:

1. Login to npm with npm login
2. Run pnpm publish
3. Follow the prompts

GitHub Action

To publish with the GitHub Action:

1. Set up a Repository Secret named NPM_TOKEN with your npm token.
2. The publish workflow will run automatically when you push to the main branch with a changeset.
3. The GitHub Action will create a new Pull Request with the new version and changelog.
4. When you merge that Pull Request, the new version will be published to npm and released on GitHub.