-
Notifications
You must be signed in to change notification settings - Fork 159
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documenting the new way to inspect fastboot #505
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks really good, I love the simplification that we can do now!
README.md
Outdated
|
||
```sh | ||
ember build && node --debug-brk ./node_modules/.bin/ember serve | ||
ember build && node --debug-brk --inspect ./node_modules/.bin/ember serve |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure exactly why we would want to ember build &&
here. Lets remove that for now (we can bring it back if someone remembers why it was there and its still important)...
README.md
Outdated
|
||
```sh | ||
ember build && node --debug-brk ./node_modules/.bin/ember serve | ||
ember build && node --debug-brk --inspect ./node_modules/.bin/ember serve | ||
``` | ||
|
||
This does a full rebuild and then starts the FastBoot server in debug | ||
mode. Note that the `--debug-brk` flag will cause your app to start |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
--debug-brk
isn't used, should this be updated to say --inspect
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
so --debug-brk
does as the documentation describes and is quite useful for issues that occur during the setup of fastboot i.e. before you get a chance to make a single request.
It essentially pauses the execution on the very first node line that is run. 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right, I know what it does, just saying that instructions haven't mentioned it to this point (the old docs said to use --debug-brk
before you updated to specify --inspect
).
Also, it was my understanding that using --inspect
and --debug-brk
together is deprecated in recent 8.x versions (in favor --inspect-brk
).
README.md
Outdated
module context (see [this issue](https://github.com/nodejs/node/issues/7593)), | ||
which is a module that FastBoot utilizes. | ||
The above method only started working for the v8.x track of Node after version v8.4.0, | ||
which is a fix to [this issue](https://github.com/nodejs/node/issues/7593) was merged and |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Possible rewording:
which has a fix to
@rwjblue I have incorporated 2 of your 3 comments, I can add a section that states that |
Thank you @mansona! |
This PR fixes #428
I decided to remove a lot of the nuance in the documentation (and refer to a previous version) because it was already quite complex with different versions and methods. That in conjunction with the fact that the Right Way™️ of doing it is the new
node --inspect
method.Please let me know if you would prefer to include instructions for versions before v8.4 in the main documentation and I will take a crack at it. Also feel free to take as much of this as you would like and use it for a new PR 😄