@tofrankie/tsconfig 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## tsconfig@0.0.1 (2026-03-29)
+
+- Initial release

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Frankie
+
+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,93 @@
+# @tofrankie/tsconfig
+
+![npm version](https://img.shields.io/npm/v/@tofrankie/tsconfig) ![node version](https://img.shields.io/node/v/@tofrankie/tsconfig) ![npm package license](https://img.shields.io/npm/l/@tofrankie/tsconfig) ![npm last update](https://img.shields.io/npm/last-update/@tofrankie/tsconfig)
+
+Shared [tsconfig](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html) configuration.
+
+## Usage
+
+```bash
+$ pnpm add typescript @tofrankie/tsconfig -D
+```
+
+Create a `tsconfig.json` in your project root:
+
+```json
+{
+  "extends": "@tofrankie/tsconfig/react.vite.json"
+  // other options...
+}
+```
+
+## Presets
+
+Use `@tofrankie/tsconfig/<filename>` in `extends`. If the last column of the table is not `—`, also add those packages to this project's devDependencies.
+
+| Preset                | Purpose (how to choose)                            | Extra dependencies      |
+| --------------------- | -------------------------------------------------- | ----------------------- |
+| `strict.json`         | Stricter rules                                     | —                       |
+| `dom.json`            | Web App / DOM API                                  | —                       |
+| `node.json`           | Node scripts / services / CLI (`@tsconfig/node20`) | —                       |
+| `lib.json`            | npm packages to publish (independent of runtime)   | —                       |
+| `node.lib.json`       | Node packages to publish                           | —                       |
+| `react.json`          | React App (bundler-agnostic)                       | —                       |
+| `react.vite.json`     | React + Vite                                       | `vite`                  |
+| `react.lib.json`      | React component libraries to publish               | —                       |
+| `react.lib.vite.json` | React component libraries developed with Vite      | `vite`                  |
+| `vue.json`            | Vue 3 App (bundler-agnostic)                       | —                       |
+| `vue.vite.json`       | Vue 3 + Vite                                       | `vite`                  |
+| `vue.lib.json`        | Vue 3 component libraries to publish               | —                       |
+| `vue.lib.vite.json`   | Vue 3 component libraries developed with Vite      | `vite`                  |
+| `vitest.json`         | Testing with Vitest                                | `@types/node`, `vitest` |
+
+Dependency relationships between them: **[DEPENDENCY_GRAPH](./DEPENDENCY_GRAPH.md)**.
+
+## Examples
+
+### React + Vite
+
+`tsconfig.json`
+
+```json
+{
+  "references": [{ "path": "./tsconfig.app.json" }, { "path": "./tsconfig.node.json" }],
+  "files": []
+}
+```
+
+`tsconfig.app.json`
+
+```json
+{
+  "extends": "@tofrankie/tsconfig/react.vite.json",
+  "compilerOptions": {
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo"
+  },
+  "include": ["src"]
+}
+```
+
+`tsconfig.node.json`
+
+```json
+{
+  "extends": "@tofrankie/tsconfig/node.json",
+  "compilerOptions": {
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo"
+  },
+  "include": ["vite.config.ts"]
+}
+```
+
+## Acknowledgements
+
+Thanks to these referenced packages:
+
+- `@tsconfig/node20`
+- `@tsconfig/strictest`
+- `@tsconfig/vite-react`
+- `@vue/tsconfig`
+
+## License
+
+MIT

package/base/tsconfig/node20/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://www.schemastore.org/tsconfig",
+  "_version": "20.1.0",
+
+  "compilerOptions": {
+    "lib": ["es2023"],
+    "module": "nodenext",
+    "target": "es2022",
+
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "moduleResolution": "node16"
+  }
+}

package/base/tsconfig/strictest/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "strict": true,
+    "allowUnusedLabels": false,
+    "allowUnreachableCode": false,
+    "exactOptionalPropertyTypes": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+
+    "isolatedModules": true,
+
+    "esModuleInterop": true,
+    "skipLibCheck": true
+  },
+  "$schema": "https://www.schemastore.org/tsconfig",
+  "_version": "2.0.0"
+}

package/base/tsconfig/vite-react/tsconfig.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "https://www.schemastore.org/tsconfig",
+  "_version": "7.0.0",
+
+  "compilerOptions": {
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
+    "target": "ES2022",
+    "useDefineForClassFields": true,
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "moduleDetection": "force",
+    "noEmit": true,
+    "jsx": "react-jsx",
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "erasableSyntaxOnly": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedSideEffectImports": true
+  }
+}

package/base/vue/tsconfig/tsconfig.dom.json

@@ -0,0 +1,24 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "lib": [
+      // Target ES2022 to align with Vite.
+      // <https://vite.dev/config/build-options.html#build-target>
+      // Support for newer versions of language built-ins are
+      // left for the users to include, because that would require:
+      //   - either the project doesn't need to support older versions of browsers;
+      //   - or the project has properly included the necessary polyfills.
+      "ES2022",
+
+      "DOM",
+      "DOM.Iterable"
+
+      // No `ScriptHost` because Vue 3 dropped support for IE
+    ],
+
+    // Set to empty to avoid accidental inclusion of unwanted types,
+    // e.g. the Node.js types that would pollute the global scope.
+    // It's the default value in TS 6+, too.
+    "types": []
+  }
+}

package/base/vue/tsconfig/tsconfig.json

@@ -0,0 +1,65 @@
+{
+  "compilerOptions": {
+    // Most non-library projects don't need to emit declarations.
+    // So we add this option by default to make the config more friendly to most users.
+    "noEmit": true,
+
+    // As long as you are using a build tool, we recommend you to author and ship in ES modules.
+    // Even if you are targeting Node.js, because
+    //  - `CommonJS` is too outdated
+    //  - the ecosystem hasn't fully caught up with `Node16`/`NodeNext`
+    // This recommendation includes environments like Vitest, Vite Config File, Vite SSR, etc.
+    "module": "ESNext",
+
+    // We expect users to use bundlers.
+    // So here we enable some resolution features that are only available in bundlers.
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "allowImportingTsExtensions": true,
+    // Even files without `import` or `export` are treated as modules.
+    // It helps to avoid mysterious errors such as `Cannot redeclare block-scoped variable 'name`.
+    // https://www.totaltypescript.com/cannot-redeclare-block-scoped-variable#solution-3-your-module-isnt-a-module
+    "moduleDetection": "force",
+
+    // Required in Vue projects
+    "jsx": "preserve",
+    "jsxImportSource": "vue",
+
+    // `"noImplicitThis": true` is part of `strict`
+    // Added again here in case some users decide to disable `strict`.
+    // This enables stricter inference for data properties on `this`.
+    "noImplicitThis": true,
+    // Strict mode is on by default in TS 6+
+    "strict": true,
+
+    // This option is part of the recommended tsconfig as of TS 5.9.
+    // Commented out for now. It's hard to land in the current ecosystem.
+    // Needs more consensus before moving forward.
+    // "exactOptionalPropertyTypes": true,
+
+    // <https://devblogs.microsoft.com/typescript/announcing-typescript-5-0/#verbatimmodulesyntax>
+    // Any imports or exports without a type modifier are left around. This is important for `<script setup>`.
+    // Anything that uses the type modifier is dropped entirely.
+    "verbatimModuleSyntax": true,
+
+    // A few notes:
+    // - Vue 3 supports ES2016+
+    // - For Vite, the actual compilation target is determined by the
+    //   `build.target` option in the Vite config.
+    //   So don't change the `target` field here. It has to be
+    //   at least `ES2020` for dynamic `import()`s and `import.meta` to work correctly.
+    // - If you are not using Vite, feel free to overwrite the `target` field.
+    "target": "ESNext",
+    // For spec compliance.
+    // `true` by default if the `target` is `ES2020` or higher.
+    // Explicitly set it to `true` here in case some users want to overwrite the `target`.
+    "useDefineForClassFields": true,
+
+    // Recommended
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "libReplacement": false,
+    // See <https://github.com/vuejs/vue-cli/pull/5688>
+    "skipLibCheck": true,
+  }
+}

package/base/vue/tsconfig/tsconfig.lib.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    // Emit declaration files for the library.
+    "noEmit": false,
+    "declaration": true,
+    "emitDeclarationOnly": true,
+
+    // Libraries generally require more strict type accuracy.
+    // For example, its types must be compatible with the Vue types.
+    // So we don't want to skip the type checking of its dependencies.
+    "skipLibCheck": false,
+
+    // See <https://www.semver-ts.org/formal-spec/5-compiler-considerations.html#strictness>
+    // Part of the recommended tsconfig as of TS 5.9.
+    // Flags starting with `no` are likely to have false positives,
+    // So they are not suitable for existing codebases, but are recommended for new codebases,
+    // as well as libraries that need to be more strict about their types.
+    // See also <https://github.com/vuejs/tsconfig/issues/38#issuecomment-3524621112> for more discussion.
+    "noUncheckedIndexedAccess": true,
+  }
+}

package/dom.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./strict.json",
+  "compilerOptions": {
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "bundler"
+  }
+}

package/lib.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./strict.json",
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true
+  }
+}

package/node.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["./strict.json", "./base/tsconfig/node20/tsconfig.json"]
+}

package/node.lib.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["./node.json", "./lib.json"]
+}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@tofrankie/tsconfig",
+  "type": "module",
+  "version": "0.0.1",
+  "description": "Shared tsconfig configuration",
+  "author": "Frankie <1426203851@qq.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/tofrankie/config/tree/main/packages/tsconfig",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tofrankie/config.git",
+    "directory": "packages/tsconfig"
+  },
+  "bugs": "https://github.com/tofrankie/config/issues",
+  "keywords": [
+    "tsconfig",
+    "tofrankie"
+  ],
+  "files": [
+    "CHANGELOG.md",
+    "base",
+    "dom.json",
+    "lib.json",
+    "node.json",
+    "node.lib.json",
+    "react.json",
+    "react.lib.json",
+    "react.lib.vite.json",
+    "react.vite.json",
+    "strict.json",
+    "vitest.json",
+    "vue.json",
+    "vue.lib.json",
+    "vue.lib.vite.json",
+    "vue.vite.json"
+  ],
+  "engines": {
+    "node": "^20.0.0 || ^22.0.0 || ^24.0.0"
+  },
+  "peerDependencies": {
+    "typescript": ">=5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@tsconfig/node20": "^20.1.9",
+    "@tsconfig/strictest": "^2.0.8",
+    "@tsconfig/vite-react": "^7.0.2",
+    "@vue/tsconfig": "^0.9.0",
+    "jsonc-parser": "^3.3.1",
+    "publint": "^0.3.18",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.2"
+  },
+  "scripts": {
+    "build": "tsx ./scripts/build.ts",
+    "test": "pnpm build && vitest run",
+    "publint": "publint"
+  }
+}

package/react.json

@@ -0,0 +1,6 @@
+{
+  "extends": "./dom.json",
+  "compilerOptions": {
+    "jsx": "react-jsx"
+  }
+}

package/react.lib.json

@@ -0,0 +1,6 @@
+{
+  "extends": ["./dom.json", "./lib.json"],
+  "compilerOptions": {
+    "jsx": "react-jsx"
+  }
+}

package/react.lib.vite.json

@@ -0,0 +1,6 @@
+{
+  "extends": "./react.lib.json",
+  "compilerOptions": {
+    "types": ["vite/client"]
+  }
+}

package/react.vite.json

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

package/strict.json

@@ -0,0 +1,3 @@
+{
+  "extends": "./base/tsconfig/strictest/tsconfig.json"
+}

package/vitest.json

@@ -0,0 +1,6 @@
+{
+  "extends": "./node.json",
+  "compilerOptions": {
+    "types": ["node", "vitest/globals"]
+  }
+}

package/vue.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["./dom.json", "./base/vue/tsconfig/tsconfig.dom.json"]
+}

package/vue.lib.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["./dom.json", "./lib.json", "./base/vue/tsconfig/tsconfig.lib.json"]
+}

package/vue.lib.vite.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./vue.lib.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "types": ["vite/client"],
+    "module": "ESNext",
+    "moduleResolution": "bundler"
+  }
+}

package/vue.vite.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./vue.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "types": ["vite/client"],
+    "module": "ESNext",
+    "moduleResolution": "bundler"
+  }
+}