Git Hooks for Fun and Profit

Core points

• Git Hooks are scripts executed when executing specific commands, helping to simplify development processes and improve efficiency. These scripts can be used to automatically perform code style checks during the commit process to prevent committing syntax errors.
• Use Git Hook to automatically check the spelling of submitted messages, reducing the chance of misspelling and maintaining professionalism. Additionally, hooks can be used to automatically check for format errors to ensure that the code meets the adopted standards.
• Git Hooks can also be used to automatically perform tasks in remote repositories such as Composer during deployment. This simplifies the process of managing application dependencies and simplifies the deployment process.

When executing a specific command, Git searches the .git/hooks directory for appropriate hook scripts, and if found, executes them. You will find a small set of sample scripts in it (you can activate them by renaming them to remove the .sample prefix and set their execution bits), and you can find a full list of hooks in the githooks(5) man page. This article recommends using some hooks to simplify development and improve efficiency.

Code style check

Submitting code with syntax errors is not advisable. If code style checks can be performed automatically during the commit process, it will greatly improve the code quality. If you run a code style check manually before each commit, automating it prevents occasional forgetting. The following shell code can be saved as .git/hooks/pre-commit (if the pre-commit hook code already exists, it can be appended) so that the automatic check is triggered on each commit:

#!/bin/bash
git diff --cached --name-status --diff-filter=ACMR | while read STATUS FILE; do
  if [[ "$FILE" =~ ^.+(php|inc)$ ]]; then
    php -l "$FILE" 1>/dev/null
    if [[ $? -ne 0 ]]; then
      echo "Aborting commit due to files with syntax errors" >&2
      exit 1
    fi
  fi
done

git diff Report what changes have occurred between commits, the above options return only files that have been added (A), copied (C), modified (M), or renamed (R) in the temporary commit. Files with .php or .inc extensions will be used by the target for code style checks, and a failure of the check will cause the script to exit with a non-zero return code, aborting the commit itself.

Submit message spell check

Professional submission is crucial. Use Git Hook to automatically check the spelling of submitted messages to avoid awkward spelling errors. The following code can be saved as .git/hooks/post-commit (or append); it calls Aspell and outputs a list of suspicious words. If there is an error, you can fix the commit message immediately by running git commit --amend.

#!/bin/bash
ASPELL=$(which aspell)
if [[ $? -ne 0 ]]; then
  echo "Aspell not installed – unable to check spelling" >&2
  exit
fi
AWK=$(which awk)
if [[ $? -ne 0 ]]; then
  echo "Awk not installed – unable to filter spelling errors" >&2
  exit
fi
# ... (rest of the spell-check code)

You can also compile a supplementary dictionary (which may be triggered by the post-checkout hook) using the identifier extracted from the project's source code and pass it to Aspell along with --extra-dicts to reduce the number of false positives.

Check code specifications

You can use Git Hook to automatically check that your code complies with the code specifications you have adopted. The following code can be used as a post-commit hook (.git/hooks/post-commit) to automatically check for format conflicts.

#!/bin/bash
git diff --cached --name-status --diff-filter=ACMR | while read STATUS FILE; do
  if [[ "$FILE" =~ ^.+(php|inc)$ ]]; then
    php -l "$FILE" 1>/dev/null
    if [[ $? -ne 0 ]]; then
      echo "Aborting commit due to files with syntax errors" >&2
      exit 1
    fi
  fi
done

Original run Composer

You can use Git Hook to automatically run Composer during deployment. The following code can be placed in the .git/hooks/post-receive file of the remote repository for the post-receive hook, which will automatically run Composer.

#!/bin/bash
ASPELL=$(which aspell)
if [[ $? -ne 0 ]]; then
  echo "Aspell not installed – unable to check spelling" >&2
  exit
fi
AWK=$(which awk)
if [[ $? -ne 0 ]]; then
  echo "Awk not installed – unable to filter spelling errors" >&2
  exit
fi
# ... (rest of the spell-check code)

Conclusion

This article shares some Git Hooks that hopefully simplifies your application development process and improves efficiency.

Git Hooks FAQ

(The FAQ section is omitted here because the article is too long and does not match the pseudo-original goal. It can be retained or deleted as needed.)

The above is the detailed content of Git Hooks for Fun and Profit. For more information, please follow other related articles on the PHP Chinese website!