help.sh

#!/bin/bash

# This script displays help information for the Makefile.
# Usage: ./help.sh Makefile

# Set colors for output
col_off='\033[0m'
target_col='\033[36m'
variable_col='\033[93m'
grey='\033[90m'

# Main function to display help information
help() {
    # Display usage information
    echo ""
    echo "Usage:"
    printf "  make %b[target]%b %b[variables]%b\n\n" "$target_col" "$col_off" "$variable_col" "$col_off"

    # Display targets information
    _help_targets "$1"

    # Display variables information
    _help_variables "$1"

    # Display examples
    _help_examples
}

# Function to display targets information
_help_targets() {
    local pattern
    pattern='^[a-zA-Z0-9._-]+:.*?##.*$'

    echo "Target(s):"
    grep -E "$pattern" "$1" | sort | while read -r line; do
        target=${line%%:*}
        description=${line#*## }
        printf "  %b%-30s%b%s\n" "$target_col" "$target" "$col_off" "$description"
    done
    echo ""
}

# Function to display variables information
_help_variables() {
    local pattern
    pattern='^[a-zA-Z0-9_-]+ [:?!+]?=.*?##.*$'

    echo "Variable(s):"
    grep -E "$pattern" "$1" | sort | while read -r line; do
        variable=${line%% *}
        default=${line#*= }
        default=${default%%##*}
        description=${line##*## }
        printf "  %b%-30s%b%s %b(default: %s)%b\n" "$variable_col" "$variable" "$col_off" "$description" "$grey" "$default" "$col_off"
    done
    echo ""
}

# Function to display examples
_help_examples() {
    echo "Example(s):"
    echo "  make install"
    echo ""
}

# Call main function
help "$1"

# Return exit code indicating success
exit 0