Connor Peet
186e565ec0
Previously in the testing API, you called `registerTestProvider` with your own instance of a TestController, and VS Code would request workspace or document tests. This has been changed: now, you call `createTestController`, which returns an object, and call `createTestItem` to insert test nodes under the `controller.root`. Extensions should generally decide themselves when to publish tests. For example, when a file is opened in an editor, test extensions will want to make sure tests for that file are available so that inline decorations can be shown. This is pretty similar to what the editor API does in diagnostics. There is still a `resolveChildrenHandler` on the controller (rather than the TestItem directly), which you should _set_ if the test extension supports lazy discovery. Additionally, if you support running tests, you'll also want a `runHandler` (migrating from the old `runTests` method). Some of the existing test providers have been updated, you can check them out here: - https://github.com/microsoft/vscode-extension-samples/tree/main/test-provider-sample - https://github.com/microsoft/vscode-selfhost-test-provider In summary, to update to the new API: - Call `vscode.test.createTestController` instead of `registerTestController` - Move the contents of your `runTests` method to `controller.runHandler` - Move your `TestItem.resolveHandler` to `controller.resolveChildrenHandler`, which may involve adding some `instanceof` checks. - If you lazily discovered tests in `createDocumentTestRoot`, you'll want to trigger that logic based on `vscode.workspace.onDidOpenTextDocument`. - If your test runner can deal with showing locations of unsaved changes, listen for `vscode.workspace.onDidChangeTextDocument` to trigger those changes in the tree.
Visual Studio Code - Open Source ("Code - OSS")
The Repository
This repository ("Code - OSS") is where we (Microsoft) develop the Visual Studio Code product together with the community. Not only do we work on code and issues here, we also publish our roadmap, monthly iteration plans, and our endgame plans. This source code is available to everyone under the standard MIT license.
Visual Studio Code
Visual Studio Code is a distribution of the Code - OSS repository with Microsoft specific customizations released under a traditional Microsoft product license.
Visual Studio Code combines the simplicity of a code editor with what developers need for their core edit-build-debug cycle. It provides comprehensive code editing, navigation, and understanding support along with lightweight debugging, a rich extensibility model, and lightweight integration with existing tools.
Visual Studio Code is updated monthly with new features and bug fixes. You can download it for Windows, macOS, and Linux on Visual Studio Code's website. To get the latest releases every day, install the Insiders build.
Contributing
There are many ways in which you can participate in this project, for example:
- Submit bugs and feature requests, and help us verify as they are checked in
- Review source code changes
- Review the documentation and make pull requests for anything from typos to additional and new content
If you are interested in fixing issues and contributing directly to the code base, please see the document How to Contribute, which covers the following:
- How to build and run from source
- The development workflow, including debugging and running tests
- Coding guidelines
- Submitting pull requests
- Finding an issue to work on
- Contributing to translations
Feedback
- Ask a question on Stack Overflow
- Request a new feature
- Upvote popular feature requests
- File an issue
- Follow @code and let us know what you think!
See our wiki for a description of each of these channels and information on some other available community-driven channels.
Related Projects
Many of the core components and extensions to VS Code live in their own repositories on GitHub. For example, the node debug adapter and the mono debug adapter have their own repositories. For a complete list, please visit the Related Projects page on our wiki.
Bundled Extensions
VS Code includes a set of built-in extensions located in the extensions folder, including grammars and snippets for many languages. Extensions that provide rich language support (code completion, Go to Definition) for a language have the suffix language-features. For example, the json extension provides coloring for JSON and the json-language-features provides rich language support for JSON.
Development Container
This repository includes a Visual Studio Code Remote - Containers / GitHub Codespaces development container.
- For Remote - Containers, use the Remote-Containers: Clone Repository in Container Volume... command which creates a Docker volume for better disk I/O on macOS and Windows.
- For Codespaces, install the Github Codespaces extension in VS Code, and use the Codespaces: Create New Codespace command.
Docker / the Codespace should have at least 4 Cores and 6 GB of RAM (8 GB recommended) to run full build. See the development container README for more information.
Code of Conduct
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
License
Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the MIT license.