@pengzhanbo/tsconfig 1.41.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 pengzhanbo
+
+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,36 @@
+# @pengzhanbo/tsconfig
+
+The tsconfig preset.
+
+## Usage
+
+### Install
+
+```sh
+pnpm add -D @pengzhanbo/tsconfig
+```
+
+### Config
+
+In `tsconfig.json`
+
+```json
+{
+  "extends": "@pengzhanbo/tsconfig/tsconfig.json"
+}
+```
+
+```json
+{
+  "extends": [
+    "@pengzhanbo/tsconfig/tsconfig.json",
+    "@pengzhanbo/tsconfig/tsconfig.lib.json"
+  ]
+}
+```
+
+```json
+{
+  "extends": "@pengzhanbo/tsconfig/tsconfig.vue.json"
+}
+```

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@pengzhanbo/tsconfig",
+  "version": "1.41.0",
+  "author": "pengzhanbo <q942450674@outlook.com> (https://github/pengzhanbo/)",
+  "license": "MIT",
+  "homepage": "https://github.com/pengzhanbo/configs#readme",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:pengzhanbo/configs.git",
+    "directory": "packages/tsconfig"
+  },
+  "keywords": [
+    "tsconfig"
+  ],
+  "main": "tsconfig.json",
+  "peerDependencies": {
+    "typescript": "5.x"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  }
+}

package/tsconfig.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "https://www.schemastore.org/tsconfig",
+  "compilerOptions": {
+    // - 对于Vite而言，实际编译目标由Vite配置中的`build.target`选项决定。
+    //   因此请勿修改此处的`target`字段。为确保动态`import()`和`import.meta`正常工作，该值至少需设置为`ES2020`。
+    // - 若未使用Vite构建工具，可自行覆盖`target`字段配置。
+    "target": "ESNext",
+    // 即使没有 `import` 或 `export` 的文件也会被视为模块。
+    // 这有助于避免诸如“无法重新声明块级作用域变量‘name’”这类难以捉摸的错误。
+    // https://www.totaltypescript.com/cannot-redeclare-block-scoped-variable#solution-3-your-module-isnt-a-module
+    "moduleDetection": "force",
+    // 为了符合规范要求。
+    // 若 `target` 设置为 `ES2020` 或更高版本，默认值为 `true`。
+    // 此处显式设置为 `true`，以防某些用户需要覆盖 `target` 配置。
+    "useDefineForClassFields": true,
+    "libReplacement": false,
+    // 只要您正在使用构建工具，我们建议您编写并发布 ES 模块格式的代码。
+    // 即使您的目标运行环境是 Node.js 也应如此，因为：
+    // - `CommonJS` 已过于陈旧
+    // - 生态系统尚未完全适配 `Node16`/`NodeNext` 模式
+    // 此建议适用于 Vitest、Vite 配置文件、Vite SSR 等各类环境。
+    "module": "ESNext",
+    // 我们预期用户会使用打包工具。
+    // 因此这里启用了一些仅在打包工具中可用的解析功能。
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "allowImportingTsExtensions": true,
+    "strict": true,
+    // `"noImplicitThis": true` 属于 `strict` 选项的组成部分
+    // 此处再次单独声明，以防某些用户选择禁用 `strict` 模式
+    // 该配置会针对 `this` 上的数据属性启用更严格的类型推断。
+    "noImplicitThis": true,
+    // See <https://www.semver-ts.org/formal-spec/5-compiler-considerations.html#strictness>
+    // 截至 TypeScript 5.9 版本，这两个选项也已纳入推荐的 tsconfig 配置中。
+    "noUncheckedIndexedAccess": true,
+    // 目前暂不启用。在当前生态系统中难以落地。
+    // 需要达成更多共识才能推进。
+    // "exactOptionalPropertyTypes": true,
+
+    // 大多数非库项目无需生成声明文件。
+    // 因此我们默认添加此选项，使配置对大多数用户更友好。
+    "noEmit": true,
+
+    // Recommended
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    // <https://devblogs.microsoft.com/typescript/announcing-typescript-5-0/#verbatimmodulesyntax>
+    // 所有未使用类型修饰符的导入或导出语句均会保留。
+    // 任何使用了类型修饰符的内容都会被完全移除。
+    "verbatimModuleSyntax": true,
+    // See <https://github.com/vuejs/vue-cli/pull/5688>
+    "skipLibCheck": true
+  }
+}

package/tsconfig.lib.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://www.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "declaration": true,
+    "emitDeclarationOnly": true,
+
+    // 为库生成声明文件。
+    "noEmit": false,
+    // 库通常需要更严格的类型精确度。
+    // 例如，其类型必须与 Vue 类型兼容。
+    // 因此我们不应跳过其依赖项的类型检查。
+    "skipLibCheck": false
+  }
+}

package/tsconfig.vue.json

@@ -0,0 +1,27 @@
+{
+  "extends": "./tsconfig.json",
+  "display": "Vue 3",
+  "compilerOptions": {
+    // Required in Vue projects
+    "jsx": "preserve",
+    "jsxImportSource": "vue",
+    "lib": [
+      // 目标设置为ES2020以与Vite对齐。
+      // <https://vite.dev/config/build-options.html#build-target>
+      // 对新版本语言内置功能的支持
+      // 交由用户自行处理，因为这将要求：
+      // - 项目无需支持旧版本浏览器；
+      // - 或项目已正确包含必要的polyfill。
+      "ES2020",
+
+      "DOM",
+      "DOM.Iterable"
+
+      // 由于 Vue 3 放弃了对 IE 的支持，因此没有 `ScriptHost`
+    ],
+
+    // 设置为空以避免意外包含不需要的类型，
+    // 例如可能污染全局作用域的Node.js类型。
+    "types": []
+  }
+}