44
55Inspired by [ node-module-boilerplate] ( https://github.com/sindresorhus/node-module-boilerplate )
66
7+ ## Features
8+
9+ - [ Semantic Release] ( https://github.com/semantic-release/semantic-release )
10+ - [ Issue Templates] ( https://github.com/ryansonshine/typescript-npm-package-template/tree/main/.github/ISSUE_TEMPLATE )
11+ - [ GitHub Actions] ( https://github.com/ryansonshine/typescript-npm-package-template/tree/main/.github/workflows )
12+ - [ Codecov] ( https://about.codecov.io/ )
13+ - [ VSCode Launch Configurations] ( https://github.com/ryansonshine/typescript-npm-package-template/blob/main/.vscode/launch.json )
14+ - [ TypeScript] ( https://www.typescriptlang.org/ )
15+ - [ Husky] ( https://github.com/typicode/husky )
16+ - [ Lint Staged] ( https://github.com/okonet/lint-staged )
17+ - [ Commitizen] ( https://github.com/search?q=commitizen )
18+ - [ Jest] ( https://jestjs.io/ )
19+ - [ ESLint] ( https://eslint.org/ )
20+ - [ Prettier] ( https://prettier.io/ )
21+
722## Getting started
823
24+ ### Set up your repository
25+
926** Click the "Use this template" button.**
1027
1128Alternatively, create a new directory and then run:
@@ -14,6 +31,23 @@ Alternatively, create a new directory and then run:
1431curl -fsSL https://github.com/ryansonshine/typescript-npm-package-template/archive/main.tar.gz | tar -xz --strip-components=1
1532```
1633
34+ Replace ` FULL_NAME ` , ` GITHUB_USER ` , and ` REPO_NAME ` in the script below with your own details to personalize your new package:
35+
36+ ``` bash
37+ FULL_NAME=" John Smith"
38+ GITHUB_USER=" johnsmith"
39+ REPO_NAME=" my-cool-package"
40+ sed -i " 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
41+ ```
42+
43+ ### Add NPM Token
44+
45+ Add your npm token to your GitHub repository secrets as ` NPM_TOKEN ` .
46+
47+ ### Add Codecov integration
48+
49+ Enable the Codecov GitHub App [ here] ( https://github.com/apps/codecov ) .
50+
1751** Remove everything from here and above**
1852
1953---
0 commit comments