#!/bin/bash
# "validate.sh" v1.0.2 | 2019/10/20
#-------------------------------------------------------------------------------
# Validate code style consistency in the repository via EditorConfig settings
# and the EClint validator tool:
# https://editorconfig.org
# https://www.npmjs.com/package/eclint
#-------------------------------------------------------------------------------
echo -e "\n\033[34;1m================================================"
echo -e "\033[33;1mValidating Code Styles via EditorConfig Settings"
echo -e "\033[34;1m================================================\033[0m"
# ==================
# Check Dependencies
# ==================
# Since the script might also be run locally by end users, check that EClint is
# installed on the user machine:
if eclint --version > /dev/null 2>&1 ; then
echo -e "Using:"
echo -e "\033[34;1m*\033[35m Node.js $(node -v)"
echo -e "\033[34;1m*\033[35m EClint v$(eclint --version).\n\033[31;1m"
else
echo -e "\033[31;1m~~~ ERROR! ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
echo -e "In order to run this script you need to install EClint (Node.js):\n"
echo -e "\thttps://www.npmjs.com/package/eclint"
echo -e "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\033[0m"
echo -e "If you've already installed Node.js on your machine, type:\n"
echo -e "\033[33;1m\tnpm install -g eclint"
echo -e "\033[31;1m\n/// Aborting All Tests ///\033[0m"
exit 1
fi
# ==============
# Validate Files
# ==============
# Check that project files meet the code style standards set in `.editorconfig`;
# if not, print only the list of files that failed -- because EClint reports are
# usually too long.
tmpLog=./eclint.log
eclint check 2> $tmpLog || {
echo -e "\033[31;1m~~~ ERROR! ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~";
echo -e "The following files didn't pass the validation test:\n\033[33;1m";
grep "^[^ ]" $tmpLog;
echo -e "\n\033[31;1mRun ECLint locally for detailed information about the problems.";
echo -e "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~";
echo -e "/// Aborting All Tests ///\033[0m";
rm $tmpLog;
exit 1;
}
rm $tmpLog;
echo -e "\033[32;1m/// Test Passed ///\033[0m"
exit
# EOF #