feat: support pkgInfo.egg.require

.github/workflows/nodejs.yml

@@ -30,6 +30,9 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
 
+    - name: update npm
+      run: npm i -g npm
+
     - name: Install Dependencies
       run: npm i -g npminstall && npminstall
 

lib/command.js

@@ -26,6 +26,12 @@ class Command extends BaseCommand {
         type: 'boolean',
         alias: [ 'ts', 'typescript' ],
       },
+
+      require: {
+        description: 'inject to execArgv --require',
+        type: 'array',
+        alias: 'r',
+      },
     };
 
     this.logger = new Logger({
@@ -38,18 +44,28 @@ class Command extends BaseCommand {
     const context = super.context;
     const { argv, execArgvObj, cwd } = context;
 
-    // read `egg.typescript` from package.json
     let baseDir = argv._[0] || cwd;
     if (!path.isAbsolute(baseDir)) baseDir = path.join(cwd, baseDir);
     const pkgFile = path.join(baseDir, 'package.json');
     if (fs.existsSync(pkgFile)) {
       const pkgInfo = require(pkgFile);
-      if (pkgInfo && pkgInfo.egg && pkgInfo.egg.typescript) {
+      const eggInfo = pkgInfo.egg;
+
+      // read `egg.typescript` from package.json
+      if (eggInfo && eggInfo.typescript) {
         argv.sourcemap = true;
       }
 
+      // read `egg.require` from package.json
+      if (eggInfo && eggInfo.require && Array.isArray(eggInfo.require)) {
+        execArgvObj.require = execArgvObj.require || [];
+        eggInfo.require.forEach(injectScript => {
+          execArgvObj.require.push(path.resolve(baseDir, injectScript));
+        });
+      }
+
       // read argv from eggScriptsConfig in package.json
-      if (pkgInfo && pkgInfo.eggScriptsConfig && typeof pkgInfo.eggScriptsConfig === 'object') {
+      if (pkgInfo.eggScriptsConfig && typeof pkgInfo.eggScriptsConfig === 'object') {
         for (const key in pkgInfo.eggScriptsConfig) {
           if (argv[key] == null) argv[key] = pkgInfo.eggScriptsConfig[key];
         }

test/fixtures/pkg-config/config/config.default.js

@@ -0,0 +1,8 @@
+'use strict';
+
+exports.keys = '123456';
+
+exports.logger = {
+  level: 'WARN',
+  consoleLevel: 'WARN',
+};

test/fixtures/pkg-config/inject.js

@@ -0,0 +1,3 @@
+'use strict';
+
+console.log('@@@ inject by pkgInfo');

test/fixtures/pkg-config/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "example",
+  "version": "1.0.0",
+  "egg": {
+    "require": [
+      "./inject.js"
+    ]
+  }
+}

test/start.test.js

@@ -473,6 +473,32 @@ describe('test/start.test.js', () => {
       });
     });
 
+    describe('read pkgInfo', () => {
+      let app;
+      let fixturePath;
+
+      before(function* () {
+        fixturePath = path.join(__dirname, 'fixtures/pkg-config');
+        yield utils.cleanup(fixturePath);
+      });
+
+      after(function* () {
+        app.proc.kill('SIGTERM');
+        yield utils.cleanup(fixturePath);
+      });
+
+      it('should --require', function* () {
+        app = coffee.fork(eggBin, [ 'start', '--workers=1', fixturePath ]);
+        app.debug();
+        app.expect('code', 0);
+
+        yield sleep(waitTime);
+
+        assert(app.stderr === '');
+        assert(app.stdout.match(/@@@ inject by pkgInfo/));
+      });
+    });
+
     describe('subDir as baseDir', () => {
       let app;
       const rootDir = path.join(__dirname, '..');
@@ -551,7 +577,11 @@ describe('test/start.test.js', () => {
         const exitEvent = awaitEvent(app.proc, 'exit');
         app.proc.kill('SIGTERM');
         const code = yield exitEvent;
-        assert(code === 0);
+        if (isWin) {
+          assert(code === null);
+        } else {
+          assert(code === 0);
+        }
       });
     });
   });