Demo commit-linter Args appear empty even with commit message argument

[Rvanmech]

Hi there,

We have been using this Husky.Net in task-runner.json to run things like dotnet format, dotnet build and dotnet test, so thank you for creating it. Lately I have been experimenting trying to add commit message linting, so I tried using the excellent example posted.

However, I'm running into a problem where using example provided is not succeeding fully. I have Husky 0.5.4 installed, and when I go to do the commit to kick off the .husky/csx/commit-lint.csx file, it ends up showing the error Unable to execute cached script.

As far as I can tell, the error is being thrown when attempting to do File.ReadAllLines(Arg[0])[0], and it seems Args[0] has a Count of 1, but must be either a whitespace character or empty string since it prints out nothing.

https://github.com/alirezanet/Husky.Net/blob/master/.husky/csx/commit-lint.csx#L10

I really don't think I have changed things, since my task-runner.json has the following, but it really seems like the commit message is always coming back as empty.

{
      "name": "commit-message-linter",
      "command": "dotnet",
      "group": "pre-commit",
      "args": ["husky", "exec", ".husky/csx/commit-lint.csx", "--args", "${args}"]
    },

For the record I invoke the script by git commit -m "Change message" and it seems to not be picking up the message contents.
If I invoke it directly like
dotnet husky run --name "commit-message-linter" --args "test" from the terminal, then the text "test" does show up.
So I my next thought was to look into${args} in task-runner.json to ensure it is capturing the commit message string and passing it along correctly. Does anyone have an idea of what might be going wrong?
Thank you.

Other relevant info: I'm on a macOS Monterey, using zsh, with .NET6 SDK and runtime installed

[alirezanet]

Hi @Rvanmech,
Thank you for the feedback, you are the second person that recently mentioned having problems with macOS, unfortunately, at the moment I don't have access to my mac machine so I can not debug exactly what is wrong. But if I give you some context, I hope you can solve it.
when you commit something, Git will create a file containing your commit message and it won't pass the commit message directly to the CSX script so the first thing I would check is your commit message file path in the commit-msg hook, dotnet husky run --name "commit-message-linter" --args "$1". here the $1 is not the commit message, it is a file path you must pass to the linter. so make sure you have it. (maybe it is better if you also log the $1 on your mac echo "\$1 is $1" to make sure it contains the file path or not)

also to test your csx file I recommend using the exec command and passing a text file to it to make sure it is working as expected.
dotnet husky exec "CSXFILE" --args "TEXT FILE PATH CONTAINING A SAMPLE COMMIT MSG"

Let me know if you need further information

[alirezanet]

One thing I thought was curious is that pre-commit is not a .sh script, but trying to rename it to .sh just skipped the pre-commit

Yes, the name of the git hook is important., git can't pick it up if you change it.

[Rvanmech]

@alirezanet Thanks for the info and help so far! I tried both of the examples, and they are giving me the same result where $@ and the variables $1, $2 etc are blank.
I'll go do some research as well to see if I can find anything.

[Rvanmech]

@alirezanet I realized something based off the info you gave me! I have made a user error.
I was inadvertently using the pre-commit hook instead of the commit-msg hook, since I was modifying some code we had already for pre-commit.
So.. the long story is that it works!

% git cm "Hello"             
.husky/commit-msg
.husky/_/husky.sh
$1 is .git/COMMIT_EDITMSG
[Husky] 🚀 Loading tasks ...
--------------------------------------------------
[Husky] ⚡ Preparing task 'commit-message-linter'
[Husky] ⌛ Executing task 'commit-message-linter' ...
1
.git/COMMIT_EDITMSG
Invalid commit message
script execution failed

[alirezanet]

I'm glad you've solved the problem 😊.

[WeihanLi]

Oh I met the same problem, I added it to the pre-commit hook, it works when I move it to the commit-msg hook.
Thanks very much