fix(rules): ignore comments in signed-off-by

[bajtos]

Fix signed-off-by rule to ignore lines starting with #.

Description

Lines starting with # are comments. They are added by git commit at the end of the commit message template to show which files are included in the commit, and removed from the actual commit message.

Before this change, the rule signed-off-by was rejecting pretty much all commit messages created by git commit from the command line.

With this change in place, the rule ignores comments and accepts commit message created by git commit from the command line.

Motivation and Context

Fixes #1809

Usage examples

Configuration

// commitlint.config.js
module.exports = {
  rules: {
    'signed-off-by': [2, 'always', 'Signed-off-by:']
  }
};

Command to run

commitlint <<EOF
feat: foobar

Signed-off-by: Miroslav Bajtoš <[email protected]>

# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
EOF

Actual output

⧗   input: feat: foobar

Signed-off-by: Miroslav Bajtoš <[email protected]>

# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
✖   message must be signed off [signed-off-by]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

How Has This Been Tested?

I added a unit-test, watched it to fail with an expected error, and then fixed the implementation to make the test pass.

I re-run the example command shown above inside commitlint monorepo to verify that the fixed version accepts the message with comments.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my changes.
• All new and existing tests passed.

[escapedcat]

Thanks @bajtos
I added @byCedric as a reviewer.

[escapedcat]

Preparing to create a new @next version. Gonna merge this now.

[escapedcat]

Released under next, please give this a try:
npm i -D @commitlint/config-conventional@next @commitlint/cli@next

[bajtos]

Released under next, please give this a try:
npm i -D @commitlint/config-conventional@next @commitlint/cli@next

Works like a charm, thank you! 🙇🏻