Merge pull request #1355 from chrunchyjesus/add_shellcheck

add doctor.el for shell and update readme

modules/lang/sh/README.org

@@ -4,19 +4,16 @@ This module adds support for shell scripting languages.
 
 + Code completion (company-shell)
 + Syntax Checking (flycheck)
-+ Added command substitution and variable interpolation fontification
++ Added variable interpolation fontification
-+ REPL support
 
 * Table of Contents :TOC:
-- [[Install][Install]]
+- [[#install][Install]]
-- [[Appendix][Appendix]]
+  - [[#dependencies][Dependencies]]
-  - [[Commands][Commands]]
 
 * Install
-This module has no dependencies.
+** Dependencies
+This module has several soft dependencies:
 
-* Appendix
++ ~shellcheck~ Enables shell script linting.
-** Commands
++ ~bashdb~ Enables debugging for bash scripts.
-| command         | key / ex command | description                                           |
++ ~zshdb~ Enables debugging for zsh scripts.
-|-----------------+------------------+-------------------------------------------------------|
-| ~+sh/open-repl~ | =:repl=          | Open a terminal (or send the current selection to it) |

modules/lang/sh/doctor.el

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

modules/lang/sh/packages.el

@@ -1,9 +1,6 @@
 ;; -*- no-byte-compile: t; -*-
 ;;; lang/sh/packages.el
 
-;; requires shellcheck
-;; optional: zshdb bashdb
-
 (when (featurep! :completion company)
   (package! company-shell))