[folding] custom folding text for folded ranges

[maptz]

Currently when you create custom folds using a FoldingRangeProvider, there is no option to edit the text that is displayed when the text is folded. The editor just displays the first line of the fold with a three dots symbol after it.

#region Some region description...

It would be helpful if it was possible for FoldingRangeProvider instances to return ranges with a RangeDisplayName property that would be displayed when the folding range wass collapsed. I'd suggest that the display text would replace the ... symbol and the first line would no longer be displayed as per the behaviour in Visual Studio.

[vscodebot]

(Experimental duplicate detection)
Thanks for submitting this issue. Please also check if it is already covered by an existing one, like:

• [folding] show folding actions at the end of folding range as well (#60670)
• [folding] Move line up/down should skip over folded regions or folded sections (#63972)
• [folding] clicking on on line number of folded line should select full folding range (#59657)
• [folding] show comment first line for folded sections (#31966)
• [folding] Add setting to allow to show first N lines (not 1) of folded block (#69078)

[Qhesz]

Is there any scope for community contributions to this feature request?

[aeschli]

PRs are always welcome, but I think this is not an easy fix.
https://github.com/microsoft/vscode/blob/master/src/vs/editor/contrib/folding/folding.ts is the starting point.
... are done with css :after decorations.

[ihdavids]

Being able to remove the fold indicator would also be really nice.
Modes like markdown could auto fold the link part of a link and unfold them as the cursor moves over a link to help declutter the visualization of the document being edited.

Emacs org mode does this for links and it is pretty slick.

[ris58h]

I believe that before implementing this we need to answer a question: should we replace the whole first line or just the ... placeholder?

In Visual Studio #region

folds to

but function body

folds to

I know that Visual Studio operates with char-ranges instead of line-ranges, but in VSCode we only have line-ranges, so we have to deal with it and we need to decide what will be the behavior for line-folding.

[mtbaqer]

Hey, wanted to take a stab at this issue since it would be really helpful for the extension we are working on, but I don't see a help wanted label. So wanted to clarify the #70794 (comment) above, can we provide a community PR for this?

[aeschli]

@mtbaqer Yes, PR's are welcome

[mtbaqer]

Great. Thanks for the clarification. One more question, I assume startCharacter can be be any value besides 0 as well? To replace parts of the first line? Or is there something in the current implementation that would stop that and we need to treat 0 as a special input?

[aeschli]

VS Code only supports full lines to be folded. So startCharacter is ignored.