Skip to content
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

Merged
merged 2 commits into from
Apr 12, 2017

Conversation

georgiy-abbasov
Copy link
Contributor

@DevExpress/testcafe-docs

@georgiy-abbasov georgiy-abbasov changed the title Debug recipe for visual studio code updated (closes #1375) [docs] Debug recipe for visual studio code updated (#1375) Apr 6, 2017
@@ -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).
Copy link
Collaborator

@VasilyStrelyaev VasilyStrelyaev Apr 6, 2017

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).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removing this note

@georgiy-abbasov
Copy link
Contributor Author

\cc @DevExpress/testcafe-docs
FPR

Copy link
Contributor

@inikulin inikulin left a 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.
Copy link
Contributor

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.

Copy link
Collaborator

@VasilyStrelyaev VasilyStrelyaev Apr 11, 2017

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.

@testcafe-build-bot
Copy link
Collaborator

✅ Tests for the commit 2e285fb have passed. See details.

@georgiy-abbasov
Copy link
Contributor Author

FPR

Copy link
Contributor

@inikulin inikulin left a 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.
Copy link
Contributor

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

@testcafe-build-bot
Copy link
Collaborator

✅ Tests for the commit 15d7155 have passed. See details.

@georgiy-abbasov
Copy link
Contributor Author

FPR

Copy link
Contributor

@inikulin inikulin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@inikulin inikulin merged commit 33a28c5 into DevExpress:master Apr 12, 2017
kirovboris pushed a commit to kirovboris/testcafe-phoenix that referenced this pull request Dec 18, 2019
…evExpress#1382)

* [docs] Debug recipe for visual studio code updated (DevExpress#1375)

* Fix remark
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants