config

package

v0.0.0-...-84ce4bd Latest Latest Go to latest Published: Apr 15, 2023 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/gomicro/align

Documentation ¶

Index ¶

func CreateDir() error
func DirExists() (bool, error)
func FileExists() (bool, error)
type Config
- func New(tkn string) *Config
- func ParseFromFile() (*Config, error)
- func (c *Config) WriteFile() error
type GithubHost
type Limits

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CreateDir ¶

func CreateDir() error

CreateDir creates the config directory and all necessary parent directories missing. It returns any error it encounters with creating the directory.

func DirExists ¶

func DirExists() (bool, error)

DirExists returns a bool and error representing whether or not a config directory exists for the current user, and any errors it encounters with statting the existence of the directory.

func FileExists ¶

func FileExists() (bool, error)

FileExists returns a bool and error representing whether or not a config file exists for the current user, and any errors it encounters with statting the existence of the file.

Types ¶

type Config ¶

type Config struct {
	Github *GithubHost `yaml:"github.com"`
}

Config represents the config file for align

func New ¶

func New(tkn string) *Config

New takes a token string and creates the most basic config capable of being written.

func ParseFromFile ¶

func ParseFromFile() (*Config, error)

ParseFromFile reads the align config file from the home directory. It returns any errors it encounters with parsing the file.

func (*Config) WriteFile ¶

func (c *Config) WriteFile() error

WriteFile writes the file to the defined location for the current user, and returns any errors encountered doing so.

type GithubHost ¶

type GithubHost struct {
	Token          string  `yaml:"token"`
	Username       string  `yaml:"username"`
	PrivateKey     string  `yaml:"private_key"`
	PrivateKeyFile string  `yaml:"private_key_file"`
	Limits         *Limits `yaml:"limits"`
}

GithubHost represents a single host for which align has a configuration

type Limits ¶

type Limits struct {
	RequestsPerSecond int `yaml:"request_per_second"`
	Burst             int `yaml:"burst"`
}

Limits represents a limits override for the client

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL