Allow ignoring comment lines in commits from files

[PurpleBooth]

When git is creating a commit, the message it reads from a file does
not include the lines beginning with a comment character. This means
that the commit files that you get passed with a git commit message
hook is not exactly what will appear in git.

The comment character in versions of git later than 1.8.2 is
configurable, in versions prior to that it's always '#'.

In this implementation we do not preserve the comment lines at all.

[sebastianfeldmann]

Nice! Thanks for making the effort.

I have three questions regarding this.
Firstly some understanding. Has the line to start with a $commentChar or does it suffice if the $commentChar is only prefixed with white spaces
So that this is a comment line

# I'm a comment line

And this is also a comment line

    # I have leading spaces but I'm a comment as well?

If so, we should trim() the line before checking the "first" character.

Secondly a note to your concern. So far the CommitMessage holds all the lines. Internally it manages the lines separately in

• $lines - all lines that where entered
• $subject - the first line of the commit message
• $body - all lines of the "body", so line 3 - end if exists

So we could keep the comment lines in $lines and remove them from $subject and $body.
This way we could have access to the comment lines as well if we would need to.
I'm not sure if this is wise or necessary so I'm hoping you have a thought on this.

And lastly a taste thing, wouldn't it be "cleaner" to set the default for $commentChar to '#'
This way it would only be of type string and if not given the git default behavior is emulated.

Thanks again, looking forward for your opinion.

Cheers, Sebastian

[PurpleBooth]

Those sound like some great improvements, I'll get on making those changes, I actually toyed with putting the logic inside the CommitMessage but it was a larger change and I wanted your feedback before I went for that.

I wasn't sure about the whitespace thing, but apparently it does have to be right at the start of the line:

commit 4b36929f1b102745732ac9c340cca57e0f0caacb
Author: Billie Thompson <billie@purplebooth.co.uk>
Date:   Sat Apr 22 11:07:09 2017 +0100

    Am I a commit Message
    
              # Am I a comment or not?

[PurpleBooth]

That's done now.

You might however notice that the CommitMessage defaults the character
to null. This is because a commit message from the repository may have
had any comment character set when it was created, so you could see
lines in a commit message from the repository that begin with what is
now the comment character.

The from file method defaults to '#' however.

The lines with the comments can still be accessed via getLines methods,
however the semantic methods of getBody and getSubject do not return
them.

[sebastianfeldmann]

Looks great!

[sebastianfeldmann]

I made a slight adjustment, the method getContent now returns the content without comments.
To get the content including all comments I added a getRawContent method.
This way if we "talk" about the content we always "talk" about the message without the comments.

• getContentLines
• isEmpty
• and now getContentas well

[PurpleBooth]

That sounds sensible

On Sat, 22 Apr 2017, 13:35 Sebastian Feldmann, ***@***.***> wrote: I made a slight adjustment, the method getContent now returns the content *without* comments. To get the content including all comments I added a getRawContent method. This way if we "talk" about the content we always "talk" about the message without the comments. - getContentLines - isEmpty - and now getContentas well — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#2 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAIIz2WG1WGN7CZAq_0bawFKMtR_U858ks5ryfQTgaJpZM4NE_bQ> .

-- Billie Thompson Software Developer Purple Booth Ltd Mob: 07813452516 Web: purplebooth.co.uk Keybase: <http://billie.codes/1NOw29c> LinkedIn: <http://billie.codes/1KT8gcI> Twitter: <http://billie.codes/1SGPMCw>

[sebastianfeldmann]

Thanks again, I just tagged version 1.0.3