editor

Documentation

Index

• func ConfiguredExternalCommand() string
• func OpenExternal(buffer string) tea.Cmd
• type ExternalFinishedMsg

Functions

func ConfiguredExternalCommand

func ConfiguredExternalCommand() string

ConfiguredExternalCommand returns the external command that should be used to open the editor.

This is either the value of the EDITOR environment variable, or "vim" if that is not set.

func OpenExternal

func OpenExternal(buffer string) tea.Cmd

OpenExternal opens the external editor and returns a command that will wait for it to finish.

The buffer is the initial contents of the file.

Types

type ExternalFinishedMsg

type ExternalFinishedMsg struct {
	Err    error
	Buffer []byte
}

ExternalFinishedMsg is a message that is sent when the external editor finishes (either successfully or with an error). The buffer is the contents of the file that was edited.