Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryansonshine/typescript-npm-package-template
Boilerplate to kickstart creating an npm package using TypeScript
https://github.com/ryansonshine/typescript-npm-package-template
boilerplate codecov commitizen eslint jest npm-package semantic-release starter typescript vscode
Last synced: 3 months ago
JSON representation
Boilerplate to kickstart creating an npm package using TypeScript
- Host: GitHub
- URL: https://github.com/ryansonshine/typescript-npm-package-template
- Owner: ryansonshine
- License: mit
- Created: 2021-04-30T15:48:46.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-23T06:56:03.000Z (9 months ago)
- Last Synced: 2024-04-26T02:04:54.086Z (6 months ago)
- Topics: boilerplate, codecov, commitizen, eslint, jest, npm-package, semantic-release, starter, typescript, vscode
- Language: TypeScript
- Homepage:
- Size: 634 KB
- Stars: 237
- Watchers: 3
- Forks: 33
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# typescript-npm-package-template
> Template to kickstart creating a Node.js module using TypeScript and VSCode
Inspired by [node-module-boilerplate](https://github.com/sindresorhus/node-module-boilerplate)
## Features
- [Semantic Release](https://github.com/semantic-release/semantic-release)
- [Issue Templates](https://github.com/ryansonshine/typescript-npm-package-template/tree/main/.github/ISSUE_TEMPLATE)
- [GitHub Actions](https://github.com/ryansonshine/typescript-npm-package-template/tree/main/.github/workflows)
- [Codecov](https://about.codecov.io/)
- [VSCode Launch Configurations](https://github.com/ryansonshine/typescript-npm-package-template/blob/main/.vscode/launch.json)
- [TypeScript](https://www.typescriptlang.org/)
- [Husky](https://github.com/typicode/husky)
- [Lint Staged](https://github.com/okonet/lint-staged)
- [Commitizen](https://github.com/search?q=commitizen)
- [Jest](https://jestjs.io/)
- [ESLint](https://eslint.org/)
- [Prettier](https://prettier.io/)
## Getting started
### Set up your repository
**Click the "Use this template" button.**
Alternatively, create a new directory and then run:
```bash
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:
```bash
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](https://github.com/apps/codecov).
**Remove everything from here and above**
---
# my-package-name
[![npm package][npm-img]][npm-url]
[![Build Status][build-img]][build-url]
[![Downloads][downloads-img]][downloads-url]
[![Issues][issues-img]][issues-url]
[![Code Coverage][codecov-img]][codecov-url]
[![Commitizen Friendly][commitizen-img]][commitizen-url]
[![Semantic Release][semantic-release-img]][semantic-release-url]
> My awesome module
## Install
```bash
npm install my-package-name
```
## Usage
```ts
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.
[build-img]:https://github.com/ryansonshine/typescript-npm-package-template/actions/workflows/release.yml/badge.svg
[build-url]:https://github.com/ryansonshine/typescript-npm-package-template/actions/workflows/release.yml
[downloads-img]:https://img.shields.io/npm/dt/typescript-npm-package-template
[downloads-url]:https://www.npmtrends.com/typescript-npm-package-template
[npm-img]:https://img.shields.io/npm/v/typescript-npm-package-template
[npm-url]:https://www.npmjs.com/package/typescript-npm-package-template
[issues-img]:https://img.shields.io/github/issues/ryansonshine/typescript-npm-package-template
[issues-url]:https://github.com/ryansonshine/typescript-npm-package-template/issues
[codecov-img]:https://codecov.io/gh/ryansonshine/typescript-npm-package-template/branch/main/graph/badge.svg
[codecov-url]:https://codecov.io/gh/ryansonshine/typescript-npm-package-template
[semantic-release-img]:https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-release-url]:https://github.com/semantic-release/semantic-release
[commitizen-img]:https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
[commitizen-url]:http://commitizen.github.io/cz-cli/