Fixed: grc fails when commit is preceded by anything else than '* '

sandr01d commented 2 years ago

Check list

[x] I have performed a self-review of my code
[x] I have commented my code in hard-to-understand areas
[x] I have made corresponding changes to the documentation

Description

Before this commit, the regex for extracting the commit hash when using grc assumed that each line starts with '* '. This is not the case when your commit history contains merges that were not squashed and looks more like this

*   7bf6560 Merge branch 'test-branch' 4 days ago
|\  
| * c753f1c (test-branch) Test commit 5 4 days ago
| * d3c7c6d Test commit 4 4 days ago
* | 1869317 Test commit 6 4 days ago
|/  
* b344261 Test commit 3 3 weeks ago

In the example above, selecting the line | * c753f1c (test-branch) Test commit 5 4 days ago would fail to revert the commit. This is now fixed. Note: The fish implementation does not seem to have this issue.

Type of change

[x] Bug fix
[ ] New feature
[ ] Refactor
[ ] Breaking change
[ ] Documentation change

Test environment

Shell
- [x] bash
- [x] zsh
- [x] fish
OS
- [x] Linux
- [ ] Mac OS X
- [ ] Windows
- [ ] Others:

sandr01d commented 2 years ago

git revert "$commits" would not work for multiple commits because git will fail to recognize that we want to revert separate commits e.g. '3f649be' and 'b344261' instead of one commit '3f649be b344261' (containing a space). git revert $(echo "$commits") would work though. I think this is better than using eval, as this makes the intent clearer IMO. Should I update the PR accordingly?

wfxr commented 2 years ago

git revert $(echo "$commits") would work though. I think this is better than using eval, as this makes the intent clearer IMO.

I think the same as you.

sandr01d commented 2 years ago

So, shellcheck failed on the solution we've discussed and I took the opportunity for a bit of refactoring. The commit hashes are now passed into an array and I revert each commit one by one. This also solves git logging an error and aborting when a commit is selected that already has been reverted.

wfxr / forgit