repo, screen and spinner modules updated & spinner ui degrade to increase performance

Author: OurCodeBase

src/repo.sh

@@ -15,12 +15,14 @@ source "${Dir}"/ask.sh
 # source inspect.sh
 # source ask.sh
 
-# repo.size(api) -> int
-#   Used to get size of a repo.
-# Args:
-#   api (str) > takes api of github repo. (eg: "OurCodeBase/bash-sdk")
-# Returns:
-#   size (int) > gives you file size in MiB. (eg: 30)
+# repo.size(api) ~ int
+# Used to get size of a repo.
+# 
+# ARGS:
+# - api (str): takes api of github repo. (eg: "OurCodeBase/bash-sdk")
+# 
+# RETURNS:
+# - size (int): gives you file size in MiB. (eg: 30)
 repo.size(){
   inspect.is_func 'curl';
   local Api="$(echo "${1}" | awk '{print $1}')";
@@ -29,9 +31,10 @@ repo.size(){
 }
 
 # repo.chart(apis)
-#   Used to view info of given repositories.
-# Args:
-#   apis (array) > takes array of repository api.
+# Used to view info of given repositories.
+# 
+# ARGS:
+# - apis (array): takes array of repository api.
 repo.chart(){
   inspect.ScreenSize '50' '12';
   local ARGs=("${@}");
@@ -58,11 +61,12 @@ repo.chart(){
   return 0;
 }
 
-# repo.clone(apis,*dirs)
-#   Used to start cloning of a repository.
-# Args:
-#   apis (array) > takes apis of github repo. (eg: OurCodeBase/bash-sdk)
-#   dirs (array) > Optional: You can give directory path to clone to it.
+# repo.clone(apis,@dirs)
+# Used to start cloning of a repository.
+# 
+# ARGS:
+# - apis (array): takes apis of github repo. (eg: OurCodeBase/bash-sdk)
+# - dirs (array,optional): You can give directory path to clone to it.
 repo.clone(){
   # required to run.
   inspect.is_func 'git';

src/screen.sh

@@ -1,24 +1,25 @@
 #!/bin/bash
 
-# screen.cols() -> int
-#   Gives you current columns count in terminal.
+# screen.cols() ~ int
+# Gives you current columns count in terminal.
 screen.cols(){
   # current columns in terminal.
   stty size | awk '{print $2}'
 }
 
-# screen.lines() -> int
-#   Gives you current lines count in terminal.
+# screen.lines() ~ int
+# Gives you current lines count in terminal.
 screen.lines(){
   # current lines in terminal.
   stty size | awk '{print $1}'
 }
 
-# screen.isSize(cols,lines) -> bool
-#   Checks that screen has atleast given lines and columns.
-# Args:
-#   cols (int) > takes columns as int.
-#   lines (int) > takes lines as int.
+# screen.isSize(cols,lines) ~ bool
+# Checks that screen has atleast given lines and columns.
+# 
+# ARGS:
+# - cols (int): takes columns as int.
+# - lines (int): takes lines as int.
 screen.isSize(){
   local ARGCols=${1};
   local ARGLines=${2};

src/spinner.sh

@@ -1,9 +1,9 @@
 #!/bin/bash
 
 # Shorts:
-#   spinner.start(use,subject)
-#   run your functions.
-#   spinner.stop
+# - spinner.start(use,subject)
+# - run your functions.
+# - spinner.stop
 
 # Suppressed Variables
 if (( 1<2 )); then
@@ -14,15 +14,7 @@ Genta="\033[1;35m";
 Green="\033[1;32m";
 Red="\033[1;31m";
 Yelo="\033[1;33m";
-Gora="\033[1;97m"
-# BG Colors.
-BGRed="\033[1;41m";
-BGGreen="\033[1;42m";
-BGYelo="\033[1;43m";
-# Status Colors.
-StatusRed="${BGRed}${Gora}";
-StatusGreen="${BGGreen}${Gora}";
-StatusYelo="${BGYelo}${Gora}";
+# Global variables.
 CircleIcon="● ";
 Success="SUCCESS";
 Failure="FAILED";
@@ -36,7 +28,7 @@ Scribe=(
 fi
 
 # spinner.setCursor(on~off)
-#   Switch terminal cursor easily.
+# Switch terminal cursor easily.
 spinner.setCursor(){
   setterm -cursor "${1}";
 }
@@ -63,23 +55,27 @@ _spinner(){
       exit 1;
       };
      kill ${3} > /dev/null 2>&1
-     echo -en "\b${Clear} ➙ ";
-     [[ $2 -eq 0 ]] &&
-       echo -e "${StatusGreen} ${Success} ${Clear}" || {
-       echo -e "${StatusRed} ${Failure} ${Clear}" &&
+     echo -en "\b${Clear} → ";
+     if [[ $2 -eq 0 ]]; then
+       echo -e "[ ${Green}${Success}${Clear} ]";
+     else
+       echo -e "[ ${Red}${Failure}${Clear} ]";
+       spinner.setCursor on;
        exit 1;
-      };
+     fi
     ;;
   esac  
 }
 
 # spinner.start(use,subject)
-#   Starts spinner to spin.
-# Args:
-#   use (str) > takes process (eg: installing, processing).
-#   subject (str) > takes subject (eg: file, function).
-# Means:
-#   (use, subject) > (Processing 'Sleep')
+# Starts spinner to spin.
+# 
+# ARGS:
+# - use (str): takes process (eg: installing, processing).
+# - subject (str): takes subject (eg: file, function).
+# 
+# EG:
+# - (use,subject): (Processing 'Sleep')
 spinner.start(){
   [[ ${#} -eq 2 ]] ||
   { echo "error: 'missing args'" && return 1; };
@@ -91,7 +87,7 @@ spinner.start(){
 }
 
 # spinner.stop()
-#   Stops spinner to spin.
+# Stops spinner to spin.
 spinner.stop(){
   _spinner stop ${?} ${_SpinnerPid};
   unset ${_SpinnerPid};