@kitschpatrol/typescript-config 5.0.0

package/init/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+	"typescript.tsdk": "node_modules/typescript/lib",
+	"typescript.enablePromptUseWorkspaceTsdk": true
+}

package/init/tsconfig.build.json

@@ -0,0 +1,7 @@
+{
+	"extends": "@kitschpatrol/typescript-config",
+
+	// Skips project files for typescript-eslint integration
+	"include": ["**/*"],
+	"exclude": ["**/dist/", "**/bin/"]
+}

package/init/tsconfig.json

@@ -0,0 +1,7 @@
+{
+	"extends": "@kitschpatrol/typescript-config",
+
+	// Includes project dit-files files for typescript-eslint integration
+	"include": ["**/*", "**/**.*"],
+	"exclude": ["**/dist/", "**/bin/"]
+}

package/license.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Eric Mika
+
+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/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@kitschpatrol/typescript-config",
+  "version": "5.0.0",
+  "description": "TypeScript configuration for @kitschpatrol/shared-config.",
+  "keywords": [
+    "shared-config",
+    "typescript",
+    "tsconfig",
+    "cli",
+    "kpi",
+    "kpi-typescript"
+  ],
+  "bugs": "https://github.com/kitschpatrol/shared-config/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kitschpatrol/shared-config/cli.git",
+    "directory": "packages/typescript-config"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Eric Mika",
+    "email": "eric@ericmika.com",
+    "url": "https://ericmika.com"
+  },
+  "type": "module",
+  "exports": {
+    ".": "./tsconfigs/base.json"
+  },
+  "bin": {
+    "kpi-typescript": "bin/cli.js"
+  },
+  "files": [
+    "tsconfigs/*",
+    "bin/*",
+    "init/*"
+  ],
+  "dependencies": {
+    "@pinojs/json-colorizer": "^4.0.0",
+    "cosmiconfig": "^9.0.0",
+    "execa": "^9.5.2",
+    "fs-extra": "^11.3.0"
+  },
+  "peerDependencies": {
+    "typescript": "~5.7.3"
+  },
+  "engines": {
+    "node": ">=22.0.0",
+    "pnpm": ">=10.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "../../scripts/build.ts",
+    "cli": "node ./bin/cli.js"
+  }
+}

package/readme.md

@@ -0,0 +1,197 @@
+<!--+ Warning: Content inside HTML comment blocks was generated by mdat and may be overwritten. +-->
+
+<!-- title -->
+
+# @kitschpatrol/typescript-config
+
+<!-- /title -->
+
+<!-- badges -->
+
+[![NPM Package @kitschpatrol/typescript-config](https://img.shields.io/npm/v/@kitschpatrol/typescript-config.svg)](https://npmjs.com/package/@kitschpatrol/typescript-config)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+<!-- /badges -->
+
+<!-- description -->
+
+**TypeScript configuration for @kitschpatrol/shared-config.**
+
+<!-- /description -->
+
+## Overview
+
+It's a shared [TypeScript](https://www.typescriptlang.org/) `tsconfig.json` config, plus a command-line tool `kpi-typescript` to perform TypeScript-related validation and linting.
+
+<!-- recommendation -->
+
+> [!Important]
+>
+> **You can use this package on its own, but it's recommended to use [`@kitschpatrol/shared-config`](https://www.npmjs.com/package/@kitschpatrol/shared-config) instead for a single-dependency and single-package approach to linting and fixing your project.**
+>
+> This package is included as a dependency in [`@kitschpatrol/shared-config`](https://www.npmjs.com/package/@kitschpatrol/shared-config), which also automatically invokes the command line functionality in this package via its `kpi` command
+
+<!-- /recommendation -->
+
+## Setup
+
+> [!Note]
+>
+> The package treats `typescript` as a peer dependency — it expects you to have `typescript` installed in your project.
+
+To use just this TypeScript config in isolation:
+
+1. Install the `.npmrc` in your project root. This is required for correct PNPM behavior:
+
+   ```sh
+   pnpm dlx @kitschpatrol/repo-config init
+   ```
+
+2. Add the package:
+
+   ```sh
+   pnpm add -D @kitschpatrol/typescript-config
+   ```
+
+3. Add the starter `tsconfig.json` and `tsconfig.build.json` files to your project root, and add any customizations you'd like:
+
+   ```sh
+   pnpm exec kpi-typescript init
+   ```
+
+## Usage
+
+You can call `kpi-typescript` directly, or use the script bundled with the config.
+
+Integrate with your `package.json` scripts as you see fit, for example:
+
+```json
+{
+  "scripts": {
+    "lint": "kpi-typescript lint"
+  }
+}
+```
+
+### Ignoring files
+
+See the `tsconfig.json` [`exclude`](https://www.typescriptlang.org/tsconfig/#exclude) key.
+
+`.gitignore` files are not ignored.
+
+### Ignoring code
+
+See [the TypeScript directive comments documentation](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-9.html#improved-checking-for-js-files) for more details.
+
+Entire files (at top):
+
+`/* @ts-nocheck */`
+
+Next line:
+
+`/* @ts-ignore */`
+
+or
+
+`/* @ts-expect-error - reason */`
+
+### CLI
+
+<!-- cli-help -->
+
+#### Command: `kpi-typescript`
+
+Kitschpatrol's TypeScript shared configuration tools.
+
+This section lists top-level commands for `kpi-typescript`.
+
+Usage:
+
+```txt
+kpi-typescript <command>
+```
+
+| Command        | Description                                                                                                                             |
+| -------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
+| `init`         | Initialize by copying starter config files to your project root.                                                                        |
+| `lint`         | Run type checking on your project. Package-scoped. In a monorepo, it will also run in all packages below the current working directory. |
+| `print-config` | Print the TypeScript configuration for the project. Package-scoped. Searches up to the root of a monorepo if necessary.                 |
+
+| Option              | Description         | Type      |
+| ------------------- | ------------------- | --------- |
+| `--help`<br>`-h`    | Show help           | `boolean` |
+| `--version`<br>`-v` | Show version number | `boolean` |
+
+_See the sections below for more information on each subcommand._
+
+#### Subcommand: `kpi-typescript init`
+
+Initialize by copying starter config files to your project root.
+
+Usage:
+
+```txt
+kpi-typescript init
+```
+
+| Option              | Description         | Type      |
+| ------------------- | ------------------- | --------- |
+| `--help`<br>`-h`    | Show help           | `boolean` |
+| `--version`<br>`-v` | Show version number | `boolean` |
+
+#### Subcommand: `kpi-typescript lint`
+
+Run type checking on your project. Package-scoped. In a monorepo, it will also run in all packages below the current working directory.
+
+Usage:
+
+```txt
+kpi-typescript lint
+```
+
+| Option              | Description         | Type      |
+| ------------------- | ------------------- | --------- |
+| `--help`<br>`-h`    | Show help           | `boolean` |
+| `--version`<br>`-v` | Show version number | `boolean` |
+
+#### Subcommand: `kpi-typescript print-config`
+
+Print the TypeScript configuration for the project. Package-scoped. Searches up to the root of a monorepo if necessary.
+
+Usage:
+
+```txt
+kpi-typescript print-config
+```
+
+| Option              | Description         | Type      |
+| ------------------- | ------------------- | --------- |
+| `--help`<br>`-h`    | Show help           | `boolean` |
+| `--version`<br>`-v` | Show version number | `boolean` |
+
+<!-- /cli-help -->
+
+## Notes
+
+### General
+
+- [tsconfig Cheat Sheet](https://www.totaltypescript.com/tsconfig-cheat-sheet)
+
+### Other shared tsconfig projects
+
+- [tsconfig/bases](https://github.com/tsconfig/bases)
+- [sindresorhus/tsconfig](https://github.com/sindresorhus/tsconfig)
+- [total-typescript/tsconfig](https://github.com/total-typescript/tsconfig)
+
+### Future integrations
+
+- [Are The Types Wrong](https://github.com/arethetypeswrong/arethetypeswrong.github.io),\
+  e.g. `attw --format ascii --no-summary --profile esm-only --pack .`
+
+<!-- license -->
+
+## License
+
+[MIT](license.txt) © Eric Mika
+
+<!-- /license -->

package/tsconfigs/base.json

@@ -0,0 +1,23 @@
+{
+	"compilerOptions": {
+		"target": "ES2023",
+		"jsx": "react",
+		"lib": ["ES2023", "DOM", "DOM.Iterable"],
+		"useDefineForClassFields": true,
+		"module": "ESNext",
+		"moduleResolution": "bundler",
+		"resolveJsonModule": true,
+		"allowImportingTsExtensions": true,
+		"allowJs": true,
+		"checkJs": true,
+		"strict": true,
+		"allowUnreachableCode": true,
+		"noFallthroughCasesInSwitch": true,
+		"noUnusedLocals": true,
+		"noUnusedParameters": true,
+		"noEmit": true,
+		"isolatedModules": true,
+		"skipLibCheck": true,
+		"noErrorTruncation": true
+	}
+}