# @edx/typescript-config 中文文档

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

版本：1\.1\.0
npm 元数据更新时间：2026-07-10T14:30:02.463Z
中文译文更新时间：2026-11-13T07:49:44.075Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：41.9 kB，13 个文件
- TypeScript 类型：未声明
- 运行依赖：0 个
- peer 依赖：typescript ^4\.9\.4
- 首次发布：2023-04-13T12:17:17.404Z
- 最新版本发布：2024-08-08T14:28:06.243Z
- 近 30 天下载量：25199（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

EdX JavaScript代码的TypeScript配置.

## 安装

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

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

## README

[![Build Status](https://github.com/openedx/typescript-config/actions/workflows/release.yml/badge.svg)](https://github.com/openedx/typescript-config/actions/workflows/release.yml/) [![NPM Version](https://img.shields.io/npm/v/@edx/typescript-config.svg)](https://www.npmjs.com/package/@edx/typescript-config) [![npm\_downloads](https://img.shields.io/npm/dt/@edx/typescript-config.svg)](https://www.npmjs.com/package/@edx/tpyescript-config) [![license](https://img.shields.io/npm/l/@edx/typescript-config.svg)](https://github.com/openedx/typescript-config/blob/main/LICENSE) [![semantic release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

# @ edx/ typescript- config

## 关于

在目录中存在 tsconfig.json 文件,表明目录是TypeScript工程的根. tsconfig.json 文件指定了编译工程所需的根文件和编译器选项(来自 [https://www.typescriptlang.org/docs/handbook/tsconfig-json.html 互联网档案馆的存檔,存档日期2014-12-22](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html)) (中文(简体) ).

## 安装

```
npx install-peerdeps --dev @edx/typescript-config
```

这将安装软件包及其所有对等依赖 .

## 使用量

在仓库中创建文件 `tsconfig.json`,带有条款 `"extends": "@edx/typescript-config"`,添加对根目录、输出目录和目录的引用,以包含/排除TypeScript汇编.

```Sample
{
  "extends": "@edx/typescript-config",
  "compilerOptions": {
    "rootDir": ".",
    "outDir": "dist"
  },
  "include": ["src/**/*"],
  "exclude": ["dist", "node_modules"]
}
```

## 常见问题

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

EdX JavaScript代码的TypeScript配置\.

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

在项目目录运行 npm install @edx/typescript-config，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：typescript（^4\.9\.4）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

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

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/edx\_\_typescript-config 是否存在。

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

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

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

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

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

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