cmd

Documentation

Index

• Constants
• Variables
• func Diagnose(d Doctor, r parser_io.ReadSeekCloserAt, cache map[string]string, ...) map[string]Diagnosis
• func Execute() int
• func Prepare() error
• func Report(diagnoses map[string]Diagnosis, strict_mode bool) error
• func SaveCache(diagnoses map[string]Diagnosis, cacheStore CacheStore, packageManager string) error
• type CachePackageManager
• type CacheRepository
• type CacheStore
  • func BuildCacheStore() CacheStore
  • func (r *CacheStore) RebuildCacheStore(diagnoses map[string]Diagnosis, packageManager string) CacheStore
  • func (r *CacheStore) URLbyPackageManager(packageManager string) map[string]string
• type DiagnoseOption
  • func (o *DiagnoseOption) Ignores() []string
• type Diagnosis
  • func (d *Diagnosis) ErrorMessage() string
• type Doctor
• type Doctors
  • func (d Doctors) PackageManagers() []string
  • func (d Doctors) UnknownErrorMessage(packageManager string) string
• type Libraries
  • func NewLibraries(libs []types.Library) Libraries
  • func (libs Libraries) Uniq() Libraries
• type Reporter
• type RepositoryParams
  • func FetchRepositoryParams(libs []types.Library, d Doctor, cache map[string]string, disableCache bool) RepositoryParams
  • func (params RepositoryParams) SearchableParams() []github.FetchRepositoryParam
  • func (params RepositoryParams) SlicedParams() [][]github.FetchRepositoryParam
• type StdoutReporter
  • func NewStdoutReporter(diagnosis map[string]Diagnosis, strict_mode bool) *StdoutReporter
  • func (r *StdoutReporter) Report() error

Constants

const CACHE_FILE = ".dep-doctor.yaml"

const FETCH_REPOS_PER_ONCE = 20

referenced as the number of goroutine parallels should be optimized?

const MAX_YEAR_TO_BE_BLANK = 5

Variables

var (
	Revision = "3"
	Version  = "1"
)

Functions

func Diagnose

func Diagnose(d Doctor, r parser_io.ReadSeekCloserAt, cache map[string]string, o DiagnoseOption) map[string]Diagnosis

func Execute

func Execute() int

func Prepare

func Prepare() error

func Report

func Report(diagnoses map[string]Diagnosis, strict_mode bool) error

func SaveCache

func SaveCache(diagnoses map[string]Diagnosis, cacheStore CacheStore, packageManager string) error

Types

type CachePackageManager

type CachePackageManager struct {
	Name         string            `yaml:"name"`
	Repositories []CacheRepository `yaml:"repositories"`
}

type CacheRepository

type CacheRepository struct {
	Name      string `yaml:"name"`
	SourceURL string `yaml:"source_url"`
}

type CacheStore

type CacheStore struct {
	PackageManagers []CachePackageManager `yaml:"package_managers"`
}

func BuildCacheStore

func BuildCacheStore() CacheStore

func (*CacheStore) RebuildCacheStore

func (r *CacheStore) RebuildCacheStore(diagnoses map[string]Diagnosis, packageManager string) CacheStore

func (*CacheStore) URLbyPackageManager

func (r *CacheStore) URLbyPackageManager(packageManager string) map[string]string

type DiagnoseOption

type DiagnoseOption struct {
	Out    io.Writer
	ErrOut io.Writer
	// contains filtered or unexported fields
}

func (*DiagnoseOption) Ignores

func (o *DiagnoseOption) Ignores() []string

type Diagnosis

type Diagnosis struct {
	Name      string
	URL       string
	Archived  bool
	Ignored   bool
	Diagnosed bool
	Active    bool
	Error     error
}

func (*Diagnosis) ErrorMessage

func (d *Diagnosis) ErrorMessage() string

type Doctor

type Doctor interface {
	Parse(r parser_io.ReadSeekerAt) (types.Libraries, error)
	SourceCodeURL(lib types.Library) (string, error)
}

type Doctors

type Doctors map[string]Doctor

func (Doctors) PackageManagers

func (d Doctors) PackageManagers() []string

func (Doctors) UnknownErrorMessage

func (d Doctors) UnknownErrorMessage(packageManager string) string

type Libraries

type Libraries []types.Library

func NewLibraries

func NewLibraries(libs []types.Library) Libraries

func (Libraries) Uniq

func (libs Libraries) Uniq() Libraries

type Reporter

type Reporter interface {
	Report() error
}

type RepositoryParams

type RepositoryParams []github.FetchRepositoryParam

func FetchRepositoryParams

func FetchRepositoryParams(libs []types.Library, d Doctor, cache map[string]string, disableCache bool) RepositoryParams

func (RepositoryParams) SearchableParams

func (params RepositoryParams) SearchableParams() []github.FetchRepositoryParam

func (RepositoryParams) SlicedParams

func (params RepositoryParams) SlicedParams() [][]github.FetchRepositoryParam

type StdoutReporter

type StdoutReporter struct {
	// contains filtered or unexported fields
}

func NewStdoutReporter

func NewStdoutReporter(diagnosis map[string]Diagnosis, strict_mode bool) *StdoutReporter

func (*StdoutReporter) Report

func (r *StdoutReporter) Report() error