Sharing hooks with the team (husky) in Git - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is Husky in the context of Git?

Husky is a tool that helps you run scripts automatically before Git actions like commit or push. It makes sure everyone on the team runs the same checks.

beginner

How does Husky help share Git hooks with a team?

Husky stores hook scripts in the project configuration, so when team members clone the repo and install dependencies, the hooks are set up automatically on their machines.

intermediate

Where do you define Husky hooks in a project?

You define Husky hooks in the package.json file under the "husky" section or in separate hook files managed by Husky in the .husky directory.

beginner

What command do you run to install Husky hooks after cloning a repo?

You run `npm install` or `yarn install` to install dependencies, and Husky will automatically set up the Git hooks defined in the project.

beginner

Why is sharing Git hooks with Husky better than manually setting hooks?

Because Husky automates hook setup, it avoids mistakes and ensures all team members use the same checks without extra manual steps.

What does Husky primarily help with in Git?

A Running scripts automatically before Git actions

B Merging branches automatically

C Creating new Git repositories

D Backing up Git data

Husky runs scripts automatically before Git actions like commit or push to enforce checks.

Where are Husky hooks usually defined?

A In the package.json or .husky directory

B In the .gitignore file

C In the README.md file

D In the node_modules folder

Husky hooks are defined in package.json under "husky" or in the .husky directory.

How do team members get Husky hooks after cloning a repo?

A By manually copying hook files

B By running npm install or yarn install

C By running git init

D By creating hooks themselves

Running npm install or yarn install installs dependencies and sets up Husky hooks automatically.

Which Git action can Husky run scripts before?

A branch

B clone

C fetch

D commit

Husky commonly runs scripts before commit or push actions.

What is a key benefit of using Husky for Git hooks?

A Automatically merges conflicts

B Increases Git repository size

C Ensures consistent hooks for all team members

D Removes the need for Git

Husky ensures all team members have the same Git hooks set up automatically.

Explain how Husky helps share Git hooks with your team.

Think about how Husky makes sure everyone runs the same checks without manual setup.

Describe the steps a team member takes to get Husky hooks after cloning a repository.

Focus on what happens after cloning and installing dependencies.

Practice

1. What is the main purpose of using Husky in a Git project?

easy

A. To share Git hooks easily with the whole team

B. To create new Git branches automatically

C. To merge pull requests without conflicts

D. To backup the Git repository to the cloud

Solution

1. Step 1: Understand what Git hooks do

   Git hooks are scripts that run at certain points in Git workflows, like before commits.

2. Step 2: Identify Husky's role

   Husky helps share these hooks easily among team members by managing them in the project.

3. Final Answer:

   To share Git hooks easily with the whole team -> Option A

4. Quick Check:

   Husky = Share Git hooks [OK]

Hint: Husky = sharing Git hooks with team [OK]

Common Mistakes:

• Thinking Husky manages branches
• Confusing Husky with backup tools
• Assuming Husky merges pull requests

2. Which command correctly installs Husky hooks in your Git project?

easy

A. npm install husky

B. git husky add

C. husky install

D. husky init

Solution

1. Step 1: Recall Husky installation steps

   First, you install Husky as a package (e.g., npm install husky), then you run husky install to set up Git hooks.

2. Step 2: Identify the command that sets up hooks

   The command husky install creates the hooks folder and configures Git to use Husky hooks.

3. Final Answer:

   husky install -> Option C

4. Quick Check:

   Setup hooks = husky install [OK]

Hint: Use 'husky install' to set up hooks folder [OK]

Common Mistakes:

• Using 'npm install husky' as hook setup
• Trying 'git husky add' which is invalid
• Confusing 'husky init' with 'husky install'

3. Given the commands below, what will be the result?

npm install husky
npx husky install
npx husky add .husky/pre-commit "npm test"
git commit -m "test commit"

medium

A. The commit will fail because the hook is not installed

B. The pre-commit hook runs 'npm test' before the commit

C. The commit message will be ignored

D. The pre-commit hook runs 'git status' before the commit

Solution

1. Step 1: Analyze the commands

   First, Husky is installed. Then hooks are installed with husky install. Next, a pre-commit hook is added to run npm test.

2. Step 2: Understand the effect on commit

   When git commit runs, the pre-commit hook triggers npm test before allowing the commit.

3. Final Answer:

   The pre-commit hook runs 'npm test' before the commit -> Option B

4. Quick Check:

   pre-commit runs npm test [OK]

Hint: Add hook with 'husky add' to run commands pre-commit [OK]

Common Mistakes:

• Assuming hooks run after commit
• Forgetting to run 'husky install'
• Confusing hook commands with commit messages

4. You committed the .husky folder but your teammate's hooks are not running. What is the most likely cause?

medium

A. They forgot to run husky install after pulling

B. The .husky folder is ignored by Git

C. Hooks only work on Windows, not Linux

D. Git does not support hooks in shared repos

Solution

1. Step 1: Understand sharing hooks with Husky

   Even if the .husky folder is committed, each user must run husky install locally to activate hooks.

2. Step 2: Identify the common setup mistake

   If teammates don't run husky install, hooks won't be linked to Git and won't run.

3. Final Answer:

   They forgot to run husky install after pulling -> Option A

4. Quick Check:

   Run husky install locally to activate hooks [OK]

Hint: Run 'husky install' after pulling to activate hooks [OK]

Common Mistakes:

• Assuming committed hooks auto-activate
• Thinking hooks don't work on Linux
• Believing Git disables hooks in shared repos

5. Your team wants to share a pre-push hook that runs tests before pushing. Which steps correctly set this up using Husky?

hard

A. Run git hook add pre-push npm test and push changes

B. Add pre-push: npm test in package.json, no other steps needed

C. Create a script named pre-push.sh and add it to .git/hooks manually

D. Run npx husky add .husky/pre-push "npm test", commit .husky, teammates run husky install

Solution

1. Step 1: Add the pre-push hook with Husky

   Use npx husky add .husky/pre-push "npm test" to create the hook script that runs tests before push.

2. Step 2: Share and activate hooks

   Commit the .husky folder so teammates get the hook, and they must run husky install locally to activate it.

3. Final Answer:

   Run npx husky add .husky/pre-push "npm test", commit .husky, teammates run husky install -> Option D

4. Quick Check:

   Add hook, commit folder, teammates install hooks [OK]

Hint: Add hook with husky add, commit folder, teammates run husky install [OK]

Common Mistakes:

• Editing package.json instead of using husky add
• Manually adding scripts to .git/hooks (not shared)
• Using invalid git commands for hooks