f

.gitignore

@@ -33,3 +33,5 @@ cmd/*.js
 !bin/postinstall.js
 .eslintcache
 dist
+test/fixtures/example-declarations/typings/
+!test/fixtures/example-declarations/node_modules

package.json

@@ -51,7 +51,7 @@
     "esbuild": "^0.17.7",
     "esbuild-register": "^3.4.2",
     "eslint": "^8.16.0",
-    "eslint-config-egg": "^12.0.0",
+    "eslint-config-egg": "^13.1.0",
     "git-contributor": "2",
     "npminstall": "^7.5.0",
     "typescript": "^5.2.2"

src/middleware/global_options.ts

@@ -5,12 +5,13 @@ import {
   Inject, ApplicationLifecycle, LifecycleHook, LifecycleHookUnit,
   Program, CommandContext,
 } from '@artus-cli/artus-cli';
+import runscript from 'runscript';
 import { addNodeOptionsToEnv, readPackageJSON, hasTsConfig } from '../utils';
 
 const debug = debuglog('egg-bin:midddleware:global_options');
 
 @LifecycleHookUnit()
-export default class implements ApplicationLifecycle {
+export default class GlobalOptions implements ApplicationLifecycle {
   @Inject()
   private readonly program: Program;
 
@@ -23,6 +24,11 @@ export default class implements ApplicationLifecycle {
         type: 'string',
         alias: 'baseDir',
       },
+      declarations: {
+        description: 'whether create typings, will add `--require egg-ts-helper/register`',
+        type: 'boolean',
+        alias: 'dts',
+      },
       typescript: {
         description: 'whether enable typescript support',
         type: 'boolean',
@@ -117,6 +123,19 @@ export default class implements ApplicationLifecycle {
         addNodeOptionsToEnv(`--loader ${esmLoader}`, ctx.env);
       }
 
+      if (ctx.args.declarations === undefined) {
+        if (typeof ctx.args.pkgEgg.declarations === 'boolean') {
+          // read `egg.declarations` from package.json if not pass argv
+          ctx.args.declarations = ctx.args.pkgEgg.declarations;
+          debug('detect declarations from pkg.egg.declarations=%o', ctx.args.pkgEgg.declarations);
+        }
+      }
+      if (ctx.args.declarations) {
+        const etsBin = require.resolve('egg-ts-helper/dist/bin');
+        debug('run ets first: %o', etsBin);
+        await runscript(`node ${etsBin}`);
+      }
+
       debug('set NODE_OPTIONS: %o', ctx.env.NODE_OPTIONS);
       debug('ctx.args: %o', ctx.args);
       debug('enter next');

test/cmd/dev.test.ts

@@ -33,6 +33,18 @@ describe('test/cmd/dev.test.ts', () => {
       .end();
   });
 
+  it('should dev start work with declarations = true', () => {
+    const cwd = path.join(fixtures, 'example-declarations');
+    return coffee.fork(eggBin, [ 'dev' ], { cwd })
+      .debug()
+      .expect('stdout', /"workers":1/)
+      .expect('stdout', /"baseDir":".*?example-declarations"/)
+      .expect('stdout', /"framework":".*?egg"/)
+      .expect('stdout', /\[egg-ts-helper\] create typings/)
+      .expect('code', 0)
+      .end();
+  });
+
   it('should startCluster with --port', () => {
     return coffee.fork(eggBin, [ 'dev', '--port', '6001' ], { cwd })
       // .debug()

test/fixtures/example-declarations/app/controller/home.js

@@ -0,0 +1,10 @@
+const { Controller } = require('egg');
+
+class HomeController extends Controller {
+  async index() {
+    const { ctx } = this;
+    ctx.body = 'hi, egg';
+  }
+}
+
+module.exports = HomeController;

test/fixtures/example-declarations/app/router.js

@@ -0,0 +1,7 @@
+/**
+ * @param {Egg.Application} app - egg application
+ */
+module.exports = app => {
+  const { router, controller } = app;
+  router.get('/', controller.home.index);
+};

test/fixtures/example-declarations/config/config.default.js

@@ -0,0 +1,28 @@
+/* eslint valid-jsdoc: "off" */
+
+/**
+ * @param {Egg.EggAppInfo} appInfo app info
+ */
+module.exports = appInfo => {
+  /**
+   * built-in config
+   * @type {Egg.EggAppConfig}
+   **/
+  const config = exports = {};
+
+  // use for cookie sign key, should change to your own and keep security
+  config.keys = appInfo.name + '_1704604037320_6202';
+
+  // add your middleware config here
+  config.middleware = [];
+
+  // add your user config here
+  const userConfig = {
+    // myAppName: 'egg',
+  };
+
+  return {
+    ...config,
+    ...userConfig,
+  };
+};

test/fixtures/example-declarations/config/plugin.js

@@ -0,0 +1,7 @@
+/** @type Egg.EggPlugin */
+module.exports = {
+  // had enabled by egg
+  // static: {
+  //   enable: true,
+  // }
+};

test/fixtures/example-declarations/jsconfig.json

@@ -0,0 +1,5 @@
+{
+  "include": [
+    "**/*"
+  ]
+}

test/fixtures/example-declarations/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "example-declarations",
+  "version": "1.0.0",
+  "description": "",
+  "private": true,
+  "egg": {
+    "declarations": true,
+    "framework": "aliyun-egg"
+  }
+}