about summary refs log tree commit diff stats
path: root/internal/options/option.go
blob: b7fe818d48a68a58c612f1b1234cf3ab0853f43e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
package options

type Markdown string

type NixValue struct {
	Text     string   `json:",omitempty"`
	Markdown Markdown `json:",omitempty"`
}

type Link struct {
	Name string
	URL  string
}

type NixOption struct {
	Option string
	Source string

	Declarations    []Link
	Default         *NixValue `json:",omitempty"`
	Description     Markdown
	Example         *NixValue `json:",omitempty"`
	Loc             []string
	RelatedPackages Markdown `json:",omitempty"`
	Type            string
}

func (*NixOption) BleveType() string {
	return "option"
}