1
0
mirror of https://github.com/jbranchaud/til synced 2026-01-03 07:08:01 +00:00

Add Generate An Initial tsconfig File as a TypeScript TIL

This commit is contained in:
jbranchaud
2023-06-15 15:00:34 -05:00
parent 6f99af3ec5
commit 72e3d551f3
2 changed files with 50 additions and 1 deletions

View File

@@ -0,0 +1,48 @@
# Generate An Initial tsconfig File
A new `tsconfig.json` file can be generated using the `tsc` CLI which is part
of the `typescript` node package.
You'll first want to add `typescript` to your project:
```bash
$ npm install typescript --save-dev
```
Since it is a local project dependency, you'll want to add `tsc` as a script in
your `package.json`.
```json
"scripts": {
"tsc": "tsc"
}
```
Now you can use `npm` to run `tsc --init` like so:
```bash
$ npm run tsc -- --init
```
Notice the delimiting `--` which tells `npm` to pass the remaining arguments to
the command being invoked. This makes sure `--init` gets passed as an argument
to `tsc`.
This will generate a huge, mostly commented-out `tsconfig.json` file full of
annotations that looks something like this:
```json
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */
/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
/* ... */
/* Language and Environment */
"target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
/* ... */
}
}
```