express-companion
TypeScript icon, indicating that this package has built-in type declarations

0.0.4-development • Public • Published

typescript-npm-package-template

Template to kickstart creating a Node.js module using TypeScript and VSCode

Inspired by node-module-boilerplate

Features

Getting started

Set up your repository

Click the "Use this template" button.

Alternatively, create a new directory and then run:

curl -fsSL https://github.com/ryansonshine/typescript-npm-package-template/archive/main.tar.gz | tar -xz --strip-components=1

Replace FULL_NAME, GITHUB_USER, and REPO_NAME in the script below with your own details to personalize your new package:

FULL_NAME="John Smith"
GITHUB_USER="johnsmith"
REPO_NAME="my-cool-package"
sed -i.mybak "s/\([\/\"]\)(ryansonshine)/$GITHUB_USER/g; s/typescript-npm-package-template\|my-package-name/$REPO_NAME/g; s/Ryan Sonshine/$FULL_NAME/g" package.json package-lock.json README.md
rm *.mybak

Add NPM Token

Add your npm token to your GitHub repository secrets as NPM_TOKEN.

Add Codecov integration

Enable the Codecov GitHub App here.

Remove everything from here and above


my-package-name

npm package Build Status Downloads Issues Code Coverage Commitizen Friendly Semantic Release

My awesome module

Install

npm install my-package-name

Usage

import { myPackage } from "my-package-name";

myPackage("hello");
//=> 'hello from my package'

API

myPackage(input, options?)

input

Type: string

Lorem ipsum.

options

Type: object

postfix

Type: string Default: rainbows

Lorem ipsum.

Package Sidebar

Install

npm i express-companion

Weekly Downloads

1

Version

0.0.4-development

License

MIT

Unpacked Size

64.3 kB

Total Files

51

Last publish

Collaborators

  • abutaher