Template Typescript Repository

NPM Package

Description

This is a repository I use as a base for my typescript libraries. It includes a basic setup for typescript, eslint, prettier, jest and GitHub Actions.

Feel free to use this template, clone it and use it as a base for your own projects.

Always open for feedback if you think this repo can be improved further.

Features:

• Typescript
• GitHub Actions worklows for code linting, formatting, testing and publishing to NPM

Table of Contents

• Description
• Table of Contents
• Pre-requisites
• Setup
• Development
• CI/CD
• Publishing to NPM
• Appendices
  • Appendix A: Publishing to private NPM Registry

Pre-requisites

• Node 16.5.0 or newer

Setup

• No setup required

Development

• npm run lint - Lint the code and checks types
• npm run format - Formats the code using prettier
• npm test - Compiles code and runs tests

CI/CD

This repo is setup with GitHub Actions to automatically run tests and publish the package to NPM when a new tag is pushed to the repo.

The two configured workflows are:

• CI/CD main - Runs on every commit to main
• CI/CD PR - Runs on every commit to PR

CI/CD main

Actions run:

• Code actions
  • Format Code
  • Test Code
• Bump Minor version
• Publish to NPM

Publishing to NPM

This happens automatically on every commit, which might not be ideal. Will probably change to publish when new tags are pushed to the repo in the future.

If you fork this repo you will need to create a NPM account and generate a NPM token to use for publishing. You can then add the token as a secret to your repo and update the workflow to use the secret.

CI/CD PR

Actions run:

• Code actions
  • Format Code
  • Test Code

Appendices

Appendix A: Publishing to private NPM Registry

Once you have setup your private NPM registry, you can publish your package to it by running the following command:

npm publish --registry <Your registry URL here>

To safeguard for accidentally publishing to the public NPM registry, you can add the following to your package.json, I usually do the following. Add a file pre-publish.js to the root of the project with the following content:

const RELEASE_MODE = !!process.env.RELEASE_MODE;

if (!RELEASE_MODE) {
  console.log('Run `npm run release` to publish the package');
  process.exit(1); //which terminates the publish process
}

This will enforce the RELEASE_MODE environment variable to be set to true before publishing the package.

Then add a new release to the scripts section of your package.json:

scripts: {
...,
'release': 'RELEASE_MODE=True npm run build && npm publish --registry <Your registry URL here> && git push --follow-tags',
...,
}

Then change any Github actions etc. to use npm run release instead of npm publish.