@jmlweb/tsconfig-base 1.0.0 → 1.0.1

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @jmlweb/tsconfig-base
+
+## 1.0.1
+
+### Patch Changes
+
+- 2208f74: Standardize repository field format to object format across all packages and configure syncpack to preserve it.

package/README.md

@@ -157,7 +157,21 @@ This base config intentionally omits `include` and `exclude` patterns because:
 - ✅ Prevents conflicts with project-specific patterns
 - ✅ More flexible for various project types
 
-## 🔧 Common Overrides
+## 🎯 When to Use
+
+Use this configuration when you want:
+
+- ✅ Strict TypeScript type checking for maximum type safety
+- ✅ Modern JavaScript features (ES2022)
+- ✅ Node.js ESM module system
+- ✅ Flexible file inclusion/exclusion patterns
+- ✅ Foundation for extending with framework-specific configs
+
+**For React projects**, use [`@jmlweb/tsconfig-react`](../tsconfig-react) instead.
+
+**For internal tooling projects**, use [`@jmlweb/tsconfig-internal`](../tsconfig-internal) instead.
+
+## 🔧 Extending the Configuration
 
 ### Using ES Modules (ESM)
 
@@ -195,15 +209,41 @@ This base config intentionally omits `include` and `exclude` patterns because:
 }
 ```
 
-## 📝 Requirements
+## 📝 Usage with Scripts
+
+TypeScript compilation is typically handled by your build tool or IDE. For manual compilation:
+
+```json
+{
+  "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc --noEmit"
+  }
+}
+```
+
+## 📋 Requirements
 
 - **Node.js** >= 18.0.0
 - **TypeScript** >= 5.0.0
 
+## 📦 Peer Dependencies
+
+This package requires the following peer dependency:
+
+- `typescript` (>= 5.0.0)
+
+## 📚 Examples
+
+See real-world usage examples:
+
+- [`example-nodejs-typescript-api`](../../apps/example-nodejs-typescript-api) - Node.js TypeScript API example
+
 ## 🔗 Related Packages
 
 - [`@jmlweb/eslint-config-base`](../eslint-config-base) - ESLint configuration for TypeScript projects
 - [`@jmlweb/prettier-config-base`](../prettier-config-base) - Prettier configuration
+- [`@jmlweb/tsconfig-react`](../tsconfig-react) - TypeScript configuration for React projects
 
 ## 📄 License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jmlweb/tsconfig-base",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Base TypeScript configuration with strict type checking and modern defaults",
   "main": "tsconfig.json",
   "exports": {
@@ -8,14 +8,15 @@
   },
   "files": [
     "tsconfig.json",
-    "README.md"
+    "README.md",
+    "CHANGELOG.md"
   ],
   "keywords": [
-    "tsconfig",
-    "typescript",
     "config",
     "strict",
-    "type-checking"
+    "tsconfig",
+    "type-checking",
+    "typescript"
   ],
   "author": "jmlweb",
   "license": "MIT",
@@ -23,14 +24,13 @@
     "type": "git",
     "url": "https://github.com/jmlweb/tooling.git"
   },
-  "bugs": {
-    "url": "https://github.com/jmlweb/tooling/issues"
-  },
+  "bugs": "https://github.com/jmlweb/tooling/issues",
   "homepage": "https://github.com/jmlweb/tooling/tree/main/packages/tsconfig-base#readme",
   "engines": {
     "node": ">=18.0.0"
   },
   "publishConfig": {
     "access": "public"
-  }
-}
+  },
+  "scripts": {}
+}