From a270dd2a71927cefc23e006059cb450e0a647e59 Mon Sep 17 00:00:00 2001 From: Emanuel Tesar Date: Wed, 22 Jun 2022 12:34:28 +0200 Subject: [PATCH] Document edge case when running scripts with ts-node --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index a02eb7bd1a..9f286ed25c 100644 --- a/README.md +++ b/README.md @@ -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