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

Avoid warning message: Couldn't find tsconfig.json. tsconfig-paths will be skipped

closes #254 (comment)

.github/workflows/nodejs.yml

@@ -14,4 +14,4 @@ jobs:
     name: Node.js
     uses: artusjs/github-actions/.github/workflows/node-test.yml@v1
     with:
-      version: '14.17.0, 14, 16, 18'
+      version: '14.19.0, 14, 16, 18'

lib/loader/egg_loader.js

@@ -46,7 +46,13 @@ class EggLoader {
     // auto require('tsconfig-paths/register') on typescript app
     // support env.EGG_TYPESCRIPT = true or { "egg": { "typescript": true } } on package.json
     if (process.env.EGG_TYPESCRIPT === 'true' || (this.pkg.egg && this.pkg.egg.typescript)) {
-      require('tsconfig-paths').register({ cwd: this.options.baseDir });
+      // skip require tsconfig-paths if tsconfig.json not exists
+      const tsConfigFile = path.join(this.options.baseDir, 'tsconfig.json');
+      if (fs.existsSync(tsConfigFile)) {
+        require('tsconfig-paths').register({ cwd: this.options.baseDir });
+      } else {
+        this.options.logger.info('[egg:loader] skip register "tsconfig-paths" because tsconfig.json not exists at %s', tsConfigFile);
+      }
     }
 
     /**

package.json

@@ -33,7 +33,7 @@
   },
   "homepage": "https://github.com/eggjs/egg-core#readme",
   "engines": {
-    "node": ">= 14.17.0"
+    "node": ">= 14.19.0"
   },
   "devDependencies": {
     "await-event": "^2.1.0",

test/egg-ts.test.js

@@ -120,6 +120,15 @@ describe('test/egg-ts.test.js', () => {
     assert(app.serviceClasses.test);
   });
 
+  it('should auto require tsconfig-paths', async () => {
+    mm(process.env, 'EGG_TYPESCRIPT', 'true');
+    app = utils.createApp('egg-ts-js-tsconfig-paths');
+
+    app.loader.loadService();
+    assert(app.serviceClasses.lord);
+    assert(app.serviceClasses.test);
+  });
+
   it('should not load ts files while EGG_TYPESCRIPT was not exist', async () => {
     app = utils.createApp('egg-ts-js');
 

test/fixtures/egg-ts-js-tsconfig-paths/app/controller/test.ts

@@ -0,0 +1,3 @@
+module.exports = async ctx => {
+  ctx.body = 'ok';
+}

test/fixtures/egg-ts-js-tsconfig-paths/app/extend/application.ts

@@ -0,0 +1,3 @@
+module.exports = {
+  appExtend: 'hello'
+}

test/fixtures/egg-ts-js-tsconfig-paths/app/service/lord.js

@@ -0,0 +1,5 @@
+module.exports = class LordService {
+  jsService() {
+    return 'from js service';
+  }
+}

test/fixtures/egg-ts-js-tsconfig-paths/app/service/test.ts

@@ -0,0 +1,5 @@
+module.exports = class TestService {
+  tsService() {
+    return 'from ts service';
+  }
+}

test/fixtures/egg-ts-js-tsconfig-paths/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "egg-ts"
+}

test/fixtures/egg-ts-js-tsconfig-paths/tsconfig.json

@@ -0,0 +1 @@
+{}