ts-帮助
这是一个简单的 TypeScript 工具, 我们在 Glide 使用, 有两个目的:
- 它发现循环进口 在我们的源文件。 我们曾经
使用情况 爱斯林特的
import/no-cycle规则 但是在我们的项目上 它非常缓慢 有时找不到现有的循环. - 它输出了我们项目中所有 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-帮助检测周期 在代码库:
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