diff --git a/modules/lang/sh/README.org b/modules/lang/sh/README.org index 5bfd3c502..b2821e7bf 100644 --- a/modules/lang/sh/README.org +++ b/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 -+ REPL support ++ Added variable interpolation fontification * Table of Contents :TOC: -- [[Install][Install]] -- [[Appendix][Appendix]] - - [[Commands][Commands]] +- [[#install][Install]] + - [[#dependencies][Dependencies]] * Install -This module has no dependencies. +** Dependencies +This module has several soft dependencies: -* Appendix -** Commands -| command | key / ex command | description | -|-----------------+------------------+-------------------------------------------------------| -| ~+sh/open-repl~ | =:repl= | Open a terminal (or send the current selection to it) | ++ ~shellcheck~ Enables shell script linting. ++ ~bashdb~ Enables debugging for bash scripts. ++ ~zshdb~ Enables debugging for zsh scripts. diff --git a/modules/lang/sh/doctor.el b/modules/lang/sh/doctor.el new file mode 100644 index 000000000..e85643b71 --- /dev/null +++ b/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"))) diff --git a/modules/lang/sh/packages.el b/modules/lang/sh/packages.el index d3e3ad9e1..b52024fd5 100644 --- a/modules/lang/sh/packages.el +++ b/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))