editor

Documentation

Overview

Package editor was sourced from this article and then updated: https://samrapdev.com/capturing-sensitive-input-with-editor-in-golang-from-the-cli

Index

• Constants
• func CaptureInput(resolveEditor PreferredEditorResolver) ([]byte, error)
• func OpenFile(filename string, resolveEditor PreferredEditorResolver) error
• func PreferredEditor() string
• type PreferredEditorResolver

Constants

const DefaultEditor = "vi"

DefaultEditor will always fall back to vi

Functions

func CaptureInput

func CaptureInput(resolveEditor PreferredEditorResolver) ([]byte, error)

CaptureInput 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 OpenFile

func OpenFile(filename string, resolveEditor PreferredEditorResolver) error

OpenFile opens filename in a text editor

func PreferredEditor

func PreferredEditor() string

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

Types

type PreferredEditorResolver

type PreferredEditorResolver func() string

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