nhcarrigan/typescript-config
2
0
Fork 0
generated from nhcarrigan/template
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update instructions for rootDir and outDir

Browse Source
This commit is contained in:
Naomi Carrigan 2024-06-25 18:24:39 -07:00
parent 7f786e4c3a
commit 236e11fbbd
No known key found for this signature in database
GPG Key ID: 7019A402E94A9808
1 changed files with 4 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -22,24 +22,18 @@ This package is compatible with TypeScript 5.
To use this package, add the following to your `tsconfig.json` file:
```json
{
"extends": "@nhcarrigan/typescript-config"
}
```
By default, the root directory is `src` and the output directory is `prod`. To override these:
```json
{
"extends": "@nhcarrigan/typescript-config",
"compilerOptions": {
"rootDir": "code",
"outDir": "dist"
"rootDir": "./src",
"outDir": "./prod"
}
}
```
You may set `rootDir` and `outDir` to any directory in your project you'd like. As of V4.0.0 this package no longer sets them by default due to incompatibilities with some package managers.
## Feedback and Bugs
If you have feedback or a bug report, please feel free to open a GitHub issue!