spacemacs/layers/+lang/shell-scripts/README.org

41 lines
1.3 KiB
Org Mode
Raw Normal View History

#+TITLE: Shell Scripts layer
2015-06-10 16:44:30 +00:00
[[file:img/fish.png]]
2016-03-31 02:59:55 +00:00
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#features][Features]]
- [[#install][Install]]
- [[#linting][Linting]]
2016-03-31 02:59:55 +00:00
- [[#key-bindings][Key Bindings]]
2015-06-10 16:44:30 +00:00
* Description
This simple layer adds support for shell scripting.
Supported scripting files:
- =.sh=
2015-06-10 16:44:30 +00:00
- =.fish=: [[https://github.com/fish-shell/fish-shell][fish shell]]
*Note:* For Windows scripting see the layer =windows-scripts=
2015-06-10 16:44:30 +00:00
** Features
- Auto-completion using [[https://github.com/Alexander-Miller/company-shell][company-shell]]
- =Sh= scripts linting using [[https://www.shellcheck.net/][shellcheck]]
2015-06-10 16:44:30 +00:00
* Install
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =shell-scripts= to the existing =dotspacemacs-configuration-layers= list in this
file.
2015-06-10 16:44:30 +00:00
** Linting
In order to enable =sh= scripts linting, install [[https://www.shellcheck.net/][shellcheck]].
2015-06-10 16:44:30 +00:00
* Key Bindings
2016-01-08 14:37:39 +00:00
| Key Binding | Description |
|-------------+-----------------------------------------------------------|
2016-09-16 18:03:28 +00:00
| ~SPC i !~ | insert shebang in a script file |
2016-01-08 14:37:39 +00:00
| ~SPC m \~ | insert end-of-line backslashes to the lines in the region |