@ailo/typescript-library-starter

This template library provides all the setup you need to create a new Ailo TypeScript library using all of our processes and best practices, e.g. our ESLint config, automatic deployments to buildkite, dependabot and PAT scanning, etc.

The template itself is maintained by Magma --- if you see anything that's out-of-date, please let us know, or create a PR to improve it!

Creating a new library

To start a new library (@ailo/new-awesome-library):

1. Create a ailohq/YOUR_LIBRARYS_NAME repo on GH. (And add permissions to the ailohq/core-team). The easiest way is do this via the GitHub UI and select this repo as a template, or in the terminal:

git clone git@github.com:ailohq/typescript-starter.git YOUR_LIBRARYS_NAME
cd YOUR_LIBRARYS_NAME
git remote rm origin
git remote add origin git@github.com:ailohq/YOUR_LIBRARYS_NAME.git

2. Add the repository to #ailo-code-activity Slack channel, so that the team can track commits pushed to remote by other people. The command is: /github subscribe ailohq/YOUR_LIBRARYS_NAME
3. Search everywhere in the repo for typescript-starter, and replace with your new library's name, e.g. YOUR_LIBRARYS_NAME from above.
4. Search everywhere in the repo for magma (case insensitive), and replace with your team name.
5. Remove existing src/** files and add your own ones.
6. Remove @ailo/ailorn from package.json dependencies, unless you actually need it --- it's added here just as an example of a dependancy.
7. Replace this description here with something meaningful --- for example, with description and a usage example of your library.

Development

yarn
yarn start

Testing

yarn lint # prettier and eslint
yarn test # unit tests
yarn test:watch # unit tests in watch mode
yarn validate # run linters, tests and build

Releasing

Buildkite automatically releases to the next patch version once changes are merged into master.