add doctor for shell and update readme

This commit is contained in:
chrunchyjesus 2019-04-23 19:28:41 +02:00
parent 5dacbb7cb1
commit 9d76d983c4
No known key found for this signature in database
GPG key ID: 0C364160C9308A88
2 changed files with 13 additions and 4 deletions

View file

@ -9,14 +9,18 @@ This module adds support for shell scripting languages.
* Table of Contents :TOC:
- [[#install][Install]]
- [[#dependencies][Dependencies]]
- [[#appendix][Appendix]]
- [[#commands][Commands]]
* Install
This module has no dependencies.
** Dependencies
This module has one soft dependency:
+ ~shellcheck~ Enables shell script linting.
* Appendix
** Commands
| command | key / ex command | description |
|------------+------------------+-------------------------------------------------------|
| ~+sh/repl~ | =:repl= | Open a terminal (or send the current selection to it) |
| command | key / ex command | description |
|-----------------+------------------+-------------------------------------------------------|
| ~+sh/open-repl~ | =:repl= | Open a terminal (or send the current selection to it) |

View file

@ -0,0 +1,5 @@
;;; lang/sh/doctor.el -*- lexical-binding: t; -*-
(when! (not (executable-find "shellcheck"))
(warn! "Couldn't find shellcheck. Shell script linting will not work"))