Typescript Monorepo Template

This template is intended for OSS (NPM published) Typescript based projects and is centered around a few tools:

• yarn for dependency management and running other tools like lerna or changeset
• lerna for running package level commands (like build or lint)
• changeset for managing changelog generation, release creation and auto publication to NPM
• codecov for code coverage reporting
• prettier for code formatting (it runs a prettier action that will fix any issue for you ✨)
• jest to test your code
• typescript as the name would have suggested

It's a template that I tend to use for my own projects like

• EAPI: a suite of middleware & utility to build scalable cloudflare workers backend/proxy
• GeocodeJSON: a suite of adapter & utility for geocoding API that maps to GeocodeJSON resutls

How to use this template

AKA: "Note to self"

• Get started by clicking Use this template
• Update the required files as described below
• Use yarn for dependencies as this template make use of Yarn Workspaces
• Browse the scripts to understand how lerna changeset and yarn play together to build test and publish releases.
• Setup integration with Changeset
• Setup integration with CodeCov
• Add the necessary SECRETS (NPM_TOKEN & CODECOV_TOKEN)

What you need to change

• package.json: change project name, author etc...
• LICENSE: change the copyright holder
• CODE_OF_CONDUCT.md: change the contact address in the Enforcement paragraph
• .github/workflows/release.yml: change the guard to your repository name
• .changeset/config.json: change the repository name

TODO

• Investigate NPM 7.6 vs Yarn v2
• Investigate esbuild

License