VSCode: Folding all @doc at once

Questions / Help
,
1

Is there a way to fold/unfold all occurrences of

@doc"""
[...]
"""

within a module at once (using a command or assigned keystroke) in VSCode?

Was talking to a colleague and have no idea where to look/ask at all.
Guess its part of language aware folding

Are there other editors which support this?

1 Like
2

Vim certainly does and is actually on my list to write one for this very purpose. I have not done so yet but if you’re interested I’ll share here when done. Otherwise see :help fold-expr if you’re curious.

1 Like
3

⌘K ⌘2 will do it for @doc in VSCode on MacOS.

The number indicates the level of indentation you want to fold. So ⌘K ⌘1 would fold the top-level defmodule, ⌘K ⌘2 folds all the 2nd level indented regions like @doc and def, ⌘K ⌘3 would fold all the highest-regions inside each def, etc.

Note: the default is that the command won’t fold the region where your cursor is. So if you’re trying to fold a particular @doc, make sure your cursor is outside it.

2 Likes
4

Oh and ⌘K ⌘J unfolds everything.

1 Like
5

Thank you both for the hints!
We are using indentation level wise folding already as well as #region folding.
Expression level folding would be nice - either for VSCode or for Zed (which I am evaluating right now)

Main reason is to just fold all @doc and keep the def open. Reason is to lower distraction if not working on the documentation.
One might argue why not folding all with ctrl-K ctrl-2 and unfold the procedure which being worked on.
The other way around is (just?) QoL.

Best regards

Note: Zed is available for windows since a few days. With the VSCode key layout it’s a tempting replacement. It is still lacking some functionality and stability.
And yes (I even remember the Atom editor…)

6

Ah gotcha, you want to fold only comments. Then you want:

Fold All Block Comments: ⌘K ⌘/

This will fold all block comments. @doc and @moduledoc all considered :comment regions by the LSP.

Note: you can also fold/unfold the current region your cursor is on with: ⌥ ⌘ [ (fold), ⌥ ⌘ ] (unfold).

Here’s some decent documentation if you want to see more:

7

Sure it’s not Emacs?

8

Fold All Block Comments never worked in VSCode using Lexical here. Not sure which to blame (likely myself)

I will give it another try very soon

9

Fold All Block Comments never worked in VSCode using Lexical here

That’s the problem. So sorry I didn’t think to check. Language aware code-folding is only implemented right now in ElixirLS:

So you have to use ElixirLS as your LSP instead of Lexical to get the language aware folding.

Reminder: it’s generally the language server protocol (LSP) that implements features like code folding, not specific editors. That’s basically the point of LSPs: each editor just implements the protocol. That way communities don’t need to write a new language server per editor. So switching to Zed or Atom won’t fix your problem (unless of course that editor happens to implement its own LS for the language in question, but that’s not usually the case).

10

Thanks for your explanation. Appreciate the link to a PR for ElixirLS.
Looking forward to see this implemented in Expert one day