- Notifications
You must be signed in to change notification settings - Fork42
Boilerplate to kickstart creating an npm package using TypeScript
License
ryansonshine/typescript-npm-package-template
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Template to kickstart creating a Node.js module using TypeScript and VSCode
Inspired bynode-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=1ReplaceFULL_NAME,GITHUB_USER, andREPO_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.mdrm*.mybak
Add your npm token to your GitHub repository secrets asNPM_TOKEN.
Enable the Codecov GitHub Apphere.
Remove everything from here and above
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:stringDefault:rainbows
Lorem ipsum.
About
Boilerplate to kickstart creating an npm package using TypeScript
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Contributors5
Uh oh!
There was an error while loading.Please reload this page.