editor

Documentation

Overview

Package editor edits issue text in the user's $EDITOR.

Index

• func Cmd(path string) *exec.Cmd
• func Command() []string
• func Parse(doc string) (title, body string, ok bool)
• func ReadAndRemove(path string) (string, error)
• func Run(doc string) (string, error)
• func TempFile(doc string) (string, error)
• func Template(title, body, help string) string

Functions

func Cmd

func Cmd(path string) *exec.Cmd

Cmd returns an exec.Cmd that opens path in the user's editor.

func Command

func Command() []string

Command returns the user's editor command: $VISUAL, $EDITOR, or the first of nano, vim, and vi that is installed.

func Parse

func Parse(doc string) (title, body string, ok bool)

Parse splits an edited document into title and body. ok is false when the document is empty, meaning the user cancelled.

func ReadAndRemove

func ReadAndRemove(path string) (string, error)

ReadAndRemove reads the edited file and deletes its temp directory.

func Run

func Run(doc string) (string, error)

Run edits doc in the user's editor, attached to the terminal, and returns the result.

func TempFile

func TempFile(doc string) (string, error)

TempFile writes doc to a new markdown file and returns its path.

func Template

func Template(title, body, help string) string

Template renders title and body as an editable document: the first line is the title and everything after the blank line is the body, like a commit message. help is appended as an HTML comment, which is stripped on parse.