Compare commits
12 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
36b964a993
|
|||
|
661ae7c87d
|
|||
|
382bb55064
|
|||
|
a2f24e4633
|
|||
|
89f78f023a
|
|||
|
6ec3280a8d
|
|||
|
257ece43e6
|
|||
|
0c9e6de3ee
|
|||
|
76d87e4325
|
|||
|
6e90f02988
|
|||
|
08d7bc42da
|
|||
|
c8073faa88
|
26
README.org
26
README.org
@@ -2,13 +2,14 @@
|
||||
#+author: Lucien Cartier-Tilet
|
||||
#+email: lucien@phundrak.com
|
||||
[[https://melpa.org/#/eshell-info-banner][file:https://melpa.org/packages/eshell-info-banner-badge.svg]]
|
||||
[[https://stable.melpa.org/#/eshell-info-banner][file:https://stable.melpa.org/packages/eshell-info-banner-badge.svg]]
|
||||
|
||||
* Introduction
|
||||
~eshell-info-banner.el~ is a utility for creating an informative banner,
|
||||
akin to ~fish_greeting~ but for Eshell. But an image is worth a thousand
|
||||
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]]
|
||||
|
||||
This will be displayed every time you open a new Eshell instance, or
|
||||
@@ -21,20 +22,28 @@ macOS. PR are welcome if you want to fix that!
|
||||
* Table of Contents :TOC_2_gh:
|
||||
- [[#introduction][Introduction]]
|
||||
- [[#recent-breaking-changes][Recent Breaking Changes]]
|
||||
- [[#081][~0.8.1~]]
|
||||
- [[#070][~0.7.0~]]
|
||||
- [[#installation][Installation]]
|
||||
- [[#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?]]
|
||||
- [[#advice-for-windows-users][Advice for Windows users]]
|
||||
- [[#contributing][Contributing]]
|
||||
- [[#license][License]]
|
||||
|
||||
* Recent Breaking Changes
|
||||
** ~0.8.1~
|
||||
Version ~0.8.1~ removes the optional argument ~REMOTE~ from
|
||||
~eshell-info-banner--executable-find~. It now only acts according to the
|
||||
user’s preference set with ~eshell-info-banner-tramp-aware~.
|
||||
|
||||
** ~0.7.0~
|
||||
Version ~0.7.0~ renames several functions to conform with the Elisp
|
||||
Coding Conventions.
|
||||
| Old Name | New Name |
|
||||
|------------------------------------------------------+------------------------------------------------------|
|
||||
|----------------------------------------------------+----------------------------------------------------|
|
||||
| ~eshell-info-banner--ge-mounted-partitions/duf~ | ~eshell-info-banner--ge-mounted-partitions-duf~ |
|
||||
| ~eshell-info-banner--get-mounted-partitions/df~ | ~eshell-info-banner--get-mounted-partitions-df~ |
|
||||
| ~eshell-info-banner--get-mounted-partitions/windows~ | ~eshell-info-banner--get-mounted-partitions-windows~ |
|
||||
@@ -88,6 +97,7 @@ There is probably a similar way to install it with pure ~straight.el~ or
|
||||
a PR to add some more installation instructions!
|
||||
|
||||
* Customizing
|
||||
** Custom Variables
|
||||
A couple of variables can be edited by the user in order to configure
|
||||
~eshell-info-banner.el~:
|
||||
- ~eshell-info-banner-partition-prefixes~ :: Filter for which
|
||||
@@ -142,7 +152,19 @@ A couple of variables can be edited by the user in order to configure
|
||||
this custom variable.
|
||||
|
||||
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
|
||||
default your theme, but you can customize the following faces:
|
||||
- ~eshell-info-banner-background-face~ :: Used for filling the empty
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
|
||||
;; Author: Lucien Cartier-Tilet <lucien@phundrak.com>
|
||||
;; Maintainer: Lucien Cartier-Tilet <lucien@phundrak.com>
|
||||
;; Version: 0.7.4
|
||||
;; Version: 0.8.1
|
||||
;; Package-Requires: ((emacs "25.1") (f "0.20") (s "1"))
|
||||
;; Homepage: https://labs.phundrak.com/phundrak/eshell-info-banner.el
|
||||
;; Homepage: https://github.com/Phundrak/eshell-info-banner.el
|
||||
|
||||
;; This file is not part of GNU Emacs
|
||||
|
||||
@@ -87,6 +87,9 @@
|
||||
("11.6" . "macOS Big Sur"))
|
||||
"Versions of OSX and macOS and their name."))
|
||||
|
||||
(defconst eshell-info-banner--posix-shells '("bash" "zsh" "sh")
|
||||
"List of POSIX-compliant shells to run external commands through.")
|
||||
|
||||
|
||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||
; Custom variables ;
|
||||
@@ -140,6 +143,19 @@
|
||||
:type 'list
|
||||
:version "0.3.0")
|
||||
|
||||
(defun eshell-info-banner--executable-find (program)
|
||||
"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. `executable-find'’s remote argument has the value of
|
||||
`eshell-info-banner-tramp-aware'."
|
||||
(if (version< emacs-version "27.1")
|
||||
(let ((default-directory (if eshell-info-banner-tramp-aware
|
||||
default-directory
|
||||
"~")))
|
||||
(executable-find program))
|
||||
(executable-find program eshell-info-banner-tramp-aware)))
|
||||
|
||||
(defcustom eshell-info-banner-duf-executable "duf"
|
||||
"Path to the `duf' executable."
|
||||
:group 'eshell-info-banner
|
||||
@@ -147,7 +163,8 @@
|
||||
:safe #'stringp
|
||||
: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
|
||||
nil)
|
||||
"If non-nil, use `duf' instead of `df'."
|
||||
@@ -156,6 +173,14 @@
|
||||
:safe #'booleanp
|
||||
: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 ;
|
||||
@@ -183,7 +208,7 @@
|
||||
|
||||
|
||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||
; Macros ;
|
||||
; Macros and Utilities ;
|
||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||
|
||||
(defmacro eshell-info-banner--with-face (str &rest properties)
|
||||
@@ -193,7 +218,32 @@
|
||||
(defun eshell-info-banner--shell-command-to-string (command)
|
||||
"Execute shell command COMMAND and return its output as a string.
|
||||
Ensures the command is ran with LANG=C."
|
||||
(shell-command-to-string (format "LANG=C %s" command)))
|
||||
(let ((shell (or (seq-find (lambda (shell)
|
||||
(eshell-info-banner--executable-find shell))
|
||||
eshell-info-banner--posix-shells)
|
||||
"sh")))
|
||||
(with-temp-buffer
|
||||
(call-process shell nil t nil "-c" (concat "LANG=C " command))
|
||||
(buffer-string))))
|
||||
|
||||
(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" "")))))
|
||||
|
||||
|
||||
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
||||
@@ -206,11 +256,11 @@ Ensures the command is ran with LANG=C."
|
||||
"Get uptime of machine if `uptime' is available.
|
||||
|
||||
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")))
|
||||
(if (not (seq-some (lambda (keyword)
|
||||
(string-match-p keyword uptime-str))
|
||||
'("invalid" "illegal")))
|
||||
'("invalid" "illegal" "unknown")))
|
||||
(s-chop-prefix "up " (s-trim uptime-str))
|
||||
(let ((uptime-str (eshell-info-banner--shell-command-to-string "uptime")))
|
||||
(save-match-data
|
||||
@@ -290,8 +340,8 @@ chosen. Relies on the `duf' command."
|
||||
:path (if (> (length mount-point) eshell-info-banner-shorten-path-from)
|
||||
(eshell-info-banner--abbr-path mount-point t)
|
||||
mount-point)
|
||||
:size (file-size-human-readable total)
|
||||
:used (file-size-human-readable used)
|
||||
:size total
|
||||
:used used
|
||||
:percent percent)))
|
||||
partitions)))
|
||||
|
||||
@@ -303,15 +353,15 @@ Common function between
|
||||
otherwise differ solely on the position of the mount point in the
|
||||
partition list. Its position is given by the argument
|
||||
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")
|
||||
t))))
|
||||
(cl-remove-if #'null
|
||||
(mapcar (lambda (partition)
|
||||
(let* ((partition (split-string partition " " t))
|
||||
(filesystem (nth 0 partition))
|
||||
(size (nth 1 partition))
|
||||
(used (nth 2 partition))
|
||||
(size (string-to-number (nth 1 partition)))
|
||||
(used (string-to-number (nth 2 partition)))
|
||||
(percent (nth 4 partition))
|
||||
(mount (nth mount-position partition)))
|
||||
(when (seq-some (lambda (prefix)
|
||||
@@ -376,20 +426,16 @@ Return detected partitions as a list of structs."
|
||||
|
||||
For TEXT-PADDING and BAR-LENGTH, see the documentation of
|
||||
`eshell-info-banner--display-memory'."
|
||||
(let ((percentage (eshell-info-banner--mounted-partitions-percent partition)))
|
||||
(concat (s-pad-right text-padding
|
||||
"."
|
||||
(eshell-info-banner--with-face
|
||||
(eshell-info-banner--mounted-partitions-path partition)
|
||||
:weight 'bold))
|
||||
": "
|
||||
(eshell-info-banner--progress-bar bar-length percentage)
|
||||
(format " %6s / %-6s (%3s%%)"
|
||||
(eshell-info-banner--progress-bar-without-prefix
|
||||
bar-length
|
||||
(eshell-info-banner--mounted-partitions-used 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))))))
|
||||
(eshell-info-banner--mounted-partitions-size partition))))
|
||||
|
||||
(defun eshell-info-banner--display-partitions (text-padding bar-length)
|
||||
"Display the detected mounted partitions of the system.
|
||||
@@ -420,13 +466,32 @@ Compatible with Darwin and FreeBSD at least."
|
||||
(let* ((command-to-mem (lambda (command)
|
||||
(string-to-number
|
||||
(s-trim
|
||||
(cadr
|
||||
(car (last
|
||||
(split-string (eshell-info-banner--shell-command-to-string command)
|
||||
" "
|
||||
t)))))))
|
||||
`(("RAM"
|
||||
,(apply command-to-mem '("sysctl hw.physmem"))
|
||||
,(apply command-to-mem '("sysctl hw.usermem"))))))
|
||||
(netbsdp (and (equal system-type 'berkeley-unix)
|
||||
(string-match-p "NetBSD" (eshell-info-banner--shell-command-to-string "uname"))))
|
||||
(total (apply command-to-mem `(,(if netbsdp "sysctl hw.physmem64" "sysctl hw.physmem"))))
|
||||
(used (if netbsdp
|
||||
(- total
|
||||
(* 1024 (string-to-number
|
||||
(s-trim
|
||||
(with-temp-buffer
|
||||
(insert-file-contents-literally "/proc/meminfo")
|
||||
(save-match-data
|
||||
(string-match (rx bol
|
||||
"MemFree:"
|
||||
(* blank)
|
||||
(group (+ digit))
|
||||
(* blank)
|
||||
"kB")
|
||||
(buffer-string))
|
||||
(substring-no-properties (buffer-string)
|
||||
(match-beginning 1)
|
||||
(match-end 1))))))))
|
||||
(apply command-to-mem '("sysctl hw.usermem")))))
|
||||
`(("RAM" ,total ,used))))
|
||||
|
||||
(defun eshell-info-banner--get-memory-windows ()
|
||||
"Get memory usage for Window."
|
||||
@@ -465,18 +530,9 @@ be displayed on the far right.
|
||||
|
||||
`BAR-LENGTH' determines the length of the progress bar to be
|
||||
displayed."
|
||||
(let ((percentage (if (= used 0)
|
||||
0
|
||||
(/ (* 100 used) total))))
|
||||
(concat (s-pad-right text-padding "." type)
|
||||
": "
|
||||
(eshell-info-banner--progress-bar bar-length percentage)
|
||||
(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))))))
|
||||
(eshell-info-banner--progress-bar-without-prefix bar-length used total t)))
|
||||
|
||||
(defun eshell-info-banner--display-memory (text-padding bar-length)
|
||||
"Display memories detected on your system.
|
||||
@@ -552,8 +608,9 @@ The usage of `eshell-info-banner-warning-percentage' and
|
||||
thought of as the “percentage of discharge” of the computer.
|
||||
Thus, setting the warning at 75% will be translated as showing
|
||||
the warning face with a battery level of 25% or less."
|
||||
(let ((battery-level (battery)))
|
||||
(if (or (string= battery-level "Battery status not available")
|
||||
(let ((battery-level (when (file-readable-p "/sys/") (battery))))
|
||||
(if (or (null battery-level)
|
||||
(string= battery-level "Battery status not available")
|
||||
(string-match-p (regexp-quote "N/A") battery-level))
|
||||
""
|
||||
(let ((percentage (save-match-data
|
||||
@@ -566,7 +623,7 @@ the warning face with a battery level of 25% or less."
|
||||
(eshell-info-banner--progress-bar bar-length
|
||||
percentage
|
||||
t)
|
||||
(s-repeat 17 " ")
|
||||
(s-repeat (if (equal eshell-info-banner-file-size-flavor 'iec) 21 17) " ")
|
||||
(format "(%3s%%)\n"
|
||||
(eshell-info-banner--with-face
|
||||
(number-to-string percentage)
|
||||
@@ -627,13 +684,27 @@ If RELEASE-FILE is nil, use '/etc/os-release'."
|
||||
"See `eshell-info-banner--get-os-information'."
|
||||
(let ((prefix (if eshell-info-banner-tramp-aware (file-remote-p default-directory) "")))
|
||||
`(,(cond
|
||||
((executable-find "hostnamectl" eshell-info-banner-tramp-aware)
|
||||
;; Bedrock Linux
|
||||
((file-exists-p (concat prefix "/bedrock/etc/bedrock-release"))
|
||||
(s-trim (with-temp-buffer
|
||||
(insert-file-contents (concat prefix "/bedrock/etc/bedrock-release"))
|
||||
(buffer-string))))
|
||||
;; Proxmox
|
||||
((eshell-info-banner--executable-find "pveversion")
|
||||
(let ((distro (eshell-info-banner--shell-command-to-string "pveversion")))
|
||||
(save-match-data
|
||||
(string-match "/\\([^/]+\\)/" distro)
|
||||
(concat "Proxmox "
|
||||
(substring-no-properties distro
|
||||
(match-beginning 1)
|
||||
(match-end 1))))))
|
||||
((eshell-info-banner--executable-find "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--get-os-information-from-lsb-release))
|
||||
((file-exists-p (concat prefix "/etc/os-release"))
|
||||
(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")))))
|
||||
(save-match-data
|
||||
(string-match "\\([0-9\\.]+\\)" distro)
|
||||
@@ -646,6 +717,10 @@ If RELEASE-FILE is nil, use '/etc/os-release'."
|
||||
(s-trim (with-temp-buffer
|
||||
(process-file "uname" nil t nil "-s")
|
||||
(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"))
|
||||
.
|
||||
,(s-trim (eshell-info-banner--shell-command-to-string "uname -rs")))))
|
||||
@@ -709,7 +784,10 @@ build number)."
|
||||
eshell-info-banner-width))
|
||||
(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))
|
||||
(format "%s: %s Kernel.: %s\n"
|
||||
(s-pad-right left-padding
|
||||
|
||||
Reference in New Issue
Block a user