feat: auto register tsconfig-paths on env.EGG_TYPESCRIPT enable #254

fengmk2 · 2022-12-19T05:08:11Z

Checklist

npm test passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

Description of change

codecov · 2022-12-19T05:10:53Z

Codecov Report

Base: 99.75% // Head: 99.75% // Increases project coverage by +0.00% 🎉

Coverage data is based on head (41725d7) compared to base (877b4f3).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #254   +/-   ##
=======================================
  Coverage   99.75%   99.75%           
=======================================
  Files          19       19           
  Lines        1207     1209    +2     
  Branches      211      212    +1     
=======================================
+ Hits         1204     1206    +2     
  Misses          3        3

Impacted Files	Coverage Δ
lib/loader/egg_loader.js	`100.00% <ø> (ø)`
lib/egg.js	`100.00% <100.00%> (ø)`

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[skip ci] ## [4.30.0](v4.29.0...v4.30.0) (2022-12-19) ### Features * auto register tsconfig-paths on env.EGG_TYPESCRIPT enable ([#254](#254)) ([6d75322](6d75322))

github-actions · 2022-12-19T05:20:10Z

🎉 This PR is included in version 4.30.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

fengmk2 · 2022-12-19T05:24:05Z

lib/egg.js

@@ -31,6 +31,10 @@ class EggCore extends KoaApplication {
   */
  constructor(options = {}) {
    options.baseDir = options.baseDir || process.cwd();
+    // auto require('tsconfig-paths/register') on typescript app
+    if (process.env.EGG_TYPESCRIPT === 'true') {


还需要增加一个 options 参数支持，生产环境不会使用 ts-node 运行，所以这里不会有 EGG_TYPESCRIPT，但是又需要 tsconfig-paths/register

#255 读取 package.json

xsbear · 2023-04-03T06:07:02Z

最近我们的egg项目升级依赖后，生产环境部署启动抛错：“Couldn't find tsconfig.json. tsconfig-paths will be skipped”，开始一直没找到什么原因，后来排查发现跟这个更新有关。我们的项目是ts的，也未用到 paths映射，且生产构建后并没有把tsconfig.json 保留，但是 package.json 中的typescript属性还是为true，默认加载 tsconfig-paths后，就会导致抛 “Couldn't find tsconfig.json“ 的error。

解决方法倒不难，生产输出包中保留tsconfig.json （如果确实用到 paths映射，那还是必需的），或者改一下生产构建后的package.json，将typescript属性改为false。不知道其他用户是否有类似情况，建议可以做一个更新说明，或者给到一些生产环境构建输出的实践建议

fengmk2 · 2023-04-03T06:42:41Z

@xsbear 能否给一个可以复现的代码库和复现方式？

xsbear · 2023-04-05T14:49:26Z

@fengmk2 抱歉，我现在用 npm init egg --type=ts 初始化出来的已经是egg3.x版本了，跟我们项目使用的 egg2.x 已有差异，但tsc后去掉tsconfig.json，还是会报这个错，只不过3.x版本的example本身就用到了 paths映射，所以tsconfig.json在生产环境中也必需保留。代码库就不上传了。

在生产构建中不保留tsconfig.json，是我们这边的工程实践。我们这么做，也符合基本认知，生产环境用的是构建后的js，理论上是不需要tsconfig.json。但是这个更新后，如果package.json 中的typescript属性还是为true，则会默认加载 tsconfig-paths/register，没有tsconfig.json 自然会报错。解决方案我上面也说了，只是说这个更新确实对我们的生产环境启动产生了新的约束，如果有其他用户也碰到类似问题，可以参考一下，如果只是个例，也请忽略。

fengmk2 · 2023-04-06T04:18:57Z

@xsbear ts 项目基本都会用到 tsconfig-paths alias，编译出来的 js 文件对应的 require 代码也是依赖 tsconfig-paths 才能正常 require 的，除非是完全没有使用到 tsconfig-paths alias。

xsbear · 2023-04-06T07:07:16Z

@fengmk2 是的。只是我们的情况相对特殊，目前都没有用到 path alias，所以之前生产构建没有保留tsconfig.json 也没问题。这个版本更新后，就出问题了，好在现在已找到原因，解决方案也有，没事了哈。

fengmk2 · 2023-04-06T09:35:21Z

@xsbear 我还是加个修复判断吧，如果没有 tsconfig.json，不自动注入 tsconfig-paths

Avoid warning message: Couldn't find tsconfig.json. tsconfig-paths will be skipped closes #254 (comment)

fengmk2 · 2023-04-06T09:57:31Z

#261

Avoid warning message: Couldn't find tsconfig.json. tsconfig-paths will be skipped closes #254 (comment)

[skip ci] ## [5.3.1](v5.3.0...v5.3.1) (2023-04-06) ### Bug Fixes * skip register tsconfig-paths if tsconfig.json not exists ([#261](#261)) ([24a0d64](24a0d64)), closes [/github.com//pull/254#issuecomment-1493713971](https://github.com/eggjs//github.com/eggjs/egg-core/pull/254/issues/issuecomment-1493713971)

xsbear · 2023-04-06T11:54:24Z

@fengmk2 4.x 版本会release吗？

fengmk2 · 2023-04-06T13:13:32Z

@xsbear 会的，我 pick 一下。

Avoid warning message: Couldn't find tsconfig.json. tsconfig-paths will be skipped closes #254 (comment) pick from #261

fengmk2 · 2023-04-07T01:09:32Z

@fengmk2 4.x 版本会release吗？

egg-core@4.30.2

feat: auto register tsconfig-paths on env.EGG_TYPESCRIPT enable

41725d7

fengmk2 added the enhancement label Dec 19, 2022

fengmk2 requested a review from popomore December 19, 2022 05:08

popomore approved these changes Dec 19, 2022

View reviewed changes

fengmk2 merged commit 6d75322 into master Dec 19, 2022

fengmk2 deleted the auto-require-tsconfig-paths branch December 19, 2022 05:18

atian25 pushed a commit that referenced this pull request Dec 19, 2022

Release 4.30.0

9bd5c28

[skip ci] ## [4.30.0](v4.29.0...v4.30.0) (2022-12-19) ### Features * auto register tsconfig-paths on env.EGG_TYPESCRIPT enable ([#254](#254)) ([6d75322](6d75322))

github-actions bot added the released label Dec 19, 2022

fengmk2 commented Dec 19, 2022

View reviewed changes

fengmk2 added a commit that referenced this pull request Apr 6, 2023

fix: skip register tsconfig-paths if tsconfig.json not exists

6bec6c9

Avoid warning message: Couldn't find tsconfig.json. tsconfig-paths will be skipped closes #254 (comment)

fengmk2 mentioned this pull request Apr 6, 2023

fix: skip register tsconfig-paths if tsconfig.json not exists #261

Merged

4 tasks

fengmk2 added a commit that referenced this pull request Apr 6, 2023

fix: skip register tsconfig-paths if tsconfig.json not exists (#261)

24a0d64

Avoid warning message: Couldn't find tsconfig.json. tsconfig-paths will be skipped closes #254 (comment)

fengmk2 added a commit that referenced this pull request Apr 6, 2023

fix: skip register tsconfig-paths if tsconfig.json not exists

d20a5d6

Avoid warning message: Couldn't find tsconfig.json. tsconfig-paths will be skipped closes #254 (comment) pick from #261

fengmk2 mentioned this pull request Apr 6, 2023

fix: skip register tsconfig-paths if tsconfig.json not exists #263

Merged

4 tasks

fengmk2 added a commit that referenced this pull request Apr 7, 2023

fix: skip register tsconfig-paths if tsconfig.json not exists (#263)

eaeabd6

Avoid warning message: Couldn't find tsconfig.json. tsconfig-paths will be skipped closes #254 (comment) pick from #261

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: auto register tsconfig-paths on env.EGG_TYPESCRIPT enable #254

feat: auto register tsconfig-paths on env.EGG_TYPESCRIPT enable #254

fengmk2 commented Dec 19, 2022

codecov bot commented Dec 19, 2022 •

edited

Loading

github-actions bot commented Dec 19, 2022

fengmk2 Dec 19, 2022

fengmk2 Dec 19, 2022

xsbear commented Apr 3, 2023

fengmk2 commented Apr 3, 2023

xsbear commented Apr 5, 2023 •

edited

Loading

fengmk2 commented Apr 6, 2023

xsbear commented Apr 6, 2023

fengmk2 commented Apr 6, 2023

fengmk2 commented Apr 6, 2023

xsbear commented Apr 6, 2023

fengmk2 commented Apr 6, 2023

fengmk2 commented Apr 7, 2023

feat: auto register tsconfig-paths on env.EGG_TYPESCRIPT enable #254

feat: auto register tsconfig-paths on env.EGG_TYPESCRIPT enable #254

Conversation

fengmk2 commented Dec 19, 2022

Checklist

Affected core subsystem(s)

Description of change

codecov bot commented Dec 19, 2022 • edited Loading

Codecov Report

github-actions bot commented Dec 19, 2022

fengmk2 Dec 19, 2022

Choose a reason for hiding this comment

fengmk2 Dec 19, 2022

Choose a reason for hiding this comment

xsbear commented Apr 3, 2023

fengmk2 commented Apr 3, 2023

xsbear commented Apr 5, 2023 • edited Loading

fengmk2 commented Apr 6, 2023

xsbear commented Apr 6, 2023

fengmk2 commented Apr 6, 2023

fengmk2 commented Apr 6, 2023

xsbear commented Apr 6, 2023

fengmk2 commented Apr 6, 2023

fengmk2 commented Apr 7, 2023

codecov bot commented Dec 19, 2022 •

edited

Loading

xsbear commented Apr 5, 2023 •

edited

Loading