[RFC] TypeScript tool support

[atian25]

背景

当前使用 TypeScript 开发 Egg ，会面临的影响开发者体验问题：

• Egg 最精髓的 Loader 自动加载机制，导致 TS 无法静态分析出部分依赖，譬如 app/service/news.ts 会自动挂载为 ctx.service.news 。
• Egg 的 Config 自动合并机制下，如何在 config.{env}.js 里面修改插件提供的配置时，能校验并智能提示？
• 开发期需要独立开一个 tsc -w 独立进程来构建代码，带来临时文件位置纠结以及 npm scripts 复杂化。
• 单元测试，覆盖率测试，线上错误堆栈如何指向 TS 源文件，而不是编译后的 js 文件。

思路

• 约束
  • Egg 目前没有计划使用 TS 重写。
  • Egg 以及它对应的插件，提供对应的 index.d.ts 文件方便开发者使用。
• 通过 TS 的 Declaration Merging 编写 d.ts 来辅助定位。
• 使用 TS 2.8 提供的 Conditional Types 黑魔法。
• 通过工具链方面的支持，在开发期无需编译 TS
  • egg loader 支持开发期加载 ts 文件
  • egg-bin 等工具支持 sourcemap 和 ts-node
• 同样需引入工具链映射 sourcemap

事项

• egg-core loader : feat: loader support custom extension core#156
• egg-cluster : feat: add typescript support cluster#61
• egg-bin : feat: support typescript bin#89
  • common-bin : fix: execArgv convert rule node-modules/common-bin#20
  • --require: fix: --require node-modules/common-bin#21
  • nyc cov 覆盖率: feat: cov support typescript bin#91
  • 支持读取 egg.typescript: feat: support egg.typescript bin#92
  • ts-node 的 tsc 版本
• egg-mock
  • feat: support ts mock#70
  • feat: support ts from env and pkg mock#71
• egg-view-nunjucks: feat: support ts filter egg-view-nunjucks#27
• egg-scripts
  • support sourcemap error stack feat: provides source map support for stack traces scripts#19
• 自动生成 d.ts - egg-ts-helper : https://github.com/whxaxes/egg-ts-helper
• docs
  • guide docs docs: add TypeScript Guide #2324
  • 语雀 https://yuque.com/egg/nodejs/ts-egg
  • 知乎 https://zhuanlan.zhihu.com/p/35334932
  • 折腾史 Egg TS 改造总结 whxaxes/blog#12
• example
  • feat: update to new egg-bin examples#63
  • feat: use egg 2.6.0 examples#66
• d.ts chore: improve d.ts with ts support #2306
• boilerplate https://github.com/eggjs/egg-boilerplate-ts

后续

以下内容不属于本期内容，仅做备忘，后续跟进

• autod
• pkgfiles
• egg-di : https://github.com/shepherdwind/egg-di
• tegg

[atian25]

cov 有问题，要看看

https://github.com/istanbuljs/istanbuljs.github.io/blob/development/content/docs/tutorials/typescript.md

[atian25]

ts-node 锁版本的，tsc 版本不匹配，可能有坑。。。

[popomore]

egg-bin 提供一个使用 ts-node 的 tsc？我还不清楚具体差异。

[atian25]

egg-bin 提供一个使用 ts-node 的 tsc？我还不清楚具体差异。

@popomore 具体指？

我想的是，fork 一个 ts-node 然后去掉它的 lock，这样可以直接用 tsc 的最新版

[whxaxes]

我在想，ts 的那些拓展能力没有写到官方文档里的，只是写在了 wiki 中，是不是意味着不是稳定的，我觉得 ts-node 的作者是不是担心 ts 某个版本突然把某个 api 改掉了，就 break 了，所以才把版本给锁了

[atian25]

但起码要更新吧。 或者提个 PR 帮他把 lock 更新到最新吧

其实我觉得更有可能是他升级了 npm5 后，无意识的加了 package-lock

[atian25]

看错了。。。 ts-node 没有带 tsc 的，那是 dev dep。

[atian25]

• egg-scripts - support sourcemap error stack feat: provides source map support for stack traces scripts#19
• example feat: update to new egg-bin examples#63
• d.ts chore: improve d.ts with ts support #2306

[atian25]

更新正文，补充背景和思路

[atian25]

• PowerPartial，EggPlugin，EnvType 下沉到 egg，合并到那个 PR
• 编写插件开发指南
• 更新 example
• Middleware Options
• ets 支持 import plugin
• ets 支持检查同名文件并提醒
• 编写 TS 踩坑折腾史