cmd/limactl: split editutil (no code change)

Signed-off-by: Akihiro Suda <[email protected]>

Author: AkihiroSuda

cmd/limactl/edit.go

@@ -8,6 +8,7 @@ import (
 	"path/filepath"
 
 	"github.com/AlecAivazis/survey/v2"
+	"github.com/lima-vm/lima/pkg/editutil"
 	"github.com/lima-vm/lima/pkg/limayaml"
 	networks "github.com/lima-vm/lima/pkg/networks/reconcile"
 	"github.com/lima-vm/lima/pkg/start"
@@ -55,8 +56,8 @@ func editAction(cmd *cobra.Command, args []string) error {
 	hdr := fmt.Sprintf("# Please edit the following configuration for Lima instance %q\n", instName)
 	hdr += "# and an empty file will abort the edit.\n"
 	hdr += "\n"
-	hdr += generateEditorWarningHeader()
-	yBytes, err := openEditor(instName, yContent, hdr)
+	hdr += editutil.GenerateEditorWarningHeader()
+	yBytes, err := editutil.OpenEditor(instName, yContent, hdr)
 	if err != nil {
 		return err
 	}

cmd/limactl/start.go

@@ -8,24 +8,22 @@ import (
 	"net/http"
 	"net/url"
 	"os"
-	"os/exec"
 	"path"
 	"path/filepath"
 	"strings"
 
 	"github.com/AlecAivazis/survey/v2"
 	"github.com/containerd/containerd/identifiers"
 	securejoin "github.com/cyphar/filepath-securejoin"
+	"github.com/lima-vm/lima/pkg/editutil"
 	"github.com/lima-vm/lima/pkg/limayaml"
 	networks "github.com/lima-vm/lima/pkg/networks/reconcile"
 	"github.com/lima-vm/lima/pkg/osutil"
 	"github.com/lima-vm/lima/pkg/start"
 	"github.com/lima-vm/lima/pkg/store"
-	"github.com/lima-vm/lima/pkg/store/dirnames"
 	"github.com/lima-vm/lima/pkg/store/filenames"
 	"github.com/lima-vm/lima/pkg/usrlocalsharelima"
 	"github.com/mattn/go-isatty"
-	"github.com/norouter/norouter/cmd/norouter/editorcmd"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
@@ -288,9 +286,9 @@ func chooseNextCreatorState(st *creatorState) (*creatorState, error) {
 			}
 			hdr += "# - To cancel starting Lima, just save this file as an empty file.\n"
 			hdr += "\n"
-			hdr += generateEditorWarningHeader()
+			hdr += editutil.GenerateEditorWarningHeader()
 			var err error
-			st.yBytes, err = openEditor(st.instName, st.yBytes, hdr)
+			st.yBytes, err = editutil.OpenEditor(st.instName, st.yBytes, hdr)
 			if err != nil {
 				return st, err
 			}
@@ -367,82 +365,6 @@ func listTemplateYAMLs() ([]TemplateYAML, error) {
 	}
 	return res, nil
 }
-
-func fileWarning(filename string) string {
-	b, err := os.ReadFile(filename)
-	if err != nil || len(b) == 0 {
-		return ""
-	}
-	s := "# WARNING: " + filename + " includes the following settings,\n"
-	s += "# which are applied before applying this YAML:\n"
-	s += "# -----------\n"
-	for _, line := range strings.Split(strings.TrimSuffix(string(b), "\n"), "\n") {
-		s += "#"
-		if len(line) > 0 {
-			s += " " + line
-		}
-		s += "\n"
-	}
-	s += "# -----------\n"
-	s += "\n"
-	return s
-}
-
-func generateEditorWarningHeader() string {
-	var s string
-	configDir, err := dirnames.LimaConfigDir()
-	if err != nil {
-		s += "# WARNING: failed to load the config dir\n"
-		s += "\n"
-		return s
-	}
-
-	s += fileWarning(filepath.Join(configDir, filenames.Default))
-	s += fileWarning(filepath.Join(configDir, filenames.Override))
-	return s
-}
-
-// openEditor opens an editor, and returns the content (not path) of the modified yaml.
-//
-// openEditor returns nil when the file was saved as an empty file, optionally with whitespaces.
-func openEditor(name string, content []byte, hdr string) ([]byte, error) {
-	editor := editorcmd.Detect()
-	if editor == "" {
-		return nil, errors.New("could not detect a text editor binary, try setting $EDITOR")
-	}
-	tmpYAMLFile, err := os.CreateTemp("", "lima-editor-")
-	if err != nil {
-		return nil, err
-	}
-	tmpYAMLPath := tmpYAMLFile.Name()
-	defer os.RemoveAll(tmpYAMLPath)
-	if err := os.WriteFile(tmpYAMLPath,
-		append([]byte(hdr), content...),
-		0o600); err != nil {
-		return nil, err
-	}
-
-	editorCmd := exec.Command(editor, tmpYAMLPath)
-	editorCmd.Env = os.Environ()
-	editorCmd.Stdin = os.Stdin
-	editorCmd.Stdout = os.Stdout
-	editorCmd.Stderr = os.Stderr
-	logrus.Debugf("opening editor %q for a file %q", editor, tmpYAMLPath)
-	if err := editorCmd.Run(); err != nil {
-		return nil, fmt.Errorf("could not execute editor %q for a file %q: %w", editor, tmpYAMLPath, err)
-	}
-	b, err := os.ReadFile(tmpYAMLPath)
-	if err != nil {
-		return nil, err
-	}
-	modifiedInclHdr := string(b)
-	modifiedExclHdr := strings.TrimPrefix(modifiedInclHdr, hdr)
-	if strings.TrimSpace(modifiedExclHdr) == "" {
-		return nil, nil
-	}
-	return []byte(modifiedExclHdr), nil
-}
-
 func startAction(cmd *cobra.Command, args []string) error {
 	if listTemplates, err := cmd.Flags().GetBool("list-templates"); err != nil {
 		return err

pkg/editutil/editutil.go

@@ -0,0 +1,91 @@
+package editutil
+
+import (
+	"errors"
+	"fmt"
+	"os"
+	"os/exec"
+	"path/filepath"
+	"strings"
+
+	"github.com/lima-vm/lima/pkg/store/dirnames"
+	"github.com/lima-vm/lima/pkg/store/filenames"
+	"github.com/norouter/norouter/cmd/norouter/editorcmd"
+	"github.com/sirupsen/logrus"
+)
+
+func fileWarning(filename string) string {
+	b, err := os.ReadFile(filename)
+	if err != nil || len(b) == 0 {
+		return ""
+	}
+	s := "# WARNING: " + filename + " includes the following settings,\n"
+	s += "# which are applied before applying this YAML:\n"
+	s += "# -----------\n"
+	for _, line := range strings.Split(strings.TrimSuffix(string(b), "\n"), "\n") {
+		s += "#"
+		if len(line) > 0 {
+			s += " " + line
+		}
+		s += "\n"
+	}
+	s += "# -----------\n"
+	s += "\n"
+	return s
+}
+
+// GenerateEditorWarningHeader generates the editor warning header.
+func GenerateEditorWarningHeader() string {
+	var s string
+	configDir, err := dirnames.LimaConfigDir()
+	if err != nil {
+		s += "# WARNING: failed to load the config dir\n"
+		s += "\n"
+		return s
+	}
+
+	s += fileWarning(filepath.Join(configDir, filenames.Default))
+	s += fileWarning(filepath.Join(configDir, filenames.Override))
+	return s
+}
+
+// OpenEditor opens an editor, and returns the content (not path) of the modified yaml.
+//
+// OpenEditor returns nil when the file was saved as an empty file, optionally with whitespaces.
+func OpenEditor(name string, content []byte, hdr string) ([]byte, error) {
+	editor := editorcmd.Detect()
+	if editor == "" {
+		return nil, errors.New("could not detect a text editor binary, try setting $EDITOR")
+	}
+	tmpYAMLFile, err := os.CreateTemp("", "lima-editor-")
+	if err != nil {
+		return nil, err
+	}
+	tmpYAMLPath := tmpYAMLFile.Name()
+	defer os.RemoveAll(tmpYAMLPath)
+	if err := os.WriteFile(tmpYAMLPath,
+		append([]byte(hdr), content...),
+		0o600); err != nil {
+		return nil, err
+	}
+
+	editorCmd := exec.Command(editor, tmpYAMLPath)
+	editorCmd.Env = os.Environ()
+	editorCmd.Stdin = os.Stdin
+	editorCmd.Stdout = os.Stdout
+	editorCmd.Stderr = os.Stderr
+	logrus.Debugf("opening editor %q for a file %q", editor, tmpYAMLPath)
+	if err := editorCmd.Run(); err != nil {
+		return nil, fmt.Errorf("could not execute editor %q for a file %q: %w", editor, tmpYAMLPath, err)
+	}
+	b, err := os.ReadFile(tmpYAMLPath)
+	if err != nil {
+		return nil, err
+	}
+	modifiedInclHdr := string(b)
+	modifiedExclHdr := strings.TrimPrefix(modifiedInclHdr, hdr)
+	if strings.TrimSpace(modifiedExclHdr) == "" {
+		return nil, nil
+	}
+	return []byte(modifiedExclHdr), nil
+}