Allow CodeQL databases to be specified in the workspace

Open
#502 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript, vscode
Domain
developer-experience, devtools

Research direction

Start by locating the extension's VS Code settings handling and the entry point used to add CodeQL databases. Trace how workspace loading currently discovers databases, then define the behavior for the proposed codeQL.preloadedDatabases paths, including successful additions and repeated workspace loads. Done means configured databases are available automatically when the workspace opens.

Written by the indexing model from the issue text.

Description

Complexity: Medium enhancement VSCode

Is your feature request related to a problem? Please describe.

In order to facilitate workspace sharing (e.g., for CodeQL trainings and CTF), it would be great if we could have a workspace that is already set up to work on a database without having the user do any configuration.

It's already partially possible through codespaces. Users can start working with almost no extra configuration. The only thing that the user needs to do is add a database. Through a Codespaces docker file, it's already possible for the database to be available in the file system.

This task is about adding this database directly to the workspace on load.

Describe the solution you'd like

One possible way to do this is to use VS Code settings. Something like:

{
  ...
  "codeQL.preloadedDatabases": [
    "/var/opt/db1",  "/var/opt/db1"
  ],
  ...
}

And then on load, the extension will add the database at that path. Possibly, all successfully added databases will be removed.

Dominant language
TypeScript
Stars
539
Forks
240
Avg merge
2d 6h
Merged PRs (30d)
29

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/vscode-codeql

All issues in github/vscode-codeql

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.