topic

type Backing string

type Claim struct {
	ID, Slug   string
	Type       ClaimType
	Prose      string
	Summary    string
	References []string
	Backing    Backing
	Verify     string
}

type ClaimReferences struct {
	ClaimID  string   `json:"claimId"`
	Incoming []string `json:"incoming"`
	Outgoing []string `json:"outgoing"`
}

type ClaimType string

type Corpus struct {
	DomainPaths map[string][]string
	Markers     MarkerIndex
	// contains filtered or unexported fields
}

type CoverageFinding struct {
	Path            string       `json:"path"`
	Domain          string       `json:"domain,omitempty"`
	Kind            CoverageKind `json:"kind"`
	CandidateTopics []string     `json:"candidateTopics,omitempty"`
	// The rank is not part of this struct's wire form. Stated rather than left
	// implicit: an untagged exported field still marshals, as a bare 0 or 1.
	Severity severity.Rank `json:"-"`
	Topics   int           `json:"topics,omitempty"`
}

type CoverageKind string

type CoveragePolicy struct {
	Coverage, Fanout bool
}

type IndexRenderModel struct {
	Domain string
	Topics []TopicListItem
}

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

type MarkerKind string

type MarkerSite struct {
	Path    string     `json:"path"`
	Line    int        `json:"line"`
	Kind    MarkerKind `json:"kind"`
	ClaimID string     `json:"claimId"`
	Note    string     `json:"note,omitempty"`
}

type Metadata struct {
	Title, Summary string
	Paths          []string
	Applies        string
}

type NavigationModel struct {
	IndexLink string
	Topics    []TopicListItem
}

type QueryClaim struct {
	ID      string    `json:"id"`
	Type    ClaimType `json:"type"`
	Prose   string    `json:"prose"`
	Backing Backing   `json:"backing"`
	Verify  string    `json:"verify,omitempty"`
}

type QueryCoverage struct {
	Applicability TopicApplicability `json:"applicability"`
}

type QueryOptions struct {
	References, Coverage bool
}

type QueryResult struct {
	Kind       string            `json:"kind"`
	ID         string            `json:"id"`
	Title      string            `json:"title,omitempty"`
	Summary    string            `json:"summary,omitempty"`
	Claims     []QueryClaim      `json:"claims"`
	References []ClaimReferences `json:"references,omitempty"`
	Coverage   *QueryCoverage    `json:"coverage,omitempty"`
}

type ScaffoldFile struct {
	Path    string
	Content []byte
}

type Topic struct {
	ID                     TopicID
	Metadata               Metadata
	Intro, Part            string
	Claims                 []Claim
	MetadataPath, PartPath string
}

type TopicApplicability struct {
	DeclaredGlobal  bool         `json:"declaredGlobal"`
	DomainPaths     []string     `json:"domainPaths"`
	TopicPaths      []string     `json:"topicPaths"`
	ApplicablePaths []string     `json:"applicablePaths"`
	OwnedPaths      []string     `json:"ownedPaths"`
	MarkerSites     []MarkerSite `json:"markerSites"`
}

type TopicID struct{ Domain, Slug string }

type TopicListItem struct{ Slug, Title, Summary, Link string }

type TopicRenderModel struct{ Title, Summary, Applicability, Part string }

type TreeReader interface {
	ReadFile(path string) ([]byte, bool, error)
	Paths(prefix string) ([]string, error)
}