Git hooks made easy with Husky.Net internal task runner! 🐶 It brings the dev-dependency concept to the .NET world!
$ dotnet add package HuskyHusky improves your commits and more 🐶 woof!
You can use it to lint your commit messages, run tests, lint code, etc... when you commit or push.
Features
next
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! 🚀🚀
# 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.
cd <Your project root directory>
dotnet husky install
dotnet husky add .husky/pre-commit "echo 'Husky is awesome!'"
git add .husky/pre-commit
git commit -m "Keep calm and commit"
# `echo 'Husky is awesome!'` will run every time you commit
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 releative 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
<Target Name="husky" BeforeTargets="Restore;CollectPackageReferences" Condition="'$(IsCrossTargetingBuild)' == 'true'">
...Or If you are using the npm, add the below code to your package.json file to automatically install husky after the installation process:
"scripts": {
"prepare": "dotnet tool restore && dotnet husky install"
}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.
e.g.
dotnet husky add .husky/pre-commit "dotnet husky run"task-runner.json
{
"tasks": [
{
"command": "dotnet",
"group": "backend",
"args": ["dotnet-format", "--include", "${staged}"],
"include": ["**/*.cs", "**/*.vb"]
},
{
"name": "eslint",
"group": "frontend",
"command": "npm",
"pathMode": "absolute",
"cwd": "Client",
"args": ["run", "lint", "${staged}"],
"include": ["**/*.ts", "**/*.vue", "**/*.js"]
},
{
"name": "prettier",
"group": "frontend",
"command": "npx",
"pathMode": "absolute",
"cwd": "Client",
"args": ["prettier", "--write", "${staged}"],
"include": [
"**/*.ts",
"**/*.vue",
"**/*.js",
"**/*.json",
"**/*.yml",
"**/*.css",
"**/*.scss"
]
},
{
"name": "Welcome",
"output": "always",
"command": "bash",
"args": ["-c", "echo 🌈 Nice work! 🥂"],
"windows": {
"command": "cmd",
"args": ["/c", "echo 🌈 Nice work! 🥂"]
}
}
]
}
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 |
| 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 |
There are some variables that you can use in your task arguments.
e.g."args": ["format", "${staged}"]]
Husky.Net supports the standard dotnet FileSystemGlobbing patterns for include or exclude task configurations. read more here
Consider all bellow 1.x versions as beta. ( we need a lot of tests before major release )
Don't forget to give a ⭐ on GitHub
This library inspired of husky & lint-staged and a few other tools, for DotNet, so make sure to support them too!
husky run command doesn't have color when executed from hooks.