# @checkdigit/typescript-config 中文文档

规范地址：https://npmcn.com/package/%40checkdigit/typescript-config/

版本：10\.2\.2
npm 元数据更新时间：2026-10-05T17:52:03.038Z
中文译文更新时间：2026-11-09T11:41:32.855Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40checkdigit/typescript-config
原文对照：https://npmcn.com/package/%40checkdigit/typescript-config/?lang=original
项目主页：https://github.com/checkdigit/typescript-config#readme
源码仓库：https://github.com/checkdigit/typescript-config

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：60 kB，20 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24\.18\.0 \<25 \|\| \>=26
- 运行依赖：0 个
- peer 依赖：esbuild 0\.28\.2，typescript \>=6\.0\.3 \<7，@types/node \>=24
- 首次发布：2020-09-22T15:52:59.451Z
- 最新版本发布：2026-09-16T16:27:05.602Z
- 近 30 天下载量：8990（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：323（近 12 个月 54 个）

## 中文简介

检查数字标准打字符配置

## 安装

```sh
npm install @checkdigit/typescript-config
```

也可以使用：`pnpm add @checkdigit/typescript-config`、`yarn add @checkdigit/typescript-config`、`bun add @checkdigit/typescript-config`

## README

# 检查数字/ 类型字符配置

[![MIT License](https://img.shields.io/github/license/checkdigit/typescript-config)](https://github.com/checkdigit/typescript-config/blob/master/LICENSE.txt)

版权所有 2021-2026 [检查 Digit, LLC](https://checkdigit.com/)

## 导言

此模块包含标准检查 Digit 类型Script 配置, 以及我们的标准构建工具 `builder`。 。 。 .

## 类型脚本配置

-   目前支持节点24.18.0至但不包括节点25,或节点26及以上.
-   节点25故意不属于支持合同.
-   发射 `esnext`,带有默认库,以避免降级. 旨在选择应用光谱测试 解决在特定环境中没有使用较新特性的任何问题。 浏览器和Node.js是快速移动的 目标,并且可以随时添加语言特性.
-   使用该 `module` 类型 `esnext`。 。 。 .
-   为最大严格性设置了所有编译器选项.

## 构建器

`builder` 是一个命令行工具,从TypeScript源生成无害环境管理模块. 打算用于向国家预防机制发布一个软件包,或捆绑一个软件包用于部署. 用这个 `tsc` 用于生成类型,以及 `esbuild` 用于生成代码.

**说明:** 页:1 `require` 函数将被定义为一个全局变量,以便 动态 `require`s由CommonJS子模块. 这不是Node.js的问题,而是会在浏览器环境中引起问题.

### 选项

-   `--type` 要生成的输出类型。 默认为 `module` (ESM) (英语). 有效值为 `module` 或者说 `types`。 。 。 .
-   `--entryPoint` 捆绑的切入点,相对于inDir。 如果不提供, inDir 中的文件将 作为单独未分解的文件处理.
-   `--inDir` 输入源代码目录.
-   `--outDir` 输出目录.
-   `--outFile` 相对于 `--outDir`此选项用于单文件捆绑,以及 `--entryPoint`。 。 。 .
-   `--external` 从捆绑中排除的外部模块。 内建 `node` 模块自动排除. 通配符 `*` 可用于排除多个外部模块.
-   `--minify` 是否对输出进行最小化.
-   `--sourceMap` 是否包含内入源图.

### 实例

```shell
# build ESM .mjs files from TypeScript source
npx builder --type=module --outDir=build-esm

# build single-file ESM .mjs bundle from TypeScript source
npx builder --type=module --outDir=build-esm-bundle --entryPoint=index.ts --outFile=index.mjs
```

## 测试

这个单元包括一些集成式测试, 以确保 TypeScript 的特定版本将相互操作 与 `builder`,除运行时间外,Check Digit使用的库和框架:

-   最近的TC39提案
-   由 AWS Lambda, Google Cloud 函数和 Azure 函数支持的节点版本
-   ESLint和 `@typescript-eslint/eslint-plugin`
-   内建 `node:test` 运行
-   `prettier`
-   `tsc`,以及 TypeScript 各版本中引入的具体功能
-   `esbuild`
-   Wallaby.js (支助) `node:test` 依赖本地节点类型选择支持)

我们这样做是为了确保TypeScript的升级不会打破这些依赖性, 并且这些相关项目的更新不会中断构建.

注意: TypeScript 的新主要版本不是立即 由eslint、更漂亮、打字-slint、, 包括: 我们的政策是等到这些项目得到充分支持 新版本的TypeScript,和/或在这些测试中不发出警告,在发布之前.

### 关于版本的注释

由于TypeScript本身不坚持 semver,严格的semver有点复杂. 因此,我们的"最大努力"政策是:

-   每次更新到最小节点目标(如节点18到节点20),或更改为主要编译器输出选项 (例如:. `module`, (中文(简体) ), `target` 或者说 `moduleResolution`)将产生本单元新的主要版本. 我们和最新版本的LTS节点 由亚马逊·兰布达支持, Google云函数和Azure函数.
-   每个"主要"版本的TypeScript(例如. `5.7.x` 改为 `5.8.x`)将产生这个模块的新小版本.
-   对TypeScript(例如. `5.7.2` 改为 `5.7.3`)或密钥依赖(如节点) `22.11` 转到节点 `22.14`(中文(简体) ) _可能_ 结果是补丁.

记住,任何对TypeScript的更新都有可能打破你的构建. 但希望能有所帮助.

### 安装

```shell
npm add -D @checkdigit/typescript-config
```

注意: 您不需要明确安装 TypeScript 本身, 因为最近支持的版本是作为 相对依赖关系 `@checkdigit/typescript-config`。 。 。 .

确定你的项目 `tsconfig.json` 扩展 `@checkdigit/typescript-config`。 。 。 .

### 示例 `tsconfig.json`

```json
{
  "extends": "@checkdigit/typescript-config"
}
```

注意此配置有 `moduleResolution` 设置为 `bundler`。 。 。 . 这需要使用 `builder` 命令 生成用于部署的工作代码.

## 许可证

麻省理工学院

## 常见问题

### @checkdigit/typescript-config 是什么？

检查数字标准打字符配置

### 如何安装 @checkdigit/typescript-config？

在项目目录运行 npm install @checkdigit/typescript-config，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：esbuild（0\.28\.2）、typescript（\>=6\.0\.3 \<7）、@types/node（\>=24）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 builder，可以用 npx builder 直接运行。

### @checkdigit/typescript-config 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @checkdigit/typescript-config 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @checkdigit/typescript-config 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=24\.18\.0 \<25 \|\| \>=26。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @checkdigit/typescript-config 可以商用吗？

@checkdigit/typescript-config 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @checkdigit/typescript-config 的下载量有多少？

根据 npm 官方下载统计，@checkdigit/typescript-config 在 2026/10/10 – 2026/11/08 这 30 天内被下载 8,990 次，日均约 300 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @checkdigit/typescript-config 还在维护吗？

最新版本 10\.2\.2 发布于 2026/09/17（1 个月前）；至今共发布 323 个版本，其中过去 12 个月发布了 54 个；首次发布于 2020/09/22。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。