editor

type Diagnostic struct {
	// File is the path of the file the problem is in: the deck, or a file
	// it reads (a kinds file, an included fragment, slides.hcl).
	File      string `json:"file"`
	Line      int    `json:"line"`
	Column    int    `json:"column"`
	EndLine   int    `json:"endLine"`
	EndColumn int    `json:"endColumn"`
	// Severity is "error" or "warning".
	Severity string `json:"severity"`
	Message  string `json:"message"`
	// Code names the kind of problem, stable across releases and wording
	// (see Codes): the Message is the compiler's or the parser's, in English;
	// a UI that speaks another language explains the Code. "" when the
	// problem is none of those known.
	Code string `json:"code,omitempty"`
}

type Directive struct {
	Name string `json:"name"`
	// Scope is "global" (the whole deck), "local" (this slide and the
	// following ones; "_name" for this slide only) or "deck" (a go-slides
	// front-matter key that is not a Marp directive).
	Scope string `json:"scope"`
	// Doc is Markdown.
	Doc string `json:"doc"`
	// Values are the values the directive takes, when they are a short
	// list.
	Values []string `json:"values,omitempty"`
}

type Func struct {
	Name      string `json:"name"`
	Signature string `json:"signature"`
	Doc       string `json:"doc"`
}

type Hover struct {
	// Doc is Markdown.
	Doc string `json:"doc"`
	// The hovered word, on Line from Column to EndColumn (UTF-16).
	Line      int `json:"line"`
	Column    int `json:"column"`
	EndColumn int `json:"endColumn"`
}

type Item struct {
	Label string `json:"label"`
	// Kind is "directive", "value", "kind", "theme", "function" or
	// "data".
	Kind   string `json:"kind"`
	Detail string `json:"detail,omitempty"`
	// Doc is Markdown.
	Doc string `json:"doc,omitempty"`
	// Insert is the text to insert when it differs from Label.
	Insert string `json:"insert,omitempty"`
}

type KV struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type KindInfo struct {
	Name    string `json:"name"`
	Extends string `json:"extends,omitempty"`
	// Directives are the resolved directives, in the order they are set.
	Directives []KV `json:"directives"`
}

type Request struct {
	// Lang is the language the help is wanted in ("fr", "pt-BR"…): the help
	// of a directive or a template function comes from the catalogue
	// RegisterHelp gave for it, English when it has none. Diagnostics stay
	// in English; their Code is what a UI explains in its own language.
	Lang string `json:"lang,omitempty"`
	// Path is the deck's path; relative paths in the deck resolve from its
	// directory.
	Path string `json:"path"`
	// Source is the deck's text, as the editor holds it (unsaved edits
	// included).
	Source string `json:"source"`
	// Files are the workspace files the editor has read, by path.
	Files map[string]string `json:"files,omitempty"`
	// Dirs are directories the editor has listed, with the names in them;
	// a subdirectory's name ends with "/". A listed file the editor has not
	// read comes back in Missing if the build reads it.
	Dirs map[string][]string `json:"dirs,omitempty"`
	// HTML allows all raw HTML. The editor sets it only when the user asked
	// for it and trusts the workspace; a configuration file's html: true is
	// not enough, since the workspace wrote it.
	HTML bool `json:"html,omitempty"`
	// NoConfig ignores slides.yaml and slides.hcl.
	NoConfig bool `json:"noConfig,omitempty"`
}

type Result struct {
	// HTML is the preview's markup: the theme's style element and the
	// slides, each an inline SVG that scales to the preview's width.
	HTML string `json:"html"`
	// Head and SlideHTML are HTML in parts, for a preview that patches
	// itself slide by slide instead of replacing its document: HTML is
	// Head, then each of SlideHTML (one inline SVG a slide), then "</div>".
	// Neither is a copy (Head is a slice of HTML, SlideHTML the rendered
	// slides' own strings), and neither is serialised.
	Head      string   `json:"-"`
	SlideHTML []string `json:"-"`
	// Slides counts the slides.
	Slides int `json:"slides"`
	// Diagnostics are the deck's problems; an error leaves HTML empty.
	Diagnostics []Diagnostic `json:"diagnostics"`
	// Missing are the files the build wanted and the request did not hold.
	Missing []string `json:"missing"`
}