viewserver

type CommitFunc func(ctx context.Context, review Review, oid string) (locallink.CommitDetail, error)

type CommitPatchFunc func(ctx context.Context, review Review, commit locallink.CommitDetail, file locallink.CommitFile) (locallink.PatchResult, error)

type FileFunc func(ctx context.Context, review Review, path string) (locallink.FileResult, error)

type Options struct {
	// Path is the document file. It is read at New; with Watch it is polled
	// for changes. Exactly one of Path and Document must be set.
	Path string
	// Document is a fixed document, such as the sample. It cannot be watched.
	Document []byte
	// Watch reloads the viewer when the file at Path changes.
	Watch bool
	// Validate returns the findings for a document. They are printed to Warn
	// each time a document is loaded; the document is served either way.
	Validate func(document []byte) []string
	// Warn receives warnings. It defaults to discarding them.
	Warn io.Writer
	// Assets is the app to serve, with index.html at its root. It defaults to
	// the embedded viewer.
	Assets fs.FS
	// Sample marks the document as the built-in sample, which belongs to no
	// clone: /api/sessions then answers that sessions are unavailable.
	Sample bool
	// Sessions links the sessions on this machine to the document's pull
	// request. It is called on the first request for /api/sessions, never at
	// start-up, and its available answers are kept for at most a minute, or until
	// invalidation or a change to the document's repository, head or base. Unset, /api/sessions is unavailable.
	Sessions SessionsFunc
	// Patch reads one file's patch of the document's pull request from this
	// machine, for GET /api/patch. It is called when a file's patch is first
	// asked for, never at start-up. Unset, every patch is unavailable.
	Patch PatchFunc
	// Commit and CommitPatch read one linked commit's message and changed
	// files, and one of those files' patch, for GET /api/commit and
	// GET /api/commit-patch. They are called on demand, only for a commit
	// GET /api/commits lists. Unset, every commit is unavailable.
	Commit      CommitFunc
	CommitPatch CommitPatchFunc
	// File reads one file at the document's head from this machine, for
	// GET /api/file. It is called on demand, only for a path the document
	// cites. Unset, every file is unavailable.
	File FileFunc
	// Versions reads another saved version of the document's pull request,
	// for GET /api/patch?version=. Unset, only the served document's version
	// has patches.
	Versions VersionsFunc
	// Home is the user's home directory, written as ~ in the transcripts
	// GET /api/sessions/{id} serves. It defaults to os.UserHomeDir, else the
	// account's home directory.
	Home string
	// PollInterval is how often a watched file is checked; it defaults to
	// 500ms. PingInterval is how often an idle event stream sends a comment
	// line; it defaults to 20s.
	PollInterval time.Duration
	PingInterval time.Duration
}

type PatchFunc func(ctx context.Context, review Review, path string) (locallink.PatchResult, error)

type Review struct {
	Repository  string
	PullRequest int
	Head, Base  string
	// MergeBase is the merge base the document records, when it does.
	MergeBase string
	// Version is the document's review version.
	Version int
}

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

type SessionsFunc func(ctx context.Context, review Review) (locallink.Result, error)

type VersionsFunc func(ctx context.Context, version int) ([]byte, error)