@nexim/typescript-config 1.0.1 → 2.0.0

package/CHANGELOG.md

@@ -3,6 +3,31 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.0.0](https://github.com/the-nexim/nanolib/compare/@nexim/typescript-config@1.1.0...@nexim/typescript-config@2.0.0) (2025-01-06)
+
+### ⚠ BREAKING CHANGES
+
+* **typescript-config:** rename `tsconfig.json` to `tsconfig.base.json`
+
+### Features
+
+* **typescript-config:** add new tsconfig environment ([536a173](https://github.com/the-nexim/nanolib/commit/536a17360081edf2b02d363e90fd9dc903d7306c)) by @njfamirm
+
+### Bug Fixes
+
+* **typescript-config:** remove root/out directory ([f0e6c9f](https://github.com/the-nexim/nanolib/commit/f0e6c9fa9dd31ec55df5cafb5b56d0209040225a)) by @njfamirm
+* **typescript-config:** set typescript as peer dependency ([0c09cb2](https://github.com/the-nexim/nanolib/commit/0c09cb2593ac594593f8994449764cf22cd47879)) by @njfamirm
+
+### Code Refactoring
+
+* **typescript-config:** rename `tsconfig.json` to `tsconfig.base.json` ([341ac77](https://github.com/the-nexim/nanolib/commit/341ac7718ff44f4f69f4f98bac906e7a86aed0cf)) by @arashagp
+
+## [1.1.0](https://github.com/the-nexim/nanolib/compare/@nexim/typescript-config@1.0.1...@nexim/typescript-config@1.1.0) (2025-01-05)
+
+### Features
+
+* **service-worker:** add service worker utilities and logging support ([#18](https://github.com/the-nexim/nanolib/issues/18)) ([d428086](https://github.com/the-nexim/nanolib/commit/d428086dd98fbb5dfd077d14de4de8dd29ed78dc)) by @
+
 ## [1.0.1](https://github.com/the-nexim/nanolib/compare/@nexim/typescript-config@1.0.0...@nexim/typescript-config@1.0.1) (2024-12-10)
 
 **Note:** Version bump only for package @nexim/typescript-config

package/README.md

@@ -1,14 +1,15 @@
-# Nexim TypeScript Config
+# Nexim TypeScript Configuration
 
-![NPM Version](https://img.shields.io/npm/v/%40nexim%2Ftypescript-config)
-![npm bundle size](https://img.shields.io/bundlephobia/min/%40nexim%2Ftypescript-config)
+![NPM Version](https://img.shields.io/npm/v/@nexim/typescript-config)
 ![Build & Lint & Test](https://github.com/the-nexim/nanolib/actions/workflows/build-lint-test.yaml/badge.svg)
-![NPM Downloads](https://img.shields.io/npm/dm/%40nexim%2Ftypescript-config)
-![NPM License](https://img.shields.io/npm/l/%40nexim%2Ftypescript-config)
+![NPM Downloads](https://img.shields.io/npm/dm/@nexim/typescript-config)
+![NPM License](https://img.shields.io/npm/l/@nexim/typescript-config)
 
-This is a base TypeScript configuration for Nexim projects.
+This package provides pre-configured settings for using TypeScript in Nexim projects.
 
-## installation
+## Installation
+
+Install the package as a development dependency:
 
 ```bash
 yarn add -D @nexim/typescript-config
@@ -16,15 +17,52 @@ yarn add -D @nexim/typescript-config
 
 ## Usage
 
-Create a `tsconfig.json` file in the root of your project:
+To use this configuration, create a `tsconfig.json` file in the root of your project and extend one of the provided configurations:
+
+### Base Configuration (`tsconfig.base.json`)
+
+This configuration contains the fundamental settings shared by all other configurations. It's generally not used directly, but serves as the foundation for other, more specific configurations.
+
+### Browser Application (`tsconfig.browser.app.json`)
+
+Use this configuration for browser-based applications. It extends the base configuration and is primarily used for type checking during development. It doesn't produce build outputs.
+
+```json
+{
+  "extends": "@nexim/typescript-config/tsconfig.browser.app.json",
+  "include": ["src/**/*.ts", "src/*.ts"] // Include all TypeScript files in your source directory
+}
+```
+
+### Browser Library (`tsconfig.browser.lib.json`)
+
+Use this configuration for browser-based libraries. extends the base configuration, generates declaration files (\*.d.ts), and supports referencing other projects.
+
+```json
+{
+  "extends": "@nexim/typescript-config/tsconfig.browser.lib.json",
+  "include": ["src/**/*.ts", "src/*.ts"] // Include all TypeScript files in your source directory
+}
+```
+
+### Node.js Application (`tsconfig.node.app.json`)
+
+Use this configuration for nodejs-based applications. It extends the base configuration and includes Node.js specific type definitions. It doesn't produce build outputs and primarily used for type checking during development.
+
+```json
+{
+  "extends": "@nexim/typescript-config/tsconfig.node.app.json",
+  "include": ["src/**/*.ts", "src/*.ts"] // Include all TypeScript files in your source directory
+}
+```
+
+### Node.js Library (`tsconfig.node.lib.json`)
+
+Use this configuration for nodejs-based libraries. extends the base configuration, incorporates Node.js type definitions, generates declaration files (\*.d.ts), and supports referencing other projects.
 
 ```json
 {
-  "extends": "@nexim/typescript-config",
-  "compilerOptions": {
-    "rootDir": "src",
-    "outDir": "dist"
-  },
-  "include": ["src/**/*.ts"]
+  "extends": "@nexim/typescript-config/tsconfig.node.lib.json",
+  "include": ["src/**/*.ts", "src/*.ts"] // Include all TypeScript files in your source directory
 }
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nexim/typescript-config",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "description": "Base TypeScript configuration for Nexim projects.",
   "keywords": [
     "typescript",
@@ -19,19 +19,21 @@
     "directory": "packages/typescript-config"
   },
   "license": "AGPL-3.0-only",
-  "author": "S. Amir Mohammad Najafi <njfamirm@gmail.com> (www.njfamirm.ir)",
+  "author": "S. Amir Mohammad Najafi <njfamirm@gmail.com> (https://www.njfamirm.ir)",
   "contributors": [
     "Arash Ghardashpoor <arash.qardashpoor@gmail.com> (https://www.agpagp.ir)"
   ],
-  "main": "tsconfig.json",
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "main": "tsconfig.base.json",
   "files": [
     "**/*.{js,mjs,cjs,map,d.ts,html,md,LEGAL.txt}",
-    "tsconfig.json",
-    "LICENSE",
-    "!demo/**/*"
+    "tsconfig*.json",
+    "LICENSE"
   ],
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a02afd5953a471c872d63e4eb2e7ccbf90c21abb"
+  "gitHead": "8d72218409e5b93b27b5026d9cea8f0bf0b1414a"
 }

package/{tsconfig.json → tsconfig.base.json}

@@ -16,7 +16,6 @@
     // "outFile": "./",
     // "outDir": "./",
     // "rootDir": "./src",
-    "composite": true,
     // "tsBuildInfoFile": ".tsbuildinfo",
     // "removeComments": true,
     // "noEmit": true,

package/tsconfig.browser.app.json

@@ -0,0 +1,6 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "noEmit": true,
+  },
+}

package/tsconfig.browser.lib.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "emitDeclarationOnly": true,
+    "composite": true,
+  },
+}

package/tsconfig.node.app.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "types": ["node"]
+  },
+}

package/tsconfig.node.lib.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "emitDeclarationOnly": true,
+    "composite": true,
+    "types": ["node"]
+  },
+}