Skip to content
This repository has been archived by the owner on Jan 22, 2025. It is now read-only.

Add a clear and concise help message (instead of simply printing the man page) for the --help option #16

Merged
merged 3 commits into from
Jun 8, 2023
Merged

Add a clear and concise help message (instead of simply printing the man page) for the --help option #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7361665
Add a clear and concise help message (instead of simply printing the …
Antiz96 Jun 8, 2023
c075bc3
Reformat the documentation in the README
Antiz96 Jun 8, 2023
cf7413f
Fix the update of the argument var when using the menu
Antiz96 Jun 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 11 additions & 50 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,58 +98,19 @@ Example below with the 31st alias (`list='ls -ltr'`), previously added in the "a

## Documentation

See the documentation below:

*The documentation is also available as a man page and with the "--help" function.*
*Run `man malias` or `malias --help` after you've installed the **malias** package.*
```
Options:
-m, --menu Print a menu that lists possible operations to choose from (default operation)
-a, --add Add a new alias
-l, --list List all current aliases
-d, --delete Delete an existing alias
-h, --help Display this message and exit
-V, --version Display version information and exit

### SYNOPSIS

malias [OPTION]

### DESCRIPTION

An alias manager that allows you to easily add, delete or list your bash aliases in your ".bashrc" file by automating and securing every steps for you.

### OPTIONS

#### -m, --menu

Open the main menu which allows you to choose what operation to perform.
You can either type `add` (`a` for short) to add a new alias, `list` (`l` for short) to list your current aliases, `delete` (`d` for short) to delete an alias, `help` (`h` for short) to print this man page or `quit` (`q` for short) to quit Malias.
This is the default if no option is passed.

#### -a, --add

Launch the `add` operation which allows you to add a new alias.

#### -l, --list

Launch the `list` operation which prints the list of your current aliases.

#### -d, --delete

Launch the `delete` operation which allows you to delete an alias.

#### -v, --version

Print the current version.

#### -h, --help

Print the help.

### EXIT STATUS

#### 0

if OK

#### 1

if problems (user didn't gave confirmation to proceed with the adding/deletion, a problem happened during the backup/restore process of the .bashrc file, the added alias is incorrect, ...)
For more information, see the malias(1) man page
```

## Contributing

You can raise your issues, feedbacks and suggestions in the [issues tab](https://github.com/Antiz96/malias/issues).
[Pull requests](https://github.com/Antiz96/malias/pulls) are welcomed as well !
[Pull requests](https://github.com/Antiz96/malias/pulls) are welcomed as well!
10 changes: 3 additions & 7 deletions doc/man/malias.1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "MALIAS" "1" "May 2022" "Malias v1" "Malias Manual"
.TH "MALIAS" "1" "June 2023" "Malias v1" "Malias Manual"

.SH NAME
malias \- An alias manager that allows you to easily add, delete or list your bash aliases.
Expand Down Expand Up @@ -32,7 +32,7 @@ Launch the "list" operation which prints the list of your current aliases.
Launch the "delete" operation which allows you to delete an alias.

.TP
.B \-v, \-\-version
.B \-V, \-\-version
Print the current version.

.TP
Expand Down Expand Up @@ -90,11 +90,7 @@ Malias will then look for potential errors and apply the deletion or restore the
.BR sed (1),
.BR cut (1),
.BR date (1),
.BR bash (1),
.BR man (1),
.BR col (1)
.br
The documentation is also available on the GitHub page https://github.com/Antiz96/malias
.BR bash (1)

.SH BUGS
Please report bugs to the GitHub page https://github.com/Antiz96/malias
Expand Down
77 changes: 49 additions & 28 deletions src/script/malias.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,55 @@
#!/bin/bash

#Variables definition
name=malias
version="1.2.1"
argument="${1}"

#Definition of the version function: Print the current version
version() {
echo "${version}"
}

#Definition of the help function: Print the help message
help() {
man malias | col
cat <<EOF
${name} v${version}

An alias manager that allows you to easily add, delete or list your bash aliases in your ".bashrc" file by automating and securing every steps for you.

Options:
-m, --menu Print a menu that lists possible operations to choose from (default operation)
-a, --add Add a new alias
-l, --list List all current aliases
-d, --delete Delete an existing alias
-h, --help Display this message and exit
-V, --version Display version information and exit

For more information, see the ${name}(1) man page
EOF
}

#Definition of the version function: Print the current version
version() {
echo "${name} ${version}"
}

#Definition of the invalid_argument function: Print an error message, ask the user to check the help and exit
invalid_argument() {
echo -e >&2 "malias : invalid argument -- '${operation}'\nTry 'malias --help' for more information."
echo -e >&2 "${name}: invalid argument -- '${operation}'\nTry '${name} --help' for more information."
exit 1
}

#Definition of the menu function: Print a menu that lists possible operations for the user to choose from
#Definition of the menu function: Print a menu that lists possible operations to choose from
menu() {
clear >"$(tty)"

echo "Welcome to Malias!"
echo
echo "Please, type one of the following operations:"
echo "add (Add a new alias)"
echo "list (List all your current aliases)"
echo "delete (Delete an existing alias)"
echo "help (Print the help)"
echo "quit (Quit Malias)"
cat <<EOF
Welcome to Malias!

Please, type one of the following operations:

add (Add a new alias)
list (List all current aliases)
delete (Delete an existing alias)
help (Print the help)
quit (Quit Malias)
EOF

read -rp $'\nWhat operation do you want to do? ' operation
operation=$(echo "${operation}" | awk '{print tolower($0)}')
Expand Down Expand Up @@ -64,7 +82,7 @@ menu() {
#Definition of the add function: Add a new alias
add() {
read -rp "Please, type the alias name you want to add: " alias_name
read -rp "Please, type the command you want to associate your alias with: " alias_command
read -rp "Please, type the command you want to associate the alias with: " alias_command

new_alias="${alias_name}"=\'"${alias_command}"\'
echo -e "\nThe following alias will be added: ${new_alias}"
Expand All @@ -80,18 +98,18 @@ add() {
;;
esac

cp -p ~/.bashrc ~/.bashrc-bck_malias-add-"${alias_name}"-"$(date +"%d-%m-%Y")" && echo -e "\nBackup of the .bashrc file created" || exit 1
cp -p ~/.bashrc ~/.bashrc-bck_${name}-add-"${alias_name}"-"$(date +"%d-%m-%Y")" && echo -e "\nBackup of the .bashrc file created" || exit 1
echo "alias ${new_alias}" >> ~/.bashrc

source_error=$(bash -x ~/.bashrc 2>/dev/null; echo $?)

if [ "${source_error}" -eq 0 ]; then
echo "Alias ${new_alias} successfully added"
rm -f ~/.bashrc-bck_malias-add-"${alias_name}"-"$(date +"%d-%m-%Y")" && echo "Backup of the .bashrc file deleted"
rm -f ~/.bashrc-bck_${name}-add-"${alias_name}"-"$(date +"%d-%m-%Y")" && echo "Backup of the .bashrc file deleted"
exec bash
else
echo -e >&2 "\nERROR: An error occured when applying your alias\nPlease verify that you typed your alias correctly\nAlso, be aware that your alias name cannot contain space(s). However, it can contain \"-\" (hyphen) or \"_\" (underscore)"
mv -f ~/.bashrc-bck_malias-add-"${alias_name}"-"$(date +"%d-%m-%Y")" ~/.bashrc && echo "Backup of the .bashrc file restored" || echo -e >&2 "\nERROR: An error occurred when restoring the backup of your ~/.bashrc file\nPlease, check for potential errors in it"
echo -e >&2 "\nERROR: An error occured when applying the alias\nPlease verify that you typed the alias correctly\nAlso, be aware that the alias name cannot contain space(s). However, it can contain \"-\" (hyphen) or \"_\" (underscore)"
mv -f ~/.bashrc-bck_${name}-add-"${alias_name}"-"$(date +"%d-%m-%Y")" ~/.bashrc && echo "Backup of the .bashrc file restored" || echo -e >&2 "\nERROR: An error occurred when restoring the backup of the ~/.bashrc file\nPlease, check for potential errors in it"
exit 1
fi
}
Expand Down Expand Up @@ -132,18 +150,18 @@ delete() {
;;
esac

cp -p ~/.bashrc ~/.bashrc-bck_malias-delete-"${alias_name}"-"$(date +"%d-%m-%Y")" && echo -e "\nBackup of the .bashrc file created" || exit 1
cp -p ~/.bashrc ~/.bashrc-bck_${name}-delete-"${alias_name}"-"$(date +"%d-%m-%Y")" && echo -e "\nBackup of the .bashrc file created" || exit 1
sed -i "/^alias ${alias_delete}$/d" ~/.bashrc || exit 1

source_error=$(bash -x ~/.bashrc 2>/dev/null; echo $?)

if [ "${source_error}" = 0 ]; then
echo -e "\nAlias ${alias_delete} successfully deleted" || exit 1
rm -f ~/.bashrc-bck_malias-delete-"${alias_name}"-"$(date +"%d-%m-%Y")" && echo "Backup of the .bashrc file deleted"
rm -f ~/.bashrc-bck_${name}-delete-"${alias_name}"-"$(date +"%d-%m-%Y")" && echo "Backup of the .bashrc file deleted"
exec bash
else
echo -e >&2 "\nERROR: An error occured when deleting the alias"
mv -f ~/.bashrc-bck_malias-delete-"${alias_name}"-"$(date +"%d-%m-%Y")" ~/.bashrc && echo "Backup of the .bashrc file restored" || echo -e >&2 "ERROR: A error occurred when restoring the backup of your ~/.bashrc file\nPlease, check for potential errors in it"
mv -f ~/.bashrc-bck_${name}-delete-"${alias_name}"-"$(date +"%d-%m-%Y")" ~/.bashrc && echo "Backup of the .bashrc file restored" || echo -e >&2 "ERROR: A error occurred when restoring the backup of the ~/.bashrc file\nPlease, check for potential errors in it"
exit 1
fi
else
Expand All @@ -156,7 +174,10 @@ delete() {
case "${argument}" in
-m|--menu|"")
menu
;;&
;;
esac

case "${argument}" in
-a|--add)
add
;;
Expand All @@ -166,12 +187,12 @@ case "${argument}" in
-d|--delete)
delete
;;
-v|--version)
version
;;
-h|--help)
help
;;
-V|--version)
version
;;
*)
invalid_argument
;;
Expand Down