aboutsummaryrefslogtreecommitdiff
path: root/Emacs/.config/emacs/elisp/eshell-prompt.el
blob: cce01d5364986d0cc3de6508059e580244ca2e68 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
;;; eshell-prompt.el --- Generating a good prompt for Eshell  -*- lexical-binding: t; -*-

;; Copyright (C) 2024  Aryadev Chavali

;; Author: Aryadev Chavali <aryadev@aryadevchavali.com>
;; Keywords:

;; This program is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public License Version
;; 2 as published by the Free Software Foundation.

;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with this program.  If not, see <https://www.gnu.org/licenses/>.

;;; Commentary:

;; We provide a function +eshell-prompt which generates a prompt on
;; demand.

;;; Code:

(defvar +eshell-prompt/user-prompt "𝜆> "
  "Prompt for user to input.")

(defvar +eshell-prompt/dir-colour "skyblue")
(defvar +eshell-prompt/success-colour "forestgreen")
(defvar +eshell-prompt/failure-colour "red")

(defun +eshell-prompt/--colour-on-last-command ()
  "Returns an Emacs colour based on ESHELL-LAST-COMMAND-STATUS."
  (if (zerop eshell-last-command-status)
      +eshell-prompt/success-colour
    +eshell-prompt/failure-colour))

(defun +eshell-prompt/--git-remote-status ()
  "Returns a propertized string for the status of a repository
in comparison to its remote.  3 differing strings are returned
dependent on:

- Is it equivalent to the remote?
- Is it ahead of the remote?
- Is it behind the remote?

The latter 2 also have a number for exactly how many commits
behind or ahead the local repository is."
  (let* ((git-cmd "git status | grep 'Your branch is'")
         (branch-status (split-string (shell-command-to-string git-cmd)))
         (status (nth 3 branch-status))
         (diff (cl-position "by" branch-status :test #'string=)))
    (if (null diff)
        (propertize "=" 'font-lock-face `(:foreground ,+eshell-prompt/success-colour))
      (let ((n (nth (+ 1 diff) branch-status)))
        (concat
         (cond
          ((string= status "ahead")
           (propertize "→" 'font-lock-face '(:foreground "dodger blue")))
          ((string= status "behind")
           (propertize "←" 'font-lock-face '(:foreground "red"))))
         n)))))

(defun +eshell-prompt/--git-change-status ()
  "Returns a propertized string for the condition of the worktree in
a repository.  If there are no changes i.e. the worktree is clean
then a green tick is returned, but if there are changes then the
number of files affected are returned in red."
  (let* ((git-cmd "git status -s")
         (command-output (split-string (shell-command-to-string git-cmd) "\n"))
         (changed-files (- (length command-output) 1)))
    (if (= changed-files 0)
        (propertize "✓"
                    'font-lock-face
                    `(:foreground ,+eshell-prompt/success-colour))
      (propertize (number-to-string changed-files)
                  'font-lock-face
                  `(:foreground ,+eshell-prompt/failure-colour)))))

(defun +eshell-prompt/--git-status ()
  "Returns a completely formatted string of
form (BRANCH-NAME<CHANGES>[REMOTE-STATUS])."
  (let ((git-branch (shell-command-to-string "git branch")))
    (if (or (string= git-branch "")
            (not (string= "*" (substring git-branch 0 1))))
        ""
      (format
       "(%s<%s>[%s])"
       (nth 2 (split-string git-branch "\n\\|\\*\\| "))
       (+eshell-prompt/--git-change-status)
       (+eshell-prompt/--git-remote-status)))))

(defun +eshell-prompt/make-prompt ()
  (let ((git (+eshell-prompt/--git-status)))
    (mapconcat
     (lambda (item)
       (if (listp item)
           (propertize (car item)
                       'font-lock-face (cdr item)
                       'front-sticky   '(font-lock-face read-only)
                       'rear-nonsticky '(font-lock-face read-only))
         item))
     (list
      "["
      `(,(abbreviate-file-name (eshell/pwd)) :foreground ,+eshell-prompt/dir-colour)
      "]"
      (if (string= git "")
          ""
        (concat " " git))
      "\n"
      (list "𝜆> " ':foreground (+eshell-prompt/--colour-on-last-command))))))


(provide 'eshell-prompt)
;;; eshell-prompt.el ends here