Adding a sample tsconfig file to the Encore documentation page

[iammichiel]

No description provided.

[nicolas-grekas]

all block should be indented, isn't it?
what about Encore v0.21: is this still valid now?

[iammichiel]

I have not yet had time to try this in the v0.21 version of Encore. I'll give it a try this evening.

[iammichiel]

So gave this a try on the 0.21.1 version of webpack-encore. It still complains with following message :

TS18002: The 'files' list in config file 'tsconfig.json' is empty.

Creating this file with this default content solved the problem. Plus most people, will customize their Typescript experience in the tsconfig file. Perhaps, this should even be fixed as a hook in the recipe of the new bundle.

[weaverryan]

Is this something that Encore should configure for you? I don’t know typescript we’ll - what does the include do?

[iammichiel]

Hi,
Well, Typescript (as far as I understand it) actually compiles your files to JS before webpack handles/bundles them. This options tells the compiler which files it should compile or not. By default, the compiler will not do anything at all as the files array is empty by default.

This simply tells the compiler, it should handle all files (having the .ts extension) in the assets/js folder.

[javiereguiluz]

@tgalopin I know you know TypeScript very well ... could you please check if this proposal is correct? Thanks.

[javiereguiluz]

Friendly ping to @Kocal and @Lyrkan to see if they can review this proposal. Thanks.

[Lyrkan]

I don't think the include part is necessary, I just tested it on a really basic project with a tsconfig.json file that only contained {} and everything went fine:

$ cat tsconfig.json
{}

$ cat webpack.config.js
const Encore = require('@symfony/webpack-encore');

Encore
  .disableSingleRuntimeChunk()
  .setOutputPath('build/')
  .setPublicPath('/')
  .cleanupOutputBeforeBuild()
  .addEntry('main', './src/index.ts')
  .enableTypeScriptLoader()
;

module.exports = Encore.getWebpackConfig();

$ ./node_modules/.bin/encore dev
Running webpack ...

 DONE  Compiled successfully in 2095ms

 I  1 files written to build
Entrypoint main = main.js

Maybe it would be a better idea to directly add a link to TypeScript's documentation or to the Webpack's page about that topic?

[javiereguiluz]

@Lyrkan thanks a lot for reviewing this. I did what you asked and I added those links while merging. Thanks.