GitHub - emacs-lsp/lsp-ui
source link: https://github.com/emacs-lsp/lsp-ui
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
lsp-ui
Table of Contents
Intro
This package contains all the higher level UI modules of lsp-mode, like flycheck support and code lenses.
By default, lsp-mode automatically activates lsp-ui unless lsp-auto-configure is set to nil.
You only have to put (use-package lsp-ui) in your config and the package will work out of the box.
(use-package)
Or use the builtin package manager.
M-x package-install [RET] lsp-ui [RET]
lsp-ui-sideline:
Show informations of the symbols on the current line. It also show flycheck diagnostics and LSP code actions
Customization:
lsp-ui-sideline-show-diagnosticsshow diagnostics messages in sidelinelsp-ui-sideline-show-hovershow hover messages in sidelinelsp-ui-sideline-show-code-actionsshow code actions in sidelinelsp-ui-sideline-update-modeWhen set to 'line' the information will be updated when user changes current line otherwise the information will be updated when user changes current pointlsp-ui-sideline-delayseconds to wait before showing sideline
lsp-ui-peek:
Add peek feature
You may remap xref-find-{definitions,references} (bound to M-. M-? by default):
(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")Customization:
lsp-ui-peek-enableenable ‘lsp-ui-peek’lsp-ui-peek-show-directoryshow the directory of files
lsp-ui-doc
Show object documentation at point in a child frame.
Show documentation in a WebKit widget
Customization:
lsp-ui-doc-enableenable lsp-ui-doclsp-ui-doc-positionWhere to display the doclsp-ui-doc-delayNumber of seconds before showing the doclsp-ui-doc-show-with-cursorWhen non-nil, move the cursor over a symbol to show the doclsp-ui-doc-show-with-mouseWhen non-nil, move the mouse pointer over a symbol to show the doc
lsp-ui-imenu
Show imenu entries.
Customization:
lsp-ui-imenu-kind-positionplace to show entries kindlsp-ui-imenu-buffer-positionplace to show the buffer windowlsp-ui-imenu-window-widthset window widthlsp-ui-imenu-window-fix-widthwhen non-nil, the window will not be resizable (eg. unaffected bybalance-windows)lsp-ui-imenu--custom-mode-line-formatmode line formatlsp-ui-imenu-auto-refreshauto refresh when necessarylsp-ui-imenu-refresh-delaydelay to refresh imenu
Contributing
Any kind of help is appreciated. If you want to help us maintaining this package, leave a note.
Recommend
-
128
README.md lsp-javascript Javascript, Typescript and Flow support for lsp-mode using one of: javascript-type...
-
185
README.md
-
84
README.md
-
102
README.md
-
75
README.md lsp-haskell
-
45
README.md lsp-go
-
44
Grow your team on GitHub GitHub is home to over 50 million developers working together. Join them to grow your own development teams, manage permissions, and collaborate on projects.
-
19
Join GitHub today GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
-
10
Files Permalink Latest commit message Commit time
-
3
One-click Emacs web IDE (beta) Quickstart Open the following url: https://gitpod.io/#ORG=emacs-lsp,PROJECT=demo-projects,PROFILE=vanilla/https://github.com/emacs-lsp/lsp-gitpod You...
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK