DVC for VS Code

[mattseddon]

For more than a year, we've been working on the DVC Extension for VS Code. The extension got its public (Beta) release a few weeks ago.

More details on why we built the extension can be found in this blog post.
There was also a VS Code live stream titled "Machine Learning Experimentation in VS Code with DVC Extension" last week.

What I want to detail here are some of the parts of the API that we've used so that other extension authors can view example usage in our codebase. We have some advanced use cases that I could not find documented or shown in any of the extension samples.

View container, TreeViews & Welcome Content:

SCM View & File Decoration Provider:

React based Webviews (bundled with Webpack):

Output Channel for detailing commands running in the background, along with a Status Bar Item to show whether or not the extension is running any processes:

Pseudoterminal for displaying the output of long-running (user-initiated) commands.

Screen.Recording.2022-07-04.at.1.32.38.pm.mov

Use of the ms-python.python extension's API to help us identify and use Python environments.

We use each of the following packages that have been provided by the VS Code team:

@vsocde/codicons
@vscode/extension-telemetry
@vscode/test-electron
@vscode/webview-ui-toolkit
vsce
vscode-uri (for testing)

These packages make it a lot easier to integrate with the product. Which gives users a far more native experience.

We also made extensive use of the UX Guidelines. Again this helps with giving the user a more native experience.

Finally, the HaaLeo/publish-vscode-extension@v1 Github action helps us to publish the extension.

Code is located at https://github.com/iterative/vscode-dvc. If you are looking for any of the above usage and cannot find it then please reach out. I'd be happy to help 👍🏻.

[mattseddon]

We are now also using wdio-vscode-service from #9. Great tool. Definitely check it out if you are building an extension with any webviews.