From 26b6bf41c7d7d5592fcd0c2dc5c494eae7891992 Mon Sep 17 00:00:00 2001 From: typicode Date: Mon, 13 Sep 2021 23:51:30 +0200 Subject: [PATCH] docs: add `npx husky add` workaround on Windows --- docs/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/README.md b/docs/README.md index 9f18ae5dd..7bc2d5599 100644 --- a/docs/README.md +++ b/docs/README.md @@ -76,6 +76,8 @@ For example: npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"' ``` +_For Windows users, if you see the help message when running `npx husky add ...`, try `node node_modules/.bin/husky add ...` instead. This isn't an issue with husky code._ + ## Manual ### Install @@ -130,6 +132,8 @@ If `npm test` command fails, your commit will be automatically aborted. !> **Using Yarn to run commands? There's an issue on Windows with Git Bash, see [Yarn on Windows](/?id=yarn-on-windows).** +_For Windows users, if you see the help message when running `npx husky add ...`, try `node node_modules/.bin/husky add ...` instead. This isn't an issue with husky code._ + ### Uninstall ```shell