История

Tom Hvitved f389a889ad Exclude consistency output from `.gitignore` files		2024-09-26 11:09:54 +02:00
..
.vscode	QL: move .vscode folder inside the ql subfolder	2021-12-14 14:39:03 +01:00
buramu	Bump `tree-sitter` to `0.23.0`	2024-09-04 09:47:59 +02:00
extractor	Bump `tree-sitter` to `0.23.0`	2024-09-04 09:47:59 +02:00
ql	Tree-sitter: Emit `empty_location` relation to avoid scan	2024-05-27 10:39:21 +02:00
scripts	QL: Rename extractor to codeql-extractor-ql	2023-04-19 06:30:09 +00:00
tools	QL: switch to shared YAML extractor	2023-05-22 19:28:59 +02:00
.gitattributes	QL: move .git files into the ql/ folder	2021-12-15 12:25:08 +01:00
.gitignore	Exclude consistency output from `.gitignore` files	2024-09-26 11:09:54 +02:00
Cargo.lock	Bump `tree-sitter` to `0.23.0`	2024-09-04 09:47:59 +02:00
Cargo.toml	QL: Merge extractor crates into one	2023-03-23 11:59:14 +13:00
README.md	move create-extractor-pack to a `scripts` folder	2022-06-19 20:09:31 +02:00
codeql-extractor.yml	Add supported build modes to extractor metadata	2024-02-06 19:51:13 +00:00
rust-toolchain.toml	Tree-sitter: Respect verbosity defined in `CODEQL_VERBOSITY`	2024-05-23 13:38:35 +02: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>