code.vegaprotocol.io/vega@v0.79.0/cmd/vegawallet/commands/flags/output.go (about)

     1  // Copyright (C) 2023 Gobalsky Labs Limited
     2  //
     3  // This program is free software: you can redistribute it and/or modify
     4  // it under the terms of the GNU Affero General Public License as
     5  // published by the Free Software Foundation, either version 3 of the
     6  // License, or (at your option) any later version.
     7  //
     8  // This program is distributed in the hope that it will be useful,
     9  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    10  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    11  // GNU Affero General Public License for more details.
    12  //
    13  // You should have received a copy of the GNU Affero General Public License
    14  // along with this program.  If not, see <http://www.gnu.org/licenses/>.
    15  
    16  package flags
    17  
    18  import (
    19  	"errors"
    20  )
    21  
    22  const (
    23  	InteractiveOutput = "interactive"
    24  	JSONOutput        = "json"
    25  )
    26  
    27  var (
    28  	ErrUnsupportedOutput = errors.New("unsupported output")
    29  
    30  	AvailableOutputs = []string{
    31  		InteractiveOutput,
    32  		JSONOutput,
    33  	}
    34  )
    35  
    36  func ValidateOutput(output string) error {
    37  	if len(output) == 0 {
    38  		return MustBeSpecifiedError("output")
    39  	}
    40  
    41  	for _, o := range AvailableOutputs {
    42  		if output == o {
    43  			return nil
    44  		}
    45  	}
    46  
    47  	// The output flag has special treatment because error reporting depends on
    48  	// it, and we need to differentiate output errors from the rest to select
    49  	// the right way to print the data.
    50  	// As a result, we return a specific error, instead of a generic
    51  	// UnsupportedFlagValueError.
    52  	return ErrUnsupportedOutput
    53  }