github
/
vscode-codeql-starter
зеркало из https://github.com/github/vscode-codeql-starter.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
Starter workspace to use with the CodeQL extension for Visual Studio Code.
158 коммитов 14 Ветки 1 Тег 411 KiB
CodeQL 100%
Перейти к файлу
Nick Rolfe 49b10b9050 Delete codeql-go submodule 2022-05-31 16:11:18 +01:00
.devcontainer Update devcontainer memory settings 2020-09-02 12:42:21 -07:00
.github/workflows Actions: Add workflow to create issues for submodule pointer mismatches 2021-09-10 15:40:21 -07:00
codeql-custom-queries-cpp Packaging: Update `qlpack.yml` files for packaging 2021-09-15 16:10:07 -07:00
codeql-custom-queries-csharp Packaging: Update `qlpack.yml` files for packaging 2021-09-15 16:10:07 -07:00
codeql-custom-queries-go Packaging: Update `qlpack.yml` files for packaging 2021-09-15 16:10:07 -07:00
codeql-custom-queries-java Packaging: Update `qlpack.yml` files for packaging 2021-09-15 16:10:07 -07:00
codeql-custom-queries-javascript Packaging: Update `qlpack.yml` files for packaging 2021-09-15 16:10:07 -07:00
codeql-custom-queries-python Packaging: Update `qlpack.yml` files for packaging 2021-09-15 16:10:07 -07:00
codeql-custom-queries-ruby Minor tidy-up 2021-11-09 10:19:00 +00:00
ql@8cd261af0e Update CodeQL submodule 2022-05-31 16:10:16 +01:00
.codeqlmanifest.json Add CodeQL manifest 2020-06-19 14:39:15 -07:00
.gitignore gitignore compilation caches. 2020-01-21 08:50:58 -08:00
.gitmodules Delete codeql-go submodule 2022-05-31 16:11:18 +01:00
CODE_OF_CONDUCT.md CodeQL for VS Code starter: Initial commit. 2019-11-12 14:05:48 -08:00
CONTRIBUTING.md CodeQL for VS Code starter: Initial commit. 2019-11-12 14:05:48 -08:00
LICENSE.md CodeQL for VS Code starter: Initial commit. 2019-11-12 14:05:48 -08:00
README.md Update README.md 2021-08-24 14:50:30 +01:00
vscode-codeql-starter.code-workspace Minor tidy-up 2021-11-09 10:19:00 +00:00

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!

Using the vscode-codeql-starter in a private repository

If you want to privately share your CodeQL queries with your teammates using this project as a template:

  1. Create an empty, private project in the organization you want.
  2. Clone this project locally: git clone git@github.com:github/vscode-codeql-starter.git
  3. Add a remote to the local copy git remote add my-org git@github.com:<MY-ORG>/vscode-codeql-starter.git
  4. Push the code to the new remote: git push my-org main

GitHub does not allow private forks of public repositories.

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.