Add option to filter by changes (-S flag) #4383

r-darwish · 2025-03-10T05:20:44Z

PR Description

This PR introduces the ability to filter logs by specific strings that appear in the patch itself. It uses Git's -S flag under the hood.

Please check if the PR fulfills these requirements

Cheatsheets are up-to-date (run go generate ./...)
Code has been formatted (see here)
Tests have been added/updated (see [here] - (https://github.com/jesseduffield/lazygit/blob/master/pkg/integration/README.md) for the integration test guide)
Text is internationalised (see here)
If a new UserConfig entry was added, make sure it can be hot-reloaded (see here) - irrelevant
Docs have been updated if necessary
You've read through your own file changes for silly mistakes etc

jesseduffield · 2025-03-10T21:48:53Z

@r-darwish could you please explain what this PR intends to do in the PR description. 'changes' is ambiguous

r-darwish · 2025-03-11T04:34:30Z

@r-darwish could you please explain what this PR intends to do in the PR description. 'changes' is ambiguous

Done 🙂

jesseduffield

Looking forward to having this in the codebase. Mostly we need to update the naming to be more aligned with git's own terminology i.e. 'pickaxe search', 'pickaxe string'.

jesseduffield · 2025-03-11T22:08:44Z

pkg/gui/controllers/helpers/mode_helper.go

@@ -46,6 +46,24 @@ type ModeStatus struct {
 	Reset       func() error
 }

+func (self *ModeHelper) getFilter() string {


This should return two strings: one for the type of thing we're filtering by, and one for the value. That removes the ambiguity

jesseduffield · 2025-03-11T22:09:44Z

pkg/gui/controllers/filtering_menu_action.go

+			self.c.Prompt(types.PromptOpts{
+				Title: self.c.Tr.EnterChanges,
+				HandleConfirm: func(response string) error {
+					return self.setFilteringChanges(strings.TrimSpace(response))


I think we shouldn't trim space now that we support filtering by patch content. Often you actually do care about trailing/leading space when doing that.

jesseduffield · 2025-03-11T22:12:11Z

pkg/commands/git_commands/reflog_commit_loader.go

@@ -23,7 +23,7 @@ func NewReflogCommitLoader(common *common.Common, cmd oscommands.ICmdObjBuilder)

 // GetReflogCommits only returns the new reflog commits since the given lastReflogCommit
 // if none is passed (i.e. it's value is nil) then we get all the reflog commits
-func (self *ReflogCommitLoader) GetReflogCommits(lastReflogCommit *models.Commit, filterPath string, filterAuthor string) ([]*models.Commit, bool, error) {
+func (self *ReflogCommitLoader) GetReflogCommits(lastReflogCommit *models.Commit, filterPath string, filterAuthor string, filterChanges string) ([]*models.Commit, bool, error) {


This now has too many positional parameters: let's introduce a CommitFilters struct which contains Path, Author, and PickaxeString fields.

Seems Pickaxe is the official term (https://git-scm.com/book/en/v2/Git-Tools-Searching):

we can use the -S option (colloquially referred to as the Git “pickaxe” option) to tell Git to show us only those commits that changed the number of occurrences of that string.

jesseduffield · 2025-03-11T22:17:27Z

pkg/i18n/english.go

 		EnterFileName:                    "Enter path:",
 		EnterAuthor:                      "Enter author:",
+		EnterChanges:                     "Enter changes:",


Suggested change

EnterChanges: "Enter changes:",

EnterChanges: "Enter string:",

jesseduffield · 2025-03-11T22:18:02Z

pkg/i18n/english.go

@@ -1637,8 +1639,10 @@ func EnglishTranslationSet() *TranslationSet {
 		ExitFilterMode:                   "Stop filtering",
 		FilterPathOption:                 "Enter path to filter by",
 		FilterAuthorOption:               "Enter author to filter by",
+		FilterChangesOption:              "Enter changes to filter by",


Suggested change

FilterChangesOption: "Enter changes to filter by",

FilterChangesOption: "Enter patch string to filter by (pickaxe search)",

jesseduffield · 2025-03-11T22:18:43Z

docs/Searching.md

+1. Start lazygit with the -f flag e.g. `lazygit -f my/path`
+2. From within lazygit, press `<c-s>` and then enter the path of the file you want to filter by
+
+## Filtering by changes


Suggested change

## Filtering by changes

## Filtering by patch content (pickaxe search)

jesseduffield · 2025-03-11T22:24:29Z

pkg/gui/controllers/helpers/refresh_helper.go

 		return err
 	}

 	if self.c.Modes().Filtering.Active() {
-		if err := refresh(&model.FilteredReflogCommits, self.c.Modes().Filtering.GetPath(), self.c.Modes().Filtering.GetAuthor()); err != nil {
+		if err := refresh(&model.FilteredReflogCommits, self.c.Modes().Filtering.GetPath(), self.c.Modes().Filtering.GetAuthor(), self.c.Modes().Filtering.GetChanges()); err != nil {


Even here I'd just go self.c.Modes().Filtering.GetFilters() and have that return a CommitFilters struct.

jesseduffield · 2025-03-11T22:26:17Z

pkg/integration/tests/filter_by_changes/type_changes.go

+	SetupConfig: func(config *config.AppConfig) {
+	},
+	SetupRepo: func(shell *Shell) {
+		shell.CreateNCommits(4)


I'd prefer to explicitly add files and associated commits, just to make this more readable. At the moment the reader has to look up the definition of CreateNCommits to see the relationship between the commit messages and their corresponding file changes. The shell.CreateNCommits is really a convenience function for when you just need multiple commits, but in this case we specifically want to be filtering based on the contents of those commits.

r-darwish added 3 commits March 10, 2025 07:18

Add option to filter by changes

f80831b

Doc

0bb899e

Fix filtering and add tests

92af3e3

r-darwish marked this pull request as ready for review March 10, 2025 06:56

r-darwish changed the title ~~Add option to filter by changes~~ Add option to filter by changes (-S flag) Mar 11, 2025

jesseduffield requested changes Mar 11, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add option to filter by changes (-S flag) #4383

Add option to filter by changes (-S flag) #4383

r-darwish commented Mar 10, 2025 •

edited

Loading

jesseduffield commented Mar 10, 2025

r-darwish commented Mar 11, 2025

jesseduffield left a comment

jesseduffield Mar 11, 2025

jesseduffield Mar 11, 2025

jesseduffield Mar 11, 2025

jesseduffield Mar 11, 2025

jesseduffield Mar 11, 2025

jesseduffield Mar 11, 2025

jesseduffield Mar 11, 2025

jesseduffield Mar 11, 2025

	EnterChanges: "Enter changes:",
	EnterChanges: "Enter string:",

	FilterChangesOption: "Enter changes to filter by",
	FilterChangesOption: "Enter patch string to filter by (pickaxe search)",

	## Filtering by changes
	## Filtering by patch content (pickaxe search)

Add option to filter by changes (-S flag) #4383

Are you sure you want to change the base?

Add option to filter by changes (-S flag) #4383

Conversation

r-darwish commented Mar 10, 2025 • edited Loading

jesseduffield commented Mar 10, 2025

r-darwish commented Mar 11, 2025

jesseduffield left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

r-darwish commented Mar 10, 2025 •

edited

Loading