fix: commitlint is reading previous commit message

[chandrashekhar07]

Expected Behavior

commitlint should evaluate the current/last commit message

Current Behavior

commitlint is reading the previous commit message while evaluating the result

My commit message is: testing
But npx --no -- commitlint --edit ${1} --verbose is evaluating the result of the previous commit.

the

Affected packages

• cli
• core
• prompt
• config-angular

Possible Solution

No response

Steps to Reproduce

My configuration:


// eslint-disable-next-line unicorn/prefer-module
module.exports = { extends: ['@commitlint/config-conventional'] };

At first, I added a valid commit message, but in the middle of committing process (husky evaluation), I canceled the process using ctrl + c

Then I changed my message to something else but still commit lint is evaluating the result of the previous commit.

### Context

_No response_

### commitlint --version

^18.4.2

### git --version

2.34.1

### node --version

v18.17.1

[escapedcat]

Does this work for you?:

#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx commitlint --edit 

[chandrashekhar07]

Does this work for you?:

#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx commitlint --edit 

Nope it's still evaluating previous/old commits

[SyedTayyabUlMazhar]

Found the solution! You need to rename your hook from pre-commit to commit-msg.

From the git hooks docs:

The pre-commit hook is run first, before you even type in a commit message. It’s used to inspect the snapshot that’s about to be committed, to see if you’ve forgotten something, ....

The commit-msg hook takes one parameter, which again is the path to a temporary file that contains the commit message written by the developer. If this script exits non-zero, Git aborts the commit process, so you can use it to validate your project state or commit message before allowing a commit to go through....

[escapedcat]

@SyedTayyabUlMazhar thanks for you comment!
So the readme is still correct, right?

@chandrashekhar07 how did you come up with using pre-commit? Is this mentioned in the docs?

[SyedTayyabUlMazhar]

@escapedcat
Yes, the readme is correct. However, I think it should explicitly mention that hook file name must be commit-msg, for those not familiar.

I found the solution by reading git's documentation on hooks.

[escapedcat]

Thanks!

I think it should explicitly mention that hook file name must be pre-commit, for those not familiar.

Anyone up for a PR to improve the docs?

[escapedcat]

Docs were improved, please see if this helps