tableutil.go

// Copyright 2016-2018, Pulumi Corporation.
//
// 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 display

import (
	"strings"

	"github.com/pulumi/pulumi/sdk/v3/go/common/diag/colors"
	"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
)

func columnHeader(msg string) string {
	return colors.Underline + colors.BrightBlue + msg + colors.Reset
}

func messagePadding(message string, maxWidth, extraPadding int) string {
	extraWhitespace := maxWidth - colors.MeasureColorizedString(message)
	contract.Assertf(extraWhitespace >= 0, "Neg whitespace. %v %s", maxWidth, message)

	// Place two spaces between all columns (except after the first column).  The first
	// column already has a ": " so it doesn't need the extra space.
	extraWhitespace += extraPadding

	return strings.Repeat(" ", extraWhitespace)
}

// Gets the padding necessary to prepend to a column in order to keep it aligned in the terminal.
func columnPadding(columns []string, columnIndex int, maxColumnWidths []int) string {
	extraWhitespace := " "
	if columnIndex >= 0 && len(maxColumnWidths) > 0 {
		column := columns[columnIndex]
		maxWidth := maxColumnWidths[columnIndex]
		extraWhitespace = messagePadding(column, maxWidth, 2)
	}
	return extraWhitespace
}

// Gets the fully padded message to be shown.  The message will always include the ID of the
// status, then some amount of optional padding, then some amount of msgWithColors, then the
// suffix.  Importantly, if there isn't enough room to display all of that on the terminal, then
// the msg will be truncated to try to make it fit.
func renderRow(columns []string, maxColumnWidths []int) string {
	var row strings.Builder
	for i := 0; i < len(columns); i++ {
		row.WriteString(columnPadding(columns, i-1, maxColumnWidths))
		row.WriteString(columns[i])
	}
	return row.String()
}