editor

package

v0.5.2 Latest Latest Go to latest Published: Nov 6, 2019 License: Apache-2.0 Imports: 14 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/pharmer/pharmer

Links

Open Source Insights

Documentation ¶

Overview ¶

Copyright The Pharmer Authors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index ¶

func ConditionalPreconditionFailedError(kind string) error
func ManualStrip(file []byte) []byte
func PreconditionFailedError() error
func PreservedFile(err error, path string, out io.Writer) error
func StripComments(file []byte) []byte
type EditHeader
- func (h *EditHeader) WriteTo(w io.Writer) (int64, error)
type EditReason
type EditResults
type Editor
- func NewDefaultEditor() Editor
- func (e Editor) Launch(path string) error
- func (e Editor) LaunchTempFile(prefix, suffix string, r io.Reader) ([]byte, string, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ConditionalPreconditionFailedError ¶

func ConditionalPreconditionFailedError(kind string) error

func ManualStrip ¶

func ManualStrip(file []byte) []byte

func PreconditionFailedError ¶

func PreconditionFailedError() error

func PreservedFile ¶

func PreservedFile(err error, path string, out io.Writer) error

func StripComments ¶

func StripComments(file []byte) []byte

Types ¶

type EditHeader ¶

type EditHeader struct {
	Reasons []EditReason
}

func (*EditHeader) WriteTo ¶

func (h *EditHeader) WriteTo(w io.Writer) (int64, error)

writeTo outputs the current header information into a stream

type EditReason ¶

type EditReason struct {
	Head  string
	Other []string
}

type EditResults ¶

type EditResults struct {
	Header EditHeader
	File   string
}

type Editor ¶

type Editor struct {
	Args  []string
	Shell bool
}

func NewDefaultEditor ¶

func NewDefaultEditor() Editor

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)

Source Files ¶

View all Source files

editor.go

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