Skip to content

Commit 8891629

Browse files
committed
Replace makenew boilerplate
1 parent 8453048 commit 8891629

File tree

11 files changed

+26
-269
lines changed

11 files changed

+26
-269
lines changed

.eslintrc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
["^\\u0000"],
2929
["^node:"],
3030
["^@?\\w"],
31-
["@seamapi/makenew-tsmodule"],
31+
["@seamapi/webhook"],
3232
["^lib/"],
3333
["^"],
3434
["^\\."]

.github/CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
* @seambot
1+
* @razor-x

.github/workflows/check.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ jobs:
100100
write-mode: overwrite
101101
path: index.js
102102
contents: |
103-
import '@seamapi/makenew-tsmodule'
103+
import '@seamapi/webhook'
104104
- name: Install
105105
run: npm install --save ${{ steps.packages.outputs.paths }}
106106
- name: Run

.github/workflows/makenew.yml

Lines changed: 0 additions & 95 deletions
This file was deleted.

README.md

Lines changed: 11 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,20 @@
1-
# TypeScript Module Package Skeleton
1+
# Seam Webhook SDK
22

3-
[![npm](https://img.shields.io/npm/v/@seamapi/makenew-tsmodule.svg)](https://www.npmjs.com/package/@seamapi/makenew-tsmodule)
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)
3+
[![npm](https://img.shields.io/npm/v/@seamapi/webhook.svg)](https://www.npmjs.com/package/@seamapi/webhook)
4+
[![GitHub Actions](https://github.com/seamapi/javascript-webhook/actions/workflows/check.yml/badge.svg)](https://github.com/seamapi/javascript-webhook/actions/workflows/check.yml)
55

6-
Package skeleton for a TypeScript module.
6+
Webhook SDK for the Seam API written in TypeScript.
77

88
## Description
99

10-
Bootstrap a new TypeScript module in five minutes or less.
11-
12-
### Features
13-
14-
- Strongly typed JavaScript with [TypeScript].
15-
- Native [ECMAScript module] compatible with [Node.js].
16-
- Package management with [npm].
17-
- Publish as a package to [GitHub Packages] and [npm].
18-
- Examples with configurable options and arguments powered by [yargs] with [landlubber].
19-
- Linting with the [JavaScript Standard Style] using [ESLint].
20-
- [Prettier] code.
21-
- Futuristic debuggable unit testing with [AVA].
22-
- Code coverage reporting with [Istanbul] and [c8].
23-
- Robust static dependency analysis with [DPDM].
24-
- Fully automated version management and package publishing with [semantic-release].
25-
- Continuous testing and package publishing with [GitHub Actions].
26-
- Consistent coding with [EditorConfig].
27-
- Start coding instantly with [GitHub Codespaces].
28-
- Get PR reviews directly from [code owners].
29-
- Automatically close [stale] Issues and Pull Requests.
30-
- Badges from [Shields.io].
31-
32-
[AVA]: https://github.com/avajs/ava
33-
[code owners]: https://github.blog/2017-07-06-introducing-code-owners/
34-
[DPDM]: https://github.com/acrazing/dpdm
35-
[ECMAScript module]: https://nodejs.org/api/esm.html
36-
[ESLint]: https://eslint.org/
37-
[EditorConfig]: https://editorconfig.org/
38-
[GitHub Actions]: https://github.com/features/actions
39-
[GitHub Codespaces]: https://github.com/features/packages
40-
[GitHub Packages]: https://github.com/features/packages
41-
[Istanbul]: https://istanbul.js.org/
42-
[JavaScript Standard Style]: https://standardjs.com/
43-
[Node.js]: https://nodejs.org/
44-
[Prettier]: https://prettier.io/
45-
[semantic-release]: https://semantic-release.gitbook.io/
46-
[Shields.io]: https://shields.io/
47-
[stale]: https://github.com/marketplace/stale
48-
[TypeScript]: https://www.typescriptlang.org/
49-
[c8]: https://github.com/bcoe/c8
50-
[landlubber]: https://github.com/razor-x/landlubber
51-
[npm]: https://www.npmjs.com/
52-
[yargs]: https://yargs.js.org/
53-
54-
### Bootstrapping a new project
55-
56-
1. [Trigger a makenew workflow from this repository][makenew workflow]. 🚀
57-
- Provide a value for each required input.
58-
- There are no defaults.
59-
- Example values are shown in parentheses.
60-
2. When the workflow completes, clone your new repo and start coding!
61-
62-
[makenew workflow]: https://github.com/seamapi/makenew-tsmodule/actions/workflows/makenew.yml
63-
64-
### Updating from this skeleton
65-
66-
If you want to pull in future updates from this skeleton,
67-
you can fetch and merge in changes from this repository.
68-
69-
Add this as a new remote with
70-
71-
```
72-
$ git remote add makenew git@github.com:seamapi/makenew-tsmodule.git
73-
```
74-
75-
You can then fetch and merge changes with
76-
77-
```
78-
$ git fetch --no-tags makenew
79-
$ git merge makenew/main
80-
```
10+
TODO
8111

8212
## Installation
8313

8414
Add this as a dependency to your project using [npm] with
8515

8616
```
87-
$ npm install @seamapi/makenew-tsmodule
17+
$ npm install @seamapi/webhook
8818
```
8919

9020
[npm]: https://www.npmjs.com/
@@ -94,8 +24,8 @@ $ npm install @seamapi/makenew-tsmodule
9424
### Quickstart
9525

9626
```
97-
$ git clone https://github.com/seamapi/makenew-tsmodule.git
98-
$ cd makenew-tsmodule
27+
$ git clone https://github.com/seamapi/javascript-webhook.git
28+
$ cd javascript-webhook
9929
$ nvm install
10030
$ npm install
10131
$ npm run test:watch
@@ -115,10 +45,10 @@ The [source code] is hosted on GitHub.
11545
Clone the project with
11646

11747
```
118-
$ git clone git@github.com:seamapi/makenew-tsmodule.git
48+
$ git clone git@github.com:seamapi/javascript-webhook.git
11949
```
12050

121-
[source code]: https://github.com/seamapi/makenew-tsmodule
51+
[source code]: https://github.com/seamapi/javascript-webhook
12252

12353
### Requirements
12454

@@ -171,7 +101,7 @@ $ gh workflow run version.yml --raw-field version=<version>
171101

172102
[GitHub CLI]: https://cli.github.com/
173103
[npm-version]: https://docs.npmjs.com/cli/version
174-
[version workflow_dispatch on GitHub Actions]: https://github.com/seamapi/makenew-tsmodule/actions?query=workflow%3Aversion
104+
[version workflow_dispatch on GitHub Actions]: https://github.com/seamapi/javascript-webhook/actions?query=workflow%3Aversion
175105

176106
## GitHub Actions
177107

examples/todo.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import type { Builder, Command, Describe, Handler } from 'landlubber'
22

3-
import { todo } from '@seamapi/makenew-tsmodule'
3+
import { todo } from '@seamapi/webhook'
44

55
interface Options {
66
x: string

makenew.sh

Lines changed: 0 additions & 78 deletions
This file was deleted.

package-lock.json

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "@seamapi/makenew-tsmodule",
3-
"version": "1.3.0",
4-
"description": "Package skeleton for a TypeScript module.",
2+
"name": "@seamapi/webhook",
3+
"version": "0.0.0",
4+
"description": "Webhook SDK for the Seam API written in TypeScript.",
55
"type": "module",
66
"main": "index.js",
77
"types": "index.d.ts",
@@ -16,9 +16,9 @@
1616
"keywords": [
1717
"node"
1818
],
19-
"homepage": "https://github.com/seamapi/makenew-tsmodule",
20-
"bugs": "https://github.com/seamapi/makenew-tsmodule/issues",
21-
"repository": "seamapi/makenew-tsmodule",
19+
"homepage": "https://github.com/seamapi/javascript-webhook",
20+
"bugs": "https://github.com/seamapi/javascript-webhook/issues",
21+
"repository": "seamapi/javascript-webhook",
2222
"license": "MIT",
2323
"author": {
2424
"name": "Seam Labs, Inc.",

test/todo.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import test from 'ava'
22

3-
import { todo } from '@seamapi/makenew-tsmodule'
3+
import { todo } from '@seamapi/webhook'
44

55
test('todo: returns argument', (t) => {
66
t.is(todo('todo'), 'todo', 'returns input')

tsconfig.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
"forceConsistentCasingInFileNames": true,
2525
"baseUrl": "./",
2626
"paths": {
27-
"@seamapi/makenew-tsmodule": ["./src/index.ts"],
27+
"@seamapi/webhook": ["./src/index.ts"],
2828
"lib/*": ["./src/lib/*"]
2929
}
3030
},

0 commit comments

Comments
 (0)