npm-package-template

A template for npm packages built in TypeScript

Setting Up the New Repo

1. Hit "Use This Template" to create the repository
2. Enable Rolling Versions using My Rolling Versions Installation
3. In Settings
   1. Disable "Wikis"
   2. Disable "Projects"
   3. Disable "Allow merge commits"
   4. Disable "Allow rebase merging"
   5. Enable "Always suggest updating pull request branches"
   6. Enable "Allow auto-merge"
   7. Enable "Automatically delete head branches"
4. Create a new branch
5. Commit initial code to the branch (be sure to replace all references to npm-package-template, and remove these instructions from the README)
6. Push the new branch and create a PR
7. In Settings -> Branch Protection, create a new rule
   1. Use "main" as the branch name pattern
   2. Enable "Require status checks to pass before merging"
   3. Select the unit tests and changelog as required
   4. Enable "Include administrators"
   5. Enable "Restrict who can push to matching branches"
8. Merge the PR

Installation

yarn add @forbeslindesay/npm-package-template

Usage

import add from '@forbeslindesay/npm-package-template';

const result = add(2, 3);
// => 5