summaryrefslogtreecommitdiffstats
path: root/internal/editor/editor.go
blob: 6a70fa017ced821649adc45930fd79291ff3c686 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
// Copyright 2020 Google LLC All Rights Reserved.
//
// 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.

// Package editor implements a simple interface for interactive file editing.
// It most likely does not work on windows.
package editor

import (
	"fmt"
	"io"
	"os"
	"os/exec"
	"path/filepath"
)

// Edit opens a temporary file in the default editor (per $EDITOR, falling back
// to "vi") with the contents of the given io.Reader and a filename ending in
// the given extension (to give a hint to the editor for syntax highlighting).
//
// The contents of the edited file are returned, and the temporary file removed.
func Edit(input io.Reader, extension string) ([]byte, error) {
	f, err := os.CreateTemp("", fmt.Sprintf("%s-edit.*.%s", filepath.Base(os.Args[0]), extension))
	if err != nil {
		return nil, err
	}
	defer os.Remove(f.Name())

	if _, err := io.Copy(f, input); err != nil {
		return nil, err
	}
	f.Close()

	editor := "vi"
	if env := os.Getenv("EDITOR"); env != "" {
		editor = env
	}

	path, err := exec.LookPath(editor)
	if err != nil {
		return nil, err
	}

	cmd := exec.Command(path, f.Name())
	cmd.Stdin = os.Stdin
	cmd.Stdout = os.Stdout
	cmd.Stderr = os.Stderr

	if err := cmd.Run(); err != nil {
		return nil, err
	}

	return os.ReadFile(f.Name())
}