progress

Documentation

Index

• func FormatJSON(result RunResult) ([]byte, error)
• func SummaryLine(steps []StepResult) string
• type Options
• type RunResult
  • func RunWithProgress(steps []Step, opts Options) (RunResult, error)
• type Step
• type StepResult

Functions

func FormatJSON

func FormatJSON(result RunResult) ([]byte, error)

FormatJSON: 결과를 JSON으로 직렬화.

func SummaryLine

func SummaryLine(steps []StepResult) string

SummaryLine: 위반 건수 요약 줄 반환.

Types

type Options

type Options struct {
	Quiet   bool
	NoColor bool
}

Options: RunWithProgress 옵션.

type RunResult

type RunResult struct {
	AllErrors []string
	Steps     []StepResult
}

RunResult: RunWithProgress 반환값.

func RunWithProgress

func RunWithProgress(steps []Step, opts Options) (RunResult, error)

RunWithProgress: 검사 단계를 순차 실행하고 결과를 반환.

type Step

type Step struct {
	Name     string
	Category string // 기계가 읽을 수 있는 카테고리 (JSON 출력 등)
	Fn       func() ([]string, error)
}

Step: 실행할 검사 단계 정보.

type StepResult

type StepResult struct {
	Name     string
	Category string
	Errors   []string
	Failed   bool // 치명적 오류 발생 여부
}

StepResult: 단계 실행 결과.