terraform/internal/command/views/workspace_list.go

// Copyright IBM Corp. 2014, 2026
// SPDX-License-Identifier: BUSL-1.1

package views

import (
	"encoding/json"
	"fmt"

	"github.com/hashicorp/terraform/internal/command/arguments"
	viewsjson "github.com/hashicorp/terraform/internal/command/views/json"
	"github.com/hashicorp/terraform/internal/tfdiags"
)

// The WorkspaceList view is used for the `workspace list` subcommand.
type WorkspaceList interface {
	List(selected string, list []string, diags tfdiags.Diagnostics)
}

func NewWorkspaceList(viewType arguments.ViewType, view *View) WorkspaceList {
	switch viewType {
	case arguments.ViewHuman:
		// TODO: Implement human-readable output for workspace list command using the views package, and remove the use of cli.Ui. This is a breaking change.
		panic("human-readable output for workspace list command is not supported via the views package.")
	case arguments.ViewJSON:
		return &WorkspaceListJSON{
			view: view,
		}
	default:
		panic(fmt.Sprintf("unsupported view type: %s", viewType))
	}
}

// The WorkspaceListJSON implementation renders machine-readable logs, suitable for
// integrating with other software.
//
// This JSON output is a 'static log'; the command should produce a single JSON object containing all the available information.
type WorkspaceListJSON struct {
	view *View
}

var _ WorkspaceList = (*WorkspaceListJSON)(nil)

type WorkspaceListOutput struct {
	FormatVersion string                  `json:"format_version"`
	Workspaces    []WorkspaceOutput       `json:"workspaces"`
	Diagnostics   []*viewsjson.Diagnostic `json:"diagnostics"`
}

type WorkspaceOutput struct {
	Name      string `json:"name"`
	IsCurrent bool   `json:"is_current,omitempty"`
}

// List is used to log the list of present workspaces and indicate which is currently selected
//
// If `workspace list` errors must return early with error diagnostics then the list will be empty and accompanied by errors.
// If the command succeeds then the list will be populated and the diagnostics list will be either empty or contain warnings.
func (v *WorkspaceListJSON) List(current string, list []string, diags tfdiags.Diagnostics) {
	// FormatVersion represents the version of the json format and will be
	// incremented for any change to this format that requires changes to a
	// consuming parser.
	const FormatVersion = "1.0"

	output := WorkspaceListOutput{
		FormatVersion: FormatVersion,
	}

	for _, item := range list {
		workspace := WorkspaceOutput{
			Name:      item,
			IsCurrent: item == current,
		}
		output.Workspaces = append(output.Workspaces, workspace)
	}

	if output.Workspaces == nil {
		// Make sure this always appears as an array in our output
		// Zero workspaces being returned is a valid outcome. In that scenario a warning diagnostic is included,
		// and that'll be easier to understand next to an empty workspace list.
		output.Workspaces = []WorkspaceOutput{}
	}

	configSources := v.view.configSources()
	for _, diag := range diags {
		output.Diagnostics = append(output.Diagnostics, viewsjson.NewDiagnostic(diag, configSources))
	}

	if output.Diagnostics == nil {
		// Make sure this always appears as an array in our output, since
		// this is easier to consume for dynamically-typed languages.
		output.Diagnostics = []*viewsjson.Diagnostic{}
	}

	jsonOutput, err := json.MarshalIndent(output, "", "  ")
	if err != nil {
		// Should never happen because we fully-control the input here
		panic(fmt.Sprintf("failed to marshal workspace list json output: %v", err))
	}

	v.view.streams.Println(string(jsonOutput))
}