Skip to content
Starter workspace to use with the CodeQL extension for Visual Studio Code.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
codeql-custom-queries-cpp CodeQL for VS Code starter: Initial commit. Nov 12, 2019
codeql-custom-queries-csharp CodeQL for VS Code starter: Initial commit. Nov 12, 2019
codeql-custom-queries-go CodeQL for VS Code starter: Initial commit. Nov 12, 2019
codeql-custom-queries-java CodeQL for VS Code starter: Initial commit. Nov 12, 2019
codeql-custom-queries-javascript CodeQL for VS Code starter: Initial commit. Nov 12, 2019
codeql-custom-queries-python
codeql-go @ d14eb85 CodeQL for VS Code starter: Initial commit. Nov 12, 2019
ql @ b9d1c38 Update CodeQL submodule Dec 2, 2019
.gitmodules Update CodeQL library for Go submodule URL Dec 2, 2019
CODE_OF_CONDUCT.md CodeQL for VS Code starter: Initial commit. Nov 12, 2019
CONTRIBUTING.md CodeQL for VS Code starter: Initial commit. Nov 12, 2019
LICENSE.md
README.md Update README.md Nov 13, 2019
vscode-codeql-starter.code-workspace CodeQL for VS Code starter: Initial commit. Nov 12, 2019

README.md

vscode-codeql-starter

A starter workspace to use with the CodeQL extension for Visual Studio Code. For more information, see the vscode-codeql repo.

Instructions

  1. Install Visual Studio Code.
  2. Install the CodeQL extension for Visual Studio Code.
  3. Clone this repository to your computer.
    • Make sure to include the submodules, either by git clone --recursive or by git submodule update --init --remote after clone.
    • Use git submodule update --remote regularly to keep the submodules up to date.
  4. In VS Code, click File > Open Workspace. Select the file vscode-codeql-starter.code-workspace in your checkout of this repository.
  5. You will see several folders open in the left sidebar:
    • The ql folder contains the open-source CodeQL standard libraries for C/C++, C#, Java, JavaScript, and Python. It tracks the lgtm.com branch. You can run the standard queries from here, and browse the libraries.
    • The codeql-go folder contains the open-source CodeQL standard libraries for Go. It tracks the lgtm.com branch. You can run the standard queries from here, and browse the libraries.
    • The folders named codeql-custom-queries-<language> are ready for you to start developing your own custom queries for each language, while using the standard libraries. There are some example queries to get you started.
  6. Follow the documentation for the CodeQL extension to learn how to set up the extension, add a database and run queries against it. Have fun!

Contributing

This project welcomes contributions. See CONTRIBUTING.md for details.

Reporting issues

Issues and suggestions should be reported in the vscode-codeql repo.

License

This project is licensed under the MIT License.

The CodeQL extension for Visual Studio Code is licensed under the MIT License. The version of CodeQL used by the CodeQL extension is subject to the GitHub CodeQL Terms & Conditions.

You can’t perform that action at this time.