feat: should run ets on pkg.egg.declarations = true (#248)

use c8@9

closes #242
closes #246

.github/workflows/nodejs.yml

@@ -2,15 +2,15 @@ name: CI
 
 on:
   push:
-    branches: [ master, 5.x ]
+    branches: [ master ]
 
   pull_request:
-    branches: [ master, 5.x ]
+    branches: [ master ]
 
 jobs:
   Job:
     name: Node.js
     uses: node-modules/github-actions/.github/workflows/node-test.yml@master
     with:
       os: 'ubuntu-latest, macos-latest, windows-latest'
-      version: '14, 16, 18, 20'
+      version: '16, 18, 20'

.github/workflows/release.yml

@@ -6,9 +6,7 @@ on:
 jobs:
   release:
     name: Node.js
-    uses: node-modules/github-actions/.github/workflows/node-release.yml@master
+    uses: eggjs/github-actions/.github/workflows/node-release.yml@master
     secrets:
       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
       GIT_TOKEN: ${{ secrets.GIT_TOKEN }}
-    with:
-      checkTest: false

.gitignore

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

.vscode/launch.json

@@ -15,8 +15,6 @@
         "--",
         "--inspect-brk"
       ],
-      "protocol": "auto",
-      "port": 9229,
       "autoAttachChildProcesses": true
     }
   ]

package.json

@@ -17,7 +17,7 @@
     "@artus-cli/artus-cli": "^0.2.9",
     "@artus-cli/plugin-autocomplete": "^0.1.1",
     "@artus-cli/plugin-version": "^1.0.1",
-    "c8": "^7.12.0",
+    "c8": "^9.0.0",
     "detect-port": "^1.3.0",
     "egg-ts-helper": "^1.30.3",
     "egg-utils": "^2.4.1",
@@ -26,7 +26,7 @@
     "mocha": "^10.2.0",
     "mochawesome-with-mocha": "^7.1.3",
     "runscript": "^1.5.3",
-    "ts-node": "^10.9.1",
+    "ts-node": "^10.9.2",
     "tsconfig-paths": "^4.1.2"
   },
   "peerDependencies": {
@@ -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"

scripts/postinstall.js

@@ -20,9 +20,12 @@ debug('npmRunRoot: %o', npmRunRoot);
 
 if (npmRunRoot) {
   const pkgFile = path.join(npmRunRoot, 'package.json');
-  if (fs.existsSync(pkgFile)) {
+  const pkgFileExists = fs.existsSync(pkgFile);
+  debug('pkgFile: %o exists: %o', pkgFile, pkgFileExists);
+  if (pkgFileExists) {
     const pkg = require(pkgFile);
-    if (!pkg.egg || !pkg.egg.typescript) return;
+    // should set pkg.egg.declarations = true or pkg.egg.typescript = true
+    if (!pkg.egg?.typescript && !pkg.egg?.declarations) return;
     // ignore eggModule and framework
     // framework package.json:
     // "egg": {

src/cmd/cov.ts

@@ -75,7 +75,7 @@ export class CovCommand extends TestCommand {
     ]);
     for (const exclude of excludes) {
       c8Args.push('-x');
-      c8Args.push(`'${exclude}'`);
+      c8Args.push(exclude);
     }
     const c8File = require.resolve('c8/bin/c8.js');
     const outputDir = path.join(this.base, 'node_modules/.c8_output');

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/cov.test.ts

@@ -50,7 +50,10 @@ describe('test/cmd/cov.test.ts', () => {
     it('should success with COV_EXCLUDES', async () => {
       await coffee.fork(eggBin, [ 'cov', '--ts=false' ], {
         cwd,
-        env: { TESTS: 'test/**/*.test.js', COV_EXCLUDES: 'ignore/*' },
+        env: {
+          TESTS: 'test/**/*.test.js',
+          COV_EXCLUDES: 'ignore/*',
+        },
       })
         // .debug()
         .expect('stdout', /should success/)

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"
+  }
+}

test/fixtures/example-ts-custom-compiler/package.json

@@ -1,6 +1,6 @@
 {
   "name": "example-ts-custom-compiler",
   "dependencies": {
-    "ts-node": "10.9.0"
+    "ts-node": "10.9.2"
   }
 }

test/ts.test.ts

@@ -245,7 +245,7 @@ describe('test/ts.test.ts', () => {
       })
         // .debug()
         .end();
-      assert.match(stderr, /ts-node@10\.9\.0/);
+      assert.match(stderr, /ts-node@10\.\d+\.\d+/);
       assert.equal(code, 0);
     });
 
@@ -257,9 +257,9 @@ describe('test/ts.test.ts', () => {
       await fs.rm(path.join(cwd, 'node_modules'), { force: true, recursive: true });
       if (process.env.CI) {
         // dont use npmmirror.com on CI
-        await runscript('npx npminstall [email protected].0 --no-save', { cwd });
+        await runscript('npx npminstall [email protected].2 --no-save', { cwd });
       } else {
-        await runscript('npx npminstall -c [email protected].0 --no-save', { cwd });
+        await runscript('npx npminstall -c [email protected].2 --no-save', { cwd });
       }
 
       // copy egg to node_modules
@@ -278,7 +278,7 @@ describe('test/ts.test.ts', () => {
       })
         // .debug()
         .end();
-      assert.match(stderr, /ts-node@10\.9\.0/);
+      assert.match(stderr, /ts-node@10\.9\.2/);
       assert.equal(code, 0);
     });
 
@@ -289,9 +289,9 @@ describe('test/ts.test.ts', () => {
       await fs.rm(path.join(cwd, 'node_modules'), { force: true, recursive: true });
       if (process.env.CI) {
         // dont use npmmirror.com on CI
-        await runscript('npx npminstall [email protected].0 --no-save', { cwd });
+        await runscript('npx npminstall [email protected].2 --no-save', { cwd });
       } else {
-        await runscript('npx npminstall -c [email protected].0 --no-save', { cwd });
+        await runscript('npx npminstall -c [email protected].2 --no-save', { cwd });
       }
 
       // copy egg to node_modules
@@ -308,7 +308,7 @@ describe('test/ts.test.ts', () => {
       })
         // .debug()
         .end();
-      assert.doesNotMatch(stderr, /ts-node@10\.9\.0/);
+      assert.doesNotMatch(stderr, /ts-node@10\.9\.2/);
       assert.equal(code, 0);
     });
 
@@ -405,7 +405,7 @@ describe('test/ts.test.ts', () => {
       })
         // .debug()
         .end();
-      assert.match(stdout, /ts-node@10\.9\.0/);
+      assert.match(stdout, /ts-node@10\.\d+\.\d+/);
       assert.equal(code, 0);
     });