Skip to content

Latest commit

 

History

History
86 lines (63 loc) · 3.93 KB

README.md

File metadata and controls

86 lines (63 loc) · 3.93 KB

VS Code probe-rs-debugger

Documentation

Full documentation on Installation, Configuration and supported functionality can be found at the probe-rs webpage and under the visual tour heading

Development Setup - only applies if you want to contribute to the extension

To work on this extensions, you first need to install VS Code and nodejs. Afterwards, follow the following steps:

  • Checkout this repository

  • Inside the repository, install the prerequisites:

    npm install

  • Install the extensions VS Code recommends. If you prefer to do this manually, you can find the list of recommended extensions in the repository's `.vscode/settings.json' file. These can then be installed from the command line, for example:

    code --install-extension amodio.tsl-problem-matcher

  • Open VS Code

  • Press F5 to start a new VS Code instance where the extension can be debugged. You can also open the "Run and Debug" panel in the left sidebar, and then start the "Extension" debug configuration.

To run against a compiled executable of probe-rs-debugger

  • Press F5 to build and launch executable probe-rs-debugger. VSCode will open another VS Code window, titled [Extension Development Host].
  • In this new VSCode window,
    • Open an existing project, or create a new one.
    • In your project, configure the launch.json in your project, as per the minimum configuration example.
    • Select the debug environment you just created.
      • Press F5 to start debugging.

To run against a debuggable instance of probe-rs-debugger

  • Clone the probe-rs repository, and open it in VSCode.
    • In this probe-rs repo, select the debug environment DAP-Server probe-rs-debugger
    • Press F5 to start probe-rs-debugger as a debuggable server.
  • Switch to the VSCode instance of the probe-rs vscode repository.
  • In this new VSCode window,
    • Open an existing project, or create a new one.
    • In your project, configure the launch.json in your project, as per the existing debugger server example.
    • Select the debug environment you just created.
      • Press F5 to start debugging.

Releasing the extension

The extension can only be released as part of the CI process on GitHub Actions.

  • The CI process will automatically build the extension and publish it to the VSCode Marketplace when the project maintainers create a new release on GitHub.

Build the extension

Building the extension refers to the process that generates the installable .vsix package.

  • Follow the instructions to setup your development environment.

  • In a terminal window, execute the following command:

    npm run package

  • This will generate a .vsix file in the root of the repository

Contributing

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed, without any additional terms or conditions, according to: