Skip to content

Commit 8b07efb

Browse files
apfelboxjohnnyreilly
authored andcommitted
Add note in docs about external config files (TypeStrong#733)
1 parent 847e5e4 commit 8b07efb

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -280,6 +280,9 @@ You may provide
280280
* a relative path to the configuration file. It will be resolved relative to the respective `.ts` entry file.
281281
* an absolute path to the configuration file.
282282

283+
Please note, that if the configuration file is outside of your project directory, you might need to set the `context` option to avoid TypeScript issues (like TS18003).
284+
In this case the `configFile` should point to the `tsconfig.json` and `context` to the project root.
285+
283286
#### colors _(boolean) (default=true)_
284287

285288
If `false`, disables built-in colors in logger messages.

0 commit comments

Comments
 (0)