Skip to content

Commit

Permalink
Document edge case when running scripts with ts-node
Browse files Browse the repository at this point in the history
  • Loading branch information
Siegrift committed Jun 22, 2022
1 parent 69fba11 commit a270dd2
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,11 @@ examples) will work out of the box.
We heavily recommend using UNIX based systems for development. If you are using Windows, consider
[WSL](https://docs.microsoft.com/en-us/windows/wsl/install).

We use [TS project references](https://www.typescriptlang.org/docs/handbook/project-references.html) to see
cross-package errors in real time. However, we use `ts-node` to run our development scripts and it
[does not support project references](https://github.com/TypeStrong/ts-node/issues/897) at the moment. This means that
some of the errors are only shown in the IDE or at build time, not when run using `ts-node`.

## Changelog

We use [changesets](https://github.com/atlassian/changesets) to manage the changelog for us. What that means for
Expand Down

0 comments on commit a270dd2

Please sign in to comment.