Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

bug: footer is considered body when using "-" (e.g. JIRA-1234) #3695

Closed
@Cry0nicS

Description

Expected Behavior

A commit message like the following:
(Note: after Body line 23. there are 2 new lines. No space.)

My commit
Body line 23.
JIRA-123

Should be accepted with bare config like

 "body-full-stop": [2, "always"],
 "body-leading-blank": [2, "always"],
 "footer-leading-blank": [2, "always"],

Current Behavior

For some reason, the above message is rejected with the message

body must end with full stop [body-full-stop]

It somehow treats the JIRA-1234 as part of the body, not as the footer.

Replacing - (dash) with # (e.g. JIRA#1234) makes commitlint treat the footer as a footer. All is good.

Affected packages

  • cli
  • core
  • prompt
  • config-angular

Possible Solution

No response

Steps to Reproduce

  1. Go to https://commit-editor.netlify.app
  2. In commit message write:
My commit
Body line 23.
JIRA-123
  1. In commitlint config (bottom part) write
{
 "rules": {
 "body-full-stop": [2, "always"],
 "body-leading-blank": [2, "always"],
 "footer-leading-blank": [2, "always"],
 }
}
  1. Notice the error.
  2. Change the commit footer to JIRA#123 and the error is gone

Context

We always write our ticket number in the footer. That's something like "ZYX-1234".
Using commitlint would prevent us from doing so.

commitlint --version

@commitlint/cli@7.8.0

git --version

2.42.0.windows.2

node --version

18.18.2

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

        AltStyle によって変換されたページ (->オリジナル) /