Skip to content

Improve linked symbol anchors with tree-sitter fallback#5105

Open
pranavvaid-ac wants to merge 3 commits intomicrosoft:mainfrom
pranavvaid-ac:pranav/symbol-linkifier-fallback
Open

Improve linked symbol anchors with tree-sitter fallback#5105
pranavvaid-ac wants to merge 3 commits intomicrosoft:mainfrom
pranavvaid-ac:pranav/symbol-linkifier-fallback

Conversation

@pranavvaid-ac
Copy link
Copy Markdown

Adds an eager tree-sitter fallback for linked-backtick symbol references so links open near the referenced symbol even before an LSP DocumentSymbolProvider result is available. Before this PR, links to referenced symbols would just take you to the top of the file if an LSP was not available.

Changes:

  • Resolve initial linked symbol locations from tree-sitter when LSP symbols are unavailable.
  • Prefer declaration-like tree-sitter symbols before generic identifier matches.
  • Cache parsed file symbols during linkification to avoid repeated parsing for the same file.
  • Keep the existing LSP resolve path so symbol kind and more precise document-symbol locations can still upgrade later.
  • Add tests for exact matches, qualified-name fallback, parser caching, linkifier integration, and LSP kind/location upgrades.

@microsoft-github-policy-service
Copy link
Copy Markdown

@pranavvaid-ac please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

@pranavvaid-ac pranavvaid-ac marked this pull request as ready for review May 4, 2026 23:35
Copilot AI review requested due to automatic review settings May 4, 2026 23:35
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an eager tree-sitter-based fallback to the linkify pipeline so linked-backtick symbol anchors can open near a symbol before document symbols are available, while still allowing later LSP-based upgrades.

Changes:

  • Injects parser-based symbol lookup into SymbolLinkifier and keeps the existing document-symbol resolve path for later upgrades.
  • Adds findSymbolLocationInFile plus shared symbol-name extraction to support exact and qualified-name fallback with per-linkification file-symbol caching.
  • Expands linkify tests to cover initial tree-sitter locations, declaration preference, qualified fallback, cache reuse, and LSP upgrade behavior.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
src/extension/linkify/vscode-node/symbolLinkifier.ts Uses tree-sitter to seed initial linked-symbol locations and adds resolve-time logging/helpers.
src/extension/linkify/vscode-node/findWord.ts Adds file-level symbol lookup/cache logic used by linked symbol anchors.
src/extension/linkify/vscode-node/findSymbol.ts Exports shared inline-code symbol-part extraction.
src/extension/linkify/test/vscode-node/symbolLinkifier.test.ts Adds integration-style tests for tree-sitter fallback, cache reuse, and LSP upgrades.
src/extension/linkify/test/vscode-node/findWord.test.ts Adds unit tests for exact/declaration/qualified-name symbol lookup and cache behavior.

Comment on lines +64 to +66
const initialLocation = await findSymbolLocationInFile(this.parserService, resolvedUri, symbolText, token, symbolFileCache)
.catch(() => undefined);
console.log(`[SymbolLinkifier] tree-sitter initial symbol="${symbolText}" uri="${resolvedUri.toString()}" location=${formatLocationForLog(initialLocation)}`);
let bestMatch: { symbol: FileSymbol; matchIndex: number } | undefined;
for (const symbol of symbols) {
const matchIndex = symbolParts.indexOf(symbol.identifier);
if (matchIndex !== -1 && (!bestMatch || matchIndex > bestMatch.matchIndex)) {
Comment on lines +123 to +138
const fullFileRange = new vscode.Range(0, 0, Number.MAX_SAFE_INTEGER, 0);
const [classDeclarations, functionDefinitions, typeDeclarations, genericSymbols] = await Promise.all([
ast.getClassDeclarations(),
ast.getFunctionDefinitions(),
ast.getTypeDeclarations(),
ast.getSymbols({
startIndex: doc.offsetAt(fullFileRange.start),
endIndex: doc.offsetAt(fullFileRange.end),
}),
]);
symbols = [
...classDeclarations,
...functionDefinitions,
...typeDeclarations,
...genericSymbols,
];
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants