Template: Typescript NPM Module

This is a template repository which you can use to quickly bootstrap your own NPM module.

Features

• Static Typing: Uses TypeScript for improved type safety and a better developer experience
• Testing: Pre-configured Jest setup for writing and running unit tests efficiently
• Linting: Leverages ESLint to catch potential bugs and enforce coding standards
• Auto-Formatting: Ensures consistent code style with automated formatting using Prettier
• Continuous Integration (CI): Pre-configured Github Actions for linting, testing, building, and formatting in CI environments
• Git Hooks: Husky-managed Git hooks to run scripts before commits, pushes, and other Git actions, ensuring code quality
• Semantic Release: Automates versioning and package publishing via Semantic Release

Table of Content

• Quick Start
• Tools
  • Typescript
  • Jest
  • ESLint
  • Prettier
  • Github Actions
  • Husky
  • Semantic Release

Quick Start

1. Clone the template

The fastest way is to use Github CLI:

# Create a new repository using a template and clone it
gh repo create new-repo-name --template serohman/npm-typescript-module
gh repo clone new-repo-name

Or go thorugh the official guide on creating templates.

2. Set Up NPM Authentication

You need to generate an NPM access token and save it as a Github Action Secret, under the key name NPM_TOKEN

gh secret set NPM_TOKEN
# A prompt for entering the token will appear

3. Instal dependencies

npm install

4. Update package.json

Open package.json and replace all occurrences of <TODO> with the relevant information.

5. Publish your package

To publish your package, switch to the release branch, then create and push a semantic commit with the changes you've made to package.json. Once the changes are pushed, GitHub Actions will automatically publish your package.

git checkout -b "release"
git stage .
git commit -m "feat: Setup package"
git push --set-upstream origin release

Development

Tools & Configurations

Typescript

Jest

ESLint

Prettier

Github Actions

Husky

Semantic Release