mirror of
https://github.com/jesseduffield/lazygit.git
synced 2025-05-12 12:55:47 +02:00
26ca41a40e
I don't know if this is a hack or not: we run a git command and increment the pending action count to 1 but at some point the command requests a username or password, so we need to prompt the user to enter that. At that point we don't want to say that there is a pending action, so we decrement the action count before prompting the user and then re-increment it again afterward. Given that we panic when the counter goes below zero, it's important that it's not zero when we run the git command (should be impossible anyway). I toyed with a different approach using channels and a long-running goroutine that handles all commands that request credentials but it feels over-engineered compared to this commit's approach.
64 lines
2.3 KiB
Go
64 lines
2.3 KiB
Go
package oscommands
|
|
|
|
import (
|
|
"io"
|
|
|
|
"github.com/sirupsen/logrus"
|
|
)
|
|
|
|
// this struct captures some IO stuff
|
|
type guiIO struct {
|
|
// this is for logging anything we want. It'll be written to a log file for the sake
|
|
// of debugging.
|
|
log *logrus.Entry
|
|
|
|
// this is for us to log the command we're about to run e.g. 'git push'. The GUI
|
|
// will write this to a log panel so that the user can see which commands are being
|
|
// run.
|
|
// The isCommandLineCommand arg is there so that we can style the log differently
|
|
// depending on whether we're directly outputting a command we're about to run that
|
|
// will be run on the command line, or if we're using something from Go's standard lib.
|
|
logCommandFn func(str string, isCommandLineCommand bool)
|
|
// this is for us to directly write the output of a command. We will do this for
|
|
// certain commands like 'git push'. The GUI will write this to a command output panel.
|
|
// We need a new cmd writer per command, hence it being a function.
|
|
newCmdWriterFn func() io.Writer
|
|
// this allows us to request info from the user like username/password, in the event
|
|
// that a command requests it.
|
|
// the 'credential' arg is something like 'username' or 'password'
|
|
promptForCredentialFn func(credential CredentialType) <-chan string
|
|
|
|
IncrementBusyCount func()
|
|
DecrementBusyCount func()
|
|
}
|
|
|
|
func NewGuiIO(
|
|
log *logrus.Entry,
|
|
logCommandFn func(string, bool),
|
|
newCmdWriterFn func() io.Writer,
|
|
promptForCredentialFn func(CredentialType) <-chan string,
|
|
IncrementBusyCount func(),
|
|
DecrementBusyCount func(),
|
|
) *guiIO {
|
|
return &guiIO{
|
|
log: log,
|
|
logCommandFn: logCommandFn,
|
|
newCmdWriterFn: newCmdWriterFn,
|
|
promptForCredentialFn: promptForCredentialFn,
|
|
IncrementBusyCount: IncrementBusyCount,
|
|
DecrementBusyCount: DecrementBusyCount,
|
|
}
|
|
}
|
|
|
|
// we use this function when we want to access the functionality of our OS struct but we
|
|
// don't have anywhere to log things, or request input from the user.
|
|
func NewNullGuiIO(log *logrus.Entry) *guiIO {
|
|
return &guiIO{
|
|
log: log,
|
|
logCommandFn: func(string, bool) {},
|
|
newCmdWriterFn: func() io.Writer { return io.Discard },
|
|
promptForCredentialFn: failPromptFn,
|
|
IncrementBusyCount: func() {},
|
|
DecrementBusyCount: func() {},
|
|
}
|
|
}
|