Subject: [bug#74551] [PATCH rust-team v3 73/73] gnu: Add starship.

From: Aaron Covrig <[email-masked]>
Date: Mon, 2 Dec 2024 22:00:53 -0500

From: Jordan Moore <[email-masked]>

* gnu/packages/shellutils.scm (starship): New variable.
---
 gnu/packages/crates-io.scm  |   2 +-
 gnu/packages/shellutils.scm | 137 ++++++++++++++++++++++++++++++++++++
 2 files changed, 138 insertions(+), 1 deletion(-)

diff --git a/gnu/packages/crates-io.scm b/gnu/packages/crates-io.scm
index f453a7316e..655cef9696 100644
--- a/gnu/packages/crates-io.scm
+++ b/gnu/packages/crates-io.scm
@@ -78184,7 +78184,7 @@ (define-public rust-starship-battery-0.10
     (home-page "https://github.com/starship/rust-battery")
     (synopsis "Cross-platform information about the notebook batteries")
     (description
-     "This package provides Cross-platform information about the notebook batteries.")
+     "This package provides Cross-platform information about notebook batteries.")
     (license license:isc)))
 
 (define-public rust-state-0.6
diff --git a/gnu/packages/shellutils.scm b/gnu/packages/shellutils.scm
index 7e9f85a5f2..101ee6cf73 100644
--- a/gnu/packages/shellutils.scm
+++ b/gnu/packages/shellutils.scm
@@ -20,6 +20,7 @@
 ;;; Copyright © 2023 Zheng Junjie <[email-masked]>
 ;;; Copyright © 2024 Artyom V. Poptsov <[email-masked]>
 ;;; Copyright © 2024 Brian Kubisiak <[email-masked]>
+;;; Copyright © 2024 Jordan Moore <[email-masked]>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -43,6 +44,7 @@ (define-module (gnu packages shellutils)
   #:use-module (guix packages)
   #:use-module (guix download)
   #:use-module (guix git-download)
+  #:use-module (guix build-system cargo)
   #:use-module (guix build-system copy)
   #:use-module (guix build-system gnu)
   #:use-module (guix build-system go)
@@ -51,6 +53,11 @@ (define-module (gnu packages shellutils)
   #:use-module (gnu packages base)
   #:use-module (gnu packages bison)
   #:use-module (gnu packages check)
+  #:use-module (gnu packages cmake)
+  #:use-module (gnu packages crates-crypto)
+  #:use-module (gnu packages crates-io)
+  #:use-module (gnu packages crates-vcs)
+  #:use-module (gnu packages crates-windows)
   #:use-module (gnu packages flex)
   #:use-module (gnu packages golang-build)
   #:use-module (gnu packages golang-check)
@@ -67,6 +74,7 @@ (define-module (gnu packages shellutils)
   #:use-module (gnu packages shells)
   #:use-module (gnu packages textutils)
   #:use-module (gnu packages tmux)
+  #:use-module (gnu packages version-control)
   #:use-module (gnu packages vim))
 
 (define-public ascii
@@ -462,6 +470,135 @@ (define-public shfmt
 @url{http://www.mirbsd.org/mksh.htm,mksh}.")
     (license license:bsd-3)))
 
+(define-public starship
+  (package
+    (name "starship")
+    (version "1.21.1")
+    (source
+     (origin
+       (method url-fetch)
+       (uri (crate-uri "starship" version))
+       (file-name (string-append name "-" version ".tar.gz"))
+       (sha256
+        (base32 "1ikdy6jwlc36add55acxlba6f009dln9iyz368c1ndbfpgn4n42g"))))
+    (build-system cargo-build-system)
+    (inputs (list cmake-minimal
+                  ;; for tests
+                  git))
+    (arguments
+     (list
+      #:phases #~(modify-phases %standard-phases
+                   (add-after 'install 'install-completions
+                     (lambda* (#:key outputs skip-build? #:allow-other-keys)
+                       (let* ((out (assoc-ref outputs "out"))
+                              (starship-bin (string-append out "/bin/starship"))
+                              (share-files (string-append out "/share"))
+                              (bash-files (string-append out
+                                           "/etc/bash-completion.d/"))
+                              (zsh-files (string-append share-files
+                                          "/zsh/site-functions/"))
+                              (fish-files (string-append share-files
+                                           "/fish/vendor_completions.d/")))
+                         ;; we cannot make completions if starship was not built
+                         (or skip-build?
+                             ;; make the directories
+                             (mkdir-p bash-files)
+                             (mkdir-p zsh-files)
+                             (mkdir-p fish-files)
+                             ;; use the build starship to generate the necessary
+                             ;; completions
+                             (invoke starship-bin "completions" "bash" ">"
+                                     (string-append bash-files "/starship"))
+                             (invoke starship-bin "completions" "zsh" ">"
+                                     (string-append zsh-files "/_starship"))
+                             (invoke starship-bin "completions" "fish" ">"
+                                     (string-append fish-files
+                                                    "/starship.fish"))))))
+                   ;; some tests require a writable home directory
+                   (add-after 'unpack 'patch-test-shell
+                     (lambda* (#:key inputs #:allow-other-keys)
+                       ;; search through the rust files and then replace `/bin/sh'
+                       ;; with the path to the `/bin/sh' in the drv inputs
+                       (let ((rust-files (find-files "." "\\.rs$")))
+                         (for-each (lambda (file)
+                                     (substitute* file
+                                       (("/bin/sh")
+                                        (search-input-file inputs "/bin/sh"))))
+                                   rust-files))))
+                   ;; Set "HOME" to be located inside the cwd so it is writable
+                   ;; for tests checking for user-configs
+                   (add-before 'check 'set-test-env-vars
+                     (lambda _
+                       (setenv "HOME"
+                               (string-append (getcwd) "/.test-home")))))
+      #:cargo-inputs `(("rust-chrono" ,rust-chrono-0.4)
+                       ("rust-clap" ,rust-clap-4)
+                       ("rust-clap-complete" ,rust-clap-complete-4)
+                       ("rust-deelevate" ,rust-deelevate-0.2)
+                       ("rust-dirs" ,rust-dirs-5)
+                       ("rust-dunce" ,rust-dunce-1)
+                       ("rust-gix" ,rust-gix-0.66)
+                       ("rust-gix-features" ,rust-gix-features-0.38)
+                       ("rust-guess-host-triple" ,rust-guess-host-triple-0.1)
+                       ("rust-home" ,rust-home-0.5)
+                       ("rust-indexmap" ,rust-indexmap-2)
+                       ("rust-log" ,rust-log-0.4)
+                       ("rust-nix" ,rust-nix-0.29)
+                       ("rust-notify-rust" ,rust-notify-rust-4)
+                       ("rust-nu-ansi-term" ,rust-nu-ansi-term-0.50)
+                       ("rust-open" ,rust-open-5)
+                       ("rust-os-info" ,rust-os-info-3)
+                       ("rust-path-slash" ,rust-path-slash-0.2)
+                       ("rust-pest" ,rust-pest-2)
+                       ("rust-pest-derive" ,rust-pest-derive-2)
+                       ("rust-process-control" ,rust-process-control-5)
+                       ("rust-quick-xml" ,rust-quick-xml-0.36)
+                       ("rust-rand" ,rust-rand-0.8)
+                       ("rust-rayon" ,rust-rayon-1)
+                       ("rust-regex" ,rust-regex-1)
+                       ("rust-rust-ini" ,rust-rust-ini-0.21)
+                       ("rust-schemars" ,rust-schemars-0.8)
+                       ("rust-semver" ,rust-semver-1)
+                       ("rust-serde" ,rust-serde-1)
+                       ("rust-serde-json" ,rust-serde-json-1)
+                       ("rust-sha1" ,rust-sha1-0.10)
+                       ("rust-shadow-rs" ,rust-shadow-rs-0.35)
+                       ("rust-shell-words" ,rust-shell-words-1)
+                       ("rust-starship-battery" ,rust-starship-battery-0.10)
+                       ("rust-strsim" ,rust-strsim-0.11)
+                       ("rust-systemstat" ,rust-systemstat-0.2)
+                       ("rust-terminal-size" ,rust-terminal-size-0.4)
+                       ("rust-toml" ,rust-toml-0.8)
+                       ("rust-toml-edit" ,rust-toml-edit-0.22)
+                       ("rust-unicode-segmentation" ,rust-unicode-segmentation-1)
+                       ("rust-unicode-width" ,rust-unicode-width-0.2)
+                       ("rust-urlencoding" ,rust-urlencoding-2)
+                       ("rust-versions" ,rust-versions-6)
+                       ("rust-which" ,rust-which-6)
+                       ("rust-whoami" ,rust-whoami-1)
+                       ("rust-windows" ,rust-windows-0.58)
+                       ("rust-winres" ,rust-winres-0.1)
+                       ("rust-yaml-rust2" ,rust-yaml-rust2-0.9))
+      #:cargo-development-inputs `(("rust-mockall" ,rust-mockall-0.13)
+                                   ("rust-tempfile" ,rust-tempfile-3))))
+    (home-page "https://starship.rs")
+    (synopsis
+     "The minimal, blazing-fast, and infinitely customizable prompt for any shell!")
+    (description
+     "This package provides The minimal, blazing-fast, and infinitely customizable
+prompt for any shell!
+
+@itemize
+@item Fast: it's fast - *really really* fast :rocket:
+@item Customizable: configure every aspect of your prompt
+@item Universal: works on any shell, on any operating system
+@item Intelligent: shows relevant information at a glance
+@item Feature rich: support for all your favorite tools
+@item Easy: quick to install - start using it in minutes
+@end itemize
+
+Note: users must have a nerd font installed and enabled in their terminal")
+    (license license:isc)))
 
 (define-public envstore
   (package
-- 
2.47.0