Skip to content

Commit

Permalink
feat: initial code skeleton
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshuaKGoldberg committed Oct 1, 2023
1 parent 1be6e28 commit 7ee1581
Show file tree
Hide file tree
Showing 21 changed files with 340,734 additions and 426 deletions.
1 change: 1 addition & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
!.*
coverage
dist
lib
node_modules
pnpm-lock.yaml
14 changes: 12 additions & 2 deletions .github/DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,28 @@ pnpm install
## Building

Run [**tsup**](https://tsup.egoist.dev) locally to build source files from `src/` into output files in `lib/`:
Run [TypeScript](https://typescriptlang.org) locally to type check and build source files from `src/` into output files in `lib/`:

```shell
pnpm build
pnpm build --watch
```

You should also see suggestions from TypeScript in your editor.

Add `--watch` to run the builder in a watch mode that continuously cleans and recreates `lib/` as you save files:

```shell
pnpm build --watch
```

### Building for Release

We use [`@vercel/ncc`](https://github.com/vercel/ncc) to create an output `dist/` to be used in production.

```shell
pnpm build:release
```

## Formatting

[Prettier](https://prettier.io) is used to format code.
Expand Down
27 changes: 0 additions & 27 deletions .github/workflows/post-release.yml

This file was deleted.

88 changes: 0 additions & 88 deletions .github/workflows/release.yml

This file was deleted.

1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.all-contributorsrc
coverage/
dist/
lib/
pnpm-lock.yaml
2 changes: 1 addition & 1 deletion cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
".github",
"CHANGELOG.md",
"coverage",
"dist",
"lib",
"node_modules",
"pnpm-lock.yaml"
Expand All @@ -21,7 +22,6 @@
"outro",
"packagejson",
"quickstart",
"tsup",
"wontfix"
]
}
Loading

0 comments on commit 7ee1581

Please sign in to comment.