[lsp-ui-peek] Don't [remap xref-find-{definitions,references}] by default

[emacs-lsp]

[lsp-ui-peek] Don't [remap xref-find-{definitions,references}] by default

[sebastiencs]

I think the defaults should provide the best experience with lsp-ui, lsp-ui-peek is intended to replace xref so remapping those keybinding is the behavior I would expect as user.
Nothing stop you from using helm-xref, does it ?

[MaskRay]

A little tricky... helm-xref does not provide entries like lsp-ui-peek-find-definitions, instead it hijects xref-show-xrefs-function and relies on xref-find-definitions/references

(require 'helm-xref)
(setq xref-show-xrefs-function 'helm-xref-show-xrefs)

helm-resume is useful and I think I may still use helm-xref occasionally (and for workspace/symbol)

[kvaneesh]

Another reason to not overload xref function is to make xref-find-definitions go to the definition and we may want peek interface to just peek the definition and not necessarily visit the file.

[kvaneesh]

i removed the remap, but then lsp-ui-peek-jump-backward doesn't work after that. Maybe we need to override then such that we can have a single interface to go back and forward the stack?

[MaskRay]

@kvaneesh lsp-ui-peek-jump-backward works by injecting jump points into lsp-ui-peek--find-xrefs.

(defun lsp-ui-peek--find-xrefs (input kind &optional request param)
  "Find INPUT references.
KIND is 'references, 'definitions or a custom kind.
REQUEST PARAM."
;; ................
    (when (featurep 'evil-jumps)
      (lsp-ui-peek--with-evil-jumps (evil-set-jump)))

You need to inject it into xref--find-xrefs if you also use xref-find-*

[phst]

Minor modes should generally not rebind key bindings that aren't specifically reserved to them. See https://www.gnu.org/software/emacs/manual/html_node/elisp/Key-Binding-Conventions.html. It's OK to document how to rebind the XRef keys, but lsp-ui shouldn't do so by default.

[MaskRay]

I hope you would not blame me.. Documented in README.md

[MaskRay]

And FYI, I made up my mind to create a LSP layer for spacemacs. syl20bnr/spacemacs#10211 But my elisp skill is incapable to make it nice.

I believe there will be helm-xref or ivy-xref users.