Skip to content

Commit 927cc8d

Browse files
committed
minor #16103 Add missing information about tsconfig.json (iquito)
This PR was submitted for the 5.4 branch but it was merged into the 4.4 branch instead. Discussion ---------- Add missing information about tsconfig.json When introducing TypeScript in a project I noticed the current documentation is still missing the mandatory step of including a tsconfig.json file in the project - without it the error "The 'files' list in config file 'tsconfig.json' is empty" occurs. Commits ------- 9e47c94 Add missing information about tsconfig.json
2 parents 587c949 + 9e47c94 commit 927cc8d

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

frontend/encore/typescript.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@ Want to use `TypeScript`_? No problem! First, enable it:
2020
+ //.enableForkedTypeScriptTypesChecking()
2121
;
2222
23+
Then add a `tsconfig.json` file with the contents `{}` to the project folder,
24+
or in the folder where your TypeScript files are located, like the `/assets`
25+
folder. In `tsconfig.json` you can define more options on how to process
26+
TypeScript, but defining no additional options will already work.
27+
2328
Then restart Encore. When you do, it will give you a command you can run to
2429
install any missing dependencies. After running that command and restarting
2530
Encore, you're done!

0 commit comments

Comments
 (0)