Compare commits
5 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
a2f24e4633
|
|||
|
89f78f023a
|
|||
|
6ec3280a8d
|
|||
|
257ece43e6
|
|||
|
0c9e6de3ee
|
17
README.org
17
README.org
@@ -9,7 +9,7 @@
|
|||||||
akin to ~fish_greeting~ but for Eshell. But an image is worth a thousand
|
akin to ~fish_greeting~ but for Eshell. But an image is worth a thousand
|
||||||
words, let’s see how it looks like:
|
words, let’s see how it looks like:
|
||||||
|
|
||||||
#+caption: Screenshot of the default Eshell information banner
|
#+caption: Screenshot of the default Eshell information banner (using the nord theme from ~doom-themes~)
|
||||||
[[file:img/screenshot.png]]
|
[[file:img/screenshot.png]]
|
||||||
|
|
||||||
This will be displayed every time you open a new Eshell instance, or
|
This will be displayed every time you open a new Eshell instance, or
|
||||||
@@ -25,6 +25,8 @@ macOS. PR are welcome if you want to fix that!
|
|||||||
- [[#070][~0.7.0~]]
|
- [[#070][~0.7.0~]]
|
||||||
- [[#installation][Installation]]
|
- [[#installation][Installation]]
|
||||||
- [[#customizing][Customizing]]
|
- [[#customizing][Customizing]]
|
||||||
|
- [[#custom-variables][Custom Variables]]
|
||||||
|
- [[#faces][Faces]]
|
||||||
- [[#my-computer-doesnt-have-a-battery-will-this-still-work][My computer doesn’t have a battery, will this still work?]]
|
- [[#my-computer-doesnt-have-a-battery-will-this-still-work][My computer doesn’t have a battery, will this still work?]]
|
||||||
- [[#advice-for-windows-users][Advice for Windows users]]
|
- [[#advice-for-windows-users][Advice for Windows users]]
|
||||||
- [[#contributing][Contributing]]
|
- [[#contributing][Contributing]]
|
||||||
@@ -89,6 +91,7 @@ There is probably a similar way to install it with pure ~straight.el~ or
|
|||||||
a PR to add some more installation instructions!
|
a PR to add some more installation instructions!
|
||||||
|
|
||||||
* Customizing
|
* Customizing
|
||||||
|
** Custom Variables
|
||||||
A couple of variables can be edited by the user in order to configure
|
A couple of variables can be edited by the user in order to configure
|
||||||
~eshell-info-banner.el~:
|
~eshell-info-banner.el~:
|
||||||
- ~eshell-info-banner-partition-prefixes~ :: Filter for which
|
- ~eshell-info-banner-partition-prefixes~ :: Filter for which
|
||||||
@@ -143,7 +146,19 @@ A couple of variables can be edited by the user in order to configure
|
|||||||
this custom variable.
|
this custom variable.
|
||||||
|
|
||||||
Default value: ~duf~
|
Default value: ~duf~
|
||||||
|
- ~eshell-info-banner-file-size-flavor~ :: This variable reflects the
|
||||||
|
possible values passed to the function ~file-size-human-readable~. It
|
||||||
|
can hold one of these three values:
|
||||||
|
- ~nil~
|
||||||
|
- ~si~
|
||||||
|
- ~iec~
|
||||||
|
Since the value ~iec~ generates longer file size prefixes, progress
|
||||||
|
bars become slightly shorter. For more details on this option, see
|
||||||
|
the documentation of ~file-size-human-readable~.
|
||||||
|
|
||||||
|
Default value: ~nil~
|
||||||
|
|
||||||
|
** Faces
|
||||||
Don’t like the colors used by the package? They should follow by
|
Don’t like the colors used by the package? They should follow by
|
||||||
default your theme, but you can customize the following faces:
|
default your theme, but you can customize the following faces:
|
||||||
- ~eshell-info-banner-background-face~ :: Used for filling the empty
|
- ~eshell-info-banner-background-face~ :: Used for filling the empty
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
;; Author: Lucien Cartier-Tilet <lucien@phundrak.com>
|
;; Author: Lucien Cartier-Tilet <lucien@phundrak.com>
|
||||||
;; Maintainer: Lucien Cartier-Tilet <lucien@phundrak.com>
|
;; Maintainer: Lucien Cartier-Tilet <lucien@phundrak.com>
|
||||||
;; Version: 0.7.6
|
;; Version: 0.8.0
|
||||||
;; Package-Requires: ((emacs "25.1") (f "0.20") (s "1"))
|
;; Package-Requires: ((emacs "25.1") (f "0.20") (s "1"))
|
||||||
;; Homepage: https://github.com/Phundrak/eshell-info-banner.el
|
;; Homepage: https://github.com/Phundrak/eshell-info-banner.el
|
||||||
|
|
||||||
@@ -140,6 +140,19 @@
|
|||||||
:type 'list
|
:type 'list
|
||||||
:version "0.3.0")
|
:version "0.3.0")
|
||||||
|
|
||||||
|
(defun eshell-info-banner--executable-find (program &optional remote)
|
||||||
|
"Find PROGRAM executable, possibly on a REMOTE machine.
|
||||||
|
This is a wrapper around `executable-find' in order to avoid
|
||||||
|
issues with older versions of the functions only accepting one
|
||||||
|
argument."
|
||||||
|
(if (version< emacs-version "27.1")
|
||||||
|
(let ((default-directory (if (and eshell-info-banner-tramp-aware
|
||||||
|
remote)
|
||||||
|
default-directory
|
||||||
|
"~")))
|
||||||
|
(executable-find program))
|
||||||
|
(executable-find program remote)))
|
||||||
|
|
||||||
(defcustom eshell-info-banner-duf-executable "duf"
|
(defcustom eshell-info-banner-duf-executable "duf"
|
||||||
"Path to the `duf' executable."
|
"Path to the `duf' executable."
|
||||||
:group 'eshell-info-banner
|
:group 'eshell-info-banner
|
||||||
@@ -147,7 +160,8 @@
|
|||||||
:safe #'stringp
|
:safe #'stringp
|
||||||
:version "0.5.0")
|
:version "0.5.0")
|
||||||
|
|
||||||
(defcustom eshell-info-banner-use-duf (if (executable-find eshell-info-banner-duf-executable)
|
(defcustom eshell-info-banner-use-duf
|
||||||
|
(if (eshell-info-banner--executable-find eshell-info-banner-duf-executable)
|
||||||
t
|
t
|
||||||
nil)
|
nil)
|
||||||
"If non-nil, use `duf' instead of `df'."
|
"If non-nil, use `duf' instead of `df'."
|
||||||
@@ -156,6 +170,14 @@
|
|||||||
:safe #'booleanp
|
:safe #'booleanp
|
||||||
:version "0.5.0")
|
:version "0.5.0")
|
||||||
|
|
||||||
|
(defcustom eshell-info-banner-file-size-flavor nil
|
||||||
|
"Display sizes with IEC prefixes."
|
||||||
|
:group 'eshell-info-banner
|
||||||
|
:type '(radio (const :tag "Default" nil)
|
||||||
|
(const :tag "SI" si)
|
||||||
|
(const :tag "IEC" iec))
|
||||||
|
:version "0.8.0")
|
||||||
|
|
||||||
|
|
||||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||||
; Faces ;
|
; Faces ;
|
||||||
@@ -183,7 +205,7 @@
|
|||||||
|
|
||||||
|
|
||||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||||
; Macros ;
|
; Macros and Utilities ;
|
||||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||||
|
|
||||||
(defmacro eshell-info-banner--with-face (str &rest properties)
|
(defmacro eshell-info-banner--with-face (str &rest properties)
|
||||||
@@ -195,6 +217,25 @@
|
|||||||
Ensures the command is ran with LANG=C."
|
Ensures the command is ran with LANG=C."
|
||||||
(shell-command-to-string (format "LANG=C %s" command)))
|
(shell-command-to-string (format "LANG=C %s" command)))
|
||||||
|
|
||||||
|
(defun eshell-info-banner--progress-bar-without-prefix (bar-length used total &optional newline)
|
||||||
|
"Display a progress bar without its prefix.
|
||||||
|
Display a progress bar of BAR-LENGTH length, followed by an
|
||||||
|
indication of how full the memory is with a human readable USED
|
||||||
|
and TOTAL size."
|
||||||
|
(let ((percentage (if (= used 0)
|
||||||
|
0
|
||||||
|
(/ (* 100 used) total))))
|
||||||
|
(concat (eshell-info-banner--progress-bar bar-length percentage)
|
||||||
|
(format (if (equal eshell-info-banner-file-size-flavor 'iec)
|
||||||
|
" %8s / %-8s (%3s%%)%s"
|
||||||
|
" %6s / %-6s (%3s%%)%s")
|
||||||
|
(file-size-human-readable used eshell-info-banner-file-size-flavor)
|
||||||
|
(file-size-human-readable total eshell-info-banner-file-size-flavor)
|
||||||
|
(eshell-info-banner--with-face
|
||||||
|
(number-to-string percentage)
|
||||||
|
:inherit (eshell-info-banner--get-color-percentage percentage))
|
||||||
|
(if newline "\n" "")))))
|
||||||
|
|
||||||
|
|
||||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||||
; Internal functions ;
|
; Internal functions ;
|
||||||
@@ -206,11 +247,11 @@ Ensures the command is ran with LANG=C."
|
|||||||
"Get uptime of machine if `uptime' is available.
|
"Get uptime of machine if `uptime' is available.
|
||||||
|
|
||||||
If the executable `uptime' is not found, return nil."
|
If the executable `uptime' is not found, return nil."
|
||||||
(when (executable-find "uptime")
|
(when (eshell-info-banner--executable-find "uptime")
|
||||||
(let ((uptime-str (eshell-info-banner--shell-command-to-string "uptime -p")))
|
(let ((uptime-str (eshell-info-banner--shell-command-to-string "uptime -p")))
|
||||||
(if (not (seq-some (lambda (keyword)
|
(if (not (seq-some (lambda (keyword)
|
||||||
(string-match-p keyword uptime-str))
|
(string-match-p keyword uptime-str))
|
||||||
'("invalid" "illegal")))
|
'("invalid" "illegal" "unknown")))
|
||||||
(s-chop-prefix "up " (s-trim uptime-str))
|
(s-chop-prefix "up " (s-trim uptime-str))
|
||||||
(let ((uptime-str (eshell-info-banner--shell-command-to-string "uptime")))
|
(let ((uptime-str (eshell-info-banner--shell-command-to-string "uptime")))
|
||||||
(save-match-data
|
(save-match-data
|
||||||
@@ -290,8 +331,8 @@ chosen. Relies on the `duf' command."
|
|||||||
:path (if (> (length mount-point) eshell-info-banner-shorten-path-from)
|
:path (if (> (length mount-point) eshell-info-banner-shorten-path-from)
|
||||||
(eshell-info-banner--abbr-path mount-point t)
|
(eshell-info-banner--abbr-path mount-point t)
|
||||||
mount-point)
|
mount-point)
|
||||||
:size (file-size-human-readable total)
|
:size total
|
||||||
:used (file-size-human-readable used)
|
:used used
|
||||||
:percent percent)))
|
:percent percent)))
|
||||||
partitions)))
|
partitions)))
|
||||||
|
|
||||||
@@ -303,15 +344,15 @@ Common function between
|
|||||||
otherwise differ solely on the position of the mount point in the
|
otherwise differ solely on the position of the mount point in the
|
||||||
partition list. Its position is given by the argument
|
partition list. Its position is given by the argument
|
||||||
MOUNT-POSITION."
|
MOUNT-POSITION."
|
||||||
(let ((partitions (cdr (split-string (eshell-info-banner--shell-command-to-string "df -lH")
|
(let ((partitions (cdr (split-string (eshell-info-banner--shell-command-to-string "df -l")
|
||||||
(regexp-quote "\n")
|
(regexp-quote "\n")
|
||||||
t))))
|
t))))
|
||||||
(cl-remove-if #'null
|
(cl-remove-if #'null
|
||||||
(mapcar (lambda (partition)
|
(mapcar (lambda (partition)
|
||||||
(let* ((partition (split-string partition " " t))
|
(let* ((partition (split-string partition " " t))
|
||||||
(filesystem (nth 0 partition))
|
(filesystem (nth 0 partition))
|
||||||
(size (nth 1 partition))
|
(size (string-to-number (nth 1 partition)))
|
||||||
(used (nth 2 partition))
|
(used (string-to-number (nth 2 partition)))
|
||||||
(percent (nth 4 partition))
|
(percent (nth 4 partition))
|
||||||
(mount (nth mount-position partition)))
|
(mount (nth mount-position partition)))
|
||||||
(when (seq-some (lambda (prefix)
|
(when (seq-some (lambda (prefix)
|
||||||
@@ -376,20 +417,16 @@ Return detected partitions as a list of structs."
|
|||||||
|
|
||||||
For TEXT-PADDING and BAR-LENGTH, see the documentation of
|
For TEXT-PADDING and BAR-LENGTH, see the documentation of
|
||||||
`eshell-info-banner--display-memory'."
|
`eshell-info-banner--display-memory'."
|
||||||
(let ((percentage (eshell-info-banner--mounted-partitions-percent partition)))
|
|
||||||
(concat (s-pad-right text-padding
|
(concat (s-pad-right text-padding
|
||||||
"."
|
"."
|
||||||
(eshell-info-banner--with-face
|
(eshell-info-banner--with-face
|
||||||
(eshell-info-banner--mounted-partitions-path partition)
|
(eshell-info-banner--mounted-partitions-path partition)
|
||||||
:weight 'bold))
|
:weight 'bold))
|
||||||
": "
|
": "
|
||||||
(eshell-info-banner--progress-bar bar-length percentage)
|
(eshell-info-banner--progress-bar-without-prefix
|
||||||
(format " %6s / %-6s (%3s%%)"
|
bar-length
|
||||||
(eshell-info-banner--mounted-partitions-used partition)
|
(eshell-info-banner--mounted-partitions-used partition)
|
||||||
(eshell-info-banner--mounted-partitions-size partition)
|
(eshell-info-banner--mounted-partitions-size partition))))
|
||||||
(eshell-info-banner--with-face
|
|
||||||
(number-to-string percentage)
|
|
||||||
:inherit (eshell-info-banner--get-color-percentage percentage))))))
|
|
||||||
|
|
||||||
(defun eshell-info-banner--display-partitions (text-padding bar-length)
|
(defun eshell-info-banner--display-partitions (text-padding bar-length)
|
||||||
"Display the detected mounted partitions of the system.
|
"Display the detected mounted partitions of the system.
|
||||||
@@ -465,18 +502,9 @@ be displayed on the far right.
|
|||||||
|
|
||||||
`BAR-LENGTH' determines the length of the progress bar to be
|
`BAR-LENGTH' determines the length of the progress bar to be
|
||||||
displayed."
|
displayed."
|
||||||
(let ((percentage (if (= used 0)
|
|
||||||
0
|
|
||||||
(/ (* 100 used) total))))
|
|
||||||
(concat (s-pad-right text-padding "." type)
|
(concat (s-pad-right text-padding "." type)
|
||||||
": "
|
": "
|
||||||
(eshell-info-banner--progress-bar bar-length percentage)
|
(eshell-info-banner--progress-bar-without-prefix bar-length used total t)))
|
||||||
(format " %6s / %-6s (%3s%%)\n"
|
|
||||||
(file-size-human-readable used)
|
|
||||||
(file-size-human-readable total)
|
|
||||||
(eshell-info-banner--with-face
|
|
||||||
(number-to-string percentage)
|
|
||||||
:inherit (eshell-info-banner--get-color-percentage percentage))))))
|
|
||||||
|
|
||||||
(defun eshell-info-banner--display-memory (text-padding bar-length)
|
(defun eshell-info-banner--display-memory (text-padding bar-length)
|
||||||
"Display memories detected on your system.
|
"Display memories detected on your system.
|
||||||
@@ -567,7 +595,7 @@ the warning face with a battery level of 25% or less."
|
|||||||
(eshell-info-banner--progress-bar bar-length
|
(eshell-info-banner--progress-bar bar-length
|
||||||
percentage
|
percentage
|
||||||
t)
|
t)
|
||||||
(s-repeat 17 " ")
|
(s-repeat (if (equal eshell-info-banner-file-size-flavor 'iec) 21 17) " ")
|
||||||
(format "(%3s%%)\n"
|
(format "(%3s%%)\n"
|
||||||
(eshell-info-banner--with-face
|
(eshell-info-banner--with-face
|
||||||
(number-to-string percentage)
|
(number-to-string percentage)
|
||||||
@@ -634,7 +662,7 @@ If RELEASE-FILE is nil, use '/etc/os-release'."
|
|||||||
(insert-file-contents (concat prefix "/bedrock/etc/bedrock-release"))
|
(insert-file-contents (concat prefix "/bedrock/etc/bedrock-release"))
|
||||||
(buffer-string))))
|
(buffer-string))))
|
||||||
;; Proxmox
|
;; Proxmox
|
||||||
((executable-find "pveversion" eshell-info-banner-tramp-aware)
|
((eshell-info-banner--executable-find "pveversion" eshell-info-banner-tramp-aware)
|
||||||
(let ((distro (eshell-info-banner--shell-command-to-string "pveversion")))
|
(let ((distro (eshell-info-banner--shell-command-to-string "pveversion")))
|
||||||
(save-match-data
|
(save-match-data
|
||||||
(string-match "/\\([^/]+\\)/" distro)
|
(string-match "/\\([^/]+\\)/" distro)
|
||||||
@@ -642,13 +670,13 @@ If RELEASE-FILE is nil, use '/etc/os-release'."
|
|||||||
(substring-no-properties distro
|
(substring-no-properties distro
|
||||||
(match-beginning 1)
|
(match-beginning 1)
|
||||||
(match-end 1))))))
|
(match-end 1))))))
|
||||||
((executable-find "hostnamectl" eshell-info-banner-tramp-aware)
|
((eshell-info-banner--executable-find "hostnamectl" eshell-info-banner-tramp-aware)
|
||||||
(eshell-info-banner--get-os-information-from-hostnamectl))
|
(eshell-info-banner--get-os-information-from-hostnamectl))
|
||||||
((executable-find "lsb_release" eshell-info-banner-tramp-aware)
|
((eshell-info-banner--executable-find "lsb_release" eshell-info-banner-tramp-aware)
|
||||||
(eshell-info-banner--get-os-information-from-lsb-release))
|
(eshell-info-banner--get-os-information-from-lsb-release))
|
||||||
((file-exists-p (concat prefix "/etc/os-release"))
|
((file-exists-p (concat prefix "/etc/os-release"))
|
||||||
(eshell-info-banner--get-os-information-from-release-file))
|
(eshell-info-banner--get-os-information-from-release-file))
|
||||||
((executable-find "shepherd")
|
((eshell-info-banner--executable-find "shepherd")
|
||||||
(let ((distro (car (s-lines (eshell-info-banner--shell-command-to-string "guix -V")))))
|
(let ((distro (car (s-lines (eshell-info-banner--shell-command-to-string "guix -V")))))
|
||||||
(save-match-data
|
(save-match-data
|
||||||
(string-match "\\([0-9\\.]+\\)" distro)
|
(string-match "\\([0-9\\.]+\\)" distro)
|
||||||
@@ -661,6 +689,10 @@ If RELEASE-FILE is nil, use '/etc/os-release'."
|
|||||||
(s-trim (with-temp-buffer
|
(s-trim (with-temp-buffer
|
||||||
(process-file "uname" nil t nil "-s")
|
(process-file "uname" nil t nil "-s")
|
||||||
(buffer-string)))))
|
(buffer-string)))))
|
||||||
|
((and (file-exists-p (concat prefix "/system/app"))
|
||||||
|
(file-exists-p (concat prefix "/system/priv-app")))
|
||||||
|
(concat "Android "
|
||||||
|
(s-trim (eshell-info-banner--shell-command-to-string "getprop ro.build.version.release"))))
|
||||||
(t "Unknown"))
|
(t "Unknown"))
|
||||||
.
|
.
|
||||||
,(s-trim (eshell-info-banner--shell-command-to-string "uname -rs")))))
|
,(s-trim (eshell-info-banner--shell-command-to-string "uname -rs")))))
|
||||||
@@ -724,7 +756,10 @@ build number)."
|
|||||||
eshell-info-banner-width))
|
eshell-info-banner-width))
|
||||||
(middle-padding (- tot-width right-text left-padding 4))
|
(middle-padding (- tot-width right-text left-padding 4))
|
||||||
|
|
||||||
(bar-length (- tot-width left-padding 4 23)))
|
(bar-length (- tot-width left-padding 4 23))
|
||||||
|
(bar-length (if (equal eshell-info-banner-file-size-flavor 'iec)
|
||||||
|
(- bar-length 4)
|
||||||
|
bar-length)))
|
||||||
(concat (format "%s\n" (s-repeat tot-width eshell-info-banner-progress-bar-char))
|
(concat (format "%s\n" (s-repeat tot-width eshell-info-banner-progress-bar-char))
|
||||||
(format "%s: %s Kernel.: %s\n"
|
(format "%s: %s Kernel.: %s\n"
|
||||||
(s-pad-right left-padding
|
(s-pad-right left-padding
|
||||||
|
|||||||
Reference in New Issue
Block a user