defaults

package

v0.1.1 Latest Latest Go to latest Published: Sep 19, 2026 License: MIT Imports: 0 Imported by: 0

Details

Package defaults provides types and functions to work with configuration of the default branch.

This section is empty.

This section is empty.

This section is empty.

type Config struct {
	// contains filtered or unexported fields
}

Config represents configuration of the default branch.

Config keeps the name of the branch that the linter treats as the main branch of the repository.

func NewConfig(opts ...Option) Config

NewConfig creates a new Config instance with provided functional options to customize the configuration.

Without options the created Config has an empty default branch name.

func (c Config) Name() string

Name returns the name of the default branch.

type Option func(*Config)

Option configures a Config instance.

Option is a functional option accepted by NewConfig to customize the created configuration.

func WithName(name string) Option

WithName sets the name of the default branch.