adr

Documentation

Overview

Package adr implements the ADR (Architecture Decision Record) adapter.

Index

• type Adapter
  • func (a *Adapter) Discover(ctx context.Context, repoRoot string, cfg *config.RepoConfig) ([]adapters.Candidate, error)
  • func (a *Adapter) Name() string
  • func (a *Adapter) Parse(ctx context.Context, c adapters.Candidate) (adapters.Artifact, []adapters.Source, todoparse.ParseResult, error)

Types

type Adapter

type Adapter struct{}

Adapter discovers and parses ADR files.

func (*Adapter) Discover

func (a *Adapter) Discover(ctx context.Context, repoRoot string, cfg *config.RepoConfig) ([]adapters.Candidate, error)

func (*Adapter) Name

func (a *Adapter) Name() string

func (*Adapter) Parse

func (a *Adapter) Parse(ctx context.Context, c adapters.Candidate) (adapters.Artifact, []adapters.Source, todoparse.ParseResult, error)