update-format.sh

#!/usr/bin/env bash
#
# SPDX-FileCopyrightText: Copyright © 2020-2023 Serpent OS Developers
#
# SPDX-License-Identifier: Zlib
#

function noisyFail ()
{
    if [[ -z "$1" ]]; then
       echo ""
       echo "\033[1;31mERROR:\033[0m\033[1m  No message parameter specified for noisyFail?\033[0m"
       echo ""
       exit 1
    fi
    # set up terminal colours
    BOLDRED="\033[1;31m"
    BOLD="\033[1m"
    RESET="\033[0m"
    ERRMSG="${BOLDRED}ERROR:${RESET}${BOLD}  ${1}${RESET}"
    echo ""
    echo -e "${ERRMSG}"
    echo ""
    exit 1
}

function checkDirPrerequisites ()
{
    if [[ ! -d .git/ ]]; then
        MSG="${PWD} does not contain a .git/ directory?\n\
        - please ensure that this script is run from the root of a git repository."
        noisyFail "${MSG}"
    fi

    if [[ ! -d source/ ]]; then
        MSG="${PWD} does not contain a source/ directory?"
        noisyFail "${MSG}"
    fi
}

function checkExePrerequisites ()
{
    command -v iconv 2>&1 > /dev/null
    if [[ ! $? -eq 0 ]]; then
        MSG="'iconv' character set conversion tool not found in your $PATH?\n\
        - please ensure that you are using a glibc-enabled distribution compiled with locale support."
        noisyFail "${MSG}"
    fi

    command -v xargs 2>&1 > /dev/null
    if [[ ! $? -eq 0 ]]; then
        MSG="'xargs' utility (part of GNU findutils) not found in your $PATH?\n\
        - please install GNU findutils using your distribution's package manager."
        noisyFail "${MSG}"
    fi

    command -v dfmt 2>&1 > /dev/null
    if [[ ! $? -eq 0 ]]; then
        MSG="'dfmt' utility not found in your $PATH\n\
        - please install 'dfmt'.\n\
        - (git clone https://github.com/dlang-community/dfmt and consult the included README.md)"
        noisyFail "${MSG}"
    fi

    command -v codespell 2>&1 > /dev/null
    if [[ ! $? -eq 0 ]]; then
        MSG="'codespell' spell checking tool not found in your \$PATH?\n\
        - please install 'codespell' using your distribution's package manager."
        noisyFail "${MSG}"
    fi
}

D_FILES=""

# Autoformat the code and check spelling
function autoFormat ()
{
    local D_FILES=""
    if [[ -d tests/ ]]; then
        D_FILES="$(find source/ tests/ -name '*.d' -type f 2>/dev/null)"
    else
        D_FILES="$(find source/ -name '*.d' -type f 2>/dev/null)"
    fi

    if [[ -n "${D_FILES}" ]]; then
        echo "Testing that Dlang files can be converted to utf-8..."
        echo "${D_FILES}" | xargs -n1 --verbose iconv -t utf8 > /dev/null || noisyFail "Failed to convert *.d files to utf-8? Please encode *.d files to utf-8."
        echo "Running Dlang files through 'dfmt'..."
        echo "${D_FILES}" | xargs -n1 --verbose dfmt -i
        echo "Running Dlang files through 'codespell'..."
        codespell "${D_FILES}"
    else
        MSG="No '*.d' Dlang source files found in ${PWD}/source/ or ${PWD}/tests/) ?"
        noisyFail "${MSG}"
    fi
}

# main ()
checkDirPrerequisites
checkExePrerequisites
autoFormat