[bug#50709] gnu: Add zsh-syntax-highlighting.

On Mon, Sep 20 2021, Alexandr Vityazev wrote:

> * gnu/packages/shellutils.scm (zsh-syntax-highlighting): New variable.
> ---
>  gnu/packages/shellutils.scm | 55 +++++++++++++++++++++++++++++++++++++
>  1 file changed, 55 insertions(+)
>
> diff --git a/gnu/packages/shellutils.scm b/gnu/packages/shellutils.scm
> index 94b5536df7..69e1d0d069 100644
> --- a/gnu/packages/shellutils.scm
> +++ b/gnu/packages/shellutils.scm
> @@ -138,6 +138,61 @@ text.")
>  as you type.")
>      (license license:expat)))
>  
> +(define-public zsh-syntax-highlighting
> +  (package
> +    (name "zsh-syntax-highlighting")
> +    (version "0.7.1")
> +    (source (origin
> +              (method git-fetch)
> +              (uri (git-reference
> +                    (url "https://github.com/zsh-users/zsh-syntax-highlighting")
> +                    (commit version)))
> +              (file-name (git-file-name name version))
> +              (sha256
> +               (base32
> +                "039g3n59drk818ylcyvkciv8k9mf739cv6v4vis1h9fv9whbcmwl"))))
> +    (build-system gnu-build-system)
> +    (native-inputs
> +     `(("zsh" ,zsh)))
> +    (arguments
> +     ;; FIXME: Tests fail when running test regexp
> +     ;; there is no pcre module in the Guix zsh package
> +     `(#:tests? #f
> +       #:phases
> +       (modify-phases %standard-phases
> +         (delete 'configure)
> +         (add-before 'build 'add-all-md
> +           (lambda _
> +             (copy-file "docs/highlighters.md" "docs/all.md")
> +             (make-file-writable "docs/all.md")
> +             #t))

Why not just invoke ‘make all’?

Also, phases no longer have to return #t

> +         (replace 'check
> +           (lambda* (#:key tests? #:allow-other-keys)
> +             (when tests?
> +               (invoke "make" "test")
> +               (invoke "make" "perf"))
> +             #t))
> +         (replace 'install
> +           (lambda* (#:key outputs #:allow-other-keys)
> +             (let* ((out (assoc-ref outputs "out"))
> +                    (zsh-plugins
> +                     (string-append out "/share/zsh/plugins/zsh-syntax-highlighting"))
> +                    (highlighters-dir (string-append zsh-plugins "/highlighters")))
> +               (invoke "make" "all")

Why is ‘make all’ invoked in the ‘install’ phase?

> +               (install-file "zsh-syntax-highlighting.zsh" zsh-plugins)
> +               (install-file ".version" zsh-plugins)
> +               (install-file ".revision-hash" zsh-plugins)
> +               (copy-recursively "highlighters" highlighters-dir)

Wouldn’t these things be handled by ‘make install’, assuming that
‘PREFIX’ and ‘SHARE_DIR’ are set correctly.

> +               #t))))))
> +    (home-page "https://github.com/zsh-users/zsh-syntax-highlighting")
> +    (synopsis "Fish shell-like syntax highlighting for zsh")

“Zsh” should be capitalized.

> +    (description
> +     "This package provides syntax highlighting for the shell zsh.

“This package provides syntax highlighting for Zsh.”

> +It enables highlighting of commands whilst they are typed at a zsh

Capitalize “Zsh”.

> +prompt into an interactive terminal.  This helps in reviewing commands
> +before running them, particularly in catching syntax errors.")
> +    (license license:expat)))

‘COPYING.md’ says BSD-3.

And I couldn’t resist, so I just went ahead and made those changes…
:-)

On 2021-09-26, 12:12 +0200, Xinglu Chen <public@yoctocell.xyz> wrote:

>
> Why is ‘make all’ invoked in the ‘install’ phase?
>
Looks like carelessness and delirium.

I agree with all the comments, the attached patch is much better,
thanks for the corrections!

Hi Alexandr,

Alexandr Vityazev <avityazev@posteo.org> skribis:

> On 2021-09-26, 12:12 +0200, Xinglu Chen <public@yoctocell.xyz> wrote:
>
>>
>> Why is ‘make all’ invoked in the ‘install’ phase?
>>
> Looks like carelessness and delirium.
>
> I agree with all the comments, the attached patch is much better,
> thanks for the corrections!

Looks like you forgot to attach the patch.  :-)

Ludo’.

Hi Ludo’,

On 2021-10-02, 17:18 +0200, Ludovic Courtès <ludo@gnu.org> wrote:

> Hi Alexandr,
>
> Alexandr Vityazev <avityazev@posteo.org> skribis:
>
>> On 2021-09-26, 12:12 +0200, Xinglu Chen <public@yoctocell.xyz> wrote:
>>
>>>
>>> Why is ‘make all’ invoked in the ‘install’ phase?
>>>
>> Looks like carelessness and delirium.
>>
>> I agree with all the comments, the attached patch is much better,
>> thanks for the corrections!
>
> Looks like you forgot to attach the patch.  :-)
>

Oh, sorry about that. I sent it.