Husky

https://typicode.github.io/husky/
Admin
Husky is an ultra-fast modern native Git hooks tool that automatically lints commit messages, code,...
Tokens:5,220
Snippets:84
Trust Score:8.3
Update:38 minutes ago
Show doc for...
Tokens:
Raw
### Husky init.sh with nvm initialization

Source: https://typicode.github.io/husky/how-to.html

Example init.sh that loads nvm, ensuring Node is available in GUI-launched Git hooks.

```shell
# ~/.config/husky/init.sh
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm
```

--------------------------------

### package.json prepare script for npm

Source: https://typicode.github.io/husky/how-to.html

Adds the 'prepare' script to package.json for automatic Husky setup after each install. Recommended for npm.

```json
{
  "scripts": {
    "prepare": "husky"
  }
}
```

--------------------------------

### Install Husky with bun

Source: https://typicode.github.io/husky/get-started.html

Installs Husky as a development dependency using bun.

```shell
bun add --dev husky
```

--------------------------------

### Install Husky with pnpm

Source: https://typicode.github.io/husky/get-started.html

Installs Husky as a development dependency using pnpm.

```shell
pnpm add --save-dev husky
```

--------------------------------

### Use install.mjs in prepare script

Source: https://typicode.github.io/husky/how-to.html

Updates the prepare script to run node .husky/install.mjs, which conditionally installs Husky.

```json
"prepare": "node .husky/install.mjs"
```

--------------------------------

### Install Husky with yarn

Source: https://typicode.github.io/husky/get-started.html

Installs Husky as a development dependency using yarn. Also installs pinst if the package is not private.

```shell
yarn add --dev husky
# Add pinst ONLY if your package is not private
yarn add --dev pinst
```

--------------------------------

### Install Husky with npm

Source: https://typicode.github.io/husky/get-started.html

Installs Husky as a development dependency using npm.

```shell
npm install --save-dev husky
```

--------------------------------

### Example of two Node versions in version manager directory

Source: https://typicode.github.io/husky/how-to.html

Shows the paths of two Node versions managed by a version manager, illustrating how PATH is modified.

```shell
~/version-manager/Node-X/node
~/version-manager/Node-Y/node
```

--------------------------------

### Create .husky/install.mjs to skip Husky install in production/CI

Source: https://typicode.github.io/husky/how-to.html

Creates a script that exits early in production or CI environments, and otherwise runs Husky's install. Used to avoid 'command not found' errors.

```js
// Skip Husky install in production and CI
if (process.env.NODE_ENV === 'production' || process.env.CI === 'true') {
  process.exit(0)
}
const husky = (await import('husky')).default
console.log(husky())
```

--------------------------------

### Run locally installed binaries via package manager

Source: https://typicode.github.io/husky/migrate-from-v4.html

Shows the v4 .huskyrc.json configuration and the v9 .husky/pre-commit script. In v9, you must run locally installed binaries via your package manager (e.g., npx).

```js
{
  "hooks": {
    "pre-commit": "jest"
  }
}
```

```shell
jest
```

--------------------------------

### Modify prepare script to never fail

Source: https://typicode.github.io/husky/how-to.html

Changes the prepare script to 'husky || true' so it doesn't fail when Husky isn't installed (e.g., when only dependencies are installed).

```json
// package.json
"prepare": "husky || true"
```

--------------------------------

### Project structure for non-Git root

Source: https://typicode.github.io/husky/how-to.html

Example project structure where Husky is in the frontend subdirectory and the Git root is the parent directory.

```text
.
├── .git/
├── backend/  # No package.json
└── frontend/ # Package.json with husky
```

--------------------------------

### Disable hooks globally via init.sh config

Source: https://typicode.github.io/husky/how-to.html

Modifies ~/.config/husky/init.sh to export HUSKY=0, preventing Husky from installing and running hooks on the machine.

```sh
# ~/.config/husky/init.sh
export HUSKY=0 # Husky won't install and won't run hooks on your machine
```

--------------------------------

### Set HUSKY=0 in GitHub Actions environment

Source: https://typicode.github.io/husky/how-to.html

Uses HUSKY=0 in a GitHub Actions workflow to avoid installing Git hooks on CI servers.

```yml
# https://docs.github.com/en/actions/learn-github-actions/variables
env:
  HUSKY: 0
```

--------------------------------

### Run postinstall script with yarn

Source: https://typicode.github.io/husky/how-to.html

Yarn doesn't support 'prepare', so run the postinstall script instead.

```sh
# Yarn doesn't support `prepare`
yarn run postinstall
```

--------------------------------

### Husky init.sh sourcing shell startup file

Source: https://typicode.github.io/husky/how-to.html

Alternative init.sh that sources the shell startup file directly, if it is fast and lightweight.

```shell
# ~/.config/husky/init.sh
. ~/.zshrc
```

--------------------------------

### Run prepare script with bun

Source: https://typicode.github.io/husky/how-to.html

Executes the prepare script once to set up Husky.

```sh
bun run prepare
```

--------------------------------

### Run prepare script with npm

Source: https://typicode.github.io/husky/how-to.html

Executes the prepare script once to set up Husky.

```sh
npm run prepare
```

--------------------------------

### Initialize Husky with bunx

Source: https://typicode.github.io/husky/get-started.html

Runs the `husky init` command using bunx.

```shell
bunx husky init
```

--------------------------------

### Run prepare script with pnpm

Source: https://typicode.github.io/husky/how-to.html

Executes the prepare script once to set up Husky.

```sh
pnpm run prepare
```

--------------------------------

### Initialize Husky with npx

Source: https://typicode.github.io/husky/get-started.html

Runs the `husky init` command using npx, which creates a pre-commit script and updates the prepare script.

```shell
npx husky init
```

--------------------------------

### Initialize Husky with pnpm exec

Source: https://typicode.github.io/husky/get-started.html

Runs the `husky init` command using pnpm exec.

```shell
pnpm exec husky init
```

--------------------------------

### Initialize Husky with yarn

Source: https://typicode.github.io/husky/get-started.html

Placeholder for yarn initialization, noting to refer to the How To section due to caveats.

```shell
# Due to specific caveats and differences with other package managers,
# refer to the How To section.
```

--------------------------------

### echo $PATH with Node-X

Source: https://typicode.github.io/husky/how-to.html

Displays the PATH after switching to Node-X.

```shell
echo $PATH
# Output
~/version-manager/Node-X/:...
```

--------------------------------

### Create pre-commit hook for npm

Source: https://typicode.github.io/husky/how-to.html

Creates a pre-commit hook file in .husky/ that runs npm test.

```shell
# .husky/pre-commit
npm test
```

--------------------------------

### Create pre-commit hook for bun

Source: https://typicode.github.io/husky/how-to.html

Creates a pre-commit hook file in .husky/ that runs bun test.

```sh
# .husky/pre-commit
bun test
```

--------------------------------

### package.json scripts for yarn

Source: https://typicode.github.io/husky/how-to.html

Yarn doesn't support the prepare script, so use postinstall. Also includes prepack and postpack scripts for publishing to npmjs.com.

```json
{
  "scripts": {
    // Yarn doesn't support prepare script
    "postinstall": "husky",
    // Include this if publishing to npmjs.com
    "prepack": "pinst --disable",
    "postpack": "pinst --enable"
  }
}
```

--------------------------------

### echo $PATH with Node-Y

Source: https://typicode.github.io/husky/how-to.html

Displays the PATH after the version manager initializes and selects Node-Y.

```shell
echo $PATH
# Output
~/version-manager/Node-Y/:...
```

--------------------------------

### Non-shell hook entrypoint

Source: https://typicode.github.io/husky/how-to.html

Create an entrypoint file for the hook, e.g., .husky/pre-commit.

```shell
.husky/pre-commit
```

--------------------------------

### Create pre-commit hook for pnpm

Source: https://typicode.github.io/husky/how-to.html

Creates a pre-commit hook file in .husky/ that runs pnpm test.

```shell
# .husky/pre-commit
pnpm test
```

--------------------------------

### Migrate package.json hooks to .husky/pre-commit

Source: https://typicode.github.io/husky/migrate-from-v4.html

Shows the v4 package.json hooks configuration and the corresponding v9 .husky/pre-commit script. In v9, commands can be on multiple lines.

```json
// package.json
{
  "hooks": {
    "pre-commit": "npm test && npm run foo"
  }
}
```

```shell
# .husky/pre-commit
# Note that you can now have commands on multiple lines
npm test // [!code hl]
npm run foo // [!code hl]
```

--------------------------------

### Add a new hook with echo command

Source: https://typicode.github.io/husky/how-to.html

Creates a pre-commit hook file that runs 'npm test'. Works on Linux/macOS.

```shell
echo "npm test" > .husky/pre-commit
```

--------------------------------

### Prepare script for non-Git root

Source: https://typicode.github.io/husky/how-to.html

Set the prepare script to change directory to the Git root and run husky on the frontend/.husky directory.

```json
"prepare": "cd .. && husky frontend/.husky"
```

--------------------------------

### Create pre-commit hook for yarn

Source: https://typicode.github.io/husky/how-to.html

Creates a pre-commit hook file in .husky/ that runs yarn test.

```shell
# .husky/pre-commit
yarn test
```

--------------------------------

### Yarn on Windows workaround: .husky/pre-commit

Source: https://typicode.github.io/husky/troubleshoot.html

Source the common.sh script in your hook file (e.g., .husky/pre-commit) before running Yarn commands.

```shell
# .husky/pre-commit
. .husky/common.sh

yarn ...
```

--------------------------------

### Non-shell hook entrypoint content

Source: https://typicode.github.io/husky/how-to.html

Add the command to run the Node.js script from the entrypoint.

```shell
node .husky/pre-commit.js
```

--------------------------------

### Lint staged files with Husky pre-commit hook

Source: https://typicode.github.io/husky/get-started.html

A basic shell script for the pre-commit hook that runs Prettier on staged files and updates the index.

```shell
# .husky/pre-commit
prettier $(git diff --cached --name-only --diff-filter=ACMR | sed 's| |\ |g') --write --ignore-unknown
git update-index --again
```

--------------------------------

### Replace HUSKY_GIT_PARAMS with native Git parameters

Source: https://typicode.github.io/husky/migrate-from-v4.html

Shows the v4 .huskyrc.json configuration and the v9 .husky/commit-msg script. HUSKY_GIT_PARAMS is replaced by native params like $1.

```js
{
  "hooks": {
    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
  }
}
```

```shell
commitlint --edit $1
```

--------------------------------

### Yarn on Windows workaround: .husky/common.sh

Source: https://typicode.github.io/husky/troubleshoot.html

Create this shell script to fix Git hooks failing with Yarn on Windows using Git Bash (stdin is not a tty). It checks for winpty and redirects stdin to /dev/tty.

```shell
command_exists () {
  command -v "$1" >/dev/null 2>&1
}

# Workaround for Windows 10, Git Bash, and Yarn
if command_exists winpty && test -t 1; then
  exec < /dev/tty
fi
```

--------------------------------

### Bash hook script

Source: https://typicode.github.io/husky/how-to.html

Use Bash in a hook script by wrapping the script in a here-document. This is only recommended if your team doesn't use Windows.

```shell
# .husky/pre-commit

bash << EOF
# Put your bash script inside
# ...
EOF
```

--------------------------------

### Node.js hook script

Source: https://typicode.github.io/husky/how-to.html

The actual Node.js code for the hook, placed in .husky/pre-commit.js.

```javascript
// Your NodeJS code
// ...
```

--------------------------------

### Test Husky with git commit

Source: https://typicode.github.io/husky/get-started.html

Commits changes to trigger the test script that runs on every commit.

```shell
git commit -m "Keep calm and commit"
# test script will run every time you commit
```

--------------------------------

### Test a hook by adding exit 1

Source: https://typicode.github.io/husky/how-to.html

Add 'exit 1' to the hook script to abort the Git command and test the hook. The commit will not be created.

```shell
# .husky/pre-commit

# Your WIP script
# ...

exit 1
```

```shell
git commit -m "testing pre-commit code"
# A commit will not be created
```

--------------------------------

### Hook script for non-Git root

Source: https://typicode.github.io/husky/how-to.html

In the hook script, change directory back to the relevant subdirectory before running commands.

```shell
# frontend/.husky/pre-commit
cd frontend
npm test
```

--------------------------------

### Skip Git hooks for a single command with -n flag

Source: https://typicode.github.io/husky/how-to.html

Uses the -n/--no-verify option to skip Git hooks for a single commit command.

```sh
git commit -m "..." -n # Skips Git hooks
```

--------------------------------

### Disable hooks for multiple commands with export HUSKY=0

Source: https://typicode.github.io/husky/how-to.html

Exports HUSKY=0 to disable hooks for an extended period (e.g., during rebase/merge), then re-enables with unset HUSKY.

```shell
export HUSKY=0 # Disables all Git hooks
git ...
git ...
unset HUSKY # Re-enables hooks
```

--------------------------------

### Temporarily disable all Git hooks with HUSKY=0

Source: https://typicode.github.io/husky/how-to.html

Sets HUSKY=0 to disable all Git hooks for a single command, then hooks run again afterward.

```shell
HUSKY=0 git ... # Temporarily disables all Git hooks
git ... # Hooks will run again
```
Tokens:
Raw