Sharing hooks with the team (husky) in Git - Mini Project: Build & Apply

Sharing hooks with the team (husky)

📖 Scenario: You are working on a team project using Git. Your team wants to ensure that everyone runs the same checks before committing code. To do this, you will use husky, a tool that helps share Git hooks easily across the team.

🎯 Goal: Set up husky in a project to share a pre-commit hook that runs npm test before every commit. This ensures all team members run tests before committing code.

📋 What You'll Learn

Create a package.json file with basic project info

Add a prepare script to install husky hooks

Initialize husky with npx husky install

Add a pre-commit hook that runs npm test

Verify the pre-commit hook runs on commit

💡 Why This Matters

🌍 Real World

Teams use husky to share Git hooks so everyone runs the same checks before committing code. This prevents errors and keeps code quality high.

💼 Career

Knowing how to set up and share Git hooks with husky is a valuable skill for developers and DevOps engineers to enforce team coding standards.

1

Create package.json with prepare script

Create a package.json file with a scripts section that includes a prepare script set to husky install.

Git

{
  "name": "my-project",
  "version": "1.0.0",
  "scripts": {
    // Add the prepare script here
  }
}

Need a hint?

The prepare script runs automatically after npm install. It should run husky install to set up Git hooks.

2

Initialize husky hooks

Run the command npx husky install in the terminal to create the .husky folder and initialize husky hooks.

Git

{
  "name": "my-project",
  "version": "1.0.0",
  "scripts": {
    "prepare": "husky install"
  }
}

# Run the command below in your terminal
# npx husky install

Need a hint?

This command creates a .husky folder in your project root. It is required to add Git hooks.

3

Add a pre-commit hook to run npm test

Add a pre-commit hook by running npx husky add .husky/pre-commit "npm test" in the terminal. This hook will run tests before every commit.

Git

{
  "name": "my-project",
  "version": "1.0.0",
  "scripts": {
    "prepare": "husky install"
  }
}

# Commands run in terminal:
npx husky install
# Add pre-commit hook below
# npx husky add .husky/pre-commit "npm test"

Need a hint?

This command creates a file .husky/pre-commit that runs npm test before commits.

4

Verify the pre-commit hook runs on commit

Run git commit -m "test commit" in the terminal. The pre-commit hook should run npm test before the commit completes.

Git

{
  "name": "my-project",
  "version": "1.0.0",
  "scripts": {
    "prepare": "husky install"
  }
}

# Commands run in terminal:
npx husky install
npx husky add .husky/pre-commit "npm test"
# Now run the commit command below
# git commit -m "test commit"

Need a hint?

If the pre-commit hook is set up correctly, running git commit will trigger npm test before the commit finishes.