config

Documentation

Index

• Constants
• Variables
• func AllowInsecureDownload() bool
• func CheckUpdates() bool
• func FilePath(name string) (string, error)
• func GaugeRepositoryUrl() string
• func GaugeVersionInPropertiesFile(name string) (*version.Version, error)
• func GetProperty(name string) (string, error)
• func IdeRequestTimeout() time.Duration
• func List(machineReadable bool) (string, error)
• func Merge() error
• func PluginConnectionTimeout() time.Duration
• func PluginKillTimeout() time.Duration
• func RefactorTimeout() time.Duration
• func RunnerConnectionTimeout() time.Duration
• func RunnerRequestTimeout() time.Duration
• func SetProjectRoot(args []string) error
• func Update(name, value string) error
• func Write(text, file string) error
• type Formatter
• type JsonFormatter
  • func (f JsonFormatter) Format(p []Property) (string, error)
• type Property
  • func NewProperty(key, defaultValue, description string) *Property
• type TextFormatter
  • func (f TextFormatter) Format(p []Property) (string, error)

Constants

const (
	LayoutForTimeStamp = "Jan 2, 2006 at 3:04pm"
)

Variables

var APILog = logging.MustGetLogger("gauge-api")

var GetPropertyFromConfig = func(propertyName string) string {
	config, err := common.GetGaugeConfiguration()
	if err != nil {
		APILog.Warningf("Failed to get configuration from Gauge properties file. Error: %s", err.Error())
		return ""
	}
	return config[propertyName]
}

var Log = logging.MustGetLogger("gauge")

var ProjectRoot string

Functions

func AllowInsecureDownload

func AllowInsecureDownload() bool

AllowInsecureDownload determines if insecure download is enabled

func CheckUpdates

func CheckUpdates() bool

CheckUpdates determines if update check is enabled

func FilePath

func FilePath(name string) (string, error)

func GaugeRepositoryUrl

func GaugeRepositoryUrl() string

GaugeRepositoryUrl fetches the repository URL to locate plugins

func GaugeVersionInPropertiesFile

func GaugeVersionInPropertiesFile(name string) (*version.Version, error)

func GetProperty

func GetProperty(name string) (string, error)

func IdeRequestTimeout

func IdeRequestTimeout() time.Duration

Timeout in milliseconds for requests from the grpc language runner.

func List

func List(machineReadable bool) (string, error)

func Merge

func Merge() error

func PluginConnectionTimeout

func PluginConnectionTimeout() time.Duration

PluginConnectionTimeout gets timeout in milliseconds for making a connection to plugins

func PluginKillTimeout

func PluginKillTimeout() time.Duration

PluginKillTimeout gets timeout in milliseconds for a plugin to stop after a kill message has been sent

func RefactorTimeout

func RefactorTimeout() time.Duration

RefactorTimeout returns the default timeout value for a refactoring request.

func RunnerConnectionTimeout

func RunnerConnectionTimeout() time.Duration

RunnerConnectionTimeout gets timeout in milliseconds for making a connection to the language runner

func RunnerRequestTimeout

func RunnerRequestTimeout() time.Duration

Timeout in milliseconds for requests from the language runner.

func SetProjectRoot

func SetProjectRoot(args []string) error

SetProjectRoot sets project root location in ENV.

func Update

func Update(name, value string) error

func Write

func Write(text, file string) error

Types

type Formatter

type Formatter interface {
	Format([]Property) (string, error)
}

type JsonFormatter

type JsonFormatter struct {
}

func (JsonFormatter) Format

func (f JsonFormatter) Format(p []Property) (string, error)

type Property

type Property struct {
	Key         string `json:"key"`
	Value       string `json:"value"`
	Description string
	// contains filtered or unexported fields
}

func NewProperty

func NewProperty(key, defaultValue, description string) *Property

type TextFormatter

type TextFormatter struct {
	Headers []string
}

func (TextFormatter) Format

func (f TextFormatter) Format(p []Property) (string, error)