Acronyms incorrectly detected as upper-case

[Qix-]

Faulty Behavior

fix: JTD types -> JSON schema types

✖   subject must not be sentence-case, start-case, pascal-case, upper-case [subject-case]

The above fails as the linter detects the subject as being upper-case, even though it's just an acronym.

Affected packages

• cli
• core
• prompt
• config-angular

Possible Solution

Check that all letters in the word are uppercase and assume it's an acronym, ignoring any title-case lints. Skip for 1 letter words.

Steps to Reproduce (for bugs)

Lint the above commit message with @commitlint/config-conventional.

Your Environment

Executable	Version
commitlint --version	17.0.3
git --version	2.34.1
node --version	16.15.1
@commitlint/config-conventional	17.0.3

[lidigobeyond]

I think it's a bug.

According to a document for @commitlint/config-conventional, subject can be either sentence-case or start-case or pascal-case or upper-case. (link)
But linter tell us "subject must not be sentence-case, start-case, pascal-case, upper-case".

[Qix-]

In this case, it's none of those though. It's an acronym.

[lidigobeyond]

@Qix-
But an acronym is also upper-case letter.
So according to a document for @commitlint/config-conventional, you can write subject with acronym.
But it couldn't.
It's a bug.

[Qix-]

Right, I understand that. But that's still not a proper fix. An acronym should not be subjected to the same rules. If a custom config were just to allow only lowercase, acronyms should be exempt.

[lidigobeyond]

I see. But It seems difficult to decide whether a letter is an acronym or not. Do you have an idea to easily decide whether a letter is an acronym or not?

[Qix-]

const isAcronym = word.length > 1 && word.toUpperCase() === word;

[lidigobeyond]

Great! But an upper case subject, for example "feat: CORRECT BODY MESSAGE", even if it does not have any an acronym, it is always decided to meet the conventional commits.

[escapedcat]

Maybe one could define an allow-list of acronyms for a projects? Might just be a plugin in that case? Just a guess.

[Qix-]

"feat: CORRECT BODY MESSAGE",

That would be a different check.

const isSubjectUpperCase = subject === subject.toUpperCase();

allow-list of acronyms

Please no. There are too many internal acronyms that would have to be maintained, and for three-letter acronyms almost all of them would be in the list anyway. Then, when you use one that just happens not to be on the list, you get cryptic errors about... what exactly? "Acronym not known"?

It's not that complicated, in my opinion. This is a case where it's beginning to get in the way of work and a simple, sane solution like the above would suffice in all but the most egregious cases.

[escapedcat]

If you both agree now I'll tag along. Up for a creating a PR?

[lidigobeyond]

Opps!
Sorry. I misunderstood!
According to a document for @commitlint/config-conventional, when subject is in one of the cases ['sentence-case', 'start-case', 'pascal-case', 'upper-case'], linter always throw an error.
So we should write a subject which is in one of the cases ['lower-case', 'camel-case', 'kebab-case', 'snake-case'].
Is that Right, @escapedcat ?

[escapedcat]

Hm, sorry for not being much a help here.

From my understanding a subject - no matter what case - should:

• always allow acronyms i.e. JSON
• everything else should be linted according to whatever subject-rule you configured

I didn't find anything about this in the specs but I guess this could maybe be an optional rule that users could turn on?
Actually wondering how other tools handle this.