TypeScript Package template

GitHub Template repository to create a npm package by using TypeScript.

Badges

OGP

// both
$ yarn run create:ogp

// dark
$ yarn run create:ogp:dark

// light
$ yarn run create:ogp:light

Prepare

$ git clone YOUR_REPO_URI
$ cd YOUR_REPO_URI

// Put your GitHub Personal Access Token
$ mv .envrc.example .envrc
$ vim .envrc
export CONVENTIONAL_GITHUB_RELEASER_TOKEN=PUT_YOUR_GITHUB_ACCESS_TOKEN

// Install
$ yarn
or
$ npm install

GitHub Personal Access Token Scope

If the project is private -> repo If the project is public -> public_repo

Commit message rule

The repository runs commitlint. We have to follow "Conventional Commit" to make a commit message.

https://www.conventionalcommits.org/en/v1.0.0-beta.4/

$ git commit -m "<type>[optional scope]: <description>

[optional body]

[optional footer]"

Contribution

// clone
$ git clone [email protected]:hideokamoto/MY_REPO_NAME.git
$ cd MY_REPO_NAME

// setup
$ yarn

// Unit test
$ yarn test
or
$ yarn run test:watch

// Lint
$ yarn run lint
or
$ yarn run lint --fix

// Build
$ yarn run build

// Rebuild docs
$ yarn run doc