Skip to content

Commit

Permalink
tsconfig.json noEmit, and DEVELOPMENT.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshuaKGoldberg committed Feb 13, 2023
1 parent f3587e4 commit ee91d4d
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 3 deletions.
16 changes: 13 additions & 3 deletions .github/DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,13 @@ pnpm install
## Building

Run [TypeScript](https://typescriptlang.org) locally to type check and build source files from `src/` into output files in `lib/`:
Run [tsup](https://tsup.egoist.dev) locally to type check and build source files from `src/` into output files in `lib/`.
Add `--watch` to run it continuously in a terminal:

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

You should also see suggestions from TypeScript in your editor.

## Formatting

[Prettier](https://prettier.io) is used to format code.
Expand Down Expand Up @@ -52,3 +51,14 @@ Add the `--coverage` flag to compute test coverage and place reports in the `cov
```shell
pnpm run test --coverage
```

## Type Checking

You can run the TypeScript compiler (`tsc`) with `pnpm type-check`.
Add `--watch` to have it run continuously:

```shell
pnpm type-check --watch
```

You should also see suggestions from TypeScript in your editor.
1 change: 1 addition & 0 deletions tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"declarationMap": true,
"esModuleInterop": true,
"moduleResolution": "node",
"noEmit": true,
"outDir": "lib",
"skipLibCheck": true,
"sourceMap": true,
Expand Down

0 comments on commit ee91d4d

Please sign in to comment.