GNU bug report logs - #41731
[PATCH] gnu: Add emacs-flymake-shellcheck.

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 41731 in the body.
You can then email your comments to 41731 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Fredrik Salomonsson <plattfot <at> gmail.com>
To: guix-patches <at> gnu.org
Cc: Fredrik Salomonsson <plattfot <at> gmail.com>
Subject: [PATCH] gnu: Add emacs-flymake-shellcheck.
Date: Fri,  5 Jun 2020 16:33:49 -0700

* gnu/packages/emacs-xyz.scm (emacs-flymake-shellcheck): New variable.
---
 gnu/packages/emacs-xyz.scm | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 6110374281..73d030f239 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -992,6 +992,34 @@ different tools.  It highlights errors and warnings inline in the buffer, and
 provides an optional IDE-like error list.")
       (license license:gpl3+))))                     ;+GFDLv1.3+ for the manual
 
+(define-public emacs-flymake-shellcheck
+  ;; No tag, version grabbed from source .el file.
+  (let ((commit "78956f0e5bb9c4d35989657a55929e8e3f5691e6")
+        (revision "0"))
+    (package
+      (name "emacs-flymake-shellcheck")
+      (version (git-version "0.1" revision commit))
+      (source
+       (origin
+         (method git-fetch)
+         (uri (git-reference
+               (url "https://github.com/federicotdn/flymake-shellcheck.git")
+               (commit commit)))
+         (file-name (git-file-name name version))
+         (sha256
+          (base32 "068mx5p4drwgppy4ry1rfq6qi79w6d82b4rnpl2jm37grsg94lix"))))
+      (build-system emacs-build-system)
+      (propagated-inputs
+       `(("shellcheck" ,shellcheck)))
+      (home-page "https://github.com/federicotdn/flymake-shellcheck")
+      (synopsis "Flymake backend for Bash/Sh powered by ShellCheck")
+      (description
+       "This package provides a backend for Flymake (emacs-26+) to use the
+tool @command{shellcheck} for static analyzing @command{bash} and @command{sh}
+scripts.  Please see the description on @command{shellcheck} for more
+information on what it can do.")
+      (license license:gpl3+))))
+
 (define-public emacs-a
   (package
     (name "emacs-a")
-- 
2.26.2

Message #8 received at 41731 <at> debbugs.gnu.org (full text, mbox):

From: Nicolas Goaziou <mail <at> nicolasgoaziou.fr>
To: Fredrik Salomonsson <plattfot <at> gmail.com>
Cc: 41731 <at> debbugs.gnu.org
Subject: Re: [bug#41731] [PATCH] gnu: Add emacs-flymake-shellcheck.
Date: Sat, 06 Jun 2020 09:44:56 +0200

Hello,

Fredrik Salomonsson <plattfot <at> gmail.com> writes:

> * gnu/packages/emacs-xyz.scm (emacs-flymake-shellcheck): New variable.

Thank you. Some comments follow.

> +      (propagated-inputs
> +       `(("shellcheck" ,shellcheck)))

I don't think we should do that. It is up to the user to install
ShellCheck if they want.

For example, installing `emacs-flycheck-haskell' doesn't pull GHC in
user's profile.

> +      (home-page "https://github.com/federicotdn/flymake-shellcheck")
> +      (synopsis "Flymake backend for Bash/Sh powered by ShellCheck")
> +      (description
> +       "This package provides a backend for Flymake (emacs-26+) to use the

Nitpick: you can remove the (emacs-26+) part.

> +tool @command{shellcheck} for static analyzing @command{bash} and @command{sh}

Nitpick: since you seem to talk about the tool as a whole, I suggest:

  @command{shellcheck} -> ShellCheck

> +scripts.  Please see the description on @command{shellcheck} for more
> +information on what it can do."

I think you can remove the last sentence.

Could you send an updated patch?

Regards,

-- 
Nicolas Goaziou

Message #11 received at 41731 <at> debbugs.gnu.org (full text, mbox):

From: Fredrik Salomonsson <plattfot <at> gmail.com>
To: 41731 <at> debbugs.gnu.org
Cc: Fredrik Salomonsson <plattfot <at> gmail.com>
Subject: [PATCH] gnu: Add emacs-flymake-shellcheck.
Date: Sat,  6 Jun 2020 09:55:12 -0700

* gnu/packages/emacs-xyz.scm (emacs-flymake-shellcheck): New variable.
---
 gnu/packages/emacs-xyz.scm | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 6110374281..73d030f239 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -992,6 +992,34 @@ different tools.  It highlights errors and warnings inline in the buffer, and
 provides an optional IDE-like error list.")
       (license license:gpl3+))))                     ;+GFDLv1.3+ for the manual
 
+(define-public emacs-flymake-shellcheck
+  ;; No tag, version grabbed from source .el file.
+  (let ((commit "78956f0e5bb9c4d35989657a55929e8e3f5691e6")
+        (revision "0"))
+    (package
+      (name "emacs-flymake-shellcheck")
+      (version (git-version "0.1" revision commit))
+      (source
+       (origin
+         (method git-fetch)
+         (uri (git-reference
+               (url "https://github.com/federicotdn/flymake-shellcheck.git")
+               (commit commit)))
+         (file-name (git-file-name name version))
+         (sha256
+          (base32 "068mx5p4drwgppy4ry1rfq6qi79w6d82b4rnpl2jm37grsg94lix"))))
+      (build-system emacs-build-system)
+      (propagated-inputs
+       `(("shellcheck" ,shellcheck)))
+      (home-page "https://github.com/federicotdn/flymake-shellcheck")
+      (synopsis "Flymake backend for Bash/Sh powered by ShellCheck")
+      (description
+       "This package provides a backend for Flymake (emacs-26+) to use the
+tool @command{shellcheck} for static analyzing @command{bash} and @command{sh}
+scripts.  Please see the description on @command{shellcheck} for more
+information on what it can do.")
+      (license license:gpl3+))))
+
 (define-public emacs-a
   (package
     (name "emacs-a")
-- 
2.26.2

Message #14 received at 41731 <at> debbugs.gnu.org (full text, mbox):

From: Fredrik Salomonsson via web <issues.guix.gnu.org <at> elephly.net>
To: 41731 <at> debbugs.gnu.org
Subject: [PATCH] gnu: Add emacs-flymake-shellcheck.
Date: Sat,  6 Jun 2020 18:58:36 +0200

Thanks for the feedback.
I was debating to myself whether to include shellcheck or not. As when I looked around in emacs-xyz.scm, for example `emacs-ag' does propagate the-silver-searcher but `emacs-direnv' does not.

Anyway, I removed it in the latest patch.

Message #17 received at 41731 <at> debbugs.gnu.org (full text, mbox):

From: Fredrik Salomonsson <plattfot <at> gmail.com>
To: 41731 <at> debbugs.gnu.org
Cc: Fredrik Salomonsson <plattfot <at> gmail.com>
Subject: [PATCH] gnu: Add emacs-flymake-shellcheck.
Date: Sat,  6 Jun 2020 10:01:37 -0700

* gnu/packages/emacs-xyz.scm (emacs-flymake-shellcheck): New variable.
---
 gnu/packages/emacs-xyz.scm | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 6110374281..d957497a06 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -992,6 +992,31 @@ different tools.  It highlights errors and warnings inline in the buffer, and
 provides an optional IDE-like error list.")
       (license license:gpl3+))))                     ;+GFDLv1.3+ for the manual
 
+(define-public emacs-flymake-shellcheck
+  ;; No tag, version grabbed from source .el file.
+  (let ((commit "78956f0e5bb9c4d35989657a55929e8e3f5691e6")
+        (revision "0"))
+    (package
+      (name "emacs-flymake-shellcheck")
+      (version (git-version "0.1" revision commit))
+      (source
+       (origin
+         (method git-fetch)
+         (uri (git-reference
+               (url "https://github.com/federicotdn/flymake-shellcheck.git")
+               (commit commit)))
+         (file-name (git-file-name name version))
+         (sha256
+          (base32 "068mx5p4drwgppy4ry1rfq6qi79w6d82b4rnpl2jm37grsg94lix"))))
+      (build-system emacs-build-system)
+      (home-page "https://github.com/federicotdn/flymake-shellcheck")
+      (synopsis "Flymake backend for Bash/Sh powered by ShellCheck")
+      (description
+       "This package provides a backend for Flymake to use the
+tool ShellCheck for static analyzing @command{bash} and @command{sh}
+scripts.")
+      (license license:gpl3+))))
+
 (define-public emacs-a
   (package
     (name "emacs-a")
-- 
2.26.2

Message #20 received at 41731 <at> debbugs.gnu.org (full text, mbox):

From: Fredrik Salomonsson <plattfot <at> gmail.com>
To: 41731 <at> debbugs.gnu.org
Subject: Re: [PATCH] gnu: Add emacs-flymake-shellcheck.
Date: Sat, 6 Jun 2020 10:04:02 -0700

[Message part 1 (text/plain, inline)]

Sorry, sent the old patch again. The last one should be the correct one.

-- 
s/Fred[re]+i[ck]+/Fredrik/g

[Message part 2 (text/html, inline)]

Message #25 received at 41731-done <at> debbugs.gnu.org (full text, mbox):

From: Nicolas Goaziou <mail <at> nicolasgoaziou.fr>
To: Fredrik Salomonsson via web <issues.guix.gnu.org <at> elephly.net>
Cc: 41731-done <at> debbugs.gnu.org
Subject: Re: [bug#41731] [PATCH] gnu: Add emacs-flymake-shellcheck.
Date: Sun, 07 Jun 2020 21:22:53 +0200

Hello,

Fredrik Salomonsson via web <issues.guix.gnu.org <at> elephly.net> writes:

> I was debating to myself whether to include shellcheck or not. As when
> I looked around in emacs-xyz.scm, for example `emacs-ag' does
> propagate the-silver-searcher but `emacs-direnv' does not.

emacs-ag package contains a comment explaining why the propagated inputs
is required.

Sometimes, it is unavoidable, but usage of propagated-inputs should be
as limited as possible.

> Anyway, I removed it in the latest patch.

Thank you. I applied your patch.

Regards,

-- 
Nicolas Goaziou

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.