Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Extension erroneously suggests certain QL keywords in QLDoc

Open
#1,564 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript, vscode
Domain
devtools

Research direction

Reproduce the issue in a Quick Query by writing a QLDoc comment and entering a period at the marked position. Trace the extension's completion behavior for QLDoc, then verify that QL keywords are not suggested there and that pressing Enter does not select one.

Written by the indexing model from the issue text.

Description

bug VSCode

Describe the bug
Possibly related to #391 and #556

The extension erroneously suggests certain QL keywords while writing QLDoc, these keywords seem to be affected: class, extends, from, import, select, where

Also a bit annoying is that these suggestsions pop up automatically when you write a period (.), and when you then press Enter to continue in the next line, you actually select that suggested keyword instead.

Screenshot showing the suggestsions pop-up

Version
Extension:

CodeQL extension version: 1.7.0 
CodeQL CLI version: 2.11.0 
Platform: win32 x64

VS Code:

Version: 1.71.2 (user setup)
Commit: 74b1f979648cc44d385a2286793c226e611f59e7
Date: 2022-09-14T21:03:37.738Z
Electron: 19.0.12
Chromium: 102.0.5005.167
Node.js: 16.14.2
V8: 10.2.154.15-electron.0
OS: Windows_NT x64 10.0.19043
Sandboxed: No

To reproduce

  1. Open the Quick Query
  2. Write any small query
  3. Write a QLDoc for the file, e.g. 
    /**
 * test<HERE>
 */
  4. At the position marked with <HERE> write a period (.)
    ❌ Bug: The extension suggests QL keywords

Expected behavior
No QL keywords should be suggested in QLDoc.

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.