1
1
Fork 0
mirror of https://github.com/tonydamage/nux-env.git synced 2025-12-11 13:24:28 +01:00
nux-env/inc/nux-base.inc.sh
Tony Tkacik 089cb5ccce shelldoc: Added micro markup support for shell comments.
Added support for micro markup to ease reading and to
highlight keywords and headings in documentation derived
from shell comments.

nuxfs and nux-runner takes advantage from this.

Signed-off-by: Tony Tkacik <tonydamage@gmail.com>
2017-06-11 17:23:55 +02:00

128 lines
2.9 KiB
Bash

readonly NUX_INC_DIR=$(dirname $(realpath ${BASH_SOURCE[0]}))
readonly NUX_ENV_DIR=$(dirname $NUX_INC_DIR)
# Color definitions
readonly nc_bold=`tput setaf 0`
readonly nc_bg_bold=`tput setab 0`
readonly nc_black=`tput setab 0`
readonly nc_bg_black=`tput setab 0`
readonly nc_cyan=`tput setaf 6`
readonly nc_bg_cyan=`tput setab 6`
readonly nc_magenta=`tput setaf 5`
readonly nc_bg_magenta=`tput setab 5`
readonly nc_red=`tput setaf 1`
readonly nc_bg_red=`tput setab 1`
readonly nc_white=`tput setaf 7`
readonly nc_bg_white=`tput setab 7`
readonly nc_green=`tput setaf 2`
readonly nc_bg_green=`tput setab 2`
readonly nc_yellow=`tput setaf 3`
readonly nc_bg_yellow=`tput setab 3`
readonly nc_blue=`tput setaf 4`
readonly nc_bg_blue=`tput setab 4`
readonly nc_end=`tput sgr0`
readonly NC_Bold=`tput bold`
readonly NC_No=`tput sgr0` # No Color
readonly NC_Black='\033[0;30m'
readonly NC_Green='\033[0;32m'
readonly NC_Red=$nc_bold$nc_red
readonly NC_BrownOrange='\033[0;33m'
readonly NC_Blue='\033[0;34m'
readonly NC_Purple='\033[0;35m'
readonly NC_Cyan='\033[0;36m'
readonly NC_LightGray='\033[0;37m'
readonly NC_DarkGray='\033[1;30m'
readonly NC_LightRed='\033[1;31m'
readonly NC_LightGreen='\033[1;32m'
readonly NC_Yellow=$nc_yellow
readonly NC_LightBlue='\033[1;34m'
readonly NC_LightPurple='\033[1;35m'
readonly NC_LightCyan='\033[1;36m'
readonly NC_White=$nc_white
# Color for message levels
NC_info=$NC_LightGray
NC_error=$NC_LightRed
NC_warning=$NC_Yellow
NC_debug=$NC_White
N_LOG_info=1
N_LOG_error=2
N_LOG_warning=3
function nux.log {
local level=$1
local color=NC_$level
local setting=N_LOG_$level
shift;
if [ ! -z ${!setting+x} ]; then
echo -e "${!color}[$level]$NC_No $*$NC_No" >&2
fi
}
function nux.echo.error {
echo -e "${NC_error}$* ${NC_No}";
}
function nux.echo.warning {
echo -e "${NC_warning}$* ${NC_No}";
}
function nux.use {
local incfile="$1.inc.sh"
source "$NUX_INC_DIR/$incfile"
}
function nux.include {
local incfile="$1.inc.sh"
source "$NUX_INC_DIR/$incfile"
}
function nux.check.function {
declare -f "$1" &>/dev/null && return 0
return 1
}
function nux.check.file.exists {
test -e "$1" -o -h "$1";
}
function nux.eval {
nux.log trace Going to evaluate "$@"
eval "$@"
}
function nux.exec.optional {
local FUNC="$1"; shift;
if nux.check.function $FUNC; then
nux.log trace Executing optional: ${NC_White}${FUNC}${NC_No} "$@";
$FUNC "$@"
fi
}
function nux.dirty.urlencode {
echo -n "$1" | sed "s/ /%20/g"
}
function nux.help.comment {
local source="$1"
grep -E "^\#\#( |$)" "$source" \
| cut -d\# -f3- \
| cut -d" " -f2- \
| nux.help.shelldoc
}
function nux.help.shelldoc {
cat | sed -r \
-e "s/^## ?(.*)/${NC_White}\1${NC_No}/gI" \
-e "s/^# ?(.*)/${NC_Bold}\1${NC_No}/gI" \
-e "s/^ ?[a-z0-9.-_]*/${NC_Bold}&${NC_No}/gI" \
-e "s/\*\*([^*]*)\*\*/${NC_Bold}\1${NC_No}/gI" \
-e "s/\*([^*]*)\*/${NC_White}\1${NC_No}/gI" \
}