README.zh-hans.md

Type Done

一键安装缺失的 TypeScript 类型声明库。

你也可以去看其他语言的 README：English, 简体中文

---

本工具解析你项目中的 package.json 文件，为你安装缺失的类型声明库，并删除无用的声明库。

（比方说，@types/moment 现在已经废弃，因为 moment 已经内置了 声明文件）

（关于类型声明，可以参考 TypeScript 文档（社区汉化版） 和 definitelytyped.org）

特性

type-done 支持的特性：

• 删除废弃的类型声明库（比如刚才提到的 @types/moment）
• 删除未使用的类型声明库
• 通过读取 npm config 解析你当前设置的仓库源（比如国内用户可能用的是 https://registry.npm.taobao.org/ 而不是 https://registry.npmjs.org/）
• 并发搜索，提高性能
• 顺便检查 @types/node
• 支持 yarn 或 npm 进行处理

本工具灵感来自以下工具，我调整了一些逻辑，运行效率更高：

• salimkayabasi/types-checker
• nfour/types-installer
• T-Specht/ts-typie

安装

全局安装：

• npm -g i type-done
• yarn global add type-done

使用

进入你的 Node 项目文件夹中，然后在终端运行 type-done 命令

type-done [options]

选项

选项	描述
-t, --tool [value]	指定包管理器 (默认按顺序尝试 yarn, pnpm, npm)
--skip-add	跳过往 package.json 新增 @types
--skip-remove	跳过往 package.json 移除 @types
--skip-sort	跳过对 package.json 的依赖进行排序
-s, --skip-install	跳过 install
-d, --dry-run	只进行分析，不做其他动作
-p, --parallel <n>	调整请求 npm 仓库的并发数量 (默认为 10)

贡献

欢迎提 PR。如果是大的改动，那你可以先开一个 issue 来讨论你想进行什么改动。

调整后记得同时更新测试。

License

MIT