Skip to content

Commit 12cfc6f

Browse files
authored
Merge pull request #342 from ryanone/master
Updated debugging instructions
2 parents e7733e8 + cea0b6a commit 12cfc6f

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -455,6 +455,29 @@ that, you can open a connection; any exceptions should be logged in the
455455
console, and you can use the tools you'd expect such as `console.log`,
456456
`debugger` statements, etc.
457457

458+
#### Note Regarding Node 6.4 and above
459+
460+
If you're using Node 6.4 and above, there's currently an
461+
[open issue](https://github.com/node-inspector/node-inspector/issues/905)
462+
involving node-inspector. [A fix](https://github.com/node-inspector/node-inspector/commit/2e5309f75099753740c4567e17fd79ee27885d71)
463+
has been committed, and an updated version just needs to be published to NPM.
464+
Until an updated version of node-inspector is published to NPM, you can clone
465+
node-inspector locally, and call the appropriate script. For example, instead
466+
of calling `node-inspector`, call `[path to node-inspector]/bin/inspector.js`
467+
468+
#### Incompatibility With `node --inspect`
469+
470+
[Node 6.3](https://nodejs.org/en/blog/release/v6.3.0/) is the first version to
471+
offer support for the `--inspect` flag. This is intended to replace usage of
472+
tools like node-inspector. However the `--inspect` flag isn't suitable for
473+
debugging FastBoot apps because Node does not support debugging of code in a vm
474+
module context (see [this issue](https://github.com/nodejs/node/issues/7593)),
475+
which is a module that FastBoot utilizes.
476+
477+
Because of this, it's recommended to use either node-inspector, or Node's
478+
[out-of-process debugging utility](https://nodejs.org/api/debugger.html#debugger_debugger),
479+
until a version of Node is released that resolves the above-mentioned issue.
480+
458481
## Tests
459482

460483
Run the automated tests by running `npm test`.

0 commit comments

Comments
 (0)