aboutsummaryrefslogtreecommitdiff
path: root/misc/ols.schema.json
blob: 81bc0cd3bb355216f29f5cdb1ef71bb0869922a0 (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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
{
	"$schema": "http://json-schema.org/draft-07/schema#",
	"type": "object",
	"properties": {
		"collections": {
			"type": "array",
			"items": {
				"type": "object",
				"properties": {
					"name": { "type": "string" },
					"path": { "type": "string" }
				},
				"required": ["name", "path"],
				"additionalProperties": false
			}
		},
		"thread_pool_count": { "type": "integer" },
		"enable_checker_only_saved": {
			"type": "boolean",
			"description": "Turns on only calling the checker on the package being saved"
		},
		"enable_semantic_tokens": {
			"type": "boolean",
			"description": "Turns on syntax highlighting."
		},
		"enable_document_symbols": {
			"type": "boolean",
			"description": "Turns on outline of all your global declarations in your document."
		},
		"enable_format": {
			"type": "boolean",
			"description": "Turns on formatting with odinfmt.",
			"default": true
		},
		"enable_hover": {
			"type": "boolean",
			"description": "Enables hover feature"
		},
		"enable_procedure_context": { "type": "boolean" },
		"enable_snippets": {
			"type": "boolean",
			"description": "Turns on builtin snippets"
		},

		"enable_inlay_hints_params": {
			"type": "boolean",
			"description": "Turn on inlay hints for (non-default) parameters.",
			"default": false
		},
		"enable_inlay_hints_default_params": {
			"type": "boolean",
			"description": "Turn on inlay hints for default parameters.",
			"default": false
		},
		"enable_inlay_hints_implicit_return": {
			"type": "boolean",
			"description": "Turn on inlay hints for implicit return values.",
			"default": false
		},
		"enable_procedure_snippet": {
			"type": "boolean",
			"description": "Use snippets when completing procedures—adds parenthesis after the name.",
			"default": true
		},
		"enable_auto_import": {
			"type": "boolean",
			"description": "Automatically import packages that aren't in your import on completion",
			"default": true
		},
		"enable_references": {
			"type": "boolean",
			"description": "Turns on finding references for a symbol.",
			"default": true
		},
		"enable_document_highlights": {
			"type": "boolean",
			"description": "Turns on highlighting of symbol references in file.",
			"default": true
		},
		"enable_completion_matching": {
			"type": "boolean",
			"description": "Attempt to match types and pointers when passing arguments to procedures.",
			"default": true
		},
		"enable_fake_methods": {
			"type": "boolean",
			"description": "Turn on fake methods completion.",
			"default": false
		},
		"enable_overload_resolution": {
			"type": "boolean",
			"description": "Enable go-to-definition to resolve overloaded procedures from procedure groups based on call arguments.",
			"default": false
		},
		"enable_document_links": {
			"type": "boolean",
			"description": "Follow links when opening documentation.",
			"default": true
		},
		"enable_comp_lit_signature_help": {
			"type": "boolean",
			"description": "Provide signature help for comp lits such as when instantiating structs. Will not display correctly on some editors such as vscode.",
			"default": false
		},
		"enable_comp_lit_signature_help_use_docs": {
			"type": "boolean",
			"description": "Put signature help for comp lits in the documentation. This will allow it to be rendered nicely using markdown in editors that render the label without colour on one line.",
			"default": false
		},
		"disable_parser_errors": { "type": "boolean" },
		"verbose": {
			"type": "boolean",
			"description": "Logs warnings instead of just errors."
		},
		"file_log": { "type": "boolean" },
		"odin_command": {
			"type": "string",
			"description": "Specify the location to your Odin executable, rather than relying on the environment path."
		},
		"odin_root_override": {
			"type": "string",
			"description": "Allows you to specify a custom `ODIN_ROOT` that `ols` will use to look for `odin` core libraries when implementing custom runtimes."
		},
		"checker_args": {
			"type": "string",
			"description": "Pass custom arguments to `odin check`."
		},
		"profile": {
			"type": "string",
			"description": "What profile to currently use."
		},
		"profiles": {
			"type": "array",
			"description": "List of different profiles that describe the environment ols is running under.",
			"items": {
				"type": "object",
				"properties": {
					"name": {
						"type": "string",
						"description": "The name of the profile."
					},
					"os": {
						"type": "string",
						"description": "The operating system for the profile."
					},
					"arch": {
						"type": "string",
						"description": "The architecture for the profile."
					},
					"checker_path": {
						"type": "array",
						"description": "List of paths where to run the checker.",
						"items": {
							"type": "string"
						}
					},
					"exclude_path": {
						"type": "array",
						"description": "List of paths that will be excluded from workspace symbol searches.",
						"items": {
							"type": "string"
						}
					},
					"defines": {
						"type": "object",
						"description": "Key-value pairs of defines. Used for evaluating when expressions, for example `ODIN_DEBUG`. The value must be a string.",
						"additionalProperties": {
							"type": "string"
						}
					}
				},
				"required": ["name", "checker_path"],
				"additionalProperties": false
			}
		}
	},
	"required": []
}