mirror of https://github.com/github/codeql.git synced 2026-02-08 11:11:06 +01:00

Files

Geoffrey White d99d02994a Update README.md

I needed the rust-analyzer extension to get anywhere in VSCode.

2021-10-13 10:09:08 +01:00

1.1 KiB

Raw Blame History

QL analysis support for CodeQL

Part of the May 2021 code scanning hackathon.

Under development.

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:

./create-extractor-pack.sh

Building a CodeQL database for a QL program

First, get an extractor pack:

Run ./create-extractor-pack.sh (Linux/Mac) or .\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>

Running qltests

Run

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