editor

Documentation

Index

• func CaptureInputFromEditor(resolveEditor PreferredEditorResolver, text, extension string) ([]byte, error)
• func GetPreferredEditorFromEnvironment() ([]string, bool)
• func OpenFileInEditor(filename string, resolveEditor PreferredEditorResolver) error
• type PreferredEditorResolver

Functions

func CaptureInputFromEditor

func CaptureInputFromEditor(resolveEditor PreferredEditorResolver, text, extension string) ([]byte, error)

CaptureInputFromEditor opens a temporary file in a text editor and returns the written bytes on success or an error on failure. It handles deletion of the temporary file behind the scenes.

func GetPreferredEditorFromEnvironment

func GetPreferredEditorFromEnvironment() ([]string, bool)

GetPreferredEditorFromEnvironment returns the user's editor as defined by the `$EDITOR` environment variable, or the `DefaultEditor` if it is not set.

func OpenFileInEditor

func OpenFileInEditor(filename string, resolveEditor PreferredEditorResolver) error

OpenFileInEditor opens filename in a text editor.

Types

type PreferredEditorResolver

type PreferredEditorResolver func() ([]string, bool)

PreferredEditorResolver is a function that returns an editor that the user prefers to use, such as the configured `$EDITOR` environment variable.