flags

Documentation

Overview

SPDX-License-Identifier: Apache-2.0

Copyright © 2023 The listen.dev team <engineering@garnet.ai>

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.

SPDX-License-Identifier: Apache-2.0

Copyright © 2023 The listen.dev team <engineering@garnet.ai>

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.

SPDX-License-Identifier: Apache-2.0

Copyright © 2023 The listen.dev team <engineering@garnet.ai>

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.

SPDX-License-Identifier: Apache-2.0

Copyright © 2023 The listen.dev team <engineering@garnet.ai>

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.

Index

• Variables
• func AsJSON(o interface{}) string
• func Define(c *cobra.Command, o interface{}, startingGroup string, exclusions []string)
• func GetDefaults(o interface{}) map[string]string
• func GetField(o interface{}, name string) reflect.Value
• func GetFieldTag(o interface{}, name string) (reflect.StructTag, bool)
• func GetNames(o interface{}) map[string]string
• func GetTypes(o interface{}) map[string]reflect.Type
• func Transform(ctx context.Context, o interface{}) error
• func Translate(err error, prefix string) []error
• func Validate(o interface{}) []error
• type ConfigFlags
  • func NewConfigFlags() (*ConfigFlags, error)
  • func (o *ConfigFlags) Define(c *cobra.Command, exclusions []string)
  • func (o *ConfigFlags) SetDefaults()
  • func (o *ConfigFlags) Transform(ctx context.Context) error
  • func (o *ConfigFlags) Validate() []error
• type DebugFlags
• type Endpoint
• type Filtering
• type GitHub
• type Ignore
• type JSONFlags
  • func (o *JSONFlags) GetOutput(ctx context.Context, input io.Reader, output io.Writer) error
  • func (o *JSONFlags) GetQuery() string
  • func (o *JSONFlags) IsJSON() bool
• type Pull
• type Registry
• type Reporting
• type Token
• type TokenMandatory

Variables

var EnvPrefix = "lstn"

EnvPrefix is the prefix of the env variables corresponding to the global flags.

var EnvReplacer = strings.NewReplacer("-", EnvSeparator, ".", EnvSeparator)

EnvReplacer is the string replacer that defines the transformation for flag names into environment variable names.

var EnvSeparator = "_"

EnvSeparator is the separator between the env variable prefix and the global flag name.

Functions

func AsJSON

func AsJSON(o interface{}) string

func Define

func Define(c *cobra.Command, o interface{}, startingGroup string, exclusions []string)

func GetDefaults

func GetDefaults(o interface{}) map[string]string

func GetField

func GetField(o interface{}, name string) reflect.Value

func GetFieldTag

func GetFieldTag(o interface{}, name string) (reflect.StructTag, bool)

func GetNames

func GetNames(o interface{}) map[string]string

func GetTypes

func GetTypes(o interface{}) map[string]reflect.Type

func Transform

func Transform(ctx context.Context, o interface{}) error

func Translate

func Translate(err error, prefix string) []error

func Validate

func Validate(o interface{}) []error

Types

type ConfigFlags

type ConfigFlags struct {
	LogLevel string `default:"info" name:"log level" flag:"loglevel" desc:"set the logging level" flagset:"Config" json:"loglevel"` // TODO > validator
	Timeout  int    ``                                                                                                              // FIXME: change to time.Duration type
	/* 134-byte string literal not displayed */
	Endpoint Endpoint `json:"endpoint"`
	Token
	Registry
	Reporting
	Filtering
	Lockfiles []string `` /* 199-byte string literal not displayed */
}

ConfigFlags are the options that the CLI also reads from the YAML configuration file.

func NewConfigFlags

func NewConfigFlags() (*ConfigFlags, error)

func (*ConfigFlags) Define

func (o *ConfigFlags) Define(c *cobra.Command, exclusions []string)

func (*ConfigFlags) SetDefaults

func (o *ConfigFlags) SetDefaults()

func (*ConfigFlags) Transform

func (o *ConfigFlags) Transform(ctx context.Context) error

func (*ConfigFlags) Validate

func (o *ConfigFlags) Validate() []error

type DebugFlags

type DebugFlags struct {
	DebugOptions bool `name:"debug options" flag:"debug-options" desc:"output the options, then exit" json:"debug-options"`
}

type Endpoint

type Endpoint struct {
	Npm  string `` /* 203-byte string literal not displayed */
	PyPi string `` /* 208-byte string literal not displayed */
	Core string `` /* 185-byte string literal not displayed */
}

type Filtering

type Filtering struct {
	Ignore     `flagset:"Filtering"`
	Expression string `` /* 167-byte string literal not displayed */
}

type GitHub

type GitHub struct {
	Owner string `name:"github owner" flag:"gh-owner" desc:"set the GitHub owner name (org|user)" flagset:"Reporting" json:"gh-owner"`
	Repo  string `name:"github repository" flag:"gh-repo" desc:"set the GitHub repository name" flagset:"Reporting" json:"gh-repo"`
	Pull
}

type Ignore

type Ignore struct {
	Packages []string          `` /* 143-byte string literal not displayed */
	Deptypes []npmdeptype.Enum `` /* 148-byte string literal not displayed */
	// contains filtered or unexported fields
}

type JSONFlags

type JSONFlags struct {
	JSON bool   `name:"json" flag:"json" desc:"output the verdicts (if any) in JSON form" json:"json"`
	JQ   string `` /* 173-byte string literal not displayed */
}

func (*JSONFlags) GetOutput

func (o *JSONFlags) GetOutput(ctx context.Context, input io.Reader, output io.Writer) error

func (*JSONFlags) GetQuery

func (o *JSONFlags) GetQuery() string

func (*JSONFlags) IsJSON

func (o *JSONFlags) IsJSON() bool

type Pull

type Pull struct {
	ID int `name:"github pull request ID" flag:"gh-pull-id" desc:"set the GitHub pull request ID" flagset:"Reporting" json:"gh-pull-id"`
}

type Registry

type Registry struct {
	NPM string `` /* 195-byte string literal not displayed */
}

type Reporting

type Reporting struct {
	Types []cmd.ReportType `json:"reporter" flag:"reporter" shorthand:"r" transform:"unique" desc:"set one or more reporters to use" flagset:"Reporting"`
	GitHub
	// contains filtered or unexported fields
}

NOTE > Struct can't have the same name of a flag.

type Token

type Token struct {
	GitHub string `name:"GitHub token" flag:"gh-token" desc:"set the GitHub token" flagset:"Token" json:"gh-token" validate:"omitempty,notblank"`
	JWT    string `` /* 133-byte string literal not displayed */
}

type TokenMandatory

type TokenMandatory struct {
	GitHub string `name:"GitHub token" flag:"gh-token" desc:"set the GitHub token" flagset:"Token" json:"gh-token" validate:"mandatory"`
	JWT    string `name:"JWT token" flag:"jwt-token" desc:"set the listen.dev auth token" flagset:"Token" json:"jwt-token" validate:"mandatory"`
}