47 lines
1.7 KiB
Org Mode
47 lines
1.7 KiB
Org Mode
#+TITLE: lang/sh
|
|
#+DATE: December 19, 2015
|
|
#+SINCE: v0.7
|
|
#+STARTUP: inlineimages
|
|
|
|
* Table of Contents :TOC:
|
|
- [[#description][Description]]
|
|
- [[#module-flags][Module Flags]]
|
|
- [[#plugins][Plugins]]
|
|
- [[#hacks][Hacks]]
|
|
- [[#prerequisites][Prerequisites]]
|
|
- [[#features][Features]]
|
|
- [[#configuration][Configuration]]
|
|
- [[#troubleshooting][Troubleshooting]]
|
|
|
|
* Description
|
|
This module adds support for shell scripting languages.
|
|
|
|
+ Code completion (company-shell)
|
|
+ Syntax Checking (flycheck)
|
|
|
|
** Module Flags
|
|
+ =+lsp= Enables LSP support for sh-mode. This requires the =:tools lsp= module
|
|
to be enabled and [[https://github.com/mads-hartmann/bash-language-server][bash-language-server]] to be installed on your system.
|
|
+ =+fish= Add syntax highlighting for fish script files.
|
|
+ =+powershell= Add syntax highlighting for Powershell script files .ps1 and .psm1
|
|
|
|
** Plugins
|
|
+ [[https://github.com/Alexander-Miller/company-shell][company-shell]]* (=:completion company=)
|
|
+ [[https://github.com/wwwjfy/emacs-fish][fish-mode]]* (=+fish=)
|
|
+ [[https://github.com/jschaf/powershell.el][powershell-mode]]* (=+powershell=)
|
|
|
|
** Hacks
|
|
+ Interpolated variables are fontified.
|
|
|
|
* Prerequisites
|
|
This module has several optional dependencies:
|
|
|
|
+ [[https://github.com/koalaman/shellcheck][shellcheck]]: Enables advanced shell script linting.
|
|
+ [[https://github.com/mads-hartmann/bash-language-server][bash-language-server]]: Enables LSP support (with =+lsp= flag).
|
|
+ With the =:tools debugger= module
|
|
+ [[http://bashdb.sourceforge.net/][bashdb]]: Enables debugging for bash scripts
|
|
+ [[https://github.com/rocky/zshdb][zshdb]]: Enables debugging for zsh scripts
|
|
|
|
* TODO Features
|
|
* TODO Configuration
|
|
* TODO Troubleshooting
|