From df5a22d9b5510c71f282bc6acda1f0d2977468d5 Mon Sep 17 00:00:00 2001 From: Sohrab Behdani Date: Sun, 17 Nov 2024 14:55:02 +0330 Subject: [PATCH] added changelog --- CHANGELOG.md | 91 ++++++++++++++++++++++++++++++++++++++++++++++++++++ PKGBUILD | 2 +- 2 files changed, 92 insertions(+), 1 deletion(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..bf5cbb3 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,91 @@ + +### **๐Ÿ“ Changelog for Alias File Revision** +#### **Version: Updated Alias File (Current Date: 2024-11-17)** + +--- + +### **โœจ Added** +- **๐Ÿ“ File and Directory Management:** + - `..`, `...`, `....`: Navigate up one, two, or three directories. + - `back`: Go back to the last directory. + - `la`: List all files (excluding `.` and `..`) with human-readable sizes. + - `lsd`: List only directories. + +- **๐ŸŒŸ Git Shortcuts for Productivity:** + - `gs`: Git status. + - `ga`: Git add. + - `gc`: Git commit with a message. + - `gl`: Pretty Git log (graph format). + +- **๐Ÿ–ฅ๏ธ System Monitoring & Management:** + - `dfh`: Disk usage in human-readable format. + - `duh`: Folder sizes in human-readable format. + - `journal`: View critical system logs. + - `meminfo`: View memory usage in MB. + - `cpuinfo`: Show CPU information. + +- **โš™๏ธ Configuration Shortcuts:** + - `bashrc`, `zshrc`, `vimrc`, `profile`: Quickly edit configuration files. + - `reload`: Reload `.zshrc` file without restarting the shell. + +- **๐Ÿ’ก Quality of Life Improvements:** + - `cls`: Clear the terminal screen. + - `now`: Show the current date and time. + - `cwd`: Copy the current working directory to the clipboard. + - Fun shortcuts like `shrug` (ยฏ\\\_(ใƒ„)\_/ยฏ), `lenny` ( อกยฐ อœส– อกยฐ), `flip` (โ•ฏยฐโ–กยฐ๏ผ‰โ•ฏ๏ธต โ”ปโ”โ”ป, and `unflip` โ”ฌโ”€โ”ฌ ใƒŽ( ใ‚œ-ใ‚œใƒŽ). + +--- + +### **โŒ Removed** +- **โš ๏ธ Dangerous or Redundant Aliases:** + - **`del`**: `alias del='mv -t ~/.local/share/Trash'` + - ๐Ÿ”’ **Reason**: Risk of unintended file deletion by masking commands. Use dedicated trash utilities like `trash-cli` instead. + - **`cleanup`**: `alias cleanup="paru -Rns $(paru -Qtdq) && paru -Sc"` + - ๐Ÿšจ **Reason**: Automatically removing orphaned packages and cache without review is unsafe. Run `paru -Qtdq` manually for review instead. + - **`flushdns`**: `alias flushdns="sudo systemctl restart systemd-resolved"` + - โŒ **Reason**: This is specific to `systemd-resolved` and may not apply to all systems. Avoid aliases dependent on a single environment. + - **`timer`**: A long-running alias that could confuse users: + ```zsh + alias timer="echo 'Timer started. Stop with Ctrl+C.' && date +%s && while true; do sleep 1; done" + ``` + - ๐Ÿ›‘ **Reason**: Infinite loops can cause confusion. Use a script or dedicated timer tool instead. + +- **๐Ÿคช Fun Aliases Removed:** + - **`party`:** A whimsical alias with no functional use. + - **Reason**: Focus on meaningful and productive aliases. + +--- + +### **๐Ÿ”„ Changed** +- **๐Ÿš€ System-Specific or Unsafe Aliases Adjusted:** + - **`rm` command is now safer (not included directly in aliases):** + - Suggest replacing `rm` with a custom safeguard function (`safe_rm`) to block dangerous commands like `sudo rm -rf /`. + +- **๐Ÿ› ๏ธ Alias Loading Order Improved:** + - Plugins and framework sources (`zsh-autosuggestions`, `zsh-syntax-highlighting`) now load **before** aliases and custom functions to avoid conflicts. + +--- + +### **๐Ÿ“š Reorganized** +- **๐Ÿ”ง Improved File Structure for Readability:** + - Organized aliases into **categories**: File Management, Git Shortcuts, System Monitoring, Package Management, Quality of Life, and Fun. + - Placed system-specific commands (e.g., `paru` aliases) into a dedicated section. + - Removed ambiguity by grouping similar aliases together for better maintainability. + +--- + +### **๐ŸŽฏ Why These Changes?** +1. **๐Ÿ›ก๏ธ Safety:** Prevent unintended consequences from ambiguous or dangerous aliases (e.g., `del` and `cleanup`). +2. **โœ… Clarity:** Focus on aliases that are genuinely useful for day-to-day tasks. +3. **๐ŸŒ Compatibility:** Make the alias file system-agnostic by avoiding environment-specific commands (e.g., `systemd-resolved` for `flushdns`). +4. **โšก Efficiency:** Provide shortcuts for frequently used tasks without overloading the configuration. + +--- + +### **๐Ÿš€ Future Improvements** +- ๐Ÿ› ๏ธ Add dynamic checks for system-specific commands to prevent sourcing incompatible aliases. +- ๐Ÿงน Introduce more safeguards for dangerous operations (e.g., using `safe_rm` to block destructive file deletions). +- ๐ŸŒŸ Expand aliases with productivity-enhancing shortcuts for commonly used tools or workflows (e.g., Docker, Kubernetes, etc.). + +--- + diff --git a/PKGBUILD b/PKGBUILD index 7a976da..2001cdb 100755 --- a/PKGBUILD +++ b/PKGBUILD @@ -1,5 +1,5 @@ pkgname=parch-zsh-config -pkgver=1.5 +pkgver=2.0 pkgrel=1 pkgdir=/usr/share/parchlinux/zsh/ pkgdesc="ZSH config of parch"