How is os.openDirInEditor triggered?

[ivomac]

I want to be able to open directories in my terminal editor. The config option os.openDirInEditor seems to be exactly what I want, but after setting it and trying to edit a directory in lazygit, I get an error: "Cannot edit directories: you can only edit individual files".

Is this feature implemented? It would be nice to "edit" folders if openDirInEditor is defined.

[stefanhaller]

At the moment, the config is only used in the Worktrees panel, when pressing o on a selected worktree. It was added for this purpose when worktree support was implemented.

It would totally make sense to use it when pressing e on a directory in the files panel. Do you want to try raising a PR for this? Let me know if you need any pointers.

As far as I can see, the main challenge is around range selection; right now we check that all selected items are files, and raise an error if not. This would have to change to allow either a range selection of only files, or one of only directories, and raise an error if it's a mixture. (I don't think it's important enough to handle the case where there's a range selection of both files and directories.)

In addition, FileCommands.GetOpenDirInEditorCmdStr would have to change so that it can take a slice of paths instead of just one, similar to GetEditCmdStr.

Maybe it's easier to only support the case of a single selected directory, that's probably good enough too.

A personal note: I wouldn't find the feature very useful myself, because the only directory I ever want to open in my editor is the repo root, and this doesn't always show up in the Files panel. I have a custom command for this that calls code ..

[ivomac]

A custom command is also enough for me, didn't think of that, thanks!

For consistency I could try to implement editing single directories with e, but it is not as useful now. I can't imagine editing multiple directories at once is ever needed.

It would still help to change the documentation so that the purpose of the openDirInEditor is more clear. And maybe your command could be added to the list of custom commands in the wiki?

[ivomac]

I'm trying to understand what is the best way to implement a simple open dir if a single dir is selected. The keymapping is done here:

lazygit/pkg/gui/controllers/files_controller.go

Lines 91 to 98 in 66caa25

	{
	Key: opts.GetKey(opts.Config.Universal.Edit),
	Handler: self.withItems(self.edit),
	GetDisabledReason: self.require(self.itemsSelected(self.canEditFiles)),
	Description: self.c.Tr.Edit,
	Tooltip: self.c.Tr.EditFileTooltip,
	DisplayOnScreen: true,
	},

How would you adapt this? Maybe something like this:

{ 
	Key:               opts.GetKey(opts.Config.Universal.Edit), 
	Handler:           self.dirOrFiles, 
	GetDisabledReason: self.any(self.singleItemSelected(), self.itemsSelected(self.canEditFiles)),
	Description:       self.c.Tr.Edit, 
	Tooltip:           self.c.Tr.EditFileTooltip, 
	DisplayOnScreen:   true, 
}, 

Here self.any is a complement of self.require that returns nil at the first callback that returns nil.

Then self.dirOrFiles would call self.openDir if a single dir is given, otherwise self.withItems(self.edit) like before.