@apitree.cz/ts-config 0.4.5 → 0.4.6

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.
Files changed (2) hide show
  1. package/README.md +40 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -63,6 +63,46 @@ Suitable for distributable `npm` packages (framework-agnostic).
63
63
  }
64
64
  ```
65
65
 
66
+ #### WebStorm Settings in PNPM Monorepos
67
+
68
+ In order for WebStorm to correctly resolve paths for internal packages in PNPM monorepos, separate your configuration into:
69
+
70
+ `tsconfig.lib.json`
71
+
72
+ ```json
73
+ {
74
+ "extends": "@apitree.cz/ts-config/library",
75
+ "include": ["**/*.js", "**/*.ts", "**/*.tsx"],
76
+ "exclude": ["dist", "node_modules"]
77
+ }
78
+ ```
79
+
80
+ `tsconfig.json`
81
+
82
+ ```json
83
+ {
84
+ "extends": "./tsconfig.lib.json",
85
+ "compilerOptions": {
86
+ "rootDir": "./src",
87
+ "outDir": "./dist"
88
+ },
89
+ "include": ["./src"]
90
+ }
91
+ ```
92
+
93
+ > 🧠 Do not forget to use the `tsconfig.lib.json` in your general type-check script.
94
+
95
+ If your package also contains other non-src files (e.g. `tests`, `scripts`, etc.), create a separate `tsconfig.json` in each of those folders:
96
+
97
+ ```json
98
+ {
99
+ "extends": "../tsconfig.lib.json",
100
+ "compilerOptions": {
101
+ "rootDir": ".."
102
+ }
103
+ }
104
+ ```
105
+
66
106
  ### Node.js
67
107
 
68
108
  Suitable for Node.js services and apps.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@apitree.cz/ts-config",
3
- "version": "0.4.5",
3
+ "version": "0.4.6",
4
4
  "description": "TypeScript configuration for ApiTree projects.",
5
5
  "keywords": [
6
6
  "apitree",