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

[shell-scripts] Add format-on-save docs to README.org

This commit is contained in:
Aaron L. Zeng 2021-08-02 16:21:08 -04:00 committed by duianto
parent 9e361eedc2
commit 0f71054dcc
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
layers/+lang/shell-scripts/README.org
View File

@ -11,6 +11,7 @@
- [[#layer][Layer]]
- [[#linting][Linting]]
- [[#style-checking][Style checking]]
- [[#format-on-save][Format on save]]
- [[#backends][Backends]]
- [[#shell-script-mode][Shell-script-mode]]
- [[#lsp][LSP]]
@ -44,6 +45,14 @@ In order to enable =sh= scripts linting, install [[https://www.shellcheck.net/][
** Style checking
In order to enable =sh= scripts style checking, install [[https://github.com/openstack-dev/bashate][bashate]].
** Format on save
To enable automatic formatting on save, set the layer variable
~shell-scripts-format-on-save~ to ~t~:
#+begin_src elisp
(shell-scripts :variables shell-scripts-format-on-save t)
#+end_src
** Backends
You have the choice between two different backends
with different setup instructions and different capabilities.