Integrating class symbol support#1984

andyleejordan · 2023-01-12T19:37:58Z

This is the full (admittedly still a bit of a work-in-progress PR) that integrates #1886 into main.

andyleejordan

Some quick comments but there's more, I just need to eat lunch.

src/PowerShellEditorServices/Services/Symbols/ReferenceTable.cs

fflaten · 2023-01-21T13:45:07Z

This is coming along very well! I'll try to consolidate my thoughts in this PR 🙂

Need to filter on symboltype when searching symbols. Function name and and class name match, Go to definition on [type] shows constructors etc. Related comment Integrating class symbol support fflaten/PowerShellEditorServices#16 (comment)
- Note: Example below will need special handling like type vs class/enum for EnumMember definition vs Property reference (or replace EnumMember with Property for simplicity).
Consider matching [classname]::new() with classname() constructors? Same as Integrating class symbol support fflaten/PowerShellEditorServices#16 (comment)
Missing method overload in outline and workspace symbol search
Hide variable symbols in outline+workspace for method parameters in definitions (image above)
Remove variable symbols for parameters in function/cmdlet calls
Only show variable assignment symbols for top-level assignments like stable? To remove noise in outline and workspace symbols - at least until we're able to handle scopes better. Related discussion Integrating class symbol support fflaten/PowerShellEditorServices#16 (comment)
- Also for go to definition? Will currently list reassignment inside of out-of-scope functions
Outline, workspace symbol search and go to definition jumps to function-keyword and not name (using scriptrange atm?).
Currently undoes fix for Outline, symbol search and go to definition should jump to symbol name #1905 in original PR.
Struggles with large files. Outline, workspace symbols and hover works. Codelens shows "no command", go to definition doesn't work, highlight on click etc. (anything searching for specific symbol?) fails. Try Pester.psm1 (17k lines).
Update 24/1: Fixed in latest commits 🎉
New 24/1: Hovering a function name should only highlight the name. Currently highlights full definition and full invocation/call

This PR would also fix #1889 and #1904 🎉

fflaten · 2023-01-24T19:20:06Z

Latest commit fixed the reference-issue with large files 🎉 I've updated the previous post

Since `FindReferencesOfSymbol` is already used.

This required using a `ScriptFile` for the associated test in `AstOperationsTests`. The coupling of the visitor to the file seems fine since that's the _point_ of this improvement: a cached sets of references for each file. We also have to carefully sort our list of symbol references for things that expect them in order.

SeeminglyScience

I'm probably about 2/3's done reviewin' but here's what I got so far. Very exciting changes though! ❤️

src/PowerShellEditorServices/Services/Symbols/SymbolsService.cs

src/PowerShellEditorServices/Services/TextDocument/ScriptRegion.cs

src/PowerShellEditorServices/Utility/VisitorUtils.cs

Co-authored-by: Patrick Meinecke <[email protected]>

andyleejordan · 2023-01-28T02:26:47Z

src/PowerShellEditorServices/Services/TextDocument/Handlers/SignatureHelpHandler.cs

            {
                Label = parameterInfo.Name,
-                Documentation = string.Empty
+                Documentation = parameterInfo.HelpMessage


@SeeminglyScience Not a whole lot comes from this it seems.

src/PowerShellEditorServices/Services/TextDocument/ScriptFile.cs

src/PowerShellEditorServices/Services/TextDocument/ScriptRegion.cs

src/PowerShellEditorServices/Utility/Extensions.cs

src/PowerShellEditorServices/Utility/VisitorUtils.cs

test/PowerShellEditorServices.Test.Shared/Symbols/DSCFile.ps1

So that we rely on the dictionary to sort our symbols into the equivalent types instead of having to perform a filter.

I think there's a cleaner way to do this, but this works.

Against the full name and not just the identifier, since it's what's displayed in the search menu. Now you can search methods by their parameters' names.

src/PowerShellEditorServices/Services/Symbols/Visitors/SymbolVisitor.cs

Should have been just `IndexOf`, and also use `+` instead of `string.Concat()` for simplicity and speed.

andyleejordan · 2023-02-01T00:59:24Z

Thanks @fflaten and @SeeminglyScience, resolved those things!

SeeminglyScience

LGTM! These changes are awesome. Huge thank you @fflaten (and ofc @andschwa) ❤️

andyleejordan added Issue-Enhancement A feature request (enhancement). Area-Symbols and References labels Jan 12, 2023

andyleejordan requested a review from a team January 12, 2023 19:37

andyleejordan force-pushed the andschwa/better-symbols branch 2 times, most recently from 82ec11f to 604d6a7 Compare January 20, 2023 22:12

andyleejordan commented Jan 20, 2023

View reviewed changes

fflaten and others added 22 commits January 24, 2023 14:40

add symbols for classes

7270bed

remove code used for supporting PSv3 and v4

69a66bb

support hover

e3845e8

add type reference symboltype

b1187b9

support references and definitions

7cf22f0

add codelens for class and enum

13adfc3

skip function ast visit for FunctionMemberAst

f2be365

drop reference-support for ConfigurationDefinition

1d1b5cc

update document symbols test

50e8a6c

refactor and cleanup

4c3a4ab

fix Contains extension method for same line extent

ad58bcd

add EnumMember, signature and fix detection

12b1366

update symbols test with name position

884fecb

check type for property and function members

109dbb0

add symbolsservice tests

e776984

add codelens tests

4be7724

add symbol tests using newline after keyword

bca3de0

fix DSC symbol test

da2ad17

Minor clean-ups

98fbfbd

Remove deprecated (and confusing) DocumentSymbolService.cs file

3eebb45

Rename overloaded method to ScanForReferencesOfSymbol

6469411

Since `FindReferencesOfSymbol` is already used.

SeeminglyScience requested changes Jan 27, 2023

View reviewed changes

Mark some methods internal

fd04c34

Co-authored-by: Patrick Meinecke <[email protected]>

andyleejordan commented Jan 28, 2023

View reviewed changes

andyleejordan added 6 commits January 30, 2023 18:00

Rename SymbolReference fields

3010065

Replace SymbolTypeMatches logic with prefixed identifiers

0135baa

So that we rely on the dictionary to sort our symbols into the equivalent types instead of having to perform a filter.

Strip qualifier from variable name in symbol identifier

7da6f9d

Handle symbol prefix identifier in CommandHelpers

4a90f28

I think there's a cleaner way to do this, but this works.

More leniently filter workspace symbols

3b08189

Against the full name and not just the identifier, since it's what's displayed in the search menu. Now you can search methods by their parameters' names.

Map symbol types to LSP better

6d2d5a7

fflaten reviewed Jan 31, 2023

View reviewed changes

src/PowerShellEditorServices/Services/Symbols/Visitors/SymbolVisitor.cs Outdated Show resolved Hide resolved

fflaten reviewed Jan 31, 2023

View reviewed changes

src/PowerShellEditorServices/Services/Symbols/Visitors/SymbolVisitor.cs Outdated Show resolved Hide resolved

andyleejordan added 4 commits January 31, 2023 16:35

Restore public ScriptRegion Create(...) method

4c1538b

Fix bugs in VisitorUtils around LastIndexOf

9e12670

Should have been just `IndexOf`, and also use `+` instead of `string.Concat()` for simplicity and speed.

Distinguish properties/enums from variables

0739fc1

Distinguish constructors/methods from functions

4296553

Remove unused code from Extensions.cs

6208b53

SeeminglyScience approved these changes Feb 2, 2023

View reviewed changes

andyleejordan merged commit 2df6d51 into main Feb 2, 2023

andyleejordan deleted the andschwa/better-symbols branch February 2, 2023 20:56

This was referenced Feb 7, 2023

Account for function and variable scope in language service features #16

Open

Include regions in symbol list/outline/breadcrumbs PowerShell/vscode-powershell#3210

Closed

JustinGrote mentioned this pull request Mar 5, 2025

Improve E2E Test Fixtures to be less flaky #2208

Merged

3 tasks

Conversation

andyleejordan commented Jan 12, 2023

Uh oh!

andyleejordan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fflaten commented Jan 21, 2023 • edited by andyleejordan Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fflaten commented Jan 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SeeminglyScience left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

andyleejordan Jan 28, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

andyleejordan commented Feb 1, 2023

Uh oh!

SeeminglyScience left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

fflaten commented Jan 21, 2023 •

edited by andyleejordan

Loading

fflaten commented Jan 24, 2023 •

edited

Loading