feature

Documentation

Overview

Package feature provides feature generator

Index

• Variables
• type Generator
  • func (g Generator) Generate(ctx *genall.GenerationContext) error
  • func (Generator) RegisterMarkers(reg *markers.Registry) error
• type Rule

Variables

var (
	// RuleDefinition is a marker for defining Feature rules.
	RuleDefinition = markers.Must(markers.MakeDefinition(markerName, markers.DescribesType, Rule{}))
)

Types

type Generator

type Generator struct{}

Generator is feature generator that registers feature markers and produces output artifacts

func (Generator) Generate

func (g Generator) Generate(ctx *genall.GenerationContext) error

Generate generates artifacts produced by feature marker.

func (Generator) RegisterMarkers

func (Generator) RegisterMarkers(reg *markers.Registry) error

RegisterMarkers registers all markers needed by this Generator

type Rule

type Rule struct {
	// Name of the feature.
	Name string
	// Description of the feature.
	Description string `marker:",optional"`
	// Activated defines the default state of the feature activation.
	Activated bool `marker:",optional"`
	// Immutable indicates this feature cannot be toggled once set
	Immutable bool `marker:",optional"`
	// Discoverable defines API clients should present or hide this feature from user-facing results.
	Discoverable bool `marker:",optional"`
	// Maturity indicates maturity level of this feature.
	Maturity string
}

Rule is the output type of the marker value