TakeV/spacemacs
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

[doc] shell-scripts: explain backend auto-select

Browse source
This commit is contained in:
Tim Ruffing 2022-06-07 12:17:45 +02:00 committed by Maxi Wolff
parent 02c667e8d8
commit 2556ecd31c
1 changed files with 11 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
layers/+lang/shell-scripts/README.org
View file

@ -66,13 +66,19 @@ To enable automatic formatting on save, set the layer variable
You have the choice between two different backends
with different setup instructions and different capabilities.
The LSP backend is automatically selected when the =lsp= layer is used.
*** Shell-script-mode
This is the recommended way for working with shell scripts in emacs. It works
by using an emacs major mode.
It supports =bash= and =fish= shell scripts.
No additional setup is necessary.
Set =shell-scripts-backend= to =nil= explicitly to use this simple backend even when the =lsp= layer is loaded.
#+BEGIN_SRC elisp
(shell-scripts :variables shell-scripts-backend nil)
#+END_SRC
*** LSP
This backend uses an external server to provide the various IDE integrations
@ -86,15 +92,15 @@ It requires installing the external server via:
npm i -g bash-language-server
#+END_SRC
Enable the =lsp= layer to activate this backend as well as setting the layer
variable =shell-scripts-backend=:
You can find further information about the project at its [[https://github.com/mads-hartmann/bash-language-server][GitHub page]].
Set the variable =shell-scripts-backend= to select the LSP backend explicitly.
This will result in the =lsp= layer being loaded.
#+BEGIN_SRC elisp
(shell-scripts :variables shell-scripts-backend 'lsp)
#+END_SRC
You can find further information about the project at its [[https://github.com/mads-hartmann/bash-language-server][GitHub page]].
* Key bindings
| Key binding | Description |