feat: support $NODE_DEBUG_OPTION

README.md

@@ -63,6 +63,8 @@ All the commands support these specific v8 options:
 $ egg-bin [command] --debug --es_staging
 ```
 
+if `process.env.NODE_DEBUG_OPTION` is provided (WebStorm etc), will use it as debug options.
+
 ### dev
 
 Start dev cluster on `local` env, it will start a master, an agent and a worker.

lib/command.js

@@ -2,6 +2,7 @@
 
 const BaseCommand = require('common-bin');
 const changeCase = require('change-case');
+const parser = require('yargs-parser');
 
 class Command extends BaseCommand {
   /**
@@ -13,30 +14,19 @@ class Command extends BaseCommand {
     const context = super.context;
     const argv = context.argv;
 
-    // extract execArgv to special item
-    const execArgvObj = {};
+    let execArgvObj = {};
     let debugPort;
-    const match = (key, arr) => arr.some(x => x instanceof RegExp ? x.test(key) : x === key); // eslint-disable-line no-confusing-arrow
-    for (const key of Object.keys(argv)) {
-      let isMatch = false;
-
-      // debug / debug-brk / debug-port / inspect / inspect-brk / inspect-port
-      if (match(key, [ /^debug.*/, /^inspect.*/ ])) {
-        isMatch = true;
-        // extract debug port
-        if (debugPort === undefined || typeof argv[key] === 'number') {
-          debugPort = argv[key];
-        }
-      } else if (match(key, [ 'es_staging', 'expose_debug_as', /^harmony.*/ ])) {
-        isMatch = true;
-      }
-
-      if (isMatch) {
-        execArgvObj[key] = argv[key];
-        argv[key] = undefined;
-        // also remove `debugBrk`
-        argv[changeCase.camelCase(key)] = undefined;
-      }
+
+    // extract from command argv
+    debugPort = findDebugPort(argv);
+    execArgvObj = extractExecArgv(argv);
+
+    // extract from WebStorm env `$NODE_DEBUG_OPTION`
+    if (context.env.NODE_DEBUG_OPTION) {
+      console.log('Use $NODE_DEBUG_OPTION: %s', context.env.NODE_DEBUG_OPTION);
+      const argvFromEnv = parser(context.env.NODE_DEBUG_OPTION);
+      debugPort = findDebugPort(argvFromEnv);
+      Object.assign(execArgvObj, extractExecArgv(argvFromEnv));
     }
 
     context.execArgv = this.helper.unparseArgv(execArgvObj);
@@ -50,4 +40,35 @@ class Command extends BaseCommand {
   }
 }
 
+function match(key, arr) {
+  return arr.some(x => x instanceof RegExp ? x.test(key) : x === key); // eslint-disable-line no-confusing-arrow
+}
+
+function findDebugPort(argv) {
+  let debugPort;
+
+  for (const key of Object.keys(argv)) {
+    if (match(key, [ /^debug.*/, /^inspect.*/ ]) && typeof argv[key] === 'number') {
+      debugPort = argv[key];
+    }
+  }
+  return debugPort;
+}
+
+// pick and remove all execArgv from origin `argv`
+function extractExecArgv(argv) {
+  const execArgvObj = {};
+  for (const key of Object.keys(argv)) {
+    // debug / debug-brk / debug-port / inspect / inspect-brk / inspect-port
+    if (match(key, [ /^debug.*/, /^inspect.*/, 'es_staging', 'expose_debug_as', /^harmony.*/ ])) {
+      execArgvObj[key] = argv[key];
+      // remove from origin obj
+      argv[key] = undefined;
+      // also remove `debugBrk`
+      argv[changeCase.camelCase(key)] = undefined;
+    }
+  }
+  return execArgvObj;
+}
+
 module.exports = Command;

package.json

@@ -11,17 +11,18 @@
     "autod": "^2.9.0",
     "change-case": "^3.0.1",
     "co-mocha": "^1.2.0",
-    "common-bin": "^2.4.0",
-    "debug": "^2.6.8",
+    "common-bin": "^2.6.0",
+    "debug": "^3.0.1",
     "detect-port": "^1.2.1",
     "egg-utils": "^2.2.0",
     "globby": "^6.1.0",
     "intelli-espower-loader": "^1.0.1",
     "mocha": "^3.5.0",
-    "mz-modules": "^1.0.0",
+    "mz-modules": "^2.0.0",
     "nyc": "^11.1.0",
     "power-assert": "^1.4.4",
     "test-exclude": "^4.1.1",
+    "yargs-parser": "^7.0.0",
     "ypkgfiles": "^1.4.0"
   },
   "devDependencies": {
@@ -32,8 +33,8 @@
     "cross-env": "^3.1.3",
     "egg-ci": "^1.8.0",
     "enzyme": "^2.0.0",
-    "eslint": "^4.3.0",
-    "eslint-config-egg": "^5.0.0",
+    "eslint": "^4.5.0",
+    "eslint-config-egg": "^5.1.0",
     "jsdom": "^8.0.1",
     "mm": "^2.1.0",
     "mz": "^2.6.0",

test/lib/cmd/debug.test.js

@@ -35,6 +35,16 @@ describe('test/lib/cmd/debug.test.js', () => {
       .end(done);
   });
 
+  it('should debug with $NODE_DEBUG_OPTION', () => {
+    const env = Object.assign({}, process.env, { NODE_DEBUG_OPTION: '--inspect=5555' });
+    return coffee.fork(eggBin, [ 'debug' ], { cwd, env })
+      .debug()
+      .expect('stderr', /Debugger listening.*5555/)
+      .expect('stdout', /"workers":1/)
+      .expect('code', 0)
+      .end();
+  });
+
   describe('auto detect available port', () => {
     let server;
     before(done => {