https://github.com/forbeslindesay/npm-package-template

📦A template for npm packages built in TypeScript
https://github.com/forbeslindesay/npm-package-template

Last synced: 26 days ago
JSON representation

📦A template for npm packages built in TypeScript

• Host: GitHub
• URL: https://github.com/forbeslindesay/npm-package-template
• Owner: ForbesLindesay
• Created: 2019-11-01T13:42:22.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2023-03-04T05:04:51.000Z (over 1 year ago)
• Last Synced: 2024-10-13T21:02:39.790Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 566 KB
• Stars: 8
• Watchers: 3
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# npm-package-template

A template for npm packages built in TypeScript

[![Build Status](https://img.shields.io/github/workflow/status/ForbesLindesay/npm-package-template/Test/main?style=for-the-badge)](https://github.com/ForbesLindesay/npm-package-template/actions?query=workflow%3ATest+branch%3Amain)

[![Rolling Versions](https://img.shields.io/badge/Rolling%20Versions-Enabled-brightgreen?style=for-the-badge)](https://rollingversions.com/ForbesLindesay/npm-package-template)

[![NPM version](https://img.shields.io/npm/v/@forbeslindesay/npm-package-template?style=for-the-badge)](https://www.npmjs.com/package/@forbeslindesay/npm-package-template)

## Setting Up the New Repo

1. Hit "Use This Template" to create the repository

1. Enable [Rolling Versions](https://rollingversions.com) using [My Rolling Versions Installation](https://github.com/settings/installations/7328191)

1. In Settings

   1. Disable "Wikis"

   1. Disable "Projects"

   1. Disable "Allow merge commits"

   1. Disable "Allow rebase merging"

   1. Enable "Always suggest updating pull request branches"

   1. Enable "Allow auto-merge"

   1. Enable "Automatically delete head branches"

1. Create a new branch

1. Commit initial code to the branch (be sure to replace all references to npm-package-template, and remove these instructions from the README)

1. Push the new branch and create a PR

1. In Settings -> Branch Protection, create a new rule

   1. Use "main" as the branch name pattern

   1. Enable "Require status checks to pass before merging"

   1. Select the unit tests and changelog as required

   1. Enable "Include administrators"

   1. Enable "Restrict who can push to matching branches"

1. Merge the PR

## Installation

```

yarn add @forbeslindesay/npm-package-template

```

## Usage

```ts

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

const result = add(2, 3);

// => 5

```