How to husky prepare-commit-msg on windows?

[creaux]

Using husky it is very useful but script which is there is designed only for bash purpose.

"husky": {
  "hooks": {
    "prepare-commit-msg": "exec < /dev/tty && git cz --hook",
  }
}

What could be solution for Windows?

[silltho]

I'm having the same issue. Can someone provide an easy workaround for this ?

[iyeldinov]

Error message on windows is
The system cannot find the path specified.

What is the possible workaround for Windows?

[a294465800]

same issue.

[fancyboynet]

I got the error on windows:

husky > prepare-commit-msg hook failed (cannot be bypassed with --no-verify due to Git specs)

[olgn]

I developed this feature for people using bash (which works for MacOS + Linux). I'm not sure how to perform the same effect using windows.

My sense is that there needs to be an additional check in the prepare-commit-msg hook on whether exec < dev/tty works, and if not assume windows and get the same behavior using native cmd commands.

I do not use windows, and so this would be difficult for me to get working (but not impossible, added to my task list). If any of y'all figure out a workaround in the meantime, please post here and / or submit a pr to this repo.

[olgn]

This thread here suggests using file.open('CON') or file.open('CON:') as an alternative.

[sadsa]

@olgn - Can we perhaps get more information around this. I've been using WSL for Windows as a workaround but realistically my whole team is running windows It would be nice to have a solution to this,

[olgn]

@sadsa I'll give it a shot.

As you know (because you had to follow the instructions in the README), the method of enforcement for commitizen commit messages uses Husky. Husky pre-commit hooks are tied into the corresponding your-commitizen-enforced-repo/.git/hooks/<hook_name>.sh file when you run yarn / npm install. This means that husky writes the content exec < /dev/tty && git-cz --hook into the `.git/hooks/prepare-commit-msg' hook script.

The git-cz --hook command should look familiar. It's just running commitizen. The --hook option essentially takes the commit message that commitizen creates and then writes it directly to the your-commitizen-enforced-repo/.git/COMMIT_EDITMSG file. This is the file from which the commit message is read. If you run git commit -m "foo", and then open the COMMIT_EDITMSG file, the content is 'foo'.

The bit of code right before the git-cz --hook command, however, is a bit less obvious. It is necessary because we need to bind the stdin of the user to the git-cz --hook command that is being run from within the prepare-commit-msg hook script. There is a thread about how to get husky hooks to be interactive if you care to read. FWIW husky stopped supporting the interactive flag for the very reason you are experiencing - namely that it did not work on windows.

So my previous comment holds - if someone here can figure out how to replicate the behavior of exec < dev/tty on Windows, you get a gold star (and a high-five from me) and both Husky and cz-cli (in --hook mode) can support Windows. My previous comment also outlines a couple things you could try. If I had the time or the Windows machine I would totally do it because such an important + tricky contribution to Husky would be awesome.

Let me know if any of that could use clarification.

[neilime]

Hi,

I've found something that works on my windows 10, with pure batch (bat) scripts (so it does not require bash or git bash)

In my package.json:

{
  "husky": {
    "hooks": {
      "prepare-commit-msg": "prepare-commit-msg",
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  }
}

I have created two bat files at the root of my repo:

1. prepare-commit-msg.cmd

@ECHO off
SETLOCAL

CALL :find_dp0
set "_prog=%dp0%exec-git-cz.cmd"
IF NOT EXIST "%_prog%" (
    ECHO "%_prog% does not exist"
    ENDLOCAL
    EXIT /b 1
)
start /wait call "%_prog%" --hook %*)

:find_dp0
SET dp0=%~dp0
EXIT /b

2. exec-git-cz.cmd

@ECHO off
SETLOCAL

CALL :find_dp0
set "_prog=%dp0%node_modules\.bin\git-cz.cmd"
IF NOT EXIST "%_prog%" (
    ECHO "%_prog% does not exist, please install commitizen"
    ENDLOCAL
    EXIT /b 1
)

call "%_prog%" %*

ENDLOCAL
EXIT %errorlevel%

:find_dp0
SET dp0=%~dp0
EXIT /b

[olgn]

@neilime interesting solution. The next obvious step would be to make one command (to place in the prepare-commit-msg hook) that does the following:

• check if the person running git commit is using windows (maybe check if /dev/tty exists?)
  • if windows, run the scripts you just posted
  • else, run the /dev/tty code that is currently implemented in the docs

that way the prepare-commit-msg command is the same for every user that installs a commitizen enforced repo, and they can all enjoy the benefits of commitizen

[shardool]

@neilime, Although your trick works, I seem to be running into the following issue where the up and down arrow keys causes this very annoying duplication effect. I'm on Windows 7 Enterprise, Git version 2.24.0.windows.2

[neilime]

@shardool I'm on Windows 10 Pro (Insider Preview) - Node v13.0.1 - 2.24.0.windows.1 - and don't have any troubles

The issue you're facing, is maybe due to Inquirer.js: SBoudrias/Inquirer.js#778

Try to upgrade your nodejs to fix it.

[shardool]

@neilime I'm on node version v12.13.0. I tried older version too.