Ephemeral quick query editor
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- typescript, vscode
- Domain
- tooling
Research direction
Start by inspecting the existing quick query implementation introduced in #210 and the query history view, then review VS Code webview views. The work is done when quick queries run from an ephemeral editor with CodeQL checking and syntax highlighting, can be reopened from query history with their text, and no longer depend on hidden files on disk.
Written by the indexing model from the issue text.
Description
Is your feature request related to a problem? Please describe.
When we added the quick query feature in #210, we had to stick within the confines of what was possible in VS Code at the time. This made the result a little less slick-feeling than the equivalent QL4E functionality: Quick queries are genuine files on disk, but in an obscure directory; this means they are stateful, and don't interact as well with repeated quick-query executions as QL4E's ephemeral design.
Describe the solution you'd like
With the advent of webview views, I think it's now possible do get feature-parity with Eclipse. We could create a "quick query" view which effectively consists of a large textarea that does CodeQL error checking and syntax highlighting in the context of the active database and workspace (meaning that the active database determines the language, and the qlpacks from the workspace are on the search path, like normal). We can then execute quick queries by passing the content of that text area to the query server, rather than by writing it to disk and passing a path.
The main benefit this unlocks is in conjunction with the query history view: If I double-click on a query execution that corresponds to a quick query, I want the quick query view to open, populated with the QL code that corresponds to the execution I double-clicked on. (We have support for looking at the QL text of existing query executions, but that goes via a slightly awkward readonly editor.)
A side benefit is the removal of the hidden quick-queries directory deep in the workspace, and any pretense that quick queries live in the filesystem, should appear in the outline, should be allowed to have QLLs next to them, and so on.
- Dominant language
- TypeScript
- Stars
- 539
- Forks
- 240
- Avg merge
- 2d 6h
- Merged PRs (30d)
- 29
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from github/vscode-codeql
-
bug VSCode
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/vscode-codeql#4471 · 1 comment ·
-
bug enhancement VSCode
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/vscode-codeql#592 · 2 comments ·
-
enhancement VSCode
Difficulty 3/5 1-2 days Newbie friendliness 55/100
github/vscode-codeql#4432 · 1 comment ·
-
bug VSCode
Difficulty 3/5 1-2 days Newbie friendliness 52/100
github/vscode-codeql#4356 ·
-
bug VSCode
Difficulty 3/5 1-2 days Newbie friendliness 64/100
github/vscode-codeql#4339 · 1 comment ·
All issues in github/vscode-codeql
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
bug v2
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
modelcontextprotocol/inspector#2458 · 1 comment ·
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
railmapgen/rmp-gallery#4068 ·
-
Mend: dependency security vulnerability status: needs triage 🕵️♀️
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
carbon-design-system/ibm-products#9907 ·