Add a man page (ALX-Students-Contribution#9)

* chore: add a man page

* refactor: Use regex instead of manual verification

Author: gekkowrld

.gitignore

@@ -0,0 +1,5 @@
+.vscode/*
+git-2.*/*
+.editorconfig
+build/*
+test*

commit

@@ -2,8 +2,10 @@
 
 # Make the credentials available at the start of the script
 
-username=$(grep -oP '^user_email:\s*\K.*' ~/.commitconfig)
-email=$(grep -oP '^user_username:\s*\K.*' ~/.commitconfig)
+y_regex="^([y|Y][eE][sS]|[y|Y])$"
+
+email=$(grep -oP '^user_email:\s*\K.*' ~/.commitconfig)
+username=$(grep -oP '^user_username:\s*\K.*' ~/.commitconfig)
 
 # Check if the --help flag is used
 if [[ "$*" == *"--help"* ]]; then
@@ -28,7 +30,7 @@ fi
 # Check if the current directory is a Git repository
 if ! git rev-parse --is-inside-work-tree > /dev/null 2>&1; then
     read -rp "The current directory is not a Git repository. Would you like to initialize it? (y/n): " initialize
-    if [[ "$initialize" == "y" || "$initialize" == "Y" ]]; then
+    if [[ "$initialize" =~ $y_regex ]]; then
         git init
     else
         echo "Script terminated. Please initialize a Git repository to continue."

commit.1

@@ -0,0 +1,53 @@
+.TH "COMMIT ASSISTANT" 1 "2023-06-18" GNU "Commit Manual"
+.SH NAME
+commit assistant \- effortlessly commit
+.SH SYNOPSIS
+.B commit
+.RB [ \-\-verbose ]
+.RB [ filename... ]
+.SH DESCRIPTION
+.B commit
+is a tool that helps you commit without having to remember any of the git commands.
+.br
+It intelligently chooses the correct
+.IR "git command"
+to use for your current situation.
+.br
+.B commit
+uses the git commands under the hood to perform it's tasks.
+.br
+.SH OPTIONS
+.TP 8
+.B \-\-verbose
+Prints out the steps that the program is taking.
+This is useful incase the process failed for whatever reason.
+.TP 8
+.B file(s)
+State explicitly which files should be committed.
+If nothing is given, all the files in the current directory are committed.
+.SH EXAMPLE
+.TP 4
+.B commit --verbose
+.br
+Runs the program in verbose mode.
+.TP 4
+.B commit file1 file2
+.br
+Commit certain files.
+.B commit
+takes 0 or more values. If zero, then all the files are selected.
+.SH FILES
+.IR /usr/local
+.br
+.IR ~/.commitconfig
+.SH SEE ALSO
+.BR git(1)
+.SH BUGS
+When run in root it may have undefined behaviours
+.br
+No support for any advanced or intermediate git commands
+.br
+If you find any problem, want to add or a feature added.
+.br
+Consider checking out the official Github repository
+https://github.com/ALX-Students-Contribution/commit-assistant

git-install.sh

@@ -1,21 +1,28 @@
-#!/bin/sh
+#!/bin/bash
 
 set -e
+y_regex="^([y|Y][eE][sS]|[y|Y])$"
 
 # Copy commit.sh to the bin directory
 if ! sudo cp commit /usr/local/bin/; then
     echo "Error: Failed to copy commit script to /usr/local/bin/"
     exit 1
 fi
 
+# Copy commit manual to man directory
+# Installation should not stop incase it fails, only a warning
+if ! sudo cp commit.1 /usr/local/man/man1; then
+	echo "Failed to add commit man page to system"
+fi
+
 # Check if git is installed in the system
 
 if ! command -v git > /dev/null 2>&1; then
 	echo -e "Git is not installed in your system \n Do you want to install it? (y/n): "
 
 	read -r git_choice
 
-	if [[ $git_choice == 'y' || $git_choice == 'Y' ]]; then
+	if [[ $git_choice =~ $y_regex ]]; then
 		echo "This process may take *alot* of time, please be patient and make sure you have stable internet connection"
 		chmod +x git_install.sh
 		./git_install.sh
@@ -28,13 +35,13 @@ fi
 # Create a validation regex that will be used to validate if the email is correct or not
 # This only checks for the syntax and not deliverability
 
-regex="^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$"
+email_regex="^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$"
 
 # Ask if the user will like to enter other details or will like to continue with the system configuration
 
 read -rp "Do you want to enter your details(y/n): " detail_choice
 
-if [[ $detail_choice == 'y' || $detail_choice == 'Y' ]]; then
+if [[ $detail_choice =~ $y_regex ]]; then
 	# Prompt for Git username
 	read -rp "Enter Git username: " username
 
@@ -54,7 +61,7 @@ if [[ $detail_choice == 'y' || $detail_choice == 'Y' ]]; then
 	fi
 
 	# Validate the email is correct
-	if [[ ! $email =~ $regex ]]; then
+	if [[ ! $email =~ $email_regex ]]; then
 		echo "Error: Your email is invalid"
 		exit 1
 	fi