Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

settings

package

Go to main page

Versions in this module

v0

v0.4.3

Feb 4, 2026

v0.4.2

Jan 23, 2026

v0.4.1

Jan 23, 2026

v0.4.0

Jan 22, 2026

Changes in this version

+ var ErrInvalidScope = errors.New("invalid scope: must be managed, user, project, or local")

+ var ErrManagedReadOnly = errors.New("managed scope is read-only")

+ func AddMarketplace(name string, source MarketplaceSource, scope Scope, projectPath string) error

+ func AllMarketplaces(projectPath string) (map[string]ExtraMarketplace, error)

+ func AtomicRename(tmpPath, finalPath string) error

+ func LocalSettingsPath(projectPath string) (string, error)

+ func ManagedSettingsPath() (string, error)

+ func ProjectSettingsPath(projectPath string) (string, error)

+ func RemoveMarketplace(name string, scope Scope, projectPath string) error

+ func RemovePluginFromScope(fullName string, scope Scope, projectPath string) error

+ func SaveSettings(s *Settings, scope Scope, projectPath string) error

+ func ScopePath(scope Scope, projectPath string) (string, error)

+ func SetPluginEnabled(fullName string, enabled bool, scope Scope, projectPath string) error

+ func UserSettingsPath() (string, error)

+ func WithLock(path string, fn func() error) error — darwin/amd64, linux/amd64, windows/amd64

+ type ExtraMarketplace struct

+ Source MarketplaceSource

+ type FileLock struct — darwin/amd64, linux/amd64, windows/amd64

+ func NewFileLock(path string) *FileLock

+ func (l *FileLock) Lock() error

+ func (l *FileLock) Unlock() error

+ type MarketplaceSource struct

+ Repo string

+ Source string

+ type PluginState struct

+ Enabled bool

+ FullName string

+ Scope Scope

+ func FilterByScope(states []PluginState, scope Scope) []PluginState

+ func FilterDisabled(states []PluginState) []PluginState

+ func FilterEnabled(states []PluginState) []PluginState

+ func GetPluginState(pluginFullName string, projectPath string) (*PluginState, error)

+ func MergedPluginStates(projectPath string) ([]PluginState, error)

+ type Scope string

+ const ScopeLocal

+ const ScopeManaged

+ const ScopeProject

+ const ScopeUser

+ func AllScopes() []Scope

+ func ParseScope(s string) (Scope, error)

+ func WritableScopes() []Scope

+ func (s Scope) IsWritable() bool

+ func (s Scope) String() string

+ type Settings struct

+ EnabledPlugins map[string]bool

+ ExtraKnownMarketplaces map[string]ExtraMarketplace

+ func LoadSettings(scope Scope, projectPath string) (*Settings, error)

+ func LoadSettingsFromPath(path string) (*Settings, error)

+ func NewSettings() *Settings

+ func (s *Settings) MarshalJSON() ([]byte, error)

+ func (s *Settings) UnmarshalJSON(data []byte) error