bufconfig

Documentation

Overview

Package bufconfig contains the configuration functionality.

Index

• Constants
• func ConfigCreate(ctx context.Context, writeBucket storage.WriteBucket, name string, ...) error
• func ConfigExists(ctx context.Context, readBucket storage.ReadBucket) (bool, error)
• type Config
• type Provider
  • func NewProvider(logger *zap.Logger) Provider

Constants

const ConfigFilePath = "buf.yaml"

ConfigFilePath is the configuration file path.

Functions

func ConfigCreate

func ConfigCreate(ctx context.Context, writeBucket storage.WriteBucket, name string, deps ...string) error

ConfigCreate writes an initial configuration file into the bucket.

func ConfigExists

func ConfigExists(ctx context.Context, readBucket storage.ReadBucket) (bool, error)

ConfigExists checks if a configuration file exists.

Types

type Config

type Config struct {
	Name     bufmodule.ModuleName
	Build    *bufmodulebuild.Config
	Breaking *bufbreaking.Config
	Lint     *buflint.Config
}

Config is the user config.

type Provider

type Provider interface {
	// GetConfig gets the Config for the given JSON or YAML data.
	//
	// If the data is of length 0, returns the default config.
	GetConfig(ctx context.Context, readBucket storage.ReadBucket) (*Config, error)
	// GetConfig gets the Config for the given JSON or YAML data.
	//
	// If the data is of length 0, returns the default config.
	GetConfigForData(ctx context.Context, data []byte) (*Config, error)
}

Provider is a provider.

func NewProvider

func NewProvider(logger *zap.Logger) Provider

NewProvider returns a new Provider.