From 9d76d983c44a6fe58656598bfae046a0eed2c6f3 Mon Sep 17 00:00:00 2001 From: chrunchyjesus Date: Tue, 23 Apr 2019 19:28:41 +0200 Subject: [PATCH] add doctor for shell and update readme --- modules/lang/sh/README.org | 12 ++++++++---- modules/lang/sh/doctor.el | 5 +++++ 2 files changed, 13 insertions(+), 4 deletions(-) create mode 100644 modules/lang/sh/doctor.el diff --git a/modules/lang/sh/README.org b/modules/lang/sh/README.org index 8ee01d3d9..782344eb9 100644 --- a/modules/lang/sh/README.org +++ b/modules/lang/sh/README.org @@ -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) | diff --git a/modules/lang/sh/doctor.el b/modules/lang/sh/doctor.el new file mode 100644 index 000000000..0a9687a29 --- /dev/null +++ b/modules/lang/sh/doctor.el @@ -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")) +