5b705cce30 | ||
---|---|---|
codeql-custom-queries-cpp | ||
codeql-custom-queries-csharp | ||
codeql-custom-queries-go | ||
codeql-custom-queries-java | ||
codeql-custom-queries-javascript | ||
codeql-custom-queries-python | ||
codeql-go@db40535b70 | ||
ql@85f6e5fe22 | ||
.gitignore | ||
.gitmodules | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
LICENSE.md | ||
README.md | ||
vscode-codeql-starter.code-workspace |
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
- Install Visual Studio Code.
- Install the CodeQL extension for Visual Studio Code.
- Clone this repository to your computer.
- Make sure to include the submodules, either by
git clone --recursive
or bygit submodule update --init --remote
after clone. - Use
git submodule update --remote
regularly to keep the submodules up to date.
- Make sure to include the submodules, either by
- In VS Code, click File > Open Workspace. Select the file
vscode-codeql-starter.code-workspace
in your checkout of this repository. - 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 thelgtm.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 thelgtm.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.
- The
- 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.