summarize

Documentation

Overview

Package summary prints a pretty summary of all targets and their destinations.

Index

• type Detector
• type Resolver
• type Summarizer
  • func (s Summarizer) Summary() string

Types

type Detector

type Detector interface {
	Detect(path string) detect.Type
}

Detector detects a file's type.

type Resolver

type Resolver interface {
	List() []string
	Resolve(name string) (string, error)
}

Resolver lists all targets and resolves individual targets' destinations. Every target returned by List must be Resolvable without error.

type Summarizer

type Summarizer struct {
	Detector Detector
	Resolver Resolver
}

Summarizer returns a pretty string summarizing targets, their destinations, and the type of each destination.

func (Summarizer) Summary

func (s Summarizer) Summary() string

Summary retuns a the summary of all targets in the Resolver.