# husky-bird > Prevents bad commit or push (git hooks, pre-commit/precommit, pre-push/prepush, post-merge/postmerge and all that stuff...) Latest version **2.6.0-twitter.0** (published 2020-06-26) · MIT license · 0 weekly downloads ## Install ```sh npm install husky-bird pnpm add husky-bird yarn add husky-bird bun add husky-bird ``` Provides the commands `husky-run`, `husky-upgrade`. ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 2.6.0-twitter.0 | | Published | 2020-06-26 | | First published | 2020-06-26 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=8.6.0 | | Dependencies | 10 | | Unpacked size | 41 KB | | Known vulnerabilities | 0 | | Install scripts | yes | | GitHub stars | 0 | | Maintainers | vincemalone | | Keywords | git, hook, hooks, pre-commit, precommit, post-commit, postcommit, pre-push, prepush, post-merge, postmerge, test, lint | ## Links - npm: https://www.npmjs.com/package/husky-bird - Repository: https://github.com/VinceMalone/husky - Homepage: https://github.com/typicode/husky#readme - Issues: https://github.com/typicode/husky/issues - npm.io page: https://npm.io/package/husky-bird ## Dependencies (10) - [execa](https://npm.io/package/execa.md) ^1.0.0 - [is-ci](https://npm.io/package/is-ci.md) ^2.0.0 - [slash](https://npm.io/package/slash.md) ^3.0.0 - [pkg-dir](https://npm.io/package/pkg-dir.md) ^4.2.0 - [read-pkg](https://npm.io/package/read-pkg.md) ^5.1.1 - [run-node](https://npm.io/package/run-node.md) ^1.0.0 - [get-stdin](https://npm.io/package/get-stdin.md) ^7.0.0 - [cosmiconfig](https://npm.io/package/cosmiconfig.md) ^5.2.1 - [please-upgrade-node](https://npm.io/package/please-upgrade-node.md) ^3.1.1 - [opencollective-postinstall](https://npm.io/package/opencollective-postinstall.md) ^2.0.2 ## Alternatives - [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads - [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads - [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads - [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads - [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads ## Recent versions - 2.6.0-twitter.0 (latest) — 2020-06-26 ## README # husky > Git hooks made easy [![Financial Contributors on Open Collective](https://opencollective.com/husky/all/badge.svg?label=financial+contributors)](https://opencollective.com/husky) [![](https://img.shields.io/npm/dm/husky.svg?style=flat)](https://www.npmjs.org/package/husky) [![Mac/Linux Build Status](https://img.shields.io/travis/typicode/husky.svg?label=Mac%20OSX%20%26%20Linux)](https://travis-ci.org/typicode/husky) [![Windows Build status](https://img.shields.io/appveyor/ci/typicode/husky/master.svg?label=Windows)](https://ci.appveyor.com/project/typicode/husky) Husky can prevent bad `git commit`, `git push` and more 🐶 _woof!_ Visit [thanks.typicode.com](https://thanks.typicode.com) to view all the people supporting husky. ## Install ```sh npm install husky --save-dev ``` ```js // package.json { "husky": { "hooks": { "pre-commit": "npm test", "pre-push": "npm test", "...": "..." } } } ``` ```sh git commit -m 'Keep calm and commit' ``` To go further, see the docs [here](https://github.com/typicode/husky/blob/master/DOCS.md). __Note__: there's a known issue with Node `v12.0`, please use `v12.1` or higher. ## Uninstall ```sh npm uninstall husky ``` ## Upgrading from 0.14 Simply move your existing hooks to `husky.hooks` field and use raw Git hooks names. Also, if you're using the `GIT_PARAMS` env variable, rename it to `HUSKY_GIT_PARAMS`. ```diff { "scripts": { - "precommit": "npm test", - "commitmsg": "commitlint -E GIT_PARAMS" }, + "husky": { + "hooks": { + "pre-commit": "npm test", + "commit-msg": "commitlint -E HUSKY_GIT_PARAMS" + } + } } ``` Alternatively, you can run the following command which will do the same automatically for you ;) ``` ./node_modules/.bin/husky-upgrade ``` Starting with `1.0.0`, you can also configure hooks using `.huskyrc`, `.huskyrc.json` or `.huskyrc.js` file. ```js // .huskyrc { "hooks": { "pre-commit": "npm test" } } ``` To view the full list of changes, please see the [CHANGELOG](https://github.com/typicode/husky/blob/master/CHANGELOG.md). ## Features * Keeps existing user hooks * Supports GUI Git clients * Supports all Git hooks (`pre-commit`, `pre-push`, ...) ## Used by * [webpack](https://github.com/webpack/webpack) * [babel](https://github.com/babel/babel) * [create-react-app](https://github.com/facebookincubator/create-react-app) * [Next.js](https://github.com/zeit/next.js) * [Hyper](https://github.com/zeit/hyper) * [Kibana](https://github.com/elastic/kibana) * [JSON Server](https://github.com/typicode/json-server) * [Hotel](https://github.com/typicode/hotel) * ... and many other awesome projects ## See also * [pkg-ok](https://github.com/typicode/pkg-ok) - Prevents publishing a module with bad paths or incorrect line endings * [please-upgrade-node](https://github.com/typicode/please-upgrade-node) - Show a message to upgrade Node instead of a stacktrace in your CLIs * [pinst](https://github.com/typicode/pinst) - dev only postinstall hook ## Financial Contributors Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/husky/contribute)] ### Individuals ### Organizations Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/husky/contribute)] ### Patreon People and companies supporting via Patreon: [thanks](https://thanks.typicode.com) ## License MIT --- _Source: https://npm.io/package/husky-bird · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._