Type Enclosing Command

[xvw]

The branch exposes the ocaml-eglot-type-enclosing function, which displays the type of the expression under the cursor.

• ocaml-eglot-type-enclosing-increase-verbosity (C-c
  C-t): to increase the verbosity of the type observed
• ocaml-eglot-type-enclosing-grow (C-↑): to grow the
  expression
• ocaml-eglot-type-enclosing-shrink (C-↓): to shrink the
  expression
• ocaml-eglot-type-enclosing-copy (C-w): to copy the
  type expression to the kill-ring (clipboard)

Decisions

At present, the control of the number of fines is reset to zero each time the enclosures are varied. However calling C-c C-t will increase the verbosity on the current enclosing type. It's easily possible to maintain verbosity control by ‘requests’ if you think that's better (which I don't).

More

Currently, there are no queries to ask for the type of an identifier (initially usable with the prefix argument in Merlin, ie: C-u C-c C-t will ask for an identifier, List.map and will display ('a -> “b) -> ”a list -> ’b list.

But as it's possible to search by type, I'm not sure that the feature is ‘so necessary’.

[gr-im]

At present, the control of the number of fines is reset to zero each time the enclosures are varied

WDYT about keeping verbosity from enclosings to enclosings? And restoring it to 0 only when re-triggering the command? (and offering a transient binding for C-<left> and C-<right> to increase/decrease verbosity for current enclosing?)

[voodoos]

I had similar thoughts when integrating the feature in vscode and I don't have a strong preference:

• The current behavior is the same as the existing client (I think), so memory muscle will be rewarded.
• The proposed 2D navigation scheme with the arrows and verbosity memory does seems nicer.

I mean, it's probably the best time to introduce this kind of UX changes, as long as we keep the "multiple presses on C-t augments verbosity"...

[xvw]

@gr-im, @voodoos
Behaviour appended on 48c95e0

[voodoos]

Just some doc comments right now, I will try to do a more in depth-review tomorrow.

We should really pay attention to the docstring of interactive functions :-)

[voodoos]

Suggested change

	`ocaml-eglot` displays the type of expression below the cursor and
	increases or decreases the enclosings of the expression or verbosity:
	In `ocaml-eglot` one can display the type of the expression below the cursor and
	navigate the enclosing nodes while increasing or decreasing verbosity:

[voodoos]

Suggested change

	- `ocaml-eglot-type-enclosing` (<kbd>C-c</kbd> <kbd>C-t</kbd>)
	And when a type is displayed, additional commands are possible:
	- `ocaml-eglot-type-enclosing` (<kbd>C-c</kbd> <kbd>C-t</kbd>)
	Display the type of the selection and start a "type enclosing" session.
	During a "type enclosing" session the following commands are available:

[voodoos]

Suggested change

	"A needed documentation."
	"A very much needed documentation."

Maybe you can take inspiration from: https://github.com/voodoos/merlin/blob/project-wide-occurrences/emacs/merlin.el

[voodoos]

Is a face a font or police/style ? Then I think Face used when highlighting a region. would be clearer.

[voodoos]

I think the feature is named type-enclosing without an s.
But what it does is returning the type of enclosings with an s.

Suggested change

	"Prepare the type-enclosings computation request."
	"Prepare the type-enclosing computation request."

[voodoos]

Also, it's not only a preparation, but it displays a type to the user. This function and the other user-facing one should describe as clearly as possible what they are doing.

[voodoos]

Hum, I am not sure of the best wording here... same for the others.

Suggested change

	"Shrinking of the type enclosing."
	"Display the type enclosing of a smaller enclosing if possible."