Feat/support short option (#13)

* feat: add support for short options

* chore: bump version to 1.7.0

Author: zdk

README.md

@@ -44,14 +44,6 @@ In other words when you run `rm -rf file directory/`
 You will have files/dir the trash first,
 then you can decide to delete or clean them later on.
 
-# Really Remove
-
-If you don't really care to move it to Trash first.
-
-Use `rm --rm`, e.g. `rm --rm file directory/`
-
-Or, you can just use `/bin/rm` directly.
-
 # Additional features
 
 ```
@@ -63,24 +55,51 @@ rm --empty-trash     Empty all trash directories
 rm --show-trash-path Display all trash directory paths
 ```
 
+# Really Remove
+
+If you don't really care to move it to Trash first.
+
+rm-safely provide bypass to your OS rm via `--rm` option.
+
+That means, use `rm --rm`
+
+For examples:
+
+- remove files and directy with OS rm.
+
+`rm --rm file directory/`
+
+- see the OS rm --help
+
+```rm --rm --help
+/bin/rm: illegal option -- -
+usage: rm [-f | -i] [-dIPRrvWx] file ...
+       unlink [--] file
+```
+
+`--rm` is nothing special other than execute `/bin/rm` from current shell.
+
+Or, you could just `/bin/rm` directly.
+
 # Uninstall
 
 `curl -fsSL https://raw.githubusercontent.com/zdk/rm-safely/main/rm-safely | bash -s uninstall`
 
-# Appendix
-
-> [!IMPORTANT]
->
-> In case of switching to root user,
->
-> 1. Please keep in mind that _the rm-safely alias is installed in current user only_.
-> 2. Always use `sudo -s` to keep current shell alias to root prompt, then run `rm` in the next step.
->
-> Otherwise, chance you will bypass this alias and execute standard `/bin/rm` as your own risk.
-
-> [!NOTE]
->
-> - Main goal of rm-safely is to write it in a pure shell script.
-> - Alternative tools:
->   - https://github.com/MilesCranmer/rip2 (rust)
->   - https://github.com/Byron/trash-rs (rust)
+# Notes
+
+- Main goal of rm-safely is to write it in a pure shell script
+  as a gateway and a suppliment to rm, not a replacement.
+
+- Alternative tools:
+
+  - https://github.com/MilesCranmer/rip2 (rust)
+  - https://github.com/Byron/trash-rs (rust)
+  - https://github.com/kaelzhang/shell-safe-rm (bash)
+  - https://github.com/hitzhangjie/rm (go)
+
+[Important Reminder],
+
+Regarding the normal bahaviour of unix alias,
+
+- Please keep in mind, _the rm-safely alias is available in current user only_.
+- So please always use `sudo -s` to switch to root user, then run `rm` in the next step.

rm-safely

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-VERSION="1.6.0"
+VERSION="1.7.0"
 HOOK_FILE="$HOME/.rm-safely"
 
 GREEN='\033[0;32m'
@@ -166,7 +166,7 @@ rm() {
                 echo "All trash directories are empty"
             fi
             ;;
-        --list-trash)
+        --list-trash|-l)
             local has_files=0
             echo "Trash Contents:"
             echo "==============="
@@ -199,7 +199,7 @@ rm() {
                 echo "Trash is empty"
             fi
             ;;
-        --undo)
+        --undo|-u)
             local entry
             entry=$(pop_from_undo_stack)
             if [ $? -ne 0 ]; then
@@ -246,7 +246,7 @@ rm() {
                 return 1
             fi
             ;;
-        --restore)
+        --restore|-s)
             shift
             if [ -z "$1" ]; then
                 echo "ERROR: Please provide a hash to restore"
@@ -312,7 +312,7 @@ rm() {
                 return 1
             fi
             ;;
-        --show-trash-path)
+        --show-trash-path|-p)
             echo "Home trash: $HOME_TRASH_DIR"
             echo "All trash directories:"
             get_all_trash_dirs
@@ -328,15 +328,15 @@ Usage: rm [options] [files...]
 Files on the same filesystem as \$HOME go to ~/.local/share/Trash
 Files on other filesystems go to <mountpoint>/.Trash-<uid>
 
-Special options:
-  --rm              Skip trash, execute real 'rm'
-  --list-trash      Show trash contents from all filesystems
-  --restore <hash>  Restore a file from trash using its hash
-  --undo            Restore the last deleted files
-  --empty-trash     Empty all trash directories
-  --show-trash-path Display all trash directory paths
-  --version         Show version information
-  --help            Show this help
+Options:
+  --rm                      Skip trash, execute real 'rm'
+  --list-trash, -l          Show trash contents from all filesystems
+  --restore <hash>, -s      Restore a file from trash using its hash
+  --undo, -u                Restore the last deleted files
+  --empty-trash             Empty all trash directories
+  --show-trash-path, -p     Display all trash directory paths
+  --version                 Show version information
+  --help                    Show this help
 HELP
             ;;
         *)

test_rm-safely.sh

@@ -1,4 +1,4 @@
-#!/usr/bin/env zsh
+#!/usr/bin/env bash
 
 set -e
 
@@ -29,7 +29,7 @@ bash "$OLDPWD/rm-safely" install >/dev/null 2>&1 || true
 print_pass "Installation complete"
 
 print_header "Testing in bash"
-bash <<'BASH_TEST'
+if bash <<'BASH_TEST'; then
 # shellcheck source=/dev/null
 source "$HOME/.rm-safely"
 
@@ -61,16 +61,14 @@ else
     exit 1
 fi
 BASH_TEST
-
-if [ $? -eq 0 ]; then
     print_pass "All bash tests passed"
 else
     print_fail "Bash tests failed"
 fi
 
 if command -v zsh >/dev/null 2>&1; then
     print_header "Testing in zsh"
-    zsh <<'ZSH_TEST'
+    if zsh <<'ZSH_TEST'; then
 source "$HOME/.rm-safely"
 
 # Test basic functionality
@@ -101,8 +99,6 @@ else
     exit 1
 fi
 ZSH_TEST
-
-    if [ $? -eq 0 ]; then
         print_pass "All zsh tests passed"
     else
         print_fail "Zsh tests failed"