Development & Contribution

Caution

⛔️ THE WIKI IS NO LONGER USED. PLEASE VIEW THE /docs DIRECTORY FOR ANY DOCUMENTATION

We recommend working with Yalc for local package development. This package allows for local package development in a similar way that npm/yarn link works, but aims to correct a number of issues and pitfalls that those bring. Here is a basic step-by-step guide for using Yalc for local package development.

1. Install Yalc globally so it can be accessed from anywhere.

npm i yalc -g

2. Clone the build-tools repo and publish the package with Yalc (don't worry, this doesn't go anywhere near npm publish)

git clone git@github.com:bigbite/build-tools.git
cd build-tools
yalc publish

3. In your test project, add the build-tools package via Yalc - this acts as a replacement for npm i or yarn add.

yalc add @bigbite/build-tools