Allow multiple commit prefixes #4253
Closed
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
ChrisMcD1
commented
Feb 11, 2025
Comment on lines
+215
to
+229
| func (a *CommitPrefixConfigs) UnmarshalYAML(value *yaml.Node) error { | ||
| var multi []CommitPrefixConfig | ||
| err := value.Decode(&multi) | ||
| if err != nil { | ||
| var single CommitPrefixConfig | ||
| err := value.Decode(&single) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| *a = []CommitPrefixConfig{single} | ||
| } else { | ||
| *a = multi | ||
| } | ||
| return nil | ||
| } |
There was a problem hiding this comment.
It seems that go-yaml has no way to express this behavior, so I created a newtype and put the behavior on it. Taken from the comments of go-yaml/yaml#100
ChrisMcD1
commented
Feb 11, 2025
There was a problem hiding this comment.
I feel like this test doesn't cover much more than the existing integration tests, since the actual logic here is 5 LOC. I'm happy to remove if we don't want the duplication. Technically, it does test that we do the fallthrough to the 3rd commit prefix correctly.
ChrisMcD1
commented
Feb 11, 2025
Comment on lines
-344
to
-351
| # See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#predefined-commit-message-prefix | ||
| commitPrefix: | ||
| # pattern to match on. E.g. for 'feature/AB-123' to match on the AB-123 use "^\\w+\\/(\\w+-\\w+).*" | ||
| pattern: "" | ||
|
|
||
| # Replace directive. E.g. for 'feature/AB-123' to start the commit message with 'AB-123 ' use "[$1] " | ||
| replace: "" | ||
|
|
There was a problem hiding this comment.
This was automatically removed by go generate. I guess since the element is now a sequence instead of a mapping. Is there some way we can tag the field in the config struct definition so that these details continue to show here?
ChrisMcD1
commented
Feb 11, 2025
| @@ -271,6 +271,8 @@ type GitConfig struct { | |||
| TruncateCopiedCommitHashesTo int `yaml:"truncateCopiedCommitHashesTo"` | |||
| } | |||
|
|
|||
| type CommitPrefixConfigs []CommitPrefixConfig | |||
There was a problem hiding this comment.
Newtype just for yaml deserialization purposes to maintain backwards compatibility.
ChrisMcD1
force-pushed
the
multiple-commit-prefixes
branch
from
5168bb9 to
88fa09d
Compare
ChrisMcD1
added a commit
to ChrisMcD1/lazygit
that referenced
this pull request
Feb 13, 2025
This implementation, unlike that proposed in jesseduffield#4253 keeps the yaml schema easy, and does a migration from the single elements to a sequence of elements.
ChrisMcD1
added a commit
to ChrisMcD1/lazygit
that referenced
this pull request
Feb 14, 2025
This implementation, unlike that proposed in jesseduffield#4253 keeps the yaml schema easy, and does a migration from the single elements to a sequence of elements.
ChrisMcD1
added a commit
to ChrisMcD1/lazygit
that referenced
this pull request
Feb 14, 2025
This implementation, unlike that proposed in jesseduffield#4253 keeps the yaml schema easy, and does a migration from the single elements to a sequence of elements.
7 tasks
|
Closed in favor of #4261 |
ChrisMcD1
added a commit
to ChrisMcD1/lazygit
that referenced
this pull request
Feb 16, 2025
This implementation, unlike that proposed in jesseduffield#4253 keeps the yaml schema easy, and does a migration from the single elements to a sequence of elements.
ChrisMcD1
added a commit
to ChrisMcD1/lazygit
that referenced
this pull request
Feb 16, 2025
This implementation, unlike that proposed in jesseduffield#4253 keeps the yaml schema easy, and does a migration from the single elements to a sequence of elements.
stefanhaller
pushed a commit
to ChrisMcD1/lazygit
that referenced
this pull request
Feb 17, 2025
This implementation, unlike that proposed in jesseduffield#4253 keeps the yaml schema easy, and does a migration from the single elements to a sequence of elements.
stefanhaller
pushed a commit
to ChrisMcD1/lazygit
that referenced
this pull request
Feb 17, 2025
This implementation, unlike that proposed in jesseduffield#4253 keeps the yaml schema easy, and does a migration from the single elements to a sequence of elements.
stefanhaller
added a commit
that referenced
this pull request
Feb 17, 2025
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.
Addresses Set git.commitPrefix as a list instead of a dict to change several branch pattern into different commit messages prefixes #4194
The only interesting implementation detail was choosing to implement a backwards compatible yaml decoding, instead of choosing to do a migration on the user's configuration file. I have a half-finished version of that branch, if we would prefer.
go generate ./...)