sideline-lsp

Show lsp information with sideline

P.S. The implementation is extracted and modified from lsp-ui-sideline 's code action.

Table of Contents

sideline-lsp

🔨 Quickstart

(use-package sideline-lsp
  :init
  (setq sideline-backends-right '(sideline-lsp)))
  
(use-package lsp-mode :hook (lsp-mode . sideline-mode))  ; enable it when lsp is on
(use-package lsp-ui :init (setq lsp-ui-sideline-enable nil))  ; disable original sideline

🔧 Customization

🧪 Variables

sideline-lsp-update-mode - When set to 'line' the information will be updated when user changes current line otherwise the information will be updated when user changes current point
sideline-lsp-ignore-duplicate - Ignore duplicate code actions
sideline-lsp-code-actions-prefix - Prefix to insert before the code action title.

🧪 Face

sideline-lsp-code-action - Face used to highlight code action text.

💥 Replace `lsp-ui-sideline`

(setq lsp-ui-sideline-enable nil)  ; disable lsp-ui-sideline

Customize backends according to your options:

lsp-ui-sideline-show-code-actions - add sideline-lsp
lsp-ui-sideline-show-diagnostics - add sideline-flycheck

Hence, you should

(setq sideline-backends-right '(sideline-lsp sideline-flycheck))

🛠️ Contribute

If you would like to contribute to this project, you may either clone and make pull requests to this repository. Or you can clone the project and establish your own branch of this tool. Any methods are welcome!

🔬 Development

To run the test locally, you will need the following tools:

Eask
Make (optional)

Install all dependencies and development dependencies:

$ eask install-deps --dev

To test the package's installation:

$ eask package
$ eask install

To test compilation:

$ eask compile

🪧 The following steps are optional, but we recommend you follow these lint results!

The built-in checkdoc linter:

$ eask lint checkdoc

The standard package linter:

$ eask lint package

📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.

⚜️ License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

See LICENSE for details.