@sebastienrousseau/dotfiles 0.2.468 → 0.2.469

package/dist/lib/functions/extract.sh

@@ -1,34 +1,86 @@
 #!/usr/bin/env bash
 
-# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.468) - <https://dotfiles.io>
-# Made with ♥ in London, UK by @wwdseb
-# Copyright (c) 2015-2024. All rights reserved
+################################################################################
+# 🅳🅾🆃🅵🅸🅻🅴🆂 - Archive Extractor (extract)
+# Made with ♥ by Sebastien Rousseau
 # License: MIT
+#
+# Description:
+#   extract is a function to extract most known archive formats with a single
+#   command. It supports various archive types like .tar, .zip, .gz, .7z, and more.
+#
+# Usage:
+#   extract [file]
+#   extract --help
+#
+# Arguments:
+#   file        The archive file to extract.
+#   --help      Displays this help menu and exits.
+#
+# Examples:
+#   extract file.tar.gz
+#       # Extracts the contents of file.tar.gz.
+#
+#   extract archive.zip
+#       # Extracts the contents of archive.zip.
+#
+#   extract --help
+#       # Displays the help menu.
+#
+################################################################################
 
-# extract: Function to extract most know archives with one command
+# Function to extract most known archive formats
 extract() {
-	if [[ "$#" != 1 ]]; then
-		echo "[ERROR] Please add one argument" >&2
-		return 1
-	fi
+  # Display help menu
+  if [[ "$1" == "--help" ]]; then
+    echo "extract: Archive Extractor"
+    echo
+    echo "Usage:"
+    echo "  extract [file]"
+    echo "  extract --help"
+    echo
+    echo "Arguments:"
+    echo "  file        The archive file to extract."
+    echo "  --help      Displays this help menu and exits."
+    echo
+    echo "Examples:"
+    echo "  extract file.tar.gz"
+    echo "      # Extracts the contents of file.tar.gz."
+    echo
+    echo "  extract archive.zip"
+    echo "      # Extracts the contents of archive.zip."
+    echo
+    echo "  extract --help"
+    echo "      # Displays the help menu."
+    echo
+    return 0
+  fi
 
-	if [[ -f "$1" ]]; then
-		echo "[INFO] Extracting $1"
-		case $1 in
-		*.tar.bz2) tar xjf "$1" ;;
-		*.tar.gz) tar xzf "$1" ;;
-		*.bz2) bunzip2 "$1" ;;
-		*.rar) unrar e "$1" ;;
-		*.gz) gunzip "$1" ;;
-		*.tar) tar xf "$1" ;;
-		*.tbz2) tar xjf "$1" ;;
-		*.tgz) tar xzf "$1" ;;
-		*.zip) unzip "$1" ;;
-		*.Z) uncompress "$1" ;;
-		*.7z) 7z x "$1" ;;
-		*) echo "[ERROR] '$1' cannot be extracted via extract()" ;;
-		esac
-	else
-		echo "[ERROR] '$1' is not a valid file"
-	fi
+  # Validate input
+  if [[ "$#" != 1 ]]; then
+    echo "[ERROR] Please provide one argument (the archive file to extract)." >&2
+    return 1
+  fi
+
+  # Check if the file exists
+  if [[ -f "$1" ]]; then
+    echo "[INFO] Extracting '$1'..."
+    case "$1" in
+      *.tar.bz2) tar xjf "$1" ;;
+      *.tar.gz)  tar xzf "$1" ;;
+      *.bz2)     bunzip2 "$1" ;;
+      *.rar)     unrar e "$1" ;;
+      *.gz)      gunzip "$1" ;;
+      *.tar)     tar xf "$1" ;;
+      *.tbz2)    tar xjf "$1" ;;
+      *.tgz)     tar xzf "$1" ;;
+      *.zip)     unzip "$1" ;;
+      *.Z)       uncompress "$1" ;;
+      *.7z)      7z x "$1" ;;
+      *)         echo "[ERROR] '$1' cannot be extracted via extract()." ;;
+    esac
+  else
+    echo "[ERROR] '$1' is not a valid file." >&2
+    return 1
+  fi
 }

package/dist/lib/functions/freespace.sh

@@ -1,21 +1,67 @@
 #!/usr/bin/env bash
 
-# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.468) - <https://dotfiles.io>
-# Made with ♥ in London, UK by @wwdseb
-# Copyright (c) 2015-2024. All rights reserved
+################################################################################
+# 🅳🅾🆃🅵🅸🅻🅴🆂 - Free Disk Space Cleaner (freespace)
+# Made with ♥ by Sebastien Rousseau
 # License: MIT
+#
+# Description:
+#   freespace is a utility function to securely erase purgeable disk space with
+#   zeros on the selected disk using the `diskutil secureErase freespace` command.
+#
+# Usage:
+#   freespace [disk]
+#   freespace --help
+#
+# Arguments:
+#   disk        The disk to clean purgeable space from (e.g., /dev/disk1s1).
+#   --help      Displays this help menu and exits.
+#
+# Examples:
+#   freespace /dev/disk1s1
+#       # Erases purgeable disk space with zeros on /dev/disk1s1.
+#
+#   freespace --help
+#       # Displays the help menu.
+#
+################################################################################
 
-# Erases purgeable disk space with 0s on the selected disk
 freespace() {
+  # Display help menu
+  if [[ "$1" == "--help" ]]; then
+    echo "freespace: Free Disk Space Cleaner"
+    echo
+    echo "Usage:"
+    echo "  freespace [disk]"
+    echo "  freespace --help"
+    echo
+    echo "Arguments:"
+    echo "  disk        The disk to clean purgeable space from (e.g., /dev/disk1s1)."
+    echo "  --help      Displays this help menu and exits."
+    echo
+    echo "Examples:"
+    echo "  freespace /dev/disk1s1"
+    echo "      # Erases purgeable disk space with zeros on /dev/disk1s1."
+    echo
+    echo "  freespace --help"
+    echo "      # Displays the help menu."
+    echo
+    echo "Available Disks:"
+    df -h | awk 'NR == 1 || /^\/dev\/disk/'
+    echo
+    return 0
+  fi
+
+  # Check if a disk argument is provided
   if [[ -z "$1" ]]; then
-    echo "Usage: $0 <disk>"
-    echo "Example: $0 /dev/disk1s1"
+    echo "[ERROR] No disk provided. Use 'freespace --help' for usage information."
     echo
-    echo "Possible disks:"
-    df -h | awk 'NR == 1 || /^\/dev\/disk/' || true
+    echo "Available Disks:"
+    df -h | awk 'NR == 1 || /^\/dev\/disk/'
     return 1
   fi
 
-  echo "Cleaning purgeable files from disk: $1 ...."
+  # Perform secure erase of free space on the selected disk
+  echo "[INFO] Cleaning purgeable files from disk: $1..."
   diskutil secureErase freespace 0 "$1"
 }

package/dist/lib/functions/genpwd.sh

@@ -1,41 +1,105 @@
 #!/usr/bin/env bash
 
-# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.468) - <https://dotfiles.io>
-# Made with ♥ in London, UK by @wwdseb
-# Copyright (c) 2015-2024. All rights reserved
+################################################################################
+# 🅳🅾🆃🅵🅸🅻🅴🆂 - Password Generator (genpwd)
+# Made with ♥ by Sebastien Rousseau
 # License: MIT
+#
+# Description:
+#   genpwd generates a strong random password with customizable length and
+#   separator. The user can specify the number of blocks and a separator
+#   character. Each block consists of 6 characters (5 alphanumeric + 1 special).
+#
+# Usage:
+#   genpwd [num_blocks] [separator]
+#
+# Arguments:
+#   num_blocks    Number of blocks of 6 characters to generate (default: 3).
+#   separator     Custom separator between blocks (default: '-').
+#
+# Examples:
+#   genpwd              # Generates a password with 3 blocks separated by '-'
+#   genpwd 5 /          # Generates a password with 5 blocks separated by '/'
+#   genpwd 6 :          # Generates a password with 6 blocks separated by ':'
+#
+# Clipboard Support:
+#   If a clipboard utility is available (pbcopy, xclip, wl-copy, or clip), the
+#   password will automatically be copied to the clipboard.
+#
+################################################################################
 
-# Function to generates a strong random password of 27 characters
-#!/usr/bin/env bash
-# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.468) - https://dotfiles.io
-# Made with ♥ in London, UK by @sebastienrousseau
-# Copyright (c) 2015-2024. All rights reserved
-# License: MIT
-
-# genpwd: Function to generates a strong random password of 20 characters (similar to Apple)
 genpwd() {
-  # Define the special characters
-  SPECIAL="!@#$%^&*()+=[]{};':,.?~"
+  # Display help menu
+  if [[ "$1" == "--help" ]]; then
+    echo "genpwd: Generate a strong random password with customizable length and separator"
+    echo
+    echo "Usage:"
+    echo "  genpwd [num_blocks] [separator]"
+    echo
+    echo "Arguments:"
+    echo "  num_blocks    Number of blocks of 6 characters to generate (default: 3)."
+    echo "  separator     Custom separator between blocks (default: '-')."
+    echo
+    echo "Examples:"
+    echo "  genpwd              # Generates a password with 3 blocks separated by '-'"
+    echo "  genpwd 5 /          # Generates a password with 5 blocks separated by '/'"
+    echo "  genpwd 6 :          # Generates a password with 6 blocks separated by ':'"
+    echo
+    echo "Clipboard Support:"
+    echo "  If a clipboard utility is available (pbcopy, xclip, wl-copy, or clip), the password will"
+    echo "  automatically be copied to the clipboard."
+    echo
+    return 0
+  fi
+
+  # Check for required tools
+  if ! command -v openssl &>/dev/null; then
+    echo "[ERROR] 'openssl' is required but not installed. Please install it and try again." >&2
+    return 1
+  fi
 
-  # Generate 3 random strings of length 8
-  m=$(openssl rand -base64 32 | tr -dc '[:alnum:]' | fold -w 8 | head -n 1 || true)
-  a=$(openssl rand -base64 32 | tr -dc '[:alnum:]' | fold -w 8 | head -n 1 || true)
-  c=$(openssl rand -base64 32 | tr -dc '[:alnum:]' | fold -w 8 | head -n 1 || true)
+  # Define the number of blocks (default: 3) and separator (default: '-')
+  local num_blocks="${1:-3}"        # Number of blocks
+  local separator="${2:--}"         # Separator between blocks
+  local SPECIAL="!@#$%^&*()+=[]{};':,.?~|<>€¥_"  # Special characters
 
-  # Choose random positions for the special characters
-  m_pos=$((RANDOM % 8))
-  a_pos=$((RANDOM % 8))
-  c_pos=$((RANDOM % 8))
+  # Generate a sufficiently long random alphanumeric base
+  local base_password=$(openssl rand -base64 128 | tr -dc '[:alnum:]')
 
-  # Choose a random special character from the list
-  special_char1="${SPECIAL:$((RANDOM % ${#SPECIAL})):1}"
-  special_char2="${SPECIAL:$((RANDOM % ${#SPECIAL})):1}"
-  special_char3="${SPECIAL:$((RANDOM % ${#SPECIAL})):1}"
+  # Initialize the password variable
+  local password=""
+  
+  # Build the password with the specified number of blocks
+  for ((i = 0; i < num_blocks; i++)); do
+    # Generate a random 6-character block with special characters
+    local block="${base_password:$((i * 6)):5}${SPECIAL:$((RANDOM % ${#SPECIAL})):1}"
+    
+    # Append the block to the password
+    if [[ -n "$password" ]]; then
+      password+="${separator}"
+    fi
+    password+="${block}"
+  done
 
-  # Combine the strings with the special character to form the password
-  pwd="${m:0:${m_pos}}${special_char1}${m:${m_pos}}-${a:0:${a_pos}}${special_char2}${a:${a_pos}}-${c:0:${c_pos}}${special_char3}${c:${c_pos}}"
+  # Output the password
+  echo "[INFO] Generated password: ${password}"
 
-  echo "[INFO] The password has been copied to the clipboard: ${pwd}"
-  echo "${pwd}" | pbcopy | pbpaste || true
+  # Copy to clipboard if possible
+  if command -v pbcopy &>/dev/null; then
+    echo -n "${password}" | pbcopy
+    echo "[INFO] Password copied to clipboard (macOS)."
+  elif command -v xclip &>/dev/null; then
+    echo -n "${password}" | xclip -selection clipboard
+    echo "[INFO] Password copied to clipboard (Linux)."
+  elif command -v wl-copy &>/dev/null; then
+    echo -n "${password}" | wl-copy
+    echo "[INFO] Password copied to clipboard (Linux with Wayland)."
+  elif command -v clip &>/dev/null; then
+    echo -n "${password}" | clip
+    echo "[INFO] Password copied to clipboard (Windows)."
+  else
+    echo "[WARNING] Clipboard tool not found. Password not copied to clipboard."
+  fi
 
+  return 0
 }

package/dist/lib/functions/goto.sh

@@ -1,16 +1,67 @@
 #!/usr/bin/env bash
 
-# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.468) - <https://dotfiles.io>
-# Made with ♥ in London, UK by @wwdseb
-# Copyright (c) 2015-2024. All rights reserved
+################################################################################
+# 🅳🅾🆃🅵🅸🅻🅴🆂 - Change Directory Helper (goto)
+# Made with ♥ by Sebastien Rousseau
 # License: MIT
+#
+# Description:
+#   goto is a utility function to quickly navigate to a specified directory.
+#   It changes to the given directory and lists its contents.
+#
+# Usage:
+#   goto [directory]
+#   goto --help
+#
+# Arguments:
+#   directory    The directory to navigate to.
+#   --help       Displays this help menu and exits.
+#
+# Examples:
+#   goto /tmp
+#       # Changes to the /tmp directory and lists its contents.
+#
+#   goto --help
+#       # Displays the help menu.
+#
+################################################################################
 
-# goto: Function to change to the directory inputed
+# Function to change to the specified directory and list its contents
 goto() {
-  if [[ -e "$1" ]]; then
-    cd "$1" || exit
-    l
+  # Display help menu
+  if [[ "$1" == "--help" ]]; then
+    echo "goto: Change Directory Helper"
+    echo
+    echo "Usage:"
+    echo "  goto [directory]"
+    echo "  goto --help"
+    echo
+    echo "Arguments:"
+    echo "  directory    The directory to navigate to."
+    echo "  --help       Displays this help menu and exits."
+    echo
+    echo "Examples:"
+    echo "  goto /tmp"
+    echo "      # Changes to the /tmp directory and lists its contents."
+    echo
+    echo "  goto --help"
+    echo "      # Displays the help menu."
+    echo
+    return 0
+  fi
+
+  # Check if a directory is provided
+  if [[ -z "$1" ]]; then
+    echo "[ERROR] No directory provided. Use 'goto --help' for usage information." >&2
+    return 1
+  fi
+
+  # Check if the directory exists
+  if [[ -d "$1" ]]; then
+    cd "$1" || return
+    ls -lh --group-directories-first
   else
-    echo "[ERROR] Please add a directory name" >&2
+    echo "[ERROR] '$1' is not a valid directory." >&2
+    return 1
   fi
 }

package/dist/lib/functions/hexdump.sh

@@ -0,0 +1,96 @@
+#!/usr/bin/env bash
+
+################################################################################
+# 🅳🅾🆃🅵🅸🅻🅴🆂 - Hex Dump Viewer (hexdump)
+# Made with ♥ by Sebastien Rousseau
+# License: MIT
+#
+# Description:
+#   hexdump is a utility function to display the contents of a file in a
+#   hex dump format. By default, it shows the entire file unless a line limit
+#   is specified.
+#
+# Usage:
+#   hexdump [file] [lines]
+#   hexdump --all
+#   hexdump --help
+#
+# Arguments:
+#   file        The file to display in hex dump format.
+#   lines       The number of lines to display (optional, default: all lines).
+#   --all       Displays the entire file in hex dump format.
+#   --help      Displays this help menu and exits.
+#
+# Examples:
+#   hexdump example.txt
+#       # Displays the entire file 'example.txt' in hex dump format.
+#
+#   hexdump example.txt 20
+#       # Displays the first 20 lines of the file 'example.txt' in hex dump format.
+#
+#   hexdump --help
+#       # Displays the help menu.
+#
+################################################################################
+
+hexdump() {
+  # Display help menu
+  if [[ "$1" == "--help" ]]; then
+    echo "hexdump: Hex Dump Viewer"
+    echo
+    echo "Usage:"
+    echo "  hexdump [file] [lines]"
+    echo "  hexdump --all"
+    echo "  hexdump --help"
+    echo
+    echo "Arguments:"
+    echo "  file        The file to display in hex dump format."
+    echo "  lines       The number of lines to display (optional, default: all lines)."
+    echo "  --all       Displays the entire file in hex dump format."
+    echo "  --help      Displays this help menu and exits."
+    echo
+    echo "Examples:"
+    echo "  hexdump example.txt"
+    echo "      # Displays the entire file 'example.txt' in hex dump format."
+    echo
+    echo "  hexdump example.txt 20"
+    echo "      # Displays the first 20 lines of the file 'example.txt' in hex dump format."
+    echo
+    echo "  hexdump --help"
+    echo "      # Displays the help menu."
+    echo
+    return 0
+  fi
+
+  # Check if no arguments are provided
+  if [[ -z "$1" ]]; then
+    echo "[ERROR] No file provided. Use 'hexdump --help' for usage information." >&2
+    return 1
+  fi
+
+  # Handle --all option
+  if [[ "$1" == "--all" ]]; then
+    echo "[ERROR] '--all' requires a file argument. Use 'hexdump file.txt' instead." >&2
+    return 1
+  fi
+
+  # Check if the file exists
+  if [[ ! -f "$1" ]]; then
+    echo "[ERROR] '$1' is not a valid file." >&2
+    return 1
+  fi
+
+  # Detect file type
+  echo "[INFO] File type: $(file "$1")"
+
+  # Display hex dump
+  if [[ -z "$2" || "$2" == "--all" ]]; then
+    # Show the entire file if no line limit or --all is specified
+    echo "[INFO] Showing full file in hex dump format:"
+    /usr/bin/xxd -u -g 1 "$1"
+  else
+    # Limit output to the specified number of lines
+    echo "[INFO] Showing first $2 lines in hex dump format:"
+    /usr/bin/xxd -u -g 1 "$1" | /usr/bin/head -n "$2"
+  fi
+}

package/dist/lib/functions/hiddenfiles.sh

@@ -0,0 +1,77 @@
+#!/usr/bin/env bash
+
+################################################################################
+# 🅳🅾🆃🅵🅸🅻🅴🆂 - Hidden Files Visibility Toggle (hiddenfiles)
+# Made with ♥ by Sebastien Rousseau
+# License: MIT
+#
+# Description:
+#   hiddenfiles is a utility function to toggle the visibility of hidden files
+#   and system files in the Finder on macOS. By default, it hides hidden files.
+#
+# Usage:
+#   hiddenfiles [show|hide]
+#   hiddenfiles --help
+#
+# Arguments:
+#   show        Show hidden files and system files in Finder.
+#   hide        Hide hidden files and system files in Finder (default behavior).
+#   --help      Displays this help menu and exits.
+#
+# Examples:
+#   hiddenfiles hide
+#       # Hides hidden files and system files in Finder.
+#
+#   hiddenfiles show
+#       # Shows hidden files and system files in Finder.
+#
+#   hiddenfiles --help
+#       # Displays the help menu.
+#
+################################################################################
+
+hiddenfiles() {
+  # Display help menu
+  if [[ "$1" == "--help" ]]; then
+    echo "hiddenfiles: Hidden Files Visibility Toggle"
+    echo
+    echo "Usage:"
+    echo "  hiddenfiles [show|hide]"
+    echo "  hiddenfiles --help"
+    echo
+    echo "Arguments:"
+    echo "  show        Show hidden files and system files in Finder."
+    echo "  hide        Hide hidden files and system files in Finder (default behavior)."
+    echo "  --help      Displays this help menu and exits."
+    echo
+    echo "Examples:"
+    echo "  hiddenfiles hide"
+    echo "      # Hides hidden files and system files in Finder."
+    echo
+    echo "  hiddenfiles show"
+    echo "      # Shows hidden files and system files in Finder."
+    echo
+    return 0
+  fi
+
+  # Set default action to 'hide' if no argument is provided
+  local action="${1:-hide}"
+
+  if [[ "$action" == "hide" ]]; then
+    echo "[INFO] Hiding hidden files and system files in Finder..."
+    defaults write com.apple.Finder AppleShowAllFiles NO
+  elif [[ "$action" == "show" ]]; then
+    echo "[INFO] Showing hidden files and system files in Finder..."
+    defaults write com.apple.Finder AppleShowAllFiles YES
+  else
+    echo "[ERROR] Invalid argument: '$1'. Use 'hiddenfiles --help' for usage information." >&2
+    return 1
+  fi
+
+  # Restart Finder to apply changes
+  osascript -e 'tell application "Finder" to quit'
+  sleep 0.25
+  osascript -e 'tell application "Finder" to activate'
+
+  echo "[INFO] Finder settings updated successfully."
+}