editor

package

v0.3.4 Latest Latest Go to latest Published: May 22, 2021 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/martinohmann/kickoff

Links

Open Source Insights

Documentation ¶

Index ¶

func Detect() string
type Editor
- func New(streams cli.IOStreams) *Editor
- func (e *Editor) Edit(contents []byte, pattern string) ([]byte, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Detect ¶

func Detect() string

Detect the editor by looking into the KICKOFF_EDITOR, EDITOR and VISUAL environment variables. If none of these contains an editor command "vi" is used as a fallback.

Types ¶

type Editor ¶

type Editor struct {
	cli.IOStreams
	Command string
}

Editor can prompt a user to manipulate text by opening it with an editor.

func New ¶

func New(streams cli.IOStreams) *Editor

New creates a new *Editor.

func (*Editor) Edit ¶

func (e *Editor) Edit(contents []byte, pattern string) ([]byte, error)

Edit writes contents to a temporary file and opens it with an editor . A pattern (e.g. '*.yaml') can be provided to control the extension of the temporary file that is created and then opened with the editor. This is useful as a hint for the editor so that it can choose a suitable syntax highlighting. Returns the byte slice with the edited result after the user closed the editor.

Source Files ¶

View all Source files

editor.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL