@jmlweb/tsconfig-base 1.0.0 → 1.0.2

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 (3) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/README.md +42 -2
  3. package/package.json +10 -10
package/CHANGELOG.md ADDED
@@ -0,0 +1,13 @@
1
+ # @jmlweb/tsconfig-base
2
+
3
+ ## 1.0.2
4
+
5
+ ### Patch Changes
6
+
7
+ - 21918eb: Standardize repository field format to object format across all packages and configure syncpack to preserve it.
8
+
9
+ ## 1.0.1
10
+
11
+ ### Patch Changes
12
+
13
+ - 2208f74: Standardize repository field format to object format across all packages and configure syncpack to preserve it.
package/README.md CHANGED
@@ -157,7 +157,21 @@ This base config intentionally omits `include` and `exclude` patterns because:
157
157
  - ✅ Prevents conflicts with project-specific patterns
158
158
  - ✅ More flexible for various project types
159
159
 
160
- ## 🔧 Common Overrides
160
+ ## 🎯 When to Use
161
+
162
+ Use this configuration when you want:
163
+
164
+ - ✅ Strict TypeScript type checking for maximum type safety
165
+ - ✅ Modern JavaScript features (ES2022)
166
+ - ✅ Node.js ESM module system
167
+ - ✅ Flexible file inclusion/exclusion patterns
168
+ - ✅ Foundation for extending with framework-specific configs
169
+
170
+ **For React projects**, use [`@jmlweb/tsconfig-react`](../tsconfig-react) instead.
171
+
172
+ **For internal tooling projects**, use [`@jmlweb/tsconfig-internal`](../tsconfig-internal) instead.
173
+
174
+ ## 🔧 Extending the Configuration
161
175
 
162
176
  ### Using ES Modules (ESM)
163
177
 
@@ -195,15 +209,41 @@ This base config intentionally omits `include` and `exclude` patterns because:
195
209
  }
196
210
  ```
197
211
 
198
- ## 📝 Requirements
212
+ ## 📝 Usage with Scripts
213
+
214
+ TypeScript compilation is typically handled by your build tool or IDE. For manual compilation:
215
+
216
+ ```json
217
+ {
218
+ "scripts": {
219
+ "build": "tsc",
220
+ "typecheck": "tsc --noEmit"
221
+ }
222
+ }
223
+ ```
224
+
225
+ ## 📋 Requirements
199
226
 
200
227
  - **Node.js** >= 18.0.0
201
228
  - **TypeScript** >= 5.0.0
202
229
 
230
+ ## 📦 Peer Dependencies
231
+
232
+ This package requires the following peer dependency:
233
+
234
+ - `typescript` (>= 5.0.0)
235
+
236
+ ## 📚 Examples
237
+
238
+ See real-world usage examples:
239
+
240
+ - [`example-nodejs-typescript-api`](../../apps/example-nodejs-typescript-api) - Node.js TypeScript API example
241
+
203
242
  ## 🔗 Related Packages
204
243
 
205
244
  - [`@jmlweb/eslint-config-base`](../eslint-config-base) - ESLint configuration for TypeScript projects
206
245
  - [`@jmlweb/prettier-config-base`](../prettier-config-base) - Prettier configuration
246
+ - [`@jmlweb/tsconfig-react`](../tsconfig-react) - TypeScript configuration for React projects
207
247
 
208
248
  ## 📄 License
209
249
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jmlweb/tsconfig-base",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "Base TypeScript configuration with strict type checking and modern defaults",
5
5
  "main": "tsconfig.json",
6
6
  "exports": {
@@ -8,14 +8,15 @@
8
8
  },
9
9
  "files": [
10
10
  "tsconfig.json",
11
- "README.md"
11
+ "README.md",
12
+ "CHANGELOG.md"
12
13
  ],
13
14
  "keywords": [
14
- "tsconfig",
15
- "typescript",
16
15
  "config",
17
16
  "strict",
18
- "type-checking"
17
+ "tsconfig",
18
+ "type-checking",
19
+ "typescript"
19
20
  ],
20
21
  "author": "jmlweb",
21
22
  "license": "MIT",
@@ -23,14 +24,13 @@
23
24
  "type": "git",
24
25
  "url": "https://github.com/jmlweb/tooling.git"
25
26
  },
26
- "bugs": {
27
- "url": "https://github.com/jmlweb/tooling/issues"
28
- },
27
+ "bugs": "https://github.com/jmlweb/tooling/issues",
29
28
  "homepage": "https://github.com/jmlweb/tooling/tree/main/packages/tsconfig-base#readme",
30
29
  "engines": {
31
30
  "node": ">=18.0.0"
32
31
  },
33
32
  "publishConfig": {
34
33
  "access": "public"
35
- }
36
- }
34
+ },
35
+ "scripts": {}
36
+ }