editor

Documentation

Index

• func GetApplyPatch(obj runtime.Object, codec runtime.Encoder) ([]byte, []byte, types.PatchType, error)
• type EditMode
• type EditOptions
  • func (o *EditOptions) Complete(f cmdutil.Factory, out, errOut io.Writer, args []string) error
  • func (o *EditOptions) Run() error
  • func (o *EditOptions) Validate() error
• type Editor
  • func NewDefaultEditor(envs []string) Editor
  • func (e Editor) Launch(path string) error
  • func (e Editor) LaunchTempFile(prefix, suffix string, r io.Reader) ([]byte, string, error)

Functions

func GetApplyPatch

func GetApplyPatch(obj runtime.Object, codec runtime.Encoder) ([]byte, []byte, types.PatchType, error)

Types

type EditMode

type EditMode string

const (
	NormalEditMode       EditMode = "normal_mode"
	EditBeforeCreateMode EditMode = "edit_before_create_mode"
	ApplyEditMode        EditMode = "edit_last_applied_mode"
)

type EditOptions

type EditOptions struct {
	resource.FilenameOptions

	Output             string
	OutputPatch        bool
	WindowsLineEndings bool

	cmdutil.ValidateOptions

	Mapper         meta.RESTMapper
	ResourceMapper *resource.Mapper
	OriginalResult *resource.Result
	Encoder        runtime.Encoder

	EditMode EditMode

	CmdNamespace    string
	ApplyAnnotation bool
	Record          bool
	ChangeCause     string
	Include3rdParty bool

	Out    io.Writer
	ErrOut io.Writer
	// contains filtered or unexported fields
}

EditOptions contains all the options for running edit cli command.

func (*EditOptions) Complete

func (o *EditOptions) Complete(f cmdutil.Factory, out, errOut io.Writer, args []string) error

Complete completes all the required options

func (*EditOptions) Run

func (o *EditOptions) Run() error

func (*EditOptions) Validate

func (o *EditOptions) Validate() error

Validate checks the EditOptions to see if there is sufficient information to run the command.

type Editor

type Editor struct {
	Args  []string
	Shell bool
}

func NewDefaultEditor

func NewDefaultEditor(envs []string) Editor

NewDefaultEditor creates a struct Editor that uses the OS environment to locate the editor program, looking at EDITOR environment variable to find the proper command line. If the provided editor has no spaces, or no quotes, it is treated as a bare command to be loaded. Otherwise, the string will be passed to the user's shell for execution.

func (Editor) Launch

func (e Editor) Launch(path string) error

Launch opens the described or returns an error. The TTY will be protected, and SIGQUIT, SIGTERM, and SIGINT will all be trapped.

func (Editor) LaunchTempFile

func (e Editor) LaunchTempFile(prefix, suffix string, r io.Reader) ([]byte, string, error)

LaunchTempFile reads the provided stream into a temporary file in the given directory and file prefix, and then invokes Launch with the path of that file. It will return the contents of the file after launch, any errors that occur, and the path of the temporary file so the caller can clean it up as needed.