github
/
codeql
зеркало из https://github.com/github/codeql.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
codeql/ql
История
Henry Mercer d80d39504f Tag successfully extracted files queries 
Tag the successfully extracted files queries with
`successfully-extracted-files` to make them easier to identify
programmatically in a language-independent way.
This follows the prior art for lines of code queries, which are tagged
`lines-of-code`.
 		2022-10-05 19:19:43 +01:00
..
.vscode QL: move .vscode folder inside the ql subfolder 2021-12-14 14:39:03 +01:00
autobuilder get the autobuilders to work after introducing test-cases 2022-07-13 09:50:55 +02:00
extractor support signature parameters in QL-for-QL 2022-08-16 13:36:05 +02:00
generator support signature parameters in QL-for-QL 2022-08-16 13:36:05 +02:00
node-types QL for QL: sync changes from Ruby 2022-02-07 17:44:40 +00:00
ql Tag successfully extracted files queries 2022-10-05 19:19:43 +01:00
scripts Use upstream `tree-sitter-ql` 2022-08-11 12:31:52 +02:00
tools QL for QL: add autobuilder that respects LGTM_INDEX_FILTERS 2021-12-17 16:05:21 +00:00
.gitattributes QL: move .git files into the ql/ folder 2021-12-15 12:25:08 +01:00
.gitignore QL: move .git files into the ql/ folder 2021-12-15 12:25:08 +01:00
Cargo.lock support signature parameters in QL-for-QL 2022-08-16 13:36:05 +02:00
Cargo.toml QL for QL: add autobuilder that respects LGTM_INDEX_FILTERS 2021-12-17 16:05:21 +00:00
README.md move create-extractor-pack to a `scripts` folder 2022-06-19 20:09:31 +02:00
codeql-extractor.yml QL: move files and folder, except dotfiles, into a ql subfolder 2021-12-14 14:34:53 +01:00

README.md

QL for QL

QL for QL is a CodeQL analysis designed to find common bug patterns in QL code.
This analysis is mostly used as a PR check in github/codeql.
QL for QL is experimental technology and not a supported product.

This directory contains the extractor, CodeQL libraries, and queries that power QL for QL.

Some setup is required to use QL for QL (see the below sections).

Building the tools from source

Install Rust (if using VSCode, you may also want the rust-analyzer extension), then run:

cargo build --release

Generating the database schema and QL library

The generated ql/src/ql.dbscheme and ql/src/codeql_ql/ast/internal/TreeSitter.qll files are included in the repository, but they can be re-generated as follows:

./scripts/create-extractor-pack.sh

Building a CodeQL database for a QL program

First, get an extractor pack:

Run ./scripts/create-extractor-pack.sh (Linux/Mac) or .\scripts\create-extractor-pack.ps1 (Windows PowerShell) and the pack will be created in the extractor-pack directory.

Then run

codeql database create <database-path> -l ql -s <project-source-path> --search-path <extractor-pack-path>

CodeQL can be configured to remember the extractor by setting the config file ~/.config/codeql/config to:

--search-path /full/path/to/extractor-pack

Running qltests

Run

codeql test run <test-path> --search-path <repository-root-path>