GitHooks

Custom logic that runs right before you create a Git commit.

• Checks performed
• Requirements
• Installation
• Usage

Checks performed

• Checks for FIXME in any of the staged text files, so that you don't accidentally commit any code that you don't want to.
  • If it finds any, it stops the commit and tells you which file and line number it was found in, so you can fix the code.
• Checks staged .NET package lock files for Microsoft.NET.ILLink.Tasks, which is automatically added by Visual Studio and causes package restoration in locked mode to fail because it's not a real dependency of your project.
  • If it finds any, it automatically removes this dependency from packages.lock.json so that dotnet restore --locked-mode will succeed. This does not break Visual Studio either, which will either ignore it or try to add it again later. The commit continues automatically.
  • This dependency is preserved if the project publishes to a single file, for example if PublishSingleFile or PublishAot are set to true in the .csproj file.

Requirements

• Operating system: Windows (x64 or arm64) or Linux (x64, arm, or arm64)
• Git
• .NET Runtime 9 or later

Installation

1. Download GitHooks.zip from the latest release.
2. Locate the pre-commit executable in the subdirectory of the ZIP file which corresponds to your operating system and CPU architecture (e.g. win-x64\pre-commit.exe for Windows x64).
3. Extract that pre-commit executable to a Git hooks directory, depending on the scope you want it to apply to.
   • One repository: extract it to <repo>/git/hooks/pre-commit.exe
   • All repositories for a user: extract it to any directory, then run git config --global core.hookspath "<dir>"
   • All repositories for all users: extract it to any directory, then run git config --system core.hookspath "<dir>"

Usage

Just run git commit the way you normally would. If it commits successfully, there were no fatal errors.

Otherwise, it will abort the commit and print a message showing why it stopped and how to proceed. This generally involves fixing whatever you commented with FIXME, removing that comment, running git add on that fixed file, and then calling git commit again with your original commit message.

Testing

If you want to run this hook without committing anything, you can call

git hook run pre-commit --no-ignore-missing