Skip to content

Latest commit

 

History

History
104 lines (67 loc) · 4.24 KB

DEVELOPMENT.md

File metadata and controls

104 lines (67 loc) · 4.24 KB
Raw

ink! Analyzer for Visual Studio Code: Development, Debugging and Automated Testing Guide

Prerequisites

Native Development

NOTE: Older versions of Node.js and Yarn may work, however, they have not been tested and no support will be provided for them. Similarly other package managers (e.g. npm and pnpm) will likely work, but they haven't been tested and no support will be provided for them.

Dev Container Development

Follow these VS Code Dev Containers tutorials to set up your development environment and get started with container-based development:

Tips for Dev Container Development

1. Cloning the repository

When using a Dev Container, you can either:

2. Opening a terminal

When using a Dev Container, you can open a terminal attached to the container inside VS Code.

Development

Installing Dependencies

Run the following command from the project root:

yarn install

NOTE: The above command is automatically run after a Dev Container is created, so it can be skipped in that context.

Debugging

  • Open the project in VS Code.
  • Start a debugging session using either the Run Extension (alongside Rust Analyzer) or Run Extension (without Rust Analyzer) launch configuration.
    • This will open a new VS Code window with the extension loaded and the test-fixtures directory set as the workspace root.
    • A debugging session can be started in a few ways including:
      • Opening the "Run and Debug" view and selecting and running the preferred launch configuration from the configuration dropdown.
      • Selecting Start Debugging > Run Extension (alongside Rust Analyzer) or Start Debugging > Run Extension (without Rust Analyzer) from the "Command Palette".
      • Selecting Run > Start Debugging from the application menu to run the last run (or default) Debug configuration.

NOTE: Extension source code is found in the src/ directory and src/extension.ts is the entrypoint.

Testing

You can run integration tests for all the core functionality either from the command line or using a launch configuration.

From the command line

Run the following command from the project root:

yarn test

Using a Launch Configuration

  • Open the project in VS Code.
  • Start a debugging session using the Run Extension Tests launch configuration.

NOTE: See the Development > Debugging section above for instructions for starting a debugging session using a launch configuration.

NOTE: For instructions for manual feature testing, refer to the "Manual Feature Testing Guide".

License

Licensed under GPL-3.0.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the GPL-3.0 license, shall be licensed as above, without any additional terms or conditions.

Acknowledgements

🌱 Funded by: the Web3 Foundation.