Template to kickstart creating a Node.js module using TypeScript and VSCode
Inspired by node-module-boilerplate
- Semantic Release
- Issue Templates
- GitHub Actions
- Codecov
- VSCode Launch Configurations
- TypeScript
- Husky
- Lint Staged
- Commitizen
- Jest
- ESLint
- Prettier
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=1Replace 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 your npm token to your GitHub repository secrets as NPM_TOKEN.
Enable the Codecov GitHub App here.
Remove everything from here and above
npm package Build Status Downloads Issues Code Coverage Commitizen Friendly Semantic Release
My awesome module
npm install my-package-name
import { myPackage } from 'my-package-name'; myPackage('hello'); //=> 'hello from my package'
Type: string
Lorem ipsum.
Type: object
Type: string
Default: rainbows
Lorem ipsum.