Set up husky.net

[reakaleek]

Details

What Gets Checked

Pre-commit hooks (run on staged files):

• prettier - Formats TypeScript, JavaScript, CSS, and JSON files in src/Elastic.Documentation.Site/
• typescript-check - Type checks TypeScript files with tsc --noEmit (only if TS files are staged)
• eslint - Lints and fixes JavaScript/TypeScript files

Pre-push hooks (run on files being pushed):

• dotnet-lint - Lints C# and F# files using ./build.sh lint (runs dotnet format --verify-no-changes)

Installation

Husky.Net is included as a dotnet tool. After cloning the repository, restore the tools:

dotnet tool restore

Then install the git hooks:

dotnet husky install

That's it! The hooks will now run automatically on every commit and push.

Usage

Once installed, hooks run automatically when you commit or push:

git add .
git commit -m "your message"  # Pre-commit hooks run here
git push                       # Pre-push hooks run here

Note: If hooks modify files (prettier, eslint), the commit will fail so you can review the changes. Simply stage the changes and commit again:

git add -u
git commit -m "your message"

If the dotnet-lint hook fails during push, you need to fix the linting errors and commit the fixes before pushing again.

Manual Execution

You can test hooks without committing or pushing:

# Run all pre-commit tasks
dotnet husky run --group pre-commit

# Run all pre-push tasks
dotnet husky run --group pre-push

# Test individual tasks
dotnet husky run --name prettier
dotnet husky run --name typescript-check
dotnet husky run --name eslint
dotnet husky run --name dotnet-lint

Configuration

Hook configuration is defined in .husky/task-runner.json. See the Husky.Net documentation for more details.

[Mpdreamz]

LGTM thank you for setting this up.

[github-actions]

🔍 Preview links for changed docs

• CONTRIBUTING.md