Skip to content
This repository has been archived by the owner on Nov 16, 2023. It is now read-only.

Latest commit

 

History

History
37 lines (27 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

37 lines (27 loc) · 2.47 KB
Raw

Contributing

Contributions are always welcome! We only ask that you open an issue first so we can discuss the problem and solution. We don't want you to waste any time headed in the wrong direction.

Development setup

  • Clone this repo
  • Run npm install -g gulp and npm install in '/vscode-edge-debug2'
    • You may see an error if bufferutil or utf-8-validate fail to build. These native modules required by ws are optional and the adapter should work fine without them.
  • Run gulp build

Generate local package for testing

After you have done the development setup you can generate a vsix for local install / testing (recommend changing the version number in package.json to simplify verification your using the local add in)

  • Run 'gulp package' This will generate a "debugger-for-edge-xx.xx.xx.vsix" file (where xx.xx.xx is the version number of the package). You can then use vscode and Install from Vsix... to install the generated package.

Developing in the vscode-chrome-debug-core module

Most of the code is actually in this repo which is published in npm as vscode-chrome-debug-core. You can clone that repo separately to any directory and use npm link to test the extension with a modified version.

Debugging

In VS Code, run the launch as server launch config - it will start the adapter as a server listening on port 4712. In your test app launch.json, include this flag at the top level: "debugServer": "4712". Then you'll be able to debug the adapter in the first instance of VS Code, in its original TypeScript, using sourcemaps.

Testing

There is a set of mocha tests which can be run with either an npm script or with one of the launch configs. Run npm run test to validate against our unit tests. Run npm run intTest to validate against our integration tests. Also run gulp tslint to check your code against our tslint rules.

See the project under testapp/ for a bunch of test scenarios crammed onto one page.

Naming

  • "Client": VS Code
  • "Target": The debuggee
  • "Server-mode": In the normal use-case, the extension does not run in server-mode. For debugging, you can run it as a debug server - see the 'Debugging' section above.

Issue tags

  • "Bug": Something that should work is broken
  • "Enhancement": AKA feature request - adds new functionality
  • "Task": Something that needs to be done that doesn't really fix anything or add major functionality. Tests, engineering, documentation, etc.