Documentation
¶
Overview ¶
Package status computes the ladders of a node (spec 04.8): H for the human proof, L for Lean, I for each language, V for the visualization and W for the writing.
Nobody writes a level by hand. Each level comes with the reasons that it is not higher, so that a page can say what it needs next.
Index ¶
- func Hash(path string) (string, error)
- func Lead(body string) string
- func LoadDecls(path string) (formal.Decls, error)
- func LoadResults(dir string) (map[string]map[string]Test, error)
- func Section(body, h string) string
- func Sections(body string) []string
- type CaseFailure
- type Env
- type Results
- type Review
- type Rung
- type Shared
- type Status
- type Test
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func LoadDecls ¶ added in v0.1.5
LoadDecls reads decls.jsonl. A missing file gives nil, which means that the Lean build did not run.
func LoadResults ¶
LoadResults reads every build/results/*.json under dir. A missing dir gives no results.
Types ¶
type CaseFailure ¶ added in v0.1.2
type CaseFailure struct {
Case string `json:"case"`
Reason string `json:"reason"`
Got string `json:"got,omitempty"`
Want string `json:"want,omitempty"`
}
CaseFailure is one shared case that failed, with the reason.
type Env ¶
type Env struct {
Corpus *node.Corpus
Results map[string]map[string]Test // slug, then lang
// VizChecked holds the scenes that passed `algo viz check` in this build, by slug, with the failures of the others.
VizChecked map[string][]string
// Decls holds the declarations that `algo lean build` extracted, or nil when it did not run.
Decls formal.Decls
}
Env is what the ladders read besides the node.
type Results ¶
type Results struct {
Lang string `json:"lang"`
Version string `json:"version,omitempty"`
Tests []Test `json:"tests"`
}
Results is the content of one file build/results/<lang>.json.
type Review ¶
type Review struct {
Part string `yaml:"part"`
Hash string `yaml:"hash"`
Reviewer string `yaml:"reviewer"`
Date string `yaml:"date"`
Verdict string `yaml:"verdict"`
}
Review is a review record, reviews/<tag>/<part>.yaml (spec 13.2).
type Rung ¶
type Rung struct {
Level int `json:"level"`
Max int `json:"max"`
Label string `json:"label"` // for example "H2"
Name string `json:"name"` // for example "full proof"
Next []string `json:"next,omitempty"`
}
Rung is the level of one ladder, with the reasons that it is not higher.
type Shared ¶ added in v0.1.2
type Shared struct {
// SkipExpected is true when the language cannot run the skipped cases by design, as C cannot run T = string. Such a skip does not hold back I1.
Error string `json:"error,omitempty"`
}
Shared is the result of the shared cases of one problem on one implementation.
type Status ¶
type Status struct {
Slug string `json:"slug"`
H Rung `json:"h"`
L Rung `json:"l"`
I map[string]Rung `json:"i"`
V Rung `json:"v"`
W Rung `json:"w"`
Tests map[string]Test `json:"tests,omitempty"`
}
Status is the set of ladders of one node.
type Test ¶
type Test struct {
Slug string `json:"slug"`
Lang string `json:"lang"`
// Pass tells if the native tests pass.
Pass bool `json:"pass"`
Output string `json:"output,omitempty"`
Ms int64 `json:"ms"`
Shared []Shared `json:"shared,omitempty"`
}
Test is the result of the native tests of one implementation, as `algo test` writes it.