go-task/taskfile/ast/output.go

package ast

import (
	"go.yaml.in/yaml/v3"

	"github.com/go-task/task/v3/errors"
)

// Output of the Task output
type Output struct {
	// Name of the Output.
	Name string `yaml:"-"`
	// Group specific style
	Group OutputGroup
	// GitLab specific style
	GitLab OutputGitLab
}

// IsSet returns true if and only if a custom output style is set.
func (s *Output) IsSet() bool {
	return s.Name != ""
}

func (s *Output) UnmarshalYAML(node *yaml.Node) error {
	switch node.Kind {

	case yaml.ScalarNode:
		var name string
		if err := node.Decode(&name); err != nil {
			return errors.NewTaskfileDecodeError(err, node)
		}
		s.Name = name
		return nil

	case yaml.MappingNode:
		var tmp struct {
			Group  *OutputGroup
			GitLab *OutputGitLab `yaml:"gitlab"`
		}
		if err := node.Decode(&tmp); err != nil {
			return errors.NewTaskfileDecodeError(err, node)
		}
		switch {
		case tmp.Group != nil && tmp.GitLab != nil:
			return errors.NewTaskfileDecodeError(nil, node).WithMessage(`output style cannot set both "group" and "gitlab"`)
		case tmp.Group != nil:
			*s = Output{
				Name:  "group",
				Group: *tmp.Group,
			}
			return nil
		case tmp.GitLab != nil:
			*s = Output{
				Name:   "gitlab",
				GitLab: *tmp.GitLab,
			}
			return nil
		default:
			return errors.NewTaskfileDecodeError(nil, node).WithMessage(`output style must have the "group" or "gitlab" key when in mapping form`)
		}
	}

	return errors.NewTaskfileDecodeError(nil, node).WithTypeMessage("output")
}

// OutputGroup is the style options specific to the Group style.
type OutputGroup struct {
	Begin, End string
	ErrorOnly  bool `yaml:"error_only"`
}

// IsSet returns true if and only if a custom output style is set.
func (g *OutputGroup) IsSet() bool {
	if g == nil {
		return false
	}
	return g.Begin != "" || g.End != ""
}

// OutputGitLab is the style options specific to the GitLab style.
type OutputGitLab struct {
	Collapsed bool
	ErrorOnly bool `yaml:"error_only"`
}