Cabal plugin outline view #4323

VenInf · 2024-06-15T22:26:34Z

This is an attempt to solve an issue #4282.
It adds an Outline for the cabal files.

Implementation details

Using runIdeAction we get parsed cabal fields with positions of the keywords.

This can be transformed with a series of functions to the DocumentSymbol. It is returned, and the moduleOutline can be plugged in to the cabal descriptor.

michaelpj

Needs some tests. I'll let the others comment on the symbol kind choices, I'm not sure what those constructors actually correspond to.

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Outline.hs

VeryMilkyJoe · 2024-06-17T10:02:45Z

Thank you for working on this feature, it seems like a great addition to the plugin!
Could you add a screenshot of what the feature looks like in action?

VenInf · 2024-06-17T10:46:11Z

Thank you for working on this feature, it seems like a great addition to the plugin! Could you add a screenshot of what the feature looks like in action?

Yes, sure.
There is how the outline looks for haskell-language-server.cabal file and simple.cabal file from cabal plugin tests.

VeryMilkyJoe · 2024-06-17T14:42:50Z

I was trying out the feature, it looks like a great start!
But, I think there is some unwanted behaviour here.
Firstly, I think it would be less overwhelming to only see the parents in the outline by default, with everything else collapsed.
Secondly, I think it would be easier to use the outline if the names of stanzas were part of the respective elements instead of being a child.
Also, I think the if conditions are not grouped correctly as can be seen below.

VeryMilkyJoe · 2024-06-17T14:49:13Z

I think, it could also make sense to not show leaf values in the outline at all?
Specifically for long descriptions or exposed-modules content, the text becomes rather long.

VenInf · 2024-06-17T19:32:07Z

I was trying out the feature, it looks like a great start! But, I think there is some unwanted behaviour here. Firstly, I think it would be less overwhelming to only see the parents in the outline by default, with everything else collapsed.

I thought that this will be an easy fix, but it looks like that it's unclear, who can provide such settings. It certanly can be done manualy, but I can't tell if it's possible to do by default. I will look into it, but I will be glad to hear any ideas for a soltion.

Secondly, I think it would be easier to use the outline if the names of stanzas were part of the respective elements instead of being a child. Also, I think the if conditions are not grouped correctly as can be seen below.

Right now the outline displays the cabal's AST without any modifications. I think it will be nice to see the if statements in one line, and looks like it can be done by jamming all SectionArgs on one level in one DocumentSymbol. I will test this.

VenInf · 2024-06-17T19:41:25Z

I think, it could also make sense to not show leaf values in the outline at all? Specifically for long descriptions or exposed-modules content, the text becomes rather long.

At least for me it's not obvious, what data should be displayed, and what omitted. As far as I can tell, it can be independent with the depth in the cabal's AST.

I think a collapsed outline would solve this issue as well.

michaelpj · 2024-06-18T10:01:52Z

I don't think we have any control over whether or not the outline is expanded or not.

At least for me it's not obvious, what data should be displayed, and what omitted.

As I understand it, the outline view is generally used for navigation between named entities in the file. So I definitely don't think we should be including the values of fields, that's quite odd.

I think having the top-level field names is probably useful, in that it allows jumping to them, but I think it would be nice to group them in a "top-level stanza" element, perhaps?

michaelpj · 2024-06-18T10:02:47Z

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Outline.hs

+  Just
+    (defDocumentSymbol range)
+      { LSP._name = decodeASCII fieldName,
+        LSP._kind = LSP.SymbolKind_Object,


Suggested change

LSP._kind = LSP.SymbolKind_Object,

LSP._kind = LSP.SymbolKind_Field,

michaelpj · 2024-06-18T10:03:46Z

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Outline.hs

+  where
+    range = cabalPositionToLSPRange pos `addNameLengthToLSPRange` decodeASCII string
+
+documentSymbolForFieldLine :: FieldLine Position -> Maybe LSP.DocumentSymbol


I think what I'm suggesting is that we get rid of this.

michaelpj · 2024-06-18T10:04:23Z

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Outline.hs

+  where
+    range = cabalPositionToLSPRange pos `addNameLengthToLSPRange` decodeASCII fieldName
+
+documentSymbolForSectionArgs :: SectionArg Position -> Maybe LSP.DocumentSymbol


I'm unsure we want to include these either, what do they correspond to? It looks like this is responsible for e.g. the weirdness with conditionals.

I think they can also include the names of stanzas so we definitely want to process them somehow but probably not into their own DocumentSymbol element

VenInf · 2024-06-18T12:08:19Z

Fixed some minor issues, and hopefully solved the problem with displaying values of the fields.
Also now the Section and SectionArgs are displayed in one line.
For example source-repository head and if impl(ghc >= 9.8)

VeryMilkyJoe · 2024-06-18T12:17:41Z

Fixed some minor issues, and hopefully solved the problem with displaying values of the fields. Also now the Section and SectionArgs are displayed in one line. For example source-repository head and if impl(ghc >= 9.8)

This looks great!

VeryMilkyJoe · 2024-06-18T13:07:33Z

To fix the pre-commit failing, you will want to run the stylish haskell formatter on your code, especially the imports.

VenInf · 2024-06-18T14:15:02Z

Once the functionality will be set I will implement the tests.

VenInf · 2024-06-21T15:56:09Z

The tests are now implemented as well.

fendor

LGTM, thanks! Just some documentation nitpicks, code looks good otherwise!

plugins/hls-cabal-plugin/test/Outline.hs

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Outline.hs

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Completion/Types.hs

fendor

One more thing

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Outline.hs

This reverts commit f77dea5.

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Completion/CabalFields.hs

…Fields.hs

VeryMilkyJoe · 2024-07-15T14:31:30Z

@VenInf You need to format some imports, but afterwards I think we're good to go to merge!

fendor · 2024-07-15T18:13:20Z

I don't understand why this isn't merging... Or rather, why CircleCI seems to be hating @VenInf in particular.

VenInf · 2024-07-15T18:14:36Z

I don't understand why this isn't merging... Or rather, why CircleCI seems to be hating @VenInf in particular.

Maybe I have to register somewhere? Or provide some sort of credentials?

VenInf added 4 commits June 16, 2024 00:41

working test message cabal file

d49a000

trivial outline with rule invocation

632f5a0

outline with field lines

3574165

complete outline prototype

965d61b

VenInf requested review from fendor and wz1000 as code owners June 15, 2024 22:26

michaelpj requested a review from VeryMilkyJoe June 16, 2024 12:16

michaelpj reviewed Jun 17, 2024

View reviewed changes

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Outline.hs Outdated Show resolved Hide resolved

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Outline.hs Outdated Show resolved Hide resolved

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Outline.hs Show resolved Hide resolved

michaelpj reviewed Jun 18, 2024

View reviewed changes

VenInf added 2 commits June 18, 2024 13:58

small improvements

fd0b2ea

remove fieldLines, one line Section display

a5e7e53

stylish haskell

d616c54

tests

a953ecb

VenInf added 2 commits July 1, 2024 19:21

imports changes

d201493

outline tests changes

f4d57a5

VenInf force-pushed the cabal-plugin-outline-view branch from 75ee342 to f4d57a5 Compare July 2, 2024 03:04

VenInf added 7 commits July 2, 2024 06:19

duplicate defDocumentSymbol

526fac3

cabal outline test imports change

9860ea3

schema 96 94 update

a79be35

schema 94 update

a0642ef

94 schema update

c867a29

94 schema update

aeca984

Merge branch 'master' into cabal-plugin-outline-view

ae772a2

VeryMilkyJoe approved these changes Jul 10, 2024

View reviewed changes

fendor approved these changes Jul 11, 2024

View reviewed changes

plugins/hls-cabal-plugin/test/Outline.hs Outdated Show resolved Hide resolved

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Outline.hs Outdated Show resolved Hide resolved

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Completion/Types.hs Outdated Show resolved Hide resolved

fendor reviewed Jul 11, 2024

View reviewed changes

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Outline.hs Outdated Show resolved Hide resolved

VenInf added 3 commits July 11, 2024 14:47

+ cabal-add

f77dea5

Revert "+ cabal-add"

6f9fbcd

This reverts commit f77dea5.

+ docs, refactoring

4735e7d

fendor reviewed Jul 11, 2024

View reviewed changes

plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Completion/CabalFields.hs Outdated Show resolved Hide resolved

fendor and others added 2 commits July 11, 2024 18:10

Update plugins/hls-cabal-plugin/src/Ide/Plugin/Cabal/Completion/Cabal…

000dcbe

…Fields.hs

Merge branch 'master' into cabal-plugin-outline-view

851daef

VenInf added 2 commits July 15, 2024 19:22

formatting

cb2fbf7

newline

050af38

VeryMilkyJoe enabled auto-merge (squash) July 15, 2024 18:02

fendor disabled auto-merge July 30, 2024 12:29

Merge branch 'master' into cabal-plugin-outline-view

af4d8c8

fendor enabled auto-merge (squash) July 30, 2024 12:54

fendor merged commit 0bf3348 into haskell:master Jul 30, 2024
21 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Cabal plugin outline view #4323

Cabal plugin outline view #4323

VenInf commented Jun 15, 2024 •

edited

Loading

michaelpj left a comment

VeryMilkyJoe commented Jun 17, 2024

VenInf commented Jun 17, 2024

VeryMilkyJoe commented Jun 17, 2024

VeryMilkyJoe commented Jun 17, 2024

VenInf commented Jun 17, 2024 •

edited

Loading

VenInf commented Jun 17, 2024

michaelpj commented Jun 18, 2024

michaelpj Jun 18, 2024

michaelpj Jun 18, 2024

michaelpj Jun 18, 2024

VeryMilkyJoe Jun 18, 2024

VenInf commented Jun 18, 2024

VeryMilkyJoe commented Jun 18, 2024

VeryMilkyJoe commented Jun 18, 2024

VenInf commented Jun 18, 2024

VenInf commented Jun 21, 2024

fendor left a comment •

edited by VeryMilkyJoe

Loading

fendor left a comment

VeryMilkyJoe commented Jul 15, 2024

fendor commented Jul 15, 2024

VenInf commented Jul 15, 2024

	LSP._kind = LSP.SymbolKind_Object,
	LSP._kind = LSP.SymbolKind_Field,

Cabal plugin outline view #4323

Cabal plugin outline view #4323

Conversation

VenInf commented Jun 15, 2024 • edited Loading

Implementation details

michaelpj left a comment

Choose a reason for hiding this comment

VeryMilkyJoe commented Jun 17, 2024

VenInf commented Jun 17, 2024

VeryMilkyJoe commented Jun 17, 2024

VeryMilkyJoe commented Jun 17, 2024

VenInf commented Jun 17, 2024 • edited Loading

VenInf commented Jun 17, 2024

michaelpj commented Jun 18, 2024

michaelpj Jun 18, 2024

Choose a reason for hiding this comment

michaelpj Jun 18, 2024

Choose a reason for hiding this comment

michaelpj Jun 18, 2024

Choose a reason for hiding this comment

VeryMilkyJoe Jun 18, 2024

Choose a reason for hiding this comment

VenInf commented Jun 18, 2024

VeryMilkyJoe commented Jun 18, 2024

VeryMilkyJoe commented Jun 18, 2024

VenInf commented Jun 18, 2024

VenInf commented Jun 21, 2024

fendor left a comment • edited by VeryMilkyJoe Loading

Choose a reason for hiding this comment

fendor left a comment

Choose a reason for hiding this comment

VeryMilkyJoe commented Jul 15, 2024

fendor commented Jul 15, 2024

VenInf commented Jul 15, 2024

VenInf commented Jun 15, 2024 •

edited

Loading

VenInf commented Jun 17, 2024 •

edited

Loading

fendor left a comment •

edited by VeryMilkyJoe

Loading