Socket
Socket
Sign inDemoInstall

husky

Package Overview
Dependencies
0
Maintainers
1
Versions
207
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    husky

Modern native Git hooks made easy


Version published
Weekly downloads
12M
increased by0.67%
Maintainers
1
Install size
6.86 kB
Created
Weekly downloads
 

Package description

What is husky?

Husky is an npm package that allows you to manage Git hooks easily. It lets you run scripts at specific points in your Git workflow, such as before committing or pushing code. This helps in automating tasks like code linting, testing, and validation before these actions take place, ensuring code quality and consistency.

What are husky's main functionalities?

Pre-commit Hook

This feature allows you to run commands before a commit is made. In this example, `npm test` and `npm run lint` are executed before each commit, ensuring that tests pass and the code is linted.

"husky": {
  "hooks": {
    "pre-commit": "npm test && npm run lint"
  }
}

Pre-push Hook

This feature allows you to run commands before code is pushed to the repository. In this example, `npm run build` is executed before each push, ensuring that the build is updated.

"husky": {
  "hooks": {
    "pre-push": "npm run build"
  }
}

Commit-msg Hook

This feature allows you to run a script to validate the commit message. In this example, `validate-commit-msg.js` is a script that checks if the commit message follows a certain format.

"husky": {
  "hooks": {
    "commit-msg": "./validate-commit-msg.js"
  }
}

Other packages similar to husky

Readme

Source

husky

Open Collective

Modern native Git hooks made easy

Husky improves your commits and more 🐶 woof!

Usage

Edit package.json > prepare script and run it once:

npm set-script prepare "husky install" && npm run prepare

Add a hook:

npx husky add .husky/pre-commit "npm test"

Make a commit:

$ git commit -m "Keep calm and commit"

Documentation

https://typicode.github.io/husky

Important upgrading from v4 to v6 requires additional steps, please see the docs.

License

MIT

Keywords

FAQs

Last updated on 29 Mar 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc