From 127baea584e4ddc87e6e07721d77a634e1a53863 Mon Sep 17 00:00:00 2001 From: darkred Date: Mon, 5 Dec 2022 19:10:20 +0200 Subject: [PATCH] Update README.md to clarify that vscode-codeql also installs 'Test Adapter Converter' and 'Test Explorer UI' (#1831) Co-authored-by: Andrew Eisenberg --- README.md | 7 +++++++ extensions/ql-vscode/README.md | 4 +++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2fc0ba4f9..1fce91247 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,13 @@ To see what has changed in the last few versions of the extension, see the [Chan This project will track new feature development in CodeQL and, whenever appropriate, bring that functionality to the Visual Studio Code experience. +## Dependencies + +This extension depends on the following two extensions for required functionality. They will be installed automatically when you install VS Code CodeQL. + +- [Test Adapter Converter](https://marketplace.visualstudio.com/items?itemName=ms-vscode.test-adapter-converter) +- [Test Explorer UI](https://marketplace.visualstudio.com/items?itemName=hbenl.vscode-test-explorer) + ## Contributing This project welcomes contributions. See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to build, install, and contribute. diff --git a/extensions/ql-vscode/README.md b/extensions/ql-vscode/README.md index cc8c48678..d0b1fc84e 100644 --- a/extensions/ql-vscode/README.md +++ b/extensions/ql-vscode/README.md @@ -16,7 +16,9 @@ For information about other configurations, see the separate [CodeQL help](https ### Quick start: Installing and configuring the extension -1. [Install the extension](#installing-the-extension). +1. [Install the extension](#installing-the-extension). + *Note: vscode-codeql installs the following dependencies for required functionality: [Test Adapter Converter](https://marketplace.visualstudio.com/items?itemName=ms-vscode.test-adapter-converter), [Test Explorer UI](https://marketplace.visualstudio.com/items?itemName=hbenl.vscode-test-explorer).* + 1. [Check access to the CodeQL CLI](#checking-access-to-the-codeql-cli). 1. [Clone the CodeQL starter workspace](#cloning-the-codeql-starter-workspace).