Better intellisense inside of QLDoc comments

Open
#556 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
42/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript, vscode
Domain
developer-experience, tooling

Research direction

Start by reviewing the QLDoc metadata completion work referenced in #392 and tracing the extension's handling of file-level QLDoc comments. The change is done when relevant @ tags, including examples such as @kind, are proposed inside those comments without changing ordinary comment behavior.

Written by the indexing model from the issue text.

Description

Complexity: Low enhancement VSCode

In addition to providing code templates for query metadata written in QLDoc blocks (see #392), we should also provide proposals inside of QLDoc comment blocks.

For now, I think all we need to do is propose relevant @ tags in file-level query metadata comments (eg- @kind).

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.