Powered by modern new Git feature (core.hooksPath)
User-friendly messages
Supports macOS, Linux and Windows
Git GUIs
Custom directories
Monorepo
If you already know what is the lint-staged or Husky (npm packages),
this is very similar but you can use Husky.Net without having node, yarn, etc.. installed, with a lot of more features! 🚀🚀
Why use Hooks and Husky.Net?
We, as developers, love platforms like GitHub, GitLab, Atlassian, Azure DevOps etc., as our managed git system and collaboration platform. We also love clean code and keep inventing new linters and rules to enforce it. In my opinion, every commit should allow the codebase to deploy to production. There is nothing worse than commits like “fixed style errors” or “fixed build”. These are often small mistakes you want to know as early as possible in your development cycle. You don’t want to break the build for the next developer because he pulled your ‘mistake’ or waste precious build minutes of your CI server. Say you have asked your teammate to review your code; in the meantime, the build server rejects your code. That means you have to go back and fix this, and your teammate has to come back and possibly review again after the changes (i.e., approvals reset on new commit). Doing so would waste a lot of time and effort. Husky.Net offers a very simple way to start using git hooks or running certain tasks, write custom scripts using c# and more ...
A lot of features are coming soon, stay tuned! 👁️🗨️👀
Installation
# local installation (recommended)
cd <Your project root directory>
dotnet new tool-manifest
dotnet tool install Husky
# global installation
dotnet tool install --global Husky
Note: With the global installation, you don't need to add the dotnet prefix to the commands.
Setup husky for your project
cd <Your project root directory>
dotnet husky install
git commit -m "Keep calm and commit"
# `echo 'Husky is awesome!'` will run every time you commit
Automate husky installation for other contributors
If you installed husky locally, just add the below code to one of your projects (*.csproj *.vbproj).
Important: Just make sure to update the working directory depending on your folder structure.
<Target Name="husky" BeforeTargets="Restore;CollectPackageReferences">
<Exec Command="dotnet tool restore" StandardOutputImportance="Low" StandardErrorImportance="High"/>
<Exec Command="dotnet husky install" StandardOutputImportance="Low" StandardErrorImportance="High"
WorkingDirectory="../../" /> <!--Update this to the relative path to your project root dir -->
</Target>
If you have only one multiple target project (TargetFrameworks) add the bellow condition IsCrossTargetingBuild to the target tag to prevent multiple execution
Linting makes more sense when run before committing your code. By doing so you can ensure no errors go into the repository and enforce code style. But running a lint process on a whole project is slow, and linting results can be irrelevant. Ultimately you only want to lint files that will be committed.
After installation, you must have task-runner.json file in your .husky directory that you can use to define your tasks.
you can run and test your tasks with husky run command. Once you are sure that your tasks are working properly, you can add it to the hook.
Using bellow configuration you can define your task with a lot of options.
name
optional
type
default
description
command
false
string
-
path to the executable file or script or executable name
args
true
[string array]
-
command arguments
include
true
[array of glob]
**/*
glob pattern to select files
name
true
string
command
name of the task (recommended)
group
true
string
-
group of the task (usually it should be the hook name)
branch
true
string (regex)
-
run task on specific branches only
pathMode
true
[absolute, relative]
relative
file path style (relative or absolute)
cwd
true
string
project root directory
current working directory for the command, can be relative or absolute
output
true
[always, verbose, never]
always
output log level
exclude
true
[array of glob]
-
glob pattern to exclude files
windows
true
object
-
overrides all the above settings for windows
Glob patterns
Husky.Net supports the standard dotnet FileSystemGlobbing patterns for include or exclude task configurations. read more here
Arg Variables
There are some variables that you can use in your task arguments.
${staged}
returns the list of currently staged files
${last-commit}
returns last commit changed files
${git-files}
returns the output of (git ls-files)
${all-files}
returns the list of matched files using include/exclude, be careful with this variable, it will return all the files if you don't specify include or exclude
${args}
returns the arguments passed directly to the husky run command using --args option
e.g."args": [ "${staged}" ]
user-defined variables
You can define your own variables by adding a task to the variables section in task-runner.json.
e.g: defining custom ${root-dir} variable to access root directory files
