@benhigham/tsconfig 0.1.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Benjamin Higham
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,138 @@
+# @benhigham/tsconfig
+
+[![npm version](https://img.shields.io/npm/v/@benhigham/tsconfig.svg)](https://www.npmjs.com/package/@benhigham/tsconfig)
+[![npm downloads](https://img.shields.io/npm/dm/@benhigham/tsconfig.svg)](https://www.npmjs.com/package/@benhigham/tsconfig)
+[![License](https://img.shields.io/github/license/benhigham/tsconfig)](LICENSE.md)
+
+My personal [TypeScript configurations](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html) designed to provide consistent, strict, and production-ready settings across different project types. These opinionated configs balance type safety with developer experience, helping you avoid common pitfalls while maintaining compatibility with modern frameworks and libraries.
+
+## Features
+
+- Ready-to-use TypeScript configurations:
+  - `@benhigham/tsconfig`: Base configuration for TypeScript projects
+  - `@benhigham/tsconfig/browser`: Configuration optimized for browser environments
+  - `@benhigham/tsconfig/astro`: Configuration for Astro framework projects
+  - `@benhigham/tsconfig/next`: Configuration for Next.js projects
+  - `@benhigham/tsconfig/react-app`: Configuration for React applications
+  - `@benhigham/tsconfig/react-library`: Configuration for React libraries
+  - `@benhigham/tsconfig/vite`: Configuration for Vite-based projects
+- Sensible defaults to ensure type safety and consistent code quality
+- Regularly updated to support the latest TypeScript features
+
+## Installation
+
+```bash
+# npm
+npm install --save-dev @benhigham/tsconfig
+
+# yarn
+yarn add --dev @benhigham/tsconfig
+
+# pnpm
+pnpm add --save-dev @benhigham/tsconfig
+```
+
+## Usage
+
+### Basic Usage
+
+Use in `tsconfig.json` by extending the desired configuration:
+
+```jsonc
+{
+  "extends": "@benhigham/tsconfig",
+  "compilerOptions": {
+    "outDir": "dist",
+    // your overrides here
+  },
+  "include": ["src"],
+}
+```
+
+### Configuration Examples
+
+#### Base Configuration
+
+```jsonc
+{
+  "extends": "@benhigham/tsconfig",
+  "compilerOptions": {
+    "outDir": "dist",
+  },
+  "include": ["src"],
+}
+```
+
+#### Browser Projects
+
+```jsonc
+{
+  "extends": "@benhigham/tsconfig/browser",
+  "compilerOptions": {
+    "outDir": "dist",
+  },
+  "include": ["src"],
+}
+```
+
+#### Astro Projects
+
+```jsonc
+{
+  "extends": "@benhigham/tsconfig/astro",
+  "include": ["src", ".astro/types.d.ts"],
+}
+```
+
+#### Next.js Projects
+
+```jsonc
+{
+  "extends": "@benhigham/tsconfig/next",
+  "include": ["src", "next-env.d.ts"],
+}
+```
+
+#### React Applications
+
+```jsonc
+{
+  "extends": "@benhigham/tsconfig/react-app",
+  "compilerOptions": {
+    "outDir": "dist",
+  },
+  "include": ["src"],
+}
+```
+
+#### React Libraries
+
+```jsonc
+{
+  "extends": "@benhigham/tsconfig/react-library",
+  "compilerOptions": {
+    "outDir": "dist",
+  },
+  "include": ["src"],
+}
+```
+
+#### Vite Projects
+
+```jsonc
+{
+  "extends": "@benhigham/tsconfig/vite",
+  "compilerOptions": {
+    "types": ["vite/client"],
+  },
+  "include": ["src"],
+}
+```
+
+## Requirements
+
+- TypeScript 5.5.x or higher
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@benhigham/tsconfig",
+  "version": "0.1.0",
+  "description": "My personal TypeScript configurations.",
+  "license": "MIT",
+  "homepage": "https://github.com/benhigham/tsconfig#readme",
+  "bugs": {
+    "url": "https://github.com/benhigham/tsconfig/issues/new"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/benhigham/tsconfig.git"
+  },
+  "funding": "https://github.com/sponsors/benhigham",
+  "author": {
+    "name": "Ben Higham",
+    "url": "https://benhigham.com"
+  },
+  "type": "module",
+  "exports": {
+    ".": "./src/base.json",
+    "./astro.json": "./src/astro.json",
+    "./browser.json": "./src/browser.json",
+    "./next.json": "./src/next.json",
+    "./react-app.json": "./src/react-app.json",
+    "./react-library.json": "./src/react-library.json",
+    "./vite.json": "./src/vite.json"
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "src"
+  ],
+  "keywords": [
+    "tsconfig",
+    "typescript",
+    "ts",
+    "config",
+    "configuration"
+  ],
+  "devDependencies": {
+    "@benhigham/commitlint-config": "^0.1.0",
+    "@benhigham/prettier-config": "^0.1.0",
+    "@changesets/changelog-github": "^0.5.1",
+    "@changesets/cli": "^2.28.1",
+    "@commitlint/cli": "^19.8.0",
+    "lefthook": "^1.11.6",
+    "prettier": "^3.5.3"
+  },
+  "peerDependencies": {
+    "typescript": ">=5.5"
+  },
+  "scripts": {
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "changeset": "changeset",
+    "changeset:status": "changeset status",
+    "version": "changeset version",
+    "release": "changeset publish"
+  }
+}

package/src/astro.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "./react-app.json",
+  "compilerOptions": {
+    "target": "ESNext"
+  }
+}

package/src/base.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "module": "NodeNext",
+    "moduleResolution": "nodenext",
+    "moduleDetection": "force",
+    "esModuleInterop": true,
+    "isolatedModules": true,
+    "verbatimModuleSyntax": true,
+    "lib": ["ES2023"],
+    "target": "ES2022",
+    "composite": false,
+    "declaration": true,
+    "declarationMap": true,
+    "incremental": false,
+    "newLine": "lf",
+    "stripInternal": true,
+    "strict": true,
+    "noEmitOnError": true,
+    "noImplicitReturns": true,
+    "noImplicitOverride": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noUncheckedSideEffectImports": true,
+    "preserveWatchOutput": true,
+    "useDefineForClassFields": true,
+    "forceConsistentCasingInFileNames": true,
+    "strictNullChecks": true,
+    "inlineSources": false,
+    "removeComments": true,
+    "sourceMap": true,
+    "skipLibCheck": true
+  }
+}

package/src/browser.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "./base.json",
+  "compilerOptions": {
+    "module": "ESNext",
+    "lib": ["DOM", "DOM.Iterable", "ESNext"],
+    "target": "ES5",
+    "jsx": "react-jsx"
+  }
+}

package/src/next.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "./react-app.json",
+  "compilerOptions": {
+    "plugins": [{ "name": "next" }]
+  }
+}

package/src/react-app.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "./browser.json",
+  "compilerOptions": {
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "resolveJsonModule": true,
+    "declaration": false,
+    "declarationMap": false,
+    "incremental": true,
+    "jsx": "preserve",
+    "noEmit": true
+  }
+}

package/src/react-library.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "./browser.json",
+  "compilerOptions": {
+    "target": "ES6"
+  }
+}

package/src/vite.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "./react-app.json",
+  "compilerOptions": {
+    "lib": ["DOM", "DOM.Iterable", "ES2020"],
+    "target": "ES2020",
+    "composite": true,
+    "allowSyntheticDefaultImports": true,
+    "jsx": "react-jsx"
+  }
+}