drupal-pre-commit/scripts/pre-commit.sh at master · asidbackup/drupal-pre-commit · GitHub

History

executable file

138 lines (118 loc) · 4.9 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

#!/bin/sh

# This hook prevents you from committing any file containing debug code.

# e.g. dsm(), dpm(), alert() and console.log(). There is also a PHP LINT check

# to ensure your syntax is okay.

# To enable this hook, symlink it (run this from the root of the repository).

# ln -s ../../scripts/pre-commit.sh .git/hooks/pre-commit

# To force a commit that breaks the below rules (e.g. when debug code is 100%

# required you can add in another parameter to `git commit` namely `--no-verify`.

# Helpful git aliases for these are:

# git config --global alias.gc commit

# git config --global alias.gcv commit --no-verify

# n.b. pwd is always the working copy's root directory.

# Non-zero exit aborts the commit

ABORT_COMMIT=1

# Get the list of modified files, excluding deleted files (status 'D')

# as obviously we cannot checkout and examine those.

DIFF_FILES=$(git diff-index HEAD --cached --name-status | grep -v ^D | cut -f2-)

# TODO: Test that when a SASS file is committed, the corresponding CSS

# file is also committed, and that the CSS file was modified no less-

# recently than the SASS file.

if [ $? -ne 0 ]; then

echo "Error getting list of changed files in pre-commit hook"

exit $ABORT_COMMIT

# Assume success.

EXIT=0

# Make a directory, under which we will checkout the staged versions of the

# files we are about to commit. We need to do this so that we are actually

# testing the code which will be committed. (If we tested against the working

# copy, we could have syntax errors in the staged version with inadvertantly-

# unstaged fixes, and we wouldn't catch the problem.)

STAGED=".validate_pre_commit"

mkdir -p "$STAGED"

# Truncate the LINT error log file

LINTLOG="$STAGED/lint.log"

>$LINTLOG

# PHP code checks.

PHP_FILES="\.(php|module|install|inc)$"

# Calls to debug functions should not be committed.

# print_r() has valid uses with its optional $return argument,

# so we do not test for it.

# n.b. This regexp needs to be valid for both egrep & PHP's preg_match()

FUNCTIONS="var_dump|dpq|dpm|dvm|dsm|dpr|kpr|dvr|kprint_r|dprint_r|devel_render|ddebug_backtrace|debug_backtrace|debug_print_backtrace|debug_to_file"

PATTERN="\b($FUNCTIONS)\("

for FILE in ${DIFF_FILES}

PARSEABLE=$(echo "$FILE" | grep -E "$PHP_FILES");

if [ "$PARSEABLE" != "" ]; then

git checkout-index -f --prefix=$STAGED/ "$FILE"

# By initially matching against code which has been stripped of

# comments, we can reliably eliminate any files which include only

# commented calls to debug functions.

php -r "exit(preg_match('/$PATTERN/', php_strip_whitespace('$STAGED/$FILE')));"

if [ $? -ne 0 ]; then

# The output of php_strip_whitespace() is of no use for display

# purposes, so we still need to grep the files; but we can at least

# eliminate any //-style comments from the code before looking for

# matches to display.

cat "$STAGED/$FILE" | sed 's|//.*||' | egrep -in -C2 "$PATTERN"

echo "---------------------------------------"

echo "^ Found PHP debug code in $FILE"

echo "---------------------------------------"

EXIT=$ABORT_COMMIT # but still run the remaining tests

# PHP LINT syntax checks.

php -l "$STAGED/$FILE" >>$LINTLOG 2>&1

if [ $? -eq 255 ]; then

ERROR_FILES="$ERROR_FILES $FILE"

rm -f "$STAGED/$FILE"

done

# Javascript code checks.

JS_FILES="\.(js|coffee)$"

# Calls to debug functions should not be committed.

FUNCTIONS="console\.log|alert"

PATTERN="\b($FUNCTIONS)\("

for FILE in ${DIFF_FILES}

PARSEABLE=$(echo "$FILE" | grep -E "$JS_FILES");

if [ "$PARSEABLE" != "" ]; then

git checkout-index -f --prefix=$STAGED/ "$FILE"

# As with the PHP tests, we can strip comments from the code before

# grepping for the function calls, to avoid displaying false-positives.

cat "$STAGED/$FILE" | sed 's|//.*||' | egrep -in -C2 "$PATTERN"

if [ $? -eq 0 ]; then

echo "---------------------------------------"

echo "^ Found Javascript debug code in $FILE"

echo "---------------------------------------"

EXIT=$ABORT_COMMIT # but still run the remaining tests

rm -f "$STAGED/$FILE"

done

# Report PHP LINT results.

if [ "$ERROR_FILES" != "" ]; then

echo "\nThe following syntax errors were found:"

echo "---------------------------------------"

IGNORE="^(Errors parsing|No syntax errors detected)"

cat $LINTLOG | egrep -v "$IGNORE" | sed "s|$STAGED/||"

echo "---------------------------------------"

EXIT=$ABORT_COMMIT # but still run the remaining tests

if [ $EXIT -ne 0 ]; then

echo "\ngit: Can't commit; fix errors first."

echo "(If you definitely need to commit this as-is, use the --no-verify option.)"

echo "\nIf the reported line numbers do not match, try stashing your unstaged changes:"

echo "git stash save --keep-index\n"

# Clean up the directory, if preferred:

# rm -f $LINTLOG

# find $STAGED -type d -print0 | xargs -0r rmdir -p --ignore-fail-on-non-empty

exit $EXIT

drupal-pre-commit/scripts/pre-commit.sh at master · asidbackup/drupal-pre-commit · GitHub

Expand file tree

Breadcrumbs

pre-commit.sh

Latest commit

History

Breadcrumbs

pre-commit.sh

File metadata and controls