nedbat / scriv

Changelog management tool
https://scriv.readthedocs.io
Apache License 2.0
256 stars 28 forks source link

scriv.user_nick appears to be invalid as a Git config option #130

Open mdickinson opened 3 months ago

mdickinson commented 3 months ago

The configuration docs say:

If you don't like the name it finds for you, you can set a name as the scriv.user_nick git setting.

But when I try this, I get an error from Git:

mdickinson@lovelace ~ % git config --global scriv.user_nick "mdickinson"
error: invalid key: scriv.user_nick

From the Git docs, I see:

The variable names are case-insensitive, allow only alphanumeric characters and -, and must start with an alphabetic character.

which leads me to believe that it's the underscore that's the issue here. If I try instead:

git config --global scriv.user-nick "mdickinson"

then the configuration succeeds, but of course then scriv doesn't pick this up.

Looking at other standard Git options, it appears the prevailing convention is camelCase, so maybe user_nick should be changed to userNick?

Scriv version: 1.5.1 Git version: 2.45.2