Add +tools/lsp layer for lsp-mode & lsp-ui #10211

MaskRay · 2018-01-21T20:32:08Z

This is a starting point to bring LSP ecosystem into spacemacs, as the initial step to address #10134

This PR adds a new layer, without changing anything default, so it is safe to merge. Based on it, we can integrate lsp-rust lsp-haskell+haskell-ide-engine and many others.

I recently raised a topic about C++ language server on Reddit. Many Emacs users expressed their interests. I am certainly confident this lsp + cquery combo works brilliantly well (refer to the Wiki definition/references and other cross references and fancy use of definition/references. But they also complain that LSP toolchain is difficult to set up. spacemacs is definitely a best place to collect these fragments and make the code navigation experience wonderful.

I also hope you appreciate references and other types of cross references as much as you do to find-definition #9911 The C++ language server cquery I am working on has some nice features. I'd also like to add a cquery layer based on this, after cquery.el is integrated into Melpa.

My elisp-fu is still too shabby to push forward everything. I'm seeking help from you.

MaskRay · 2018-01-21T21:55:49Z

I hope the language server protocol ecosystem can draw a bit more attention. Notably,

Rust Language Server (BTW, why is https://rust-lang-nursery.github.io/rust-toolstate/ so unstable..)
haskell-ide-engine
cquery

rely on this

syl20bnr · 2018-01-23T04:05:08Z

layers/+tools/lsp/packages.el

+    ))
+
+(defun lsp/init-markdown-mode ()
+  (use-package markdown-mode))


You don't need to add markdown to this layer, package.el will install it implicitly for us.

On the init functions:
There can be only one init-<package> function, the layer defining this function is told to be the owner of <package>. For instance the markdown layer defines the function markdown/init-markdown-mode and it makes this layer the owner of the markdown-mode package.
Other layers that extend the configuration of <package> define function names pre-init-<package> and/or post-init-<package> which are respectively executed before and after the init-<package> function.
A package is installed and configured only if its init-<package> function is declared which means that the user added the layer owning this package in their dotfile, we say that the layer/package is used when it is explicitly listed in the dotfile.
Therefore if the layer owning a package is not used (not in the dotfile) then the init-<package> function is not declared and then pre-init and post-init functions are not called.
This is the basic principle in Spacemacs to achieve isolation of configuration.

Now in this particular case, even if the markdown-mode package is not used (i.e. the user has not added the markdown layer to the dotfile) package.el will still install the dependencies for lsp-ui so markdown-mode will be installed, but not configured by Spacemacs.

As a side note, a layer created by a user can redefine the init-<package> function and add this layer at the end of the layer list in the dotfile, we say that the layer steals the ownership of <package> as the last layer in the list to declare the init-<package> function wins the ownership.
This mechanism allows users to be able to reconfigure all pieces of configuration provided by Spacemacs.

More info in https://github.com/syl20bnr/spacemacs/blob/develop/doc/LAYERS.org

Thx. Removed lsp/init-markdown-mode... Yeah, I do not know much about spacemacs that was why I didn't create the layer earlier.

Declspeck · 2018-01-23T22:56:25Z

Thank you for your hard work - I installed this and have been using it with PHP language server.

I'm wondering where the code which enables this for specific languages should go - to get it running I had to comment out company-php initialization from the PHP layer and hook into php-mode in .spacemacs.

Add enablable / disablable sections for each language in +tools/lsp?
Add separate LSP layers for each language?
Or instantiate LSP in language-specific layers if it is enabled, while disabling "regular" language support?

MaskRay · 2018-01-24T17:51:13Z

Maybe a config var in individual +lang/ language layer to toggle LSP

@syl20bnr should make a decision here.

I don't add any default key bindings because I'm not clear what keys would not cause surprise.

Adding bindings for these function can be a good starting point.

;; (define-key lsp-ui-mode-map [remap xref-find-definitions] #'lsp-ui-peek-find-definitions)
;; (define-key lsp-ui-mode-map [remap xref-find-references] #'lsp-ui-peek-find-references)
There is a window-local jump list dedicated to cross references:

(lsp-ui-peek-jump-backward)
(lsp-ui-peek-jump-forward)
Other cross references:

(lsp-ui-peek-find-workspace-symbol "pattern 0")
;; If the server supports custom cross references
(lsp-ui-peek-find-custom 'base "$cquery/base")

...... I just want to make this and cquery checked in earlier so that others can pick up and polish them.

My personal key bindings:

    (dolist (mode c-c++-modes)
      (spacemacs/set-leader-keys-for-major-mode mode
        "la" #'lsp-ui-find-workspace-symbol
        "lA" #'lsp-ui-peek-find-workspace-symbol
        "lb" #'cquery/base
        "lc" #'cquery/callers
        "ld" #'cquery/derived
        ;; Formatting requires waf configure --use-clang-cxx
        ;; https://github.com/jacobdufault/cquery/wiki/Formatting
        "lf" #'lsp-format-buffer
        "ll" #'lsp-ui-sideline-mode
        "lD" #'lsp-ui-doc-mode
        "ln" #'lsp-ui-find-next-reference
        "lp" #'lsp-ui-find-previous-reference
        "lr" #'lsp-rename
        "lv" #'cquery/vars
       ))

Declspeck · 2018-01-24T19:08:46Z

Awesome - I didn't know some of those functions in your keybindings even existed. I'll try and see how they work with php-language-server, if at all.

Adding configurable LSP-interfacing parts to each +lang layer seems like the best option to me too, at least among the ones I presented. But I've never contributed to spacemacs so my opinion probably won't matter much. When we have a decision and I have released lsp-php, I might make a PR to add PHP support.

CestDiego · 2018-01-25T04:28:13Z

I think it would be helpful to add the completion provide by the language service to the head of thee list of company-backends instead of overriding a language's Spacemacs configuration.

However, there are some features that interfere with what's provided by lsp and lsp-ui, so I encourage discussion to know whether we disable certain functionality that interferes with lsp functionality.

As per how should we enable this per language: We have language specific company-backends configuration and that seems to work out pretty great so far.

myrgy · 2018-01-25T08:18:10Z

Guys, what do you think about c-c++-lsp, c-c++-rtags layers.
This layers may use c-c++ as a core layer and then extend it. As a result user will be able to choose required things.
And we will keep that layers as a small modules.

CestDiego · 2018-01-25T15:11:44Z

I'm against it. Because that will.create n+ layers for all the languages. It should be a later variable that you can customize or not.

…

On Thu, Jan 25, 2018, 03:18 Alexander Dalshov ***@***.***> wrote: Guys, what do you think about c-c++-lsp, c-c++-rtags layers. This layers may use c-c++ as a core layer and then extend it. As a result user will be able to choose required things. And we will keep that layers as a small modules. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#10211 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ADI54w9rTSJVxiMTJ5WBVzde32yO7Jatks5tODjPgaJpZM4Rl9Ka> .

-- Diego Berrocal http://diegoberrocal.com

MaskRay · 2018-01-25T17:59:33Z

For c-c++, we may add c-c++-enable-cquery-support to the list of defvar's in layers/+lang/c-c++/config.el:

(defvar c-c++-enable-clang-support nil
  "If non nil Clang related packages and configuration are enabled.")

(defvar c-c++-enable-rtags-support nil
  "If non nil Rtags related packages and configuration are enabled.")

Yes, lsp-ui-flycheck.el conflicts with lsp-flycheck.el, and the latter is a bit out-of-date that's why I disable the latter.

MaskRay · 2018-01-30T05:12:14Z

Ping?

sebastiencs · 2018-01-31T14:35:16Z

layers/+tools/lsp/funcs.el

+                      :distant-foreground (face-attribute 'highlight :foreground))
+  (set-face-attribute 'lsp-ui-peek-header nil
+                      :background (face-attribute 'highlight :background)
+                      :foreground (face-attribute 'default :foreground))


I would set the INHERIT parameter of face-attribute to t

sebastiencs · 2018-01-31T14:35:40Z

layers/+tools/lsp/README.org

+- Each language server may support a subset of these features and may have their extension, check =M-x lsp-capabilities= in a LSP buffer and the language server's website for details.
+
+* Configuration
+The LSP ecosystem is based on two packages: [[https://github.com/emacs-lsp/lsp-mode][lsp-mode]] and [[https://github.com/emacs-lsp/lsp-mode][lsp-ui]].


The link to lsp-ui is wrong

sebastiencs · 2018-01-31T14:38:45Z

layers/+tools/lsp/packages.el

+      (add-hook 'lsp-mode-hook #'lsp-ui-mode)
+
+      (require 'lsp-imenu)
+      (add-hook 'lsp-after-open-hook #'lsp-enable-imenu)


This isn't necessary anymore, lsp-ui-imenu-enable does it

MaskRay · 2018-02-04T21:07:07Z

Ping

I am not qualified to write a LSP layer because my elisp-fu is just not decent. But I believe people will be very active to contribute C++/Python/Rust/Haskell plugins, pick up and improve this common layer, and make the language support of spacemacs even better. @syl20bnr

You also don't need to worry that current language settings will be deprecated. The LSP language-specific support can be selectively enabled like:

(defvar c-c++-enable-cquery-support nil  ...)
(defvar python-enable-pyls-support nil  ...)

I am very proud of cquery because I see it attracts GCC developer(s), Linux kernel developer(s), the author of irony-mode (an alternative to ycmd)

These are collective efforts. the main author of lsp-ui, the author of company-lsp, +tools/lsp-python they will all be willing to push forward the LSP ecosystem.

tadfisher · 2018-02-04T21:38:54Z

This also would be very useful for Java, Scala, Kotlin, and the rest of the JVM ecosystem. I am working on a standalone LSP server using IntelliJ IDEA as a base, which would finally bring advanced JVM language support to Emacs without heavy-handed and incompatible approaches like eclim and meghanda.

CestDiego · 2018-02-06T00:13:34Z

I would love to see this too :)

iromise · 2018-02-17T00:52:05Z

I think this is a new generation design for emacs configure of different Ianguage, and I would like to see it soon :)

syl20bnr · 2018-02-18T03:30:16Z

layers/+tools/lsp/funcs.el

@@ -0,0 +1,18 @@
+(defun lsp//sync-peek-face ()


What does this function do exactly ? Can you add a docstring ?

syl20bnr · 2018-02-18T03:42:30Z

Does it make sense to have both helm-xref and ivy-xref owned by the LSP layer ? Would it make sense to have them owned by helm and ivy layer respectively and have the LSP layer configure them via post-init functions ?

MaskRay · 2018-02-18T03:44:12Z

Thanks for paying attention to this. You can decide

syl20bnr · 2018-02-18T03:54:30Z

Flycheck package needs to appear in the package list of the LSP layer and the flycheck specific setup for LSP should be done in a post-init-flycheck function.

We could even invent an imaginary package flycheck-lsp to mirror company-lsp, would be:

(defconst lsp-packages
  '(
    (company-lsp :requires company)
    # this package does not exists so we flag it as built-in
    # we use this package to hook flycheck LSP specific configuration in language layers
    (flycheck-lsp :requires flycheck :location built-in)
    (helm-xref :requires helm)
    (ivy-xref :requires ivy)
    lsp-mode
   lsp-ui
    ))

With this dummy package we can hook flycheck specific config for LSP in language layers. Exactly like we can do it by using the company-lsp package. For instance in the python layer we can then hook company LSP backends in a post-init-company-lsp function. We can also hook flycheck checkers powered by LSP in post-init-flycheck-lsp function.

If LSP layer is not used then all the company-lsp and flycheck-lsp configuration will be ignored as both packages are not used.
Similarly to activate auto-completion with LSP, both auto-completion and lsp layers must be activated, if only lsp layer is activated then auto-completion will be automatically disabled in LSP as company-lsp will be declared not used because company package is not used.

Not sure it is clear but both company-lsp and flycheck-lsp will represent the auto-completion and syntax-checking feature of LSP respectively in Spacemacs config.

MaskRay · 2018-02-18T03:56:28Z

Thanks for the comment but I think I am incapable (in terms of elisp-fu and familiarity with spacemacs) to sort these out and make it perfect. But I believe there will be improvement from other contributors after this is checked in.

syl20bnr · 2018-02-18T03:57:42Z

No problem, I can do it. Will work on it and the python integration tomorrow. From there, we will have an example of how to integrate a language.

syl20bnr · 2018-02-18T03:58:48Z

To be clear, I'll merge your PR tomorrow as well as the python one and will work from this state. Don't close this PR please :-)

MaskRay · 2018-02-18T04:02:38Z

Thanks! I am not good at elisp but I will be very happy to improve and answer these LSP questions (as being the maintainer of the C++ language server cquery (its PR), its Emacs plugin emacs-cquery, lsp-ui, and having commits to other clients)

https://github.com/cquery-project/cquery/wiki/Emacs contains some settings for cquery but many concepts are useful for other language servers. But I'm unclear how to set default keybindings properly so I do not do that in this PR.

This is a starting point to bring LSP ecosystem into spacemacs. Theme by 0bl.blwl

syl20bnr · 2018-02-19T05:12:29Z

Thank you ! 💜

I added LSP support for python layer in commit 81a931f4. You an check this commit to see how it is done. Don't hesitate if you have questions.

Cherry-picked into develop branch, you can safely delete your branch.

MaskRay mentioned this pull request Jan 21, 2018

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

Closed

MaskRay force-pushed the lsp branch from d923ad2 to ef2af74 Compare January 22, 2018 00:50

rietmann mentioned this pull request Jan 22, 2018

Semantic highlighting errors cquery-project/emacs-cquery#5

Closed

MaskRay mentioned this pull request Jan 22, 2018

Add ccls/cquery (language server) to c-c++ layer #10134

Closed

syl20bnr reviewed Jan 23, 2018

View reviewed changes

MaskRay force-pushed the lsp branch 4 times, most recently from a72f7e3 to 6c6abe0 Compare January 23, 2018 05:40

This was referenced Jan 23, 2018

cquery-use-default-rainbow-sem-highlight and non indexed projects cquery-project/emacs-cquery#3

Closed

Add +tools/cquery layer #10236

Closed

C-C++ layer cleanup #10143

Closed

casouri mentioned this pull request Jan 24, 2018

Add +tools/lsp-python layer #10241

Closed

MaskRay force-pushed the lsp branch 5 times, most recently from abb5751 to de5d68f Compare January 24, 2018 08:53

MaskRay force-pushed the lsp branch from de5d68f to a493a40 Compare January 24, 2018 18:03

MaskRay force-pushed the lsp branch from a493a40 to 9b1f5c5 Compare January 30, 2018 05:07

MaskRay mentioned this pull request Jan 31, 2018

Remove lsp-flycheck emacs-lsp/lsp-mode#200

Closed

sebastiencs reviewed Jan 31, 2018

View reviewed changes

MaskRay force-pushed the lsp branch 2 times, most recently from fe2d831 to db9ac7e Compare January 31, 2018 18:54

MaskRay mentioned this pull request Feb 2, 2018

Option to turn off sorting alexmurray/ivy-xref#4

Closed

syl20bnr reviewed Feb 18, 2018

View reviewed changes

MaskRay force-pushed the lsp branch 3 times, most recently from 86b27ea to 28d49ab Compare February 18, 2018 03:53

Add +tools/lsp layer for lsp-mode & lsp-ui

d99cb00

This is a starting point to bring LSP ecosystem into spacemacs. Theme by 0bl.blwl

MaskRay force-pushed the lsp branch from 28d49ab to d99cb00 Compare February 18, 2018 04:17

syl20bnr added the Merged label Feb 19, 2018

syl20bnr self-assigned this Feb 19, 2018

syl20bnr merged commit d99cb00 into syl20bnr:develop Feb 19, 2018

syl20bnr removed the Merged label Feb 19, 2018

MaskRay deleted the lsp branch February 19, 2018 07:12

smile13241324 mentioned this pull request Aug 11, 2018

How do I use LSP with Java/Python/Rust/C++? #11161

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add +tools/lsp layer for lsp-mode & lsp-ui #10211

Add +tools/lsp layer for lsp-mode & lsp-ui #10211

MaskRay commented Jan 21, 2018 •

edited

Loading

MaskRay commented Jan 21, 2018

syl20bnr Jan 23, 2018 •

edited

Loading

syl20bnr Jan 23, 2018 •

edited

Loading

MaskRay Jan 23, 2018

Declspeck commented Jan 23, 2018

MaskRay commented Jan 24, 2018 •

edited

Loading

Declspeck commented Jan 24, 2018

CestDiego commented Jan 25, 2018

myrgy commented Jan 25, 2018

CestDiego commented Jan 25, 2018 via email

MaskRay commented Jan 25, 2018 •

edited

Loading

MaskRay commented Jan 30, 2018

sebastiencs Jan 31, 2018

sebastiencs Jan 31, 2018

MaskRay Jan 31, 2018

sebastiencs Jan 31, 2018

MaskRay Jan 31, 2018

MaskRay commented Feb 4, 2018 •

edited

Loading

tadfisher commented Feb 4, 2018

CestDiego commented Feb 6, 2018

iromise commented Feb 17, 2018

syl20bnr Feb 18, 2018

MaskRay Feb 18, 2018

syl20bnr commented Feb 18, 2018

MaskRay commented Feb 18, 2018

syl20bnr commented Feb 18, 2018 •

edited

Loading

MaskRay commented Feb 18, 2018

syl20bnr commented Feb 18, 2018

syl20bnr commented Feb 18, 2018

MaskRay commented Feb 18, 2018 •

edited

Loading

syl20bnr commented Feb 19, 2018

Add +tools/lsp layer for lsp-mode & lsp-ui #10211

Add +tools/lsp layer for lsp-mode & lsp-ui #10211

Conversation

MaskRay commented Jan 21, 2018 • edited Loading

MaskRay commented Jan 21, 2018

syl20bnr Jan 23, 2018 • edited Loading

Choose a reason for hiding this comment

syl20bnr Jan 23, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Declspeck commented Jan 23, 2018

MaskRay commented Jan 24, 2018 • edited Loading

Declspeck commented Jan 24, 2018

CestDiego commented Jan 25, 2018

myrgy commented Jan 25, 2018

CestDiego commented Jan 25, 2018 via email

MaskRay commented Jan 25, 2018 • edited Loading

MaskRay commented Jan 30, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MaskRay commented Feb 4, 2018 • edited Loading

tadfisher commented Feb 4, 2018

CestDiego commented Feb 6, 2018

iromise commented Feb 17, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

syl20bnr commented Feb 18, 2018

MaskRay commented Feb 18, 2018

syl20bnr commented Feb 18, 2018 • edited Loading

MaskRay commented Feb 18, 2018

syl20bnr commented Feb 18, 2018

syl20bnr commented Feb 18, 2018

MaskRay commented Feb 18, 2018 • edited Loading

syl20bnr commented Feb 19, 2018

MaskRay commented Jan 21, 2018 •

edited

Loading

syl20bnr Jan 23, 2018 •

edited

Loading

syl20bnr Jan 23, 2018 •

edited

Loading

MaskRay commented Jan 24, 2018 •

edited

Loading

MaskRay commented Jan 25, 2018 •

edited

Loading

MaskRay commented Feb 4, 2018 •

edited

Loading

syl20bnr commented Feb 18, 2018 •

edited

Loading

MaskRay commented Feb 18, 2018 •

edited

Loading