I have developed a simple way to search Clojure symbols with CIDER; merge into this package or keep separate? about cider HOT 6 CLOSED

Hi, thanks for creating the discussion!

I'm not sure I understand the use case, mind to expand?

completing-read normally is a tool for accomplishing something else - it's not a end user intent in itself.

from cider.

@vemv very simply, I can search a Clojure symbol that is defined by name, and then select it to get documentation. With something like Ivy or Vert&co (which puts completing-read on steroids), I can fuzzy search said name. Here is a picture

By using completing-read, I can be mostly agnostic to the completion framework you use, even if you use none. (Not sure if Helm supports completing-read yet though...)

from cider.

Hmm, I can M-x cider-doc, type "red", trigger completion, and see:

Then the following pops up:

Probably that *Completions* buffer can be customized by users for Ivy/etc to be used instead.

Let me know if that workflow isn't sufficient to replicate what you built - we'd welcome a PR that optionally made it richer.

from cider.

A simpler workflow is typing "red", triggering autocompletion with TAB or a similar keybinding, and letting a framework like company-mode show the doc:

from cider.

@vemv yeah, swapping out completing-read (which is what the completion frameworks do) does not change the cider-doc, which I am guessing is using separate completion machinery?

I agree there are other ways to search, I was just trying to search in the same way I search Emacs Lisp.

from cider.

cider-doc is defined honoring a cider-prompt-for-symbol-function defcustom, like so:

Note that it receives #'cider-doc-lookup as an argument.

By customizing cider-prompt-for-symbol-function you should have all it takes for a custom UX, with docs displayed inline.

Let us know how it works for you. I'll close the issue for now, but feel free to keep the conversation going!

We'd always welcome further customization options or perhaps, if no changes are needed, a "how to" in our user manual.

Cheers - V

from cider.