Add document symbols for #region by fflaten · Pull Request #1911 · PowerShell/PowerShellEditorServices

fflaten · 2022-08-26T16:18:58Z

PR Summary

Adds symbols for regions for easier navigation. Currently available in outline + breadcrumbs and "go to symbol in current editor".

PR Context

Fix PowerShell/vscode-powershell#3604
Fix PowerShell/vscode-powershell#3210

fflaten · 2022-08-26T16:20:05Z

Waiting for #1886 as I'd rather get merge conflicts here 🙂

andyleejordan · 2023-02-02T20:56:11Z

Heh, ok @fflaten things are so cleaned up now I think you can do this again (much more easily!)

For consistent behavior and easier maintenance

fflaten · 2023-02-14T19:36:06Z

Rewrote to use ReferenceTable for caching, but still a WIP.
@andschwa: Does it make sense to use ReferenceTable here? It'll make it available for handlers incl. find all references. And it isn't something we'd need to track in the workspace.

Todo:

Test with full scriptrange (track endregion)
- How does outline behave when endregion occurs in the middle of a function/class etc?
Validate regex behavior against PowerShell ISE
~~Move out of ReferenceTable?~~
Ignore symbol in scenarios like highlight and hover?

andyleejordan · 2023-02-14T20:09:27Z

Does it make sense to use ReferenceTable here?

I'd keep using it, it'll make everything easier. We can add "region" as a symbol type and just exclude them where appropriate.

andyleejordan · 2023-02-14T20:53:19Z

Does it make sense to use ReferenceTable here?

I'd keep using it, it'll make everything easier. We can add "region" as a symbol type and just exclude them where appropriate.

Hm I see what you mean now, since it's not done via AST but simply RegEx, and is only useful for the current document...I'll ponder, I'm sure there's a good way to handle that.

Adds support for outline nesting and breadcrumbs

Regions aren't a reference. Only useful as cosmetic/navigation symbol in current document.

fflaten · 2023-02-18T12:44:39Z

Test with full scriptrange (track endregion)

How does outline behave when endregion occurs in the middle of a function/class etc?

It didn't break as I feared, but only wraps symbols with both start and end position inside. Ex.

Updated to include it and returning only regions with matching end just like folding.
I've disabled hover, highlight (on click) and reference scanning.

Hopefully we'll get some feedback if it becomes too noisy in go to symbol or the outline-nesting. Breadcrumbs require the latter to work, so hopefully worth it.

andyleejordan

If you want to take a crack at what I'm contemplating, go for it! Otherwise I'll try to get to it later today.

src/PowerShellEditorServices/Services/Symbols/ReferenceTable.cs

src/PowerShellEditorServices/Services/Symbols/SymbolsService.cs

andyleejordan · 2023-02-23T20:06:21Z

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

+{
+    internal static class RegionVisitor
+    {
+        internal static void GetRegionsInDocument(ScriptFile file, Func<SymbolReference, AstVisitAction> action)


I like this a lot, makes reworking it much easier!

@andschwa: I assume you meant the separate class.
Because the Func-parameter won't make much sense when moving out of ReferenceTable, would it? Unless you'd prefer Action<SymbolReference>-parameter over IEnumerable return type.

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

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

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

test/PowerShellEditorServices.Test/Language/SymbolsServiceTests.cs

andyleejordan · 2023-02-23T20:42:03Z

Does it make sense to use ReferenceTable here?

I'd keep using it, it'll make everything easier. We can add "region" as a symbol type and just exclude them where appropriate.

I was wrong here 😆

fflaten · 2023-02-24T20:41:56Z

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

            IEnumerable<SymbolReference> foundSymbols = ProvideDocumentSymbols(scriptFile);
-            if (foundSymbols is null)
-            {
-                return null;
-            }
+            foundSymbols = foundSymbols.Concat(RegionVisitor.GetRegionsInDocument(scriptFile));



I didn't see a reason to keep the null-check. The local method ProvideDocumentSymbols() always returns a list, right?

fflaten · 2023-02-24T20:43:33Z

test/PowerShellEditorServices.Test/Language/SymbolsServiceTests.cs

        }
+
+        [Fact]
+        public void FindsRegionSymbolsInFile()


This technically doesn't belong here as SymbolsService isn't used for DocumentSymbolHandler. Move to own test-file? Suggestion?

andyleejordan · 2023-02-28T22:22:24Z

Closing since I integrated this, thanks again so much for your work!

fflaten mentioned this pull request Feb 7, 2023

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

Closed

add document symbols for #region start

bd28a73

fflaten force-pushed the region-symbol branch from 12e63f8 to bd28a73 Compare February 14, 2023 19:18

Reuse regex-patterns for regions

27e80e0

For consistent behavior and easier maintenance

fflaten added 4 commits February 18, 2023 12:30

Track only regions with matching endregion

851384f

Adds support for outline nesting and breadcrumbs

Never scan for region symbols

6468b56

Regions aren't a reference. Only useful as cosmetic/navigation symbol in current document.

Exclude hover for Region symbols

907d481

Exclude highlight for Region symbols

4aed74c

fflaten added 2 commits February 18, 2023 12:57

cleanup symbol name and id

8e59ea8

update tests

e892de3

fflaten marked this pull request as ready for review February 18, 2023 12:57

fflaten requested a review from a team February 18, 2023 12:57

andyleejordan requested changes Feb 23, 2023

View reviewed changes

fflaten added 2 commits February 24, 2023 20:39

Get region symbols only for DocumentSymbolHandler

bea7293

cleanup comment

196edbc

fflaten commented Feb 24, 2023

View reviewed changes

andyleejordan mentioned this pull request Feb 24, 2023

Add document symbols for #region #2003

Merged

andyleejordan closed this Feb 28, 2023

Conversation

fflaten commented Aug 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Context

Uh oh!

fflaten commented Aug 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

andyleejordan commented Feb 2, 2023

Uh oh!

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

Uh oh!

Uh oh!

andyleejordan commented Feb 14, 2023

Uh oh!

andyleejordan commented Feb 14, 2023

Uh oh!

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

Uh oh!

Uh oh!

andyleejordan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

andyleejordan Feb 23, 2023

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

andyleejordan commented Feb 23, 2023

Uh oh!

fflaten Feb 24, 2023

Choose a reason for hiding this comment

Uh oh!

fflaten Feb 24, 2023

Choose a reason for hiding this comment

Uh oh!

andyleejordan commented Feb 28, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

fflaten commented Aug 26, 2022 •

edited

Loading

fflaten commented Aug 26, 2022 •

edited

Loading

fflaten commented Feb 14, 2023 •

edited

Loading

fflaten commented Feb 18, 2023 •

edited

Loading

fflaten Feb 24, 2023 •

edited

Loading