autoenv

Documentation

Index

• func Sync(ctx *context.Context, set FeatureSet)
• type FeatureInfo
  • func NewFeatureInfo(name string, param string) *FeatureInfo
  • func (f FeatureInfo) String() string
• type FeatureSet
  • func NewFeatureSet() FeatureSet
  • func (s FeatureSet) Get(name string) *FeatureInfo
  • func (s FeatureSet) String() string
  • func (s FeatureSet) With(featureInfo *FeatureInfo) FeatureSet
  • func (s FeatureSet) Without(name string) FeatureSet
• type StateData
• type StateManager
  • func (s *StateManager) ForgetEnv()
  • func (s *StateManager) GetActiveFeatures() FeatureSet
  • func (s *StateManager) GetProjectSlug() string
  • func (s *StateManager) RestoreEnv()
  • func (s *StateManager) SaveEnv()
  • func (s *StateManager) SetFeature(featureInfo *FeatureInfo)
  • func (s *StateManager) SetProjectSlug(slug string)
  • func (s *StateManager) UnsetFeature(name string)

Functions

func Sync

func Sync(ctx *context.Context, set FeatureSet)

Sync activates / deactivates the features in the instance of env.Env. When a feature is already active but unknown, it will be ignored completely. When a param changes, the feature is deactivated with the current param then activated with the new param.

Types

type FeatureInfo

type FeatureInfo struct {
	Name  string `json:"name"`
	Param string `json:"param"`
}

FeatureInfo represents a parameterized feature

func NewFeatureInfo

func NewFeatureInfo(name string, param string) *FeatureInfo

NewFeatureInfo returns a FeatureInfo

func (FeatureInfo) String

func (f FeatureInfo) String() string

type FeatureSet

type FeatureSet []*FeatureInfo

FeatureSet represents a set of parameterized features

func NewFeatureSet

func NewFeatureSet() FeatureSet

NewFeatureSet returns a FeatureSet

func (FeatureSet) Get

func (s FeatureSet) Get(name string) *FeatureInfo

Get returns a new FeatureSet augmented with the featureInfo provided

func (FeatureSet) String

func (s FeatureSet) String() string

func (FeatureSet) With

func (s FeatureSet) With(featureInfo *FeatureInfo) FeatureSet

With returns a new FeatureSet augmented with the featureInfo provided

func (FeatureSet) Without

func (s FeatureSet) Without(name string) FeatureSet

Without returns a new FeatureSet augmented with the featureInfo provided

type StateData

type StateData struct {
	ProjectSlug string     `json:"project"`
	Features    FeatureSet `json:"features"`
	SavedEnv    savedEnv   `json:"saved_env"`
}

type StateManager

type StateManager struct {
	UI *termui.UI
	// contains filtered or unexported fields
}

StateManager remember the current state of the features (whether they are active)

func (*StateManager) ForgetEnv

func (s *StateManager) ForgetEnv()

ForgetEnv clears the environment mutations previously recorded in the state

func (*StateManager) GetActiveFeatures

func (s *StateManager) GetActiveFeatures() FeatureSet

GetActiveFeatures returns the FeatureSet recorded in the state

func (*StateManager) GetProjectSlug

func (s *StateManager) GetProjectSlug() string

GetProjectSlug returns the slug of the project in which DevBuddy was when the state was written

func (*StateManager) RestoreEnv

func (s *StateManager) RestoreEnv()

RestoreEnv reverts the environment as recorded in the state

func (*StateManager) SaveEnv

func (s *StateManager) SaveEnv()

SaveEnv records the environment mutations in the state

func (*StateManager) SetFeature

func (s *StateManager) SetFeature(featureInfo *FeatureInfo)

SetFeature marks a feature as active

func (*StateManager) SetProjectSlug

func (s *StateManager) SetProjectSlug(slug string)

SetProjectSlug records the project slug in the state

func (*StateManager) UnsetFeature

func (s *StateManager) UnsetFeature(name string)

UnsetFeature marks a feature as inactive