adrgo

README

adr-go

Architecture Decision Records with Go.

Documentation

Index

• Variables
• func CreateADRTemplate(body Body) (out string)
• func HeaderInfo(title string) (id int, name string)
• func Init(conf Config) (err error)
• func IsInitedConfig() bool
• func IsValidLanguage(lang string) bool
• func List(ctx context.Context, conf Config, w io.Writer) (err error)
• func LoadLanguage(lang string)
• func MarshalConfig(conf Config) []byte
• func New(ctx context.Context, conf Config, new ADRecord) (err error)
• func T(id string) string
• type ADRecord
• type Body
  • func ParserFile(ctx context.Context, fp string) (body Body, err error)
• type Config
  • func ReadConfig() (conf Config, err error)
• type Head
• type Status

Variables

var (
	ErrAlreadyExists   = errors.New("already exists")
	ErrWriteFileFailed = errors.New("write file failed")
)

Functions

func CreateADRTemplate

func CreateADRTemplate(body Body) (out string)

func HeaderInfo

func HeaderInfo(title string) (id int, name string)

headerInfo formats the header information.

func Init

func Init(conf Config) (err error)

func IsInitedConfig

func IsInitedConfig() bool

func IsValidLanguage

func IsValidLanguage(lang string) bool

func List

func List(ctx context.Context, conf Config, w io.Writer) (err error)

func LoadLanguage

func LoadLanguage(lang string)

func MarshalConfig

func MarshalConfig(conf Config) []byte

func New

func New(ctx context.Context, conf Config, new ADRecord) (err error)

func T

func T(id string) string

Types

type ADRecord

type ADRecord struct {
	ID           int
	Title        string
	Path         string
	Status       string
	LastModified string
}

type Body

type Body struct {
	FileName   string
	Index      int
	Title      string
	LastUpdate string
	Status     []Status
	Heads      []Head
}

func ParserFile

func ParserFile(ctx context.Context, fp string) (body Body, err error)

type Config

type Config struct {
	Language string
	Path     string
	Digits   int
}

func ReadConfig

func ReadConfig() (conf Config, err error)

type Head

type Head struct {
	Head  string
	Start int
	End   int
}

type Status

type Status struct {
	Value string
	Date  string
}