@kurone-kito/typescript-config 0.20.0-alpha.3 → 0.20.0-alpha.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -29,6 +29,35 @@ If exists, merge the following configuration into it:
|
|
|
29
29
|
}
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
+
### Example
|
|
33
|
+
|
|
34
|
+
The [example CLI project](../example-cli/tsconfig.json) extends this
|
|
35
|
+
configuration and adds settings for the output directory and additional
|
|
36
|
+
libraries:
|
|
37
|
+
|
|
38
|
+
```json
|
|
39
|
+
{
|
|
40
|
+
"extends": "@kurone-kito/typescript-config",
|
|
41
|
+
"compilerOptions": {
|
|
42
|
+
"lib": ["DOM", "ES2023"],
|
|
43
|
+
"outDir": "dist",
|
|
44
|
+
"rootDir": "src"
|
|
45
|
+
},
|
|
46
|
+
"exclude": [
|
|
47
|
+
"**/*.config.mts",
|
|
48
|
+
"**/*.spec.mts",
|
|
49
|
+
"coverage",
|
|
50
|
+
"dist",
|
|
51
|
+
"node_modules"
|
|
52
|
+
]
|
|
53
|
+
}
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Recommended settings
|
|
57
|
+
|
|
58
|
+
- Set `outDir` and `rootDir` to keep compiled files separate from sources.
|
|
59
|
+
- Include `types: ["node"]` when targeting Node.js.
|
|
60
|
+
|
|
32
61
|
## LICENSE
|
|
33
62
|
|
|
34
63
|
MIT
|