The pre-commit file listed here is setup to scan files for invalid keywords prior to commit to avoid debug or logging information making its way into production files.
Setup to scan .js, .coffee, .rb, .erb files for 'debugger' or 'binding.pry'
cp pre-commit .git/hooks/chmod +x .git/hooks/pre-commit| #!/usr/bin/env bash | |
| # https://github.com/borisguery/git-keywords-checker | |
| # Add or remove keywords here | |
| KEYWORDS_REGEX="debugger|binding\.pry" | |
| # Add extensions to check here | |
| EXTENSIONS_REGEX="(.js$|.coffee$|.rb$|.erb$)" | |
| ERRORS_BUFFER="" | |
| TEXT_DEFAULT="\\033[0;39m" | |
| TEXT_INFO="\\033[1;32m" | |
| TEXT_ERROR="\\033[1;31m" | |
| TEXT_UNDERLINE="\\0033[4m" | |
| TEXT_BOLD="\\0033[1m" | |
| VERBOSE=false | |
| FILES=$(git diff-index --cached --name-only --diff-filter=ACMR HEAD) | |
| echo -e "\\033[1;33m""Keywords checker - pre-commit hook" "$TEXT_DEFAULT" | |
| echo | |
| for FILE in $FILES; do | |
| if [[ $FILE =~ $EXTENSIONS_REGEX ]]; then | |
| ERRORS="" | |
| while IFS=: read -ra RESULT; do | |
| if [ "$RESULT" != "" ]; then | |
| ERRORS="$ERRORS\n\tline $TEXT_BOLD${RESULT[1]}$TEXT_DEFAULT: " | |
| ERRORS="$ERRORS"$(sed -n ${RESULT[1]}p $FILE | sed -E "s/($KEYWORDS_REGEX)/\\$TEXT_UNDERLINE\1\\$TEXT_DEFAULT/g") | |
| if [ "$ERRORS_BUFFER" != "" ]; then | |
| ERRORS_BUFFER="$ERRORS_BUFFER\n$ERRORS" | |
| else | |
| ERRORS_BUFFER="$ERRORS" | |
| fi | |
| fi | |
| done < <(grep -sEnH $KEYWORDS_REGEX $FILE) | |
| if [ "$ERRORS" != "" ]; then | |
| ERRORS="$TEXT_ERROR Errors found in $TEXT_BOLD$FILE$TEXT_DEFAULT$ERRORS" | |
| echo -e "$ERRORS" | |
| fi | |
| fi | |
| done | |
| if [ "$ERRORS_BUFFER" != "" ]; then | |
| echo | |
| echo -e "$TEXT_ERROR" "There were errors or warnings, commit aborted." "$TEXT_DEFAULT" | |
| echo -e "$TEXT_INFO" "If you are sure you want to commit those files, use --no-verify option" "$TEXT_DEFAULT" | |
| exit 1 | |
| else | |
| echo -e "$TEXT_INFO" "All files are clean." "$TEXT_DEFAULT" | |
| exit 0 | |
| fi |