11# TypeScript Module Package Skeleton
22
3+ [ ![ npm] ( https://img.shields.io/npm/v/@seamapi/makenew-tsmodule.svg )] ( https://www.npmjs.com/package/@seamapi/makenew-tsmodule )
34[ ![ GitHub Actions] ( https://github.com/seamapi/makenew-tsmodule/actions/workflows/check.yml/badge.svg )] ( https://github.com/seamapi/makenew-tsmodule/actions/workflows/check.yml )
45
56Package skeleton for a TypeScript module.
@@ -14,7 +15,7 @@ Bootstrap a new TypeScript module in five minutes or less.
1415- Native [ ECMAScript module] compatible with [ Node.js] .
1516- Package management with [ npm] .
1617- Use private packages from [ GitHub Packages] .
17- - Publish as a package to [ GitHub Packages] .
18+ - Publish as a package to [ GitHub Packages] and [ npm ] .
1819- Examples with configurable options and arguments powered by [ yargs] with [ landlubber] .
1920- Linting with the [ JavaScript Standard Style] using [ ESLint] .
2021- [ Prettier] code.
@@ -27,6 +28,7 @@ Bootstrap a new TypeScript module in five minutes or less.
2728- Start coding instantly with [ GitHub Codespaces] .
2829- Get PR reviews directly from [ code owners] .
2930- Automatically close [ stale] Issues and Pull Requests.
31+ - Badges from [ Shields.io] .
3032
3133[ AVA ] : https://github.com/avajs/ava
3234[ code owners ] : https://github.blog/2017-07-06-introducing-code-owners/
@@ -42,6 +44,7 @@ Bootstrap a new TypeScript module in five minutes or less.
4244[ Node.js ] : https://nodejs.org/
4345[ Prettier ] : https://prettier.io/
4446[ semantic-release ] : https://semantic-release.gitbook.io/
47+ [ Shields.io ] : https://shields.io/
4548[ stale ] : https://github.com/marketplace/stale
4649[ TypeScript ] : https://www.typescriptlang.org/
4750[ c8 ] : https://github.com/bcoe/c8
@@ -102,14 +105,7 @@ $ git merge makenew/main
102105
103106## Installation
104107
105- Add this as a dependency to your project using [ npm]
106- by adding the line below to your project's ` .npmrc ` ,
107-
108- ```
109- @seamapi:registry=https://npm.pkg.github.com
110- ```
111-
112- and installing the package with
108+ Add this as a dependency to your project using [ npm] with
113109
114110```
115111$ npm install @seamapi/makenew-tsmodule
@@ -209,6 +205,7 @@ _GitHub Actions should already be configured: this section is for reference only
209205
210206The following repository secrets must be set on [ GitHub Actions] :
211207
208+ - ` NPM_TOKEN ` : npm token for installing and publishing packages.
212209- ` GH_TOKEN ` : A personal access token for the bot user with
213210 ` packages:write ` and ` contents:write ` permission.
214211- ` GIT_USER_NAME ` : The GitHub bot user's real name.
0 commit comments