Better content assist inside of comments

Open
#391 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start with the language server and the linked QLDoc specification to understand comment structure, tags, and supported Markdown syntax. Implement completion for the documented tags and auto-closing for Markdown-style backticks and underscores, then verify both behaviors inside QLDoc comments.

Written by the indexing model from the issue text.

Description

enhancement VSCode

Inside of a QLDoc, there is structure and the editor can be more helpful at providing better content assist support for comments and tags.

Documentation on QLDoc: https://help.semmle.com/QL/ql-spec/qldoc.html

At a minimum, the editor should propose completion of well known tags, e.g. all the tags here-

/**
 * @name Useless assignment to local variable
 * @description An assignment to a local variable that is not used later on, or whose value is always
 *              overwritten, has no effect.
 * @kind problem
 * @problem.severity warning
 * @id cs/useless-assignment-to-local
 * @tags maintainability
 *       external/cwe/cwe-563
 * @precision very-high
 */

Also, since QLDoc accepts markdown syntax, we should auto-close markdown-ish tags, like backticks and _

This task will probably require changes to the language server.

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.