Support for commentchar=auto, always respect --edit
#1660
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Before, the code outside of `editor.go` was responsible for prefixing lines of the commented section with the comment char. The code to do this was scattered all over the codebase and was difficult to refactor re: adding support for `commentchar=auto`. Now, Editor has a `AddCommentedSection()` method that allows for declarative adding of a commented section. Furthermore, the caller doesn't have to query git to determine the comment char.
Previously, passing `--edit` in combination with `-m` would skip opening the editor. For compatibility with `git commit`, `--edit` is now always respected.
The commit body comes first, then template text. This is for compatibility with GitHub web interface. Fixes #1657
This shows commented-out text such as "Creating an issue for github/hub" not only when `-m` or `-F` weren't passed, but also when they were passed and `--edit` was used.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a significant refactor to code that processes
-m,-F, and--editflags, making--editalways respected even if-mwas provided, and changes the logic that strips commented lines and splits content into title and body to be more consistent.This also adds support for
git config core.commentchar auto. Fixes #1512