Skip to content

Removing extra newline in replacement string #709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 11, 2020
Merged

Removing extra newline in replacement string #709

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/overcommit/hook/prepare_commit_msg/replace_branch.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ def run
Overcommit::Utils.log.debug("Writing #{commit_message_filename} with #{new_template}")

modify_commit_message do |old_contents|
"#{new_template}\n#{old_contents}"
"#{new_template} #{old_contents}"
Copy link
Owner

@sds sds Mar 11, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you actually want the space? Won't that result in the old contents getting a leading space, or am I misunderstanding the fix? Should we instead check if new_template has a newline and add one if it doesn't?

Copy link
Contributor Author

@cmackenzie1 cmackenzie1 Mar 11, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we would want the space since the text is replaced using the replacement_text value. So unless the user consciously adds a space to the end of that value, it will not be included.

Just for reference, using git version 2.25.0, old_contents would be as follows (with the preceding newline):


# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
#
# On branch bug/705-extra-newline
# Your branch is up to date with 'origin/bug/705-extra-newline'.
#
# Changes to be committed:
#       modified:   lib/overcommit/hook/prepare_commit_msg/replace_branch.rb
#

end

:pass
Expand Down