Search for pre-committed files

Question

I am trying to add a pre-commit git hook that will check all modified and new files for TODO: text.

I tried

 #!/bin/sh . git-sh-setup # for die git-diff-index -p -M --cached HEAD -- | grep '^+' | grep TODO: && die Blocking commit because string TODO: detected in patch : 

What I saw in a similar question, but no luck.

Answer 1

First, the hook must be in the .git/hook folder and the pre-commit name (with execute chmod +x .git/hooks/pre-commit : chmod +x .git/hooks/pre-commit )

OP jesusjjf confirms in the comments that there was a problem:

I copied what was in the pre-commit.sample file into a simple text file, and not just renamed it.

Secondly, here are some sample scripts:

---

You have another example using a similar technique, using git rev-parse and git diff-index and the empty tree that I mentioned earlier :

 #!/bin/sh if git rev-parse --verify HEAD >/dev/null 2>&1; then against=HEAD else against=4b825dc642cb6eb9a060e54bf8d69288fbee4904 fi for FILE in `git diff-index --name-status $against -- | cut -c3-` ; do # Check if the file contains 'debugger' if [ "grep 'debugger' $FILE" ] then echo $FILE ' contains debugger!' exit 1 fi done exit 

Comments on this topic mention:

On my system, if [ "grep 'debugger' $FILE" ] always evaluated as true .
Changing this parameter to if grep -q 'debugger' "$FILE" fixes this.

---

A more recent example :

 #!/bin/bash # Pre commit hook that prevents FORBIDDEN code from being commited. # Add unwanted code to the FORBIDDEN array as necessary FILES_PATTERN='\.(rb|js|coffee)(\..+)?$' FORBIDDEN=( debugger ruby-debug ) for i in "${FORBIDDEN[@]}" do git diff --cached --name-only| grep ".js" |xargs sed 's/ //g'|grep "ha_mobile.debug=true" && \ echo 'COMMIT REJECTED Found ha_mobile.debug=true references. Please remove them before commiting' && exit 1 git diff --cached --name-only | \ grep -E $FILES_PATTERN | \ GREP_COLOR='4;5;37;41' xargs grep --color --with-filename -n $i && \ echo 'COMMIT REJECTED Found' $i 'references. Please remove them before commiting' && exit 1 done exit 0 

Answer 2

This bit iterates over the files that are arranged, yes, but then it cleans the entire file no matter what parts are organized!

  git diff --cached --name-only | \ grep -E $FILES_PATTERN | \ echo 'COMMIT REJECTED Found' $i 'references. Please remove them before commiting' && exit 1 

This is not good - do not test strings that are not supplied.

This solution checks one or more FORBIDDEN lines for only step-by-step code, not the whole file :

before fixing

 #!/bin/bash RESTORE='\033[0m' RED='\033[00;31m' YELLOW='\033[00;33m' BLUE='\033[00;34m' FORBIDDEN=( 'TODO:' 'DO NOT COMMIT' 'console.log' 'die' ) FOUND='' for j in "${FORBIDDEN[@]}" do for i in `git diff --cached --name-only` do # the trick is here...use `git show :file` to output what is staged # test it against each of the FORBIDDEN strings ($j) if echo `git show :$i` | grep -q "$j"; then FOUND+="${BLUE}$i ${RED}contains ${RESTORE}\"$j\"${RESTORE}\n" fi done done # if FOUND is not empty, REJECT the COMMIT # PRINT the results (colorful-like) if [[ ! -z $FOUND ]]; then printf "${YELLOW}COMMIT REJECTED\n" printf "$FOUND" exit 1 fi # nothing found? let the commit happen exit 0