JACDAC TypeScript

This repository contains a TypeScript/JavaScript client library for the JACDAC protocol.

• User Documentation

The rest of this page is meant developing the jacdac-ts library.

Devevelop setup

Setup

• run npm install

Build watch

You can do npm run start to watch/build bundles

Commits create releases

The releases are automatically created by the build system based on the title of the commit:

• patch|fix:... patch
• minor:feature:... minor

NPM scripts

• npm t: Run test suite
• npm start: Run npm run build in watch mode
• npm run test:watch: Run test suite in interactive watch mode
• npm run test:prod: Run linting and generate coverage
• npm run build: Generate bundles and typings, create docs
• npm run lint: Lints code

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.