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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
# ols
Language server for Odin. This project is still in early development.
## Table Of Contents
- [Installation](#installation)
- [Configuration](#Configuration)
- [Features](#features)
- [Clients](#clients)
- [Vs Code](#vs-code)
- [Sublime](#sublime)
- [Vim](#vim)
- [Neovim](#neovim)
- [Emacs](#emacs)
- [Helix](#helix)
- [Micro](#micro)
## Installation
```bash
cd ols
# for windows
./build.bat
# for linux and macos
./build.sh
```
### Configuration
In order for the language server to index your files, it must know about your collections.
To do that you can either configure ols via an `ols.json` file (it should be located at the root of your workspace).
Or you can provide the configuration via your editor of choice.
Example of `ols.json`:
```json
{
"$schema": "https://raw.githubusercontent.com/DanielGavin/ols/master/misc/ols.schema.json",
"collections": [
{ "name": "custom_collection", "path": "c:/path/to/collection" }
],
"enable_semantic_tokens": false,
"enable_document_symbols": true,
"enable_hover": true,
"enable_snippets": true,
"profile": "default",
"profiles": [
{ "name": "default", "checker_path": ["src"]},
{ "name": "linux_profile", "os": "linux", "checker_path": ["src/main.odin"]},
{ "name": "windows_profile", "os": "windows", "checker_path": ["src"]}
]
}
```
You can also set `ODIN_ROOT` environment variable to the path where ols should look for core and vendor libraries.
Options:
`enable_format`: Turns on formatting with `odinfmt`. _(Enabled by default)_
`enable_hover`: Enables hover feature
`enable_snippets`: Turns on builtin snippets
`enable_semantic_tokens`: Turns on syntax highlighting.
`enable_document_symbols`: Turns on outline of all your global declarations in your document.
`enable_fake_methods`: Turn on fake methods completion. This is currently highly experimental.
`enable_inlay_hints`: Turn on inlay hints for editors that support it.
`enable_procedure_snippet`: Use snippets when completing procedures—adds parenthesis after the name. _(Enabled by default)_
`odin_command`: Allows you to specify your Odin location, instead of just relying on the environment path.
`checker_args`: Pass custom arguments to `odin check`.
`verbose`: Logs warnings instead of just errors.
`profile`: What profile to currently use.
`profiles`: List of different profiles that describe the environment ols is running under.
### Odinfmt configurations
Odinfmt reads configuration through `odinfmt.json`.
Example:
```json
{
"$schema": "https://raw.githubusercontent.com/DanielGavin/ols/master/misc/odinfmt.schema.json",
"character_width": 80,
"tabs": true,
"tabs_width": 4
}
```
Options:
`character_width`: How many characters it takes before it line breaks it.
`spaces`: How many spaces is in one indentation.
`newline_limit`: The limit of newlines between statements and declarations.
`tabs`: Tabs or spaces.
`tabs_width`: How many characters one tab represents
`sort_imports`: A boolean that defaults to true, which can be set to false to disable sorting imports.
## Features
Support Language server features:
- Completion
- Go to definition
- Semantic tokens(really unstable and unfinished)
- Document symbols
- Signature help
- Hover
## Clients
### VS Code
Install the extension https://marketplace.visualstudio.com/items?itemName=DanielGavin.ols
### Sublime
Install the package https://github.com/sublimelsp/LSP
Configuration of the LSP:
```
{
"clients": {
"odin": {
"command": [
"/path/to/ols"
],
"enabled": false, // true for globally-enabled, but not required due to 'Enable In Project' command
"selector": "source.odin",
"initializationOptions": {
"collections": [
{
"name": "collection_a",
"path": "/path/to/collection_a"
}
],
"enable_semantic_tokens": true,
"enable_document_symbols": true,
"enable_hover": true,
"enable_snippets": true,
"enable_format": true,
}
}
}
}
```
### Vim
Install [Coc](https://github.com/neoclide/coc.nvim).
Configuration of the LSP:
```
{
"languageserver": {
"odin": {
"command": "ols",
"filetypes": ["odin"],
"rootPatterns": ["ols.json"]
}
}
}
```
### Neovim
Neovim has a builtin support for LSP.
There is a plugin that turns easier the setup, called [nvim-lspconfig](https://github.com/neovim/nvim-lspconfig). You can
install it with you prefered package manager.
A simple configuration to use with Odin would be like this:
```lua
local lspconfig = require('lspconfig')
lspconfig.ols.setup({})
```
### Emacs
```
;; With odin-mode (https://github.com/mattt-b/odin-mode) and lsp-mode already added to your init.el of course!.
(setq-default lsp-auto-guess-root t) ;; if you work with Projectile/project.el this will help find the ols.json file.
(defvar lsp-language-id-configuration '((odin-mode . "odin")))
(lsp-register-client
(make-lsp-client :new-connection (lsp-stdio-connection "/path/to/ols/executable")
:major-modes '(odin-mode)
:server-id 'ols
:multi-root t)) ;; This is just so lsp-mode sends the "workspaceFolders" param to the server.
(add-hook 'odin-mode-hook #'lsp)
```
### Helix
Guide for installing helix with ols:
https://github.com/joaocarvalhoopen/Helix_editor_for_the_Odin_programming_Language
### Micro
Install the [LSP plugin](https://github.com/AndCake/micro-plugin-lsp)
Configure the plugin in micro's settings.json:
```json
{
"lsp.server": "c=clangd,go=gopls,odin=ols"
}
```
|
