Jump-to-definition doesn't work on not-zipped source archives.

Open
#477 8 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript, vscode
Domain
devtools

Research direction

Start by tracing how the zipped-archive DefinitionProvider is registered and how database add/delete events are handled. Compare the proposed per-database registration with a broadly applicable provider; done means jump-to-definition works for LGTM databases without running database cleanup.

Written by the indexing model from the issue text.

Description

enhancement VSCode

Databases from LGTM are built with odasa rather than codeql, and so don't have zipped source archives, and require an extra codeql database cleanup step to zip the source archive before jump-to-definition works on them.

It would be nice in principle if it just worked out of the box. With the current strategy of making one DefinitionProvider for the zipped archive scheme, it doesn't seem possible. We could perhaps, for each database add and delete, register and unregister a DefinitionProvider with an absolute file path pattern matching files in that database's source archive. Alternatively it might be the case that registering a broadly applicable DefinitionProvider isn't harmful as long as it simply returns zero results when another DefinitionProvider also exists.

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.