1
1
# TypeScript Module Package Skeleton
2
2
3
+ [ ![ npm] ( https://img.shields.io/npm/v/@seamapi/makenew-tsmodule.svg )] ( https://www.npmjs.com/package/@seamapi/makenew-tsmodule )
3
4
[ ![ GitHub Actions] ( https://github.com/seamapi/makenew-tsmodule/actions/workflows/check.yml/badge.svg )] ( https://github.com/seamapi/makenew-tsmodule/actions/workflows/check.yml )
4
5
5
6
Package skeleton for a TypeScript module.
@@ -14,7 +15,7 @@ Bootstrap a new TypeScript module in five minutes or less.
14
15
- Native [ ECMAScript module] compatible with [ Node.js] .
15
16
- Package management with [ npm] .
16
17
- Use private packages from [ GitHub Packages] .
17
- - Publish as a package to [ GitHub Packages] .
18
+ - Publish as a package to [ GitHub Packages] and [ npm ] .
18
19
- Examples with configurable options and arguments powered by [ yargs] with [ landlubber] .
19
20
- Linting with the [ JavaScript Standard Style] using [ ESLint] .
20
21
- [ Prettier] code.
@@ -27,6 +28,7 @@ Bootstrap a new TypeScript module in five minutes or less.
27
28
- Start coding instantly with [ GitHub Codespaces] .
28
29
- Get PR reviews directly from [ code owners] .
29
30
- Automatically close [ stale] Issues and Pull Requests.
31
+ - Badges from [ Shields.io] .
30
32
31
33
[ AVA ] : https://github.com/avajs/ava
32
34
[ 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.
42
44
[ Node.js ] : https://nodejs.org/
43
45
[ Prettier ] : https://prettier.io/
44
46
[ semantic-release ] : https://semantic-release.gitbook.io/
47
+ [ Shields.io ] : https://shields.io/
45
48
[ stale ] : https://github.com/marketplace/stale
46
49
[ TypeScript ] : https://www.typescriptlang.org/
47
50
[ c8 ] : https://github.com/bcoe/c8
@@ -102,14 +105,7 @@ $ git merge makenew/main
102
105
103
106
## Installation
104
107
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
113
109
114
110
```
115
111
$ npm install @seamapi/makenew-tsmodule
@@ -209,6 +205,7 @@ _GitHub Actions should already be configured: this section is for reference only
209
205
210
206
The following repository secrets must be set on [ GitHub Actions] :
211
207
208
+ - ` NPM_TOKEN ` : npm token for installing and publishing packages.
212
209
- ` GH_TOKEN ` : A personal access token for the bot user with
213
210
` packages:write ` and ` contents:write ` permission.
214
211
- ` GIT_USER_NAME ` : The GitHub bot user's real name.
0 commit comments