Merge pull request #3990 from jandubois/list-yaml

Make `limactl ls --format yaml` use the same schema as the json output

Author: AkihiroSuda

cmd/limactl/list.go

@@ -31,10 +31,14 @@ func fieldNames() []string {
 		f := t.Field(i)
 		if f.Anonymous {
 			for j := range f.Type.NumField() {
-				names = append(names, f.Type.Field(j).Name)
+				if tag := f.Tag.Get("lima"); tag != "deprecated" {
+					names = append(names, f.Type.Field(j).Name)
+				}
 			}
 		} else {
-			names = append(names, t.Field(i).Name)
+			if tag := f.Tag.Get("lima"); tag != "deprecated" {
+				names = append(names, t.Field(i).Name)
+			}
 		}
 	}
 	return names

pkg/limainfo/limainfo.go

@@ -7,12 +7,15 @@ import (
 	"context"
 	"errors"
 	"io/fs"
+	"path/filepath"
+	"runtime"
 
 	"github.com/sirupsen/logrus"
 
 	"github.com/lima-vm/lima/v2/pkg/envutil"
 	"github.com/lima-vm/lima/v2/pkg/limatype"
 	"github.com/lima-vm/lima/v2/pkg/limatype/dirnames"
+	"github.com/lima-vm/lima/v2/pkg/limatype/filenames"
 	"github.com/lima-vm/lima/v2/pkg/limayaml"
 	"github.com/lima-vm/lima/v2/pkg/registry"
 	"github.com/lima-vm/lima/v2/pkg/templatestore"
@@ -29,6 +32,9 @@ type LimaInfo struct {
 	VMTypesEx       map[string]DriverExt         `json:"vmTypesEx"`   // since Lima v2.0.0
 	GuestAgents     map[limatype.Arch]GuestAgent `json:"guestAgents"` // since Lima v1.1.0
 	ShellEnvBlock   []string                     `json:"shellEnvBlock"`
+	HostOS          string                       `json:"hostOS"`       // since Lima v2.0.0
+	HostArch        string                       `json:"hostArch"`     // since Lima v2.0.0
+	IdentityFile    string                       `json:"identityFile"` // since Lima v2.0.0
 }
 
 type DriverExt struct {
@@ -72,6 +78,8 @@ func New(ctx context.Context) (*LimaInfo, error) {
 		VMTypesEx:       vmTypesEx,
 		GuestAgents:     make(map[limatype.Arch]GuestAgent),
 		ShellEnvBlock:   envutil.GetDefaultBlockList(),
+		HostOS:          runtime.GOOS,
+		HostArch:        limatype.NewArch(runtime.GOARCH),
 	}
 	info.Templates, err = templatestore.Templates()
 	if err != nil {
@@ -81,6 +89,11 @@ func New(ctx context.Context) (*LimaInfo, error) {
 	if err != nil {
 		return nil, err
 	}
+	configDir, err := dirnames.LimaConfigDir()
+	if err != nil {
+		return nil, err
+	}
+	info.IdentityFile = filepath.Join(configDir, filenames.UserPrivateKey)
 	for _, arch := range limatype.ArchTypes {
 		bin, err := usrlocalsharelima.GuestAgentBinary(limatype.LINUX, arch)
 		if err != nil {

pkg/store/instance.go

@@ -225,11 +225,14 @@ func ReadPIDFile(path string) (int, error) {
 }
 
 type FormatData struct {
-	limatype.Instance
-	HostOS       string
-	HostArch     string
-	LimaHome     string
-	IdentityFile string
+	limatype.Instance `yaml:",inline"`
+
+	// Using these host attributes is deprecated; they will be removed in Lima 3.0
+	// The values are available from `limactl info` as hostOS, hostArch, limaHome, and identifyFile.
+	HostOS       string `json:"HostOS" yaml:"HostOS" lima:"deprecated"`
+	HostArch     string `json:"HostArch" yaml:"HostArch" lima:"deprecated"`
+	LimaHome     string `json:"LimaHome" yaml:"LimaHome" lima:"deprecated"`
+	IdentityFile string `json:"IdentityFile" yaml:"IdentityFile" lima:"deprecated"`
 }
 
 var FormatHelp = "\n" +