From eb39c5c29bc0e9b5e15a940a1b71bdac688b6535 Mon Sep 17 00:00:00 2001 From: Michael Muré Date: Tue, 31 Jul 2018 15:18:09 +0200 Subject: cli: rework new and comment command to better use the editor a nice templace is now provided with explanations new: title and message can now be provided from the editor. Title will be the first non-empty line --- input/input.go | 205 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 205 insertions(+) create mode 100644 input/input.go (limited to 'input/input.go') diff --git a/input/input.go b/input/input.go new file mode 100644 index 00000000..49d3501d --- /dev/null +++ b/input/input.go @@ -0,0 +1,205 @@ +// Originally taken from the git-appraise project + +package input + +import ( + "bufio" + "bytes" + "fmt" + "github.com/MichaelMure/git-bug/repository" + "github.com/pkg/errors" + "io/ioutil" + "os" + "os/exec" + "strings" +) + +var ErrEmptyMessage = errors.New("empty message") +var ErrEmptyTitle = errors.New("empty title") + +const bugTitleCommentTemplate = `%s%s + +# Please enter the title and comment message. The first non-empty line will be +# used as the title. Lines starting with '#' will be ignored. +# An empty title aborts the operation. +` + +func BugCreateEditorInput(repo repository.Repo, fileName string, preTitle string, preMessage string) (string, string, error) { + if preMessage != "" { + preMessage = "\n\n" + preMessage + } + + template := fmt.Sprintf(bugTitleCommentTemplate, preTitle, preMessage) + + raw, err := LaunchEditorWithTemplate(repo, fileName, template) + + if err != nil { + return "", "", err + } + + lines := strings.Split(raw, "\n") + + var title string + var b strings.Builder + for _, line := range lines { + if strings.HasPrefix(line, "#") { + continue + } + + if title == "" { + trimmed := strings.TrimSpace(line) + if trimmed != "" { + title = trimmed + } + continue + } + + b.WriteString(line) + b.WriteString("\n") + } + + if title == "" { + return "", "", ErrEmptyTitle + } + + message := strings.TrimSpace(b.String()) + + return title, message, nil +} + +const bugCommentTemplate = ` + +# Please enter the comment message. Lines starting with '#' will be ignored, +# and an empty message aborts the operation. +` + +func BugCommentEditorInput(repo repository.Repo, fileName string) (string, error) { + raw, err := LaunchEditorWithTemplate(repo, fileName, bugCommentTemplate) + + if err != nil { + return "", err + } + + lines := strings.Split(raw, "\n") + + var b strings.Builder + for _, line := range lines { + if strings.HasPrefix(line, "#") { + continue + } + b.WriteString(line) + b.WriteString("\n") + } + + message := strings.TrimSpace(b.String()) + + if message == "" { + return "", ErrEmptyMessage + } + + return message, nil +} + +func LaunchEditorWithTemplate(repo repository.Repo, fileName string, template string) (string, error) { + path := fmt.Sprintf("%s/.git/%s", repo.GetPath(), fileName) + + err := ioutil.WriteFile(path, []byte(template), 0644) + + if err != nil { + return "", err + } + + return LaunchEditor(repo, fileName) +} + +// LaunchEditor launches the default editor configured for the given repo. This +// method blocks until the editor command has returned. +// +// The specified filename should be a temporary file and provided as a relative path +// from the repo (e.g. "FILENAME" will be converted to ".git/FILENAME"). This file +// will be deleted after the editor is closed and its contents have been read. +// +// This method returns the text that was read from the temporary file, or +// an error if any step in the process failed. +func LaunchEditor(repo repository.Repo, fileName string) (string, error) { + path := fmt.Sprintf("%s/.git/%s", repo.GetPath(), fileName) + defer os.Remove(path) + + editor, err := repo.GetCoreEditor() + if err != nil { + return "", fmt.Errorf("Unable to detect default git editor: %v\n", err) + } + + cmd, err := startInlineCommand(editor, path) + if err != nil { + // Running the editor directly did not work. This might mean that + // the editor string is not a path to an executable, but rather + // a shell command (e.g. "emacsclient --tty"). As such, we'll try + // to run the command through bash, and if that fails, try with sh + args := []string{"-c", fmt.Sprintf("%s %q", editor, path)} + cmd, err = startInlineCommand("bash", args...) + if err != nil { + cmd, err = startInlineCommand("sh", args...) + } + } + if err != nil { + return "", fmt.Errorf("Unable to start editor: %v\n", err) + } + + if err := cmd.Wait(); err != nil { + return "", fmt.Errorf("Editing finished with error: %v\n", err) + } + + output, err := ioutil.ReadFile(path) + + if err != nil { + return "", fmt.Errorf("Error reading edited file: %v\n", err) + } + + return string(output), err +} + +// FromFile loads and returns the contents of a given file. If - is passed +// through, much like git, it will read from stdin. This can be piped data, +// unless there is a tty in which case the user will be prompted to enter a +// message. +func FromFile(fileName string) (string, error) { + if fileName == "-" { + stat, err := os.Stdin.Stat() + if err != nil { + return "", fmt.Errorf("Error reading from stdin: %v\n", err) + } + if (stat.Mode() & os.ModeCharDevice) == 0 { + // There is no tty. This will allow us to read piped data instead. + output, err := ioutil.ReadAll(os.Stdin) + if err != nil { + return "", fmt.Errorf("Error reading from stdin: %v\n", err) + } + return string(output), err + } + + fmt.Printf("(reading comment from standard input)\n") + var output bytes.Buffer + s := bufio.NewScanner(os.Stdin) + for s.Scan() { + output.Write(s.Bytes()) + output.WriteRune('\n') + } + return output.String(), nil + } + + output, err := ioutil.ReadFile(fileName) + if err != nil { + return "", fmt.Errorf("Error reading file: %v\n", err) + } + return string(output), err +} + +func startInlineCommand(command string, args ...string) (*exec.Cmd, error) { + cmd := exec.Command(command, args...) + cmd.Stdin = os.Stdin + cmd.Stdout = os.Stdout + cmd.Stderr = os.Stderr + err := cmd.Start() + return cmd, err +} -- cgit