@sebastienrousseau/dotfiles 0.2.468 → 0.2.469

package/dist/lib/functions/hostinfo.sh

@@ -1,27 +1,98 @@
 #!/usr/bin/env bash
 
-# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.468) - <https://dotfiles.io>
-# Made with ♥ in London, UK by @wwdseb
-# Copyright (c) 2015-2024. All rights reserved
+################################################################################
+# 🅳🅾🆃🅵🅸🅻🅴🆂 - Host Information Viewer (hostinfo)
+# Made with ♥ by Sebastien Rousseau
 # License: MIT
+#
+# Description:
+#   hostinfo is a utility function to display detailed information about the
+#   current host in a structured table format. This includes system stats,
+#   network configuration, and public-facing IP address.
+#
+# Usage:
+#   hostinfo
+#   hostinfo --help
+#
+# Arguments:
+#   --help      Displays this help menu and exits.
+#
+# Examples:
+#   hostinfo
+#       # Displays detailed host information in a table format.
+#
+#   hostinfo --help
+#       # Displays the help menu.
+#
+################################################################################
 
-# hostinfo: Function to display useful host related informaton
 hostinfo() {
-	echo "You are logged on"
-	$HOST
-	echo "Additionnal information: "
-	uname -a
-	echo "Users logged on: "
-	w -h
-	echo "Current date : "
-	date
-	echo "Machine stats : "
-	uptime
-	echo "Current network location : "
-	scselect
-	echo "Public facing IP Address : "
-	myip
-	echo "DNS Configuration: "
-	scutil --dns
-	echo
+  # Display help menu
+  if [[ "$1" == "--help" ]]; then
+    echo "hostinfo: Host Information Viewer"
+    echo
+    echo "Usage:"
+    echo "  hostinfo"
+    echo "  hostinfo --help"
+    echo
+    echo "Arguments:"
+    echo "  --help      Displays this help menu and exits."
+    echo
+    echo "Examples:"
+    echo "  hostinfo"
+    echo "      # Displays detailed host information in a table format."
+    echo
+    echo "  hostinfo --help"
+    echo "      # Displays the help menu."
+    echo
+    return 0
+  fi
+
+  # Fetch host information
+  local username
+  local hostname
+  local system_info
+  local users_logged_on
+  local current_date
+  local machine_stats
+  local network_location="Not available"
+  local public_ip="Not available"
+  local dns_config="Not available"
+
+  username=$(whoami)
+  hostname=$(hostname)
+  system_info=$(uname -a)
+  users_logged_on=$(w -h | awk '{print $1}' | sort | uniq | paste -sd ", " -)
+  current_date=$(date)
+  machine_stats=$(uptime | sed 's/^ *//')
+
+  # Check if scselect is available (macOS specific)
+  if command -v scselect &>/dev/null; then
+    network_location=$(scselect | grep '^ *\*' | sed 's/^ *\* //')
+  fi
+
+  # Fetch public IP address using a reliable service
+  if command -v curl &>/dev/null; then
+    public_ip=$(curl -s https://api.ipify.org || echo "Not available")
+  elif command -v wget &>/dev/null; then
+    public_ip=$(wget -qO- https://api.ipify.org || echo "Not available")
+  fi
+
+  # Fetch DNS configuration (macOS specific)
+  if command -v scutil &>/dev/null; then
+    dns_config=$(scutil --dns | awk '/nameserver/ {print $3}' | paste -sd ", " -)
+  fi
+
+  # Display information in a table format
+  echo "====================================="
+  printf "%-25s : %s\n" "Username" "$username"
+  printf "%-25s : %s\n" "Hostname" "$hostname"
+  printf "%-25s : %s\n" "System Information" "$system_info"
+  printf "%-25s : %s\n" "Users Logged On" "${users_logged_on:-None}"
+  printf "%-25s : %s\n" "Current Date" "$current_date"
+  printf "%-25s : %s\n" "Machine Stats" "$machine_stats"
+  printf "%-25s : %s\n" "Network Location" "$network_location"
+  printf "%-25s : %s\n" "Public IP Address" "$public_ip"
+  printf "%-25s : %s\n" "DNS Servers" "${dns_config:-None}"
+  echo "====================================="
 }

package/dist/lib/functions/hstats.sh

@@ -1,11 +1,75 @@
 #!/usr/bin/env bash
 
-# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.468) - <https://dotfiles.io>
-# Made with ♥ in London, UK by @wwdseb
-# Copyright (c) 2015-2024. All rights reserved
+################################################################################
+# 🅳🅾🆃🅵🅸🅻🅴🆂 - History Statistics Viewer (hstats)
+# Made with ♥ by Sebastien Rousseau
 # License: MIT
+#
+# Description:
+#   hstats is a utility function to display statistics about the most commonly
+#   used commands from the shell history. It shows the top 20 commands along
+#   with their usage count and the full command.
+#
+# Usage:
+#   hstats
+#   hstats --help
+#
+# Arguments:
+#   --help      Displays this help menu and exits.
+#
+# Examples:
+#   hstats
+#       # Displays the top 20 most commonly used commands from shell history.
+#
+#   hstats --help
+#       # Displays the help menu.
+#
+################################################################################
 
-# hstats: Function to display Ze Shell history stats informaton
 hstats() {
-  history | awk '{CMD[$2]++;count++;}END { for (a in CMD)print CMD[a] " " CMD[a]/count*100 "% " a;}' | grep -v "./" | column -c3 -s " " -t | sort -nr | nl | head -n20
+  # Display help menu
+  if [[ "$1" == "--help" ]]; then
+    echo "hstats: History Statistics Viewer"
+    echo
+    echo "Usage:"
+    echo "  hstats"
+    echo "  hstats --help"
+    echo
+    echo "Arguments:"
+    echo "  --help      Displays this help menu and exits."
+    echo
+    echo "Examples:"
+    echo "  hstats"
+    echo "      # Displays the top 20 most commonly used commands from shell history."
+    echo
+    echo "  hstats --help"
+    echo "      # Displays the help menu."
+    echo
+    return 0
+  fi
+
+  # Ensure the history command is available
+  if ! command -v history &>/dev/null; then
+    echo "[ERROR] 'history' command is not available in this shell." >&2
+    return 1
+  fi
+
+  # Extract only the commands from history, removing timestamps or extra metadata
+  if [[ "$SHELL" =~ "zsh" ]]; then
+    # For zsh, use `fc -l` to get clean commands
+    history_output=$(fc -l 1 | awk '{$1=""; print $0}')
+  else
+    # For bash, use `history` directly
+    history_output=$(history | awk '{$1=""; print $0}')
+  fi
+
+  # Generate statistics
+  echo "============================================"
+  echo "Commonly Used Commands"
+  echo "============================================"
+  echo "$history_output" | awk '{CMD[$1]++; count++;} END {for (a in CMD) printf "%-15s %s\n", CMD[a], a;}' \
+    | sort -nr \
+    | head -n20 \
+    | nl
+  echo "============================================"
 }

package/dist/lib/functions/httpdebug.sh

@@ -1,9 +1,113 @@
 #!/usr/bin/env bash
 
-# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.468) - <https://dotfiles.io>
-# Made with ♥ in London, UK by @wwdseb
-# Copyright (c) 2015-2024. All rights reserved
+################################################################################
+# 🅳🅾🆃🅵🅸🅻🅴🆂 - HTTP Debugging Utility (httpdebug)
+# Made with ♥ by Sebastien Rousseau
 # License: MIT
+#
+# Description:
+#   httpdebug is a utility function to debug HTTP requests by measuring the
+#   timing of various stages of the request process in milliseconds. This
+#   includes DNS lookup, connection establishment, SSL handshake, and total
+#   request time. It also provides details like the server IP address.
+#
+# Usage:
+#   httpdebug [options] [url]
+#   httpdebug --help
+#
+# Arguments:
+#   options     Additional curl options (optional).
+#   url         The URL to debug.
+#   --help      Displays this help menu and exits.
+#
+# Examples:
+#   httpdebug https://example.com
+#       # Debugs the HTTP request to https://example.com and displays timing info.
+#
+#   httpdebug -v https://example.com
+#       # Debugs the HTTP request with verbose output from curl.
+#
+#   httpdebug --help
+#       # Displays the help menu.
+#
+################################################################################
+
+httpdebug() {
+  # Display help menu
+  if [[ "$1" == "--help" ]]; then
+    echo "httpdebug: HTTP Debugging Utility"
+    echo
+    echo "Usage:"
+    echo "  httpdebug [options] [url]"
+    echo "  httpdebug --help"
+    echo
+    echo "Arguments:"
+    echo "  options     Additional curl options (optional)."
+    echo "  url         The URL to debug."
+    echo "  --help      Displays this help menu and exits."
+    echo
+    echo "Examples:"
+    echo "  httpdebug https://example.com"
+    echo "      # Debugs the HTTP request to https://example.com and displays timing info."
+    echo
+    echo "  httpdebug -v https://example.com"
+    echo "      # Debugs the HTTP request with verbose output from curl."
+    echo
+    echo "  httpdebug --help"
+    echo "      # Displays the help menu."
+    echo
+    return 0
+  fi
+
+  # Ensure curl is available
+  if ! command -v curl &>/dev/null; then
+    echo "[ERROR] 'curl' command is required but not installed. Please install it and try again." >&2
+    return 1
+  fi
+
+  # Check if a URL or options are provided
+  if [[ -z "$1" ]]; then
+    echo "[ERROR] No URL provided. Use 'httpdebug --help' for usage information." >&2
+    return 1
+  fi
+
+  # Perform HTTP request and measure timing
+  echo "[INFO] Debugging HTTP request to: ${*}"
+  curl_output=$(/usr/bin/curl "$@" -o /dev/null -s -w "\
+IP Address: %{remote_ip}\n\
+DNS Lookup: %{time_namelookup}\n\
+TCP Connection: %{time_connect}\n\
+SSL Handshake: %{time_appconnect}\n\
+Server Processing: %{time_pretransfer}\n\
+Time to First Byte: %{time_starttransfer}\n\
+Total Time: %{time_total}\n")
+
+  # Display results in a clean table format
+  printf "%-25s %-25s %-45s\n" "Metric" "Details" "Description"
+  printf "%-25s %-25s %-45s\n" "------------------------" "------------------------" "---------------------------------------------"
+
+  echo "$curl_output" | while IFS= read -r line; do
+    metric=$(echo "$line" | awk -F: '{print $1}')
+    value=$(echo "$line" | awk -F: '{print $2}' | xargs)
+    description=""
+
+    case "$metric" in
+      "IP Address") description="IP address of the server" ;;
+      "DNS Lookup") description="Time to resolve the domain name to an IP address" ;;
+      "TCP Connection") description="Time to establish a TCP connection to the server" ;;
+      "SSL Handshake") description="Time to complete the SSL/TLS handshake (if applicable)" ;;
+      "Server Processing") description="Time from connection to server readiness to transfer data" ;;
+      "Time to First Byte") description="Time until the first byte of the response is received" ;;
+      "Total Time") description="Total time for the request, including all stages" ;;
+    esac
+
+    if [[ "$metric" == "IP Address" ]]; then
+      printf "%-25s %-25s %-45s\n" "$metric" "$value" "$description"
+    else
+      # Convert time values to milliseconds for consistency
+      time_in_milliseconds=$(awk "BEGIN {printf \"%.2f\", $value * 1000}")
+      printf "%-25s %-25s %-45s\n" "$metric" "$time_in_milliseconds ms" "$description"
+    fi
+  done
+}
 
-# httpdebug: Function to download a web page and show info on what took time
-httpdebug() { /usr/bin/curl "$@" -o /dev/null -w "dns: %{time_namelookup} connect: %{time_connect} pretransfer: %{time_pretransfer} starttransfer: %{time_starttransfer} total: %{time_total}\\n"; }

package/dist/lib/functions/kebabcase.sh

@@ -0,0 +1,61 @@
+#!/usr/bin/env bash
+
+################################################################################
+# 🅳🅾🆃🅵🅸🅻🅴🆂 - Cross-Platform Kebabcase Utility (kebabcase)
+# Made with ♥ by Sebastien Rousseau
+# License: MIT
+#
+# Description:
+#   kebabcase converts file or directory names to kebab-case. All letters
+#   are lowercase and spaces or other non-alphanumeric characters are replaced
+#   by hyphens.
+#
+# Usage:
+#   kebabcase <file_or_directory> [<file_or_directory> ...]
+#
+# Arguments:
+#   <file_or_directory>     One or more file or directory paths to rename
+#                           to kebab-case.
+#
+# Notes:
+#   - Already kebab-case files are skipped.
+#   - Non-existent paths will produce an error message.
+#   - Special characters (other than alphanumeric and '.') are replaced
+#     with hyphens.
+#
+################################################################################
+
+kebabcase() {
+  if [[ "$#" -lt 1 ]]; then
+    echo "[ERROR] Please provide at least one file or directory to convert to kebab-case." >&2
+    return 1
+  fi
+
+  for file in "$@"; do
+    if [[ ! -e "$file" ]]; then
+      echo "[ERROR] The file or directory '$file' does not exist." >&2
+      continue
+    fi
+
+    dirname=$(dirname "$file")
+    filename=$(basename "$file")
+
+    # Convert to lowercase and replace non-alphanumeric chars (except '.') with hyphens
+    kc_filename=$(printf "%s" "$filename" \
+      | tr '[:upper:]' '[:lower:]' \
+      | sed 's/[^[:alnum:].]/-/g')
+
+    # If already kebab-case, skip
+    if [[ "$filename" == "$kc_filename" ]]; then
+      echo "[INFO] '$file' is already in kebab-case."
+      continue
+    fi
+
+    newname="${dirname}/${kc_filename}"
+    if mv "$file" "$newname"; then
+      echo "[INFO] Renamed '$file' to '$newname'."
+    else
+      echo "[ERROR] Failed to rename '$file'." >&2
+    fi
+  done
+}

package/dist/lib/functions/keygen.sh

@@ -1,31 +1,194 @@
 #!/usr/bin/env bash
 
-# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.468) - <https://dotfiles.io>
-# Made with ♥ in London, UK by @wwdseb
-# Copyright (c) 2015-2024. All rights reserved
+################################################################################
+# 🅳🅾🆃🅵🅸🅻🅴🆂 - SSH Key Generator (keygen)
+# Made with ♥ by Sebastien Rousseau
 # License: MIT
+#
+# Description:
+#   keygen is a utility function to generate high-quality SSH key pairs with
+#   strong encryption and entropy. Supports ed25519, RSA, ECDSA, and DSA keys
+#   with configurable key lengths.
+#
+# Usage:
+#   keygen [name] [email] [type] [bits]
+#   keygen --help
+#
+# Arguments:
+#   name        The name for the SSH key (e.g., username, service name)
+#   email       The email address associated with the key
+#   type        Key type (ed25519, rsa, ecdsa, dsa). Default: ed25519
+#   bits        Key length in bits (RSA: 2048-8192, ECDSA: 256/384/521)
+#   --help      Displays this help menu and exits
+#
+################################################################################
+
+log_info() {
+  echo "[INFO] $*"
+}
+
+log_warning() {
+  echo "[WARNING] $*" >&2
+}
+
+log_error() {
+  echo "[ERROR] $*" >&2
+  exit 1
+}
 
-# keygen: Function to generates SSH key
 keygen() {
-	if [[ $# -eq 0 ]]; then
-		echo "What's the name of the Key (no space please)? "
-		read -r name
-		echo "What's the email associated with it? "
-		read -r email
-	elif [[ $# -eq 1 ]]; then
-		name="$1"
-		echo "What's the email associated with the key? "
-		read -r email
-	elif [[ $# -eq 2 ]]; then
-		name="$1"
-		email="$2"
-	else
-		echo "Usage: keygen [name] [email]"
-		return 1
-	fi
-
-	ssh-keygen -t rsa -f ~/.ssh/id_rsa_"${name}" -C "${email}"
-	ssh-add ~/.ssh/id_rsa_"${name}"
-	pbcopy <~/.ssh/id_rsa_"${name}".pub
-	echo "[INFO] SSH Key id_rsa_${name}.pub copied in your clipboard"
+  # Display help menu
+  if [[ "$1" == "--help" ]]; then
+    cat << 'EOH'
+SSH Key Generator (keygen)
+
+Description:
+  keygen is a utility function to generate high-quality SSH key pairs with
+  strong encryption and entropy. Supports ed25519, RSA, ECDSA, and DSA keys
+  with configurable key lengths.
+
+Usage:
+  keygen [name] [email] [type] [bits]
+  keygen --help
+
+Arguments:
+  name        The name for the SSH key (e.g., username, service name).
+              This name is used to create a unique file path for the key.
+  email       The email address associated with the key.
+  type        Key type (ed25519, rsa, ecdsa, dsa). Default: ed25519.
+  bits        Key length in bits:
+             - RSA:   2048-8192 bits (default: 4096).
+             - ECDSA: 256, 384, or 521 bits (default: 256).
+             - DSA:   1024, 2048, or 3072 bits (default: 3072).
+             - ED25519: Fixed length.
+  --help      Displays this help menu and exits.
+
+Examples:
+  keygen
+      # Interactive mode with prompts.
+
+  keygen mykey myemail@example.com
+      # Generates an ed25519 key pair named 'mykey'.
+
+  keygen mykey myemail@example.com rsa 4096
+      # Generates a 4096-bit RSA key pair named 'mykey'.
+
+  keygen mykey myemail@example.com ecdsa 256
+      # Generates a 256-bit ECDSA key pair named 'mykey'.
+
+  keygen mykey myemail@example.com dsa 1024
+      # Generates a 1024-bit DSA key pair named 'mykey'.
+
+Notes:
+  - Keys are stored in ~/.ssh with the specified name.
+  - Public keys are copied to the clipboard for convenience.
+  - The private key is never exposed; keep it secure.
+
+EOH
+    return 0
+  fi
+
+  # Ensure ~/.ssh directory exists
+  mkdir -p -m 700 ~/.ssh || log_error "Failed to create ~/.ssh directory."
+
+  # Collect inputs
+  local name email key_type key_bits
+  if [[ $# -eq 0 ]]; then
+    echo "Enter a unique name for the SSH key (e.g., 'myserver' or 'username'):"
+    read -r name
+    echo "Enter an email address associated with the key:"
+    read -r email
+    echo "Enter key type (ed25519, rsa, ecdsa, dsa) [default: ed25519]:"
+    read -r key_type
+    key_type="${key_type:-ed25519}"
+
+    if [[ "${key_type}" != "ed25519" ]]; then
+      case "${key_type}" in
+        "rsa") echo "Enter RSA key length (2048-8192) [default: 4096]:" && read -r key_bits ;;
+        "ecdsa") echo "Enter ECDSA key length (256/384/521) [default: 256]:" && read -r key_bits ;;
+        "dsa") echo "Enter DSA key length (1024/2048/3072) [default: 3072]:" && read -r key_bits ;;
+        *) log_error "Invalid key type: ${key_type}" ;;
+      esac
+    fi
+  elif [[ $# -ge 2 ]]; then
+    name="$1"
+    email="$2"
+    key_type="${3:-ed25519}"
+    key_bits="$4"
+  else
+    log_error "Usage: keygen [name] [email] [type] [bits] or keygen --help"
+  fi
+
+  # Validate inputs
+  [[ ! "${name}" =~ ^[a-zA-Z0-9_-]+$ ]] && log_error "Invalid name format. Only alphanumeric, _, and - are allowed."
+  [[ ! "${email}" =~ ^[^@]+@[^@]+\.[^@]+$ ]] && log_error "Invalid email format."
+
+  # Key validation
+  key_type="${key_type:-ed25519}"
+  case "${key_type}" in
+    "ed25519") ;;
+    "rsa")
+      key_bits="${key_bits:-4096}"
+      [[ ! "${key_bits}" =~ ^[0-9]+$ ]] && log_error "RSA key length must be a number."
+      [[ "${key_bits}" -lt 2048 || "${key_bits}" -gt 8192 ]] && log_error "RSA key length must be between 2048 and 8192 bits."
+      ;;
+    "ecdsa")
+      key_bits="${key_bits:-256}"
+      [[ ! "${key_bits}" =~ ^(256|384|521)$ ]] && log_error "ECDSA key length must be 256, 384, or 521 bits."
+      ;;
+    "dsa")
+      key_bits="${key_bits:-3072}"
+      [[ ! "${key_bits}" =~ ^(1024|2048|3072)$ ]] && log_error "DSA key length must be 1024, 2048, or 3072 bits."
+      ;;
+    *) log_error "Invalid key type: ${key_type}. Use 'ed25519', 'rsa', 'ecdsa', or 'dsa'." ;;
+  esac
+
+  # Set file paths
+  local key_path="${HOME}/.ssh/id_${key_type}_${name}"
+
+  # Generate key pair
+  log_info "Generating ${key_type} SSH key named '${name}'..."
+  if [[ "${key_type}" == "ed25519" ]]; then
+    ssh-keygen -t ed25519 -f "${key_path}" -C "${email}"
+  else
+    ssh-keygen -t "${key_type}" -b "${key_bits}" -f "${key_path}" -C "${email}"
+  fi
+
+  # Set permissions
+  chmod 600 "${key_path}" && chmod 644 "${key_path}.pub"
+
+  # Add to SSH agent
+  if ! ssh-add "${key_path}" &>/dev/null; then
+    log_warning "SSH agent not running. Start it and run 'ssh-add ${key_path}'."
+  fi
+
+  # Copy to clipboard
+  copy_to_clipboard "${key_path}.pub"
+
+  # Display success message
+  log_info "SSH key successfully generated!"
+  echo "  Private key: ${key_path}"
+  echo "  Public key: ${key_path}.pub"
+
+  # Display fingerprint
+  ssh-keygen -l -f "${key_path}.pub"
+}
+
+copy_to_clipboard() {
+  local pub_key_file="$1"
+  if command -v pbcopy &>/dev/null; then
+    pbcopy < "${pub_key_file}"
+    log_info "Public key copied to clipboard (macOS)."
+  elif command -v xclip &>/dev/null; then
+    xclip -selection clipboard < "${pub_key_file}"
+    log_info "Public key copied to clipboard (Linux)."
+  elif command -v wl-copy &>/dev/null; then
+    wl-copy < "${pub_key_file}"
+    log_info "Public key copied to clipboard (Wayland)."
+  elif command -v clip.exe &>/dev/null; then
+    clip.exe < "${pub_key_file}"
+    log_info "Public key copied to clipboard (Windows)."
+  else
+    log_warning "Clipboard tool not available. Public key not copied."
+  fi
 }