-
Notifications
You must be signed in to change notification settings - Fork 673
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
[docs] Debug recipe for visual studio code updated (#1375) #1382
[docs] Debug recipe for visual studio code updated (#1375) #1382
Conversation
50b2ca3
to
ddecd23
Compare
@@ -44,12 +45,15 @@ You will need to add the following configuration to the `launch.json` file. | |||
This configuration contains the following attributes: | |||
|
|||
* `type` - specifies the type of the configuration. Set to `node` for a Node.js configuration. | |||
* `protocol` - specifies Node.js [debugger wire protocol](https://code.visualstudio.com/docs/nodejs/nodejs-debugging#_supported-nodelike-runtimes). |
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.
* `protocol` - specifies the Node.js [debugger wire protocol](https://code.visualstudio.com/docs/nodejs/nodejs-debugging#_supported-nodelike-runtimes). Set to `inspector` to use the [Inspector protocol](https://chromedevtools.github.io/debugger-protocol-viewer/v8/). This protocol is available in Node.js v6.3 (or v6.9 for Windows) or newer. If you are using an older Node.js, do not specify the `protocol` option. In this instance, the `Legacy` protocol will be used.
* `request` - specifies the request type. Set to `launch` since this configuration launches a program. | ||
* `name` - specifies the name of the configuration. | ||
* `program` - path to a JS file that will be executed. In this case, it is the TestCafe module. | ||
* `args` - [command line arguments](../using-testcafe/command-line-interface.md) passed to the launched program. In this case, they specify the browser in which the tests should run and the test file. | ||
* `cwd` - the current working directory. Set to the workspace root. | ||
|
||
**Note**: Prior to Node.js v6.3 (or v6.9 for Windows), the debugger protocol had several issues and limitations. To ensure that the debugger works correctly, use newer Node.js versions that support the [Inspector debugging protocol](https://code.visualstudio.com/docs/nodejs/nodejs-debugging#_supported-nodelike-runtimes). |
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.
removing this note
ddecd23
to
b55455d
Compare
\cc @DevExpress/testcafe-docs |
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.
\r-
@@ -44,6 +45,7 @@ You will need to add the following configuration to the `launch.json` file. | |||
This configuration contains the following attributes: | |||
|
|||
* `type` - specifies the type of the configuration. Set to `node` for a Node.js configuration. | |||
* `protocol` - specifies the Node.js [debugger wire protocol](https://code.visualstudio.com/docs/nodejs/nodejs-debugging#_supported-nodelike-runtimes). Set to `inspector` to use the [Inspector protocol](https://chromedevtools.github.io/debugger-protocol-viewer/v8/). This protocol is available in Node.js v6.3 (or v6.9 for Windows) or newer. If you are using an older Node.js, do not specify the `protocol` option. In this instance, the `Legacy` protocol will be used, which may cause issues with source maps while debugging test files. |
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.
Quite odd general phrasing. It sound like issues with source maps while debugging test files
is some kind of feature and to enable it you need to avoid specifying protocol
.
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.
* `protocol` - specifies the Node.js
[debugger wire protocol](https://code.visualstudio.com/docs/nodejs/nodejs-debugging#_supported-nodelike-runtimes).
Set to `inspector` to use the [Inspector protocol](https://chromedevtools.github.io/debugger-protocol-viewer/v8/).
This protocol is available in Node.js v6.3 (or v6.9 for Windows) or newer.
Older Node.js versions do not support the `protocol` option.
They use the `Legacy` protocol that has issues with source maps.
FPR |
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.
\r-
@@ -44,6 +45,7 @@ You will need to add the following configuration to the `launch.json` file. | |||
This configuration contains the following attributes: | |||
|
|||
* `type` - specifies the type of the configuration. Set to `node` for a Node.js configuration. | |||
* `protocol` - specifies the Node.js [debugger wire protocol](https://code.visualstudio.com/docs/nodejs/nodejs-debugging#_supported-nodelike-runtimes). Set to `inspector` to use the [Inspector protocol](https://chromedevtools.github.io/debugger-protocol-viewer/v8/). This protocol is available in Node.js v6.3 (or v6.9 for Windows) or newer. Older Node.js versions do not support the `protocol` option. They use the `Legacy` protocol that has issues with source maps. |
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.
specifies the Node.js [debugger wire protocol](https://code.visualstudio.com/docs/nodejs/nodejs-debugging#_supported-nodelike-runtimes). Note that
inspector protocol is supported in Node.js v6.3 (or v6.9 for Windows) or later. For early versions omit this property. In that case legacy debugger protocol will be used. Legacy protocol is well known for it's issues with source map support, therefore newer versions of Node.js are recommended.
\cc @VasilyStrelyaev
2e285fb
to
15d7155
Compare
FPR |
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.
lgtm
…evExpress#1382) * [docs] Debug recipe for visual studio code updated (DevExpress#1375) * Fix remark
@DevExpress/testcafe-docs