adrgo

package module

v0.0.0-...-1bd88ca Latest Latest Go to latest Published: Feb 2, 2022 License: MIT Imports: 26 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Architecture Decision Records with Go.

This section is empty.

View Source

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

func CreateADRTemplate(body Body) (out string)

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

headerInfo formats the header information.

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 struct {
	ID           int
	Title        string
	Path         string
	Status       string
	LastModified string
}

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

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

type Config struct {
	Language string
	Path     string
	Digits   int
}

func ReadConfig() (conf Config, err error)

type Head struct {
	Head  string
	Start int
	End   int
}

type Status struct {
	Value string
	Date  string
}

Path	Synopsis
cmd
adr