# @glideapps/ts-helper 中文文档

规范地址：https://npmcn.com/package/%40glideapps/ts-helper/

版本：6\.0\.1
npm 元数据更新时间：2026-09-16T16:01:39.947Z
中文译文更新时间：2026-11-16T15:44:30.951Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：46.5 kB，9 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：5 个
- 首次发布：2021-11-11T16:03:48.139Z
- 最新版本发布：2025-12-02T15:16:44.498Z
- 近 30 天下载量：25808（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 1 个）

## 中文简介

分析类型脚本项目

## 安装

```sh
npm install @glideapps/ts-helper
```

也可以使用：`pnpm add @glideapps/ts-helper`、`yarn add @glideapps/ts-helper`、`bun add @glideapps/ts-helper`

## README

# ts-帮助

这是一个简单的 TypeScript 工具, 我们在 Glide 使用, 有两个目的:

1.  它发现循环进口 在我们的源文件。 我们曾经 使用情况 [爱斯林特的 `import/no-cycle` 规则](https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-cycle.md) 但是在我们的项目上 它非常缓慢 有时找不到现有的循环.
2.  它输出了我们项目中所有 TypeScript 源文件的依赖图, 我们可以进一步使用 分析.

## 洞穴

我们只按需要执行 才能在密码库上工作 所以可能有些案子没有 支持,或坠入其中。 如果你遇到这样的情况 请考虑给我们发公关 或者至少报告一下 问题与复制.

少了几件东西,特别是:

-   我们不尊重 `exclude` 在项目配置中.
-   我们只看 `import` (和 `export`(没有) `require`。 。 。 .
-   我们处理类型的导入电话,例如 `type X = import("foo").Bar` 作为正常的"强"进口.

## 使用量

### `-p|--project TS-PROJECT`

添加一个工程. `TS-PROJECT` 可以是带有 `tsconfig.json` 文件,或类型脚本的路径 配置文件 。 ts- helper 将递归添加工程引用, 但是如果需要, 您可以添加多个根工程 改为:.

### `-r|--root SOURCE-FILE`

添加根类型Script源文件。 此文件必须是指定的工程之一 。 可以多加一数.

### `-c|--detect-cycles`

运行所有源文件的循环检测,这些源文件可以从根得到。 如果它探测到一个循环,它将打印其中之一 它发现和退出时有错误状态.

注意它只考虑"强"进口 循环检测,vs `type` 进口和懒惰进口.

### `-o|--output FILENAME`

输出 JSON 文件与依赖图 .

### `-v|--verbose`

在读取和处理项目时打印消息.

## 示例

在Glide的主存储器中,我们有两个TypeScript项目——一个用于前端,一个用于后端. 这个 前端有1个根源文件,后端有2个-一个用于实际后端,一个用于CLI. 是这样的 我们运行 ts-帮助检测周期 在代码库:

```shell
npx "@glideapps/ts-helper" \
    -p ~/Work/glide/functions \
    -r ~/Work/glide/functions/src/cli.ts \
    -r ~/Work/glide/functions/src/index.ts \
    -p ~/Work/glide/app \
    -r ~/Work/glide/app/src/index.tsx \
    -c
```

## 常见问题

### @glideapps/ts-helper 是什么？

分析类型脚本项目

### 如何安装 @glideapps/ts-helper？

在项目目录运行 npm install @glideapps/ts-helper，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 ts-helper，可以用 npx ts-helper 直接运行。

### @glideapps/ts-helper 支持 TypeScript 吗？

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

### @glideapps/ts-helper 支持 ESM 还是 CommonJS？

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

### @glideapps/ts-helper 可以商用吗？

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

### @glideapps/ts-helper 的下载量有多少？

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

### @glideapps/ts-helper 还在维护吗？

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

