@@ -35,24 +35,22 @@ for `initializationOptions`. On the protocol level messages look like:
35
35
36
36
Ada Language Server understands these settings:
37
37
38
- * [ projectFile] ( #projectFile )
39
- * [ scenarioVariables] ( #scenarioVariables )
40
- * [ defaultCharset] ( #defaultCharset )
41
- * [ relocateBuildTree] ( #relocateBuildTree )
42
- * [ rootDir] ( #rootDir )
43
- * [ enableDiagnostics] ( #enableDiagnostics )
44
- * [ enableIndexing] ( #enableIndexing )
45
- * [ renameInComments] ( #renameInComments )
46
- * [ namedNotationThreshold] ( #namedNotationThreshold )
47
- * [ foldComments] ( #foldComments )
48
- * [ followSymlinks] ( #followSymlinks )
49
- * [ documentationStyle] ( #documentationStyle )
50
- * [ onTypeFormatting.indentOnly] ( #onTypeFormatting.indentOnly )
38
+ * [ projectFile] ( #projectfile )
39
+ * [ scenarioVariables] ( #scenariovariables )
40
+ * [ defaultCharset] ( #defaultcharset )
41
+ * [ relocateBuildTree] ( #relocatebuildtree )
42
+ * [ rootDir] ( #rootdir )
43
+ * [ enableDiagnostics] ( #enablediagnostics )
44
+ * [ enableIndexing] ( #enableindexing )
45
+ * [ renameInComments] ( #renameincomments )
46
+ * [ namedNotationThreshold] ( #namednotationthreshold )
47
+ * [ foldComments] ( #foldcomments )
48
+ * [ followSymlinks] ( #followsymlinks )
49
+ * [ documentationStyle] ( #documentationstyle )
50
+ * [ onTypeFormatting.indentOnly] ( #ontypeformattingindentonly )
51
51
52
52
----
53
53
54
-
55
-
56
54
## projectFile
57
55
58
56
You can configure the GNAT Project File via the ` projectFile ` key.
@@ -67,6 +65,7 @@ root folder, then ALS will use it.
67
65
```
68
66
69
67
## scenarioVariables
68
+
70
69
You can configure scenario variables via the ` scenarioVariables ` key.
71
70
The setting has an object value. Keys in this object correspond to
72
71
scenario variables names and string values to variables values.
@@ -76,7 +75,9 @@ scenario variables names and string values to variables values.
76
75
' BUILD_MODE' : ' DEBUG'
77
76
}
78
77
```
78
+
79
79
## defaultCharset
80
+
80
81
You can set the character set to use when the server has to use when reading
81
82
files from disk by specifying an ` defaultCharset ` key. The default is
82
83
` iso-8859-1 ` . This should have a string value.
@@ -86,28 +87,33 @@ files from disk by specifying an `defaultCharset` key. The default is
86
87
```
87
88
88
89
## relocateBuildTree
90
+
89
91
With this option it is possible to achieve out-of-tree build. That is,
90
92
real object, library or exec directories are relocated to the current
91
93
working directory or dir if specified. Ensure that it is full normalized
92
94
path ended with the directory separator. Visit
93
- https://docs.adacore.com/gprbuild-docs/html/gprbuild_ug/building_with_gprbuild.html#switches
95
+ the [ gprbuild documentation ] ( https://docs.adacore.com/gprbuild-docs/html/gprbuild_ug/building_with_gprbuild.html#switches )
94
96
for more details about the corresponding gprbuild switch.
97
+
95
98
``` javascript
96
99
' relocateBuildTree' : ' /home/user/project/build/'
97
100
```
98
101
99
102
## rootDir
103
+
100
104
This option is to be used with relocateBuildTree above and cannot be
101
105
specified alone. This option specifies the root directory for artifacts
102
106
for proper relocation. Ensure that it is full normalized path ended
103
107
with the directory separator. Visit
104
- https://docs.adacore.com/gprbuild-docs/html/gprbuild_ug/building_with_gprbuild.html#switches
108
+ the [ gprbuild documentation ] ( https://docs.adacore.com/gprbuild-docs/html/gprbuild_ug/building_with_gprbuild.html#switches )
105
109
for more details about the corresponding gprbuild switch.
110
+
106
111
``` javascript
107
112
' relocateBuildTree' : ' /home/user/project/'
108
113
```
109
114
110
115
## enableDiagnostics
116
+
111
117
You can explicitly deactivate the emission of diagnostics, via the
112
118
` enableDiagnostics ` key. By default, diagnostics are enabled.
113
119
The value is a boolean.
@@ -117,6 +123,7 @@ The value is a boolean.
117
123
```
118
124
119
125
## enableIndexing
126
+
120
127
By default, the server indexes the source files after loading a project,
121
128
to speed up subsequent requests. This behavior can be controlled
122
129
via the ` enableIndexing ` flag in this request.
@@ -127,6 +134,7 @@ The value is a boolean.
127
134
```
128
135
129
136
## renameInComments
137
+
130
138
The language server is able to edit Ada comments while executing
131
139
` textDocument/rename ` request. To enable this just set
132
140
` renameInComments ` setting to ` true ` .
@@ -137,6 +145,7 @@ The value is a boolean.
137
145
```
138
146
139
147
## useCompletionSnippets
148
+
140
149
Whether we should use snippets in completion results. Snippets can be
141
150
returned in case of subprogram calls for instance, with placeholders
142
151
for each parameter needed by the subprogram.
@@ -147,25 +156,27 @@ The value is a boolean.
147
156
```
148
157
149
158
## displayMethodAncestryOnNavigation
159
+
150
160
This setting controls the policy for displaying overriding and overridden
151
161
subprograms on navigation requests such as ` textDocument/definition ` ,
152
162
` textDocument/declaration ` or ` textDocument/implementation ` .
153
163
154
164
The different policies are:
155
165
156
- * ` never ` : Never list overridding and/or overridden suprograms.
157
- * ` usage_and_abstract_only ` : List overridding and/or overridden suprograms
158
- on dispatching calls and on abstract subprogram declarations.
159
- * ` definition_only ` : List overridding and/or overridden suprograms on
160
- declarations only.
161
- * ` always ` : Always list overridding and/or overridden suprograms when
162
- possible.
166
+ * ` never ` : Never list overridding and/or overridden suprograms.
167
+ * ` usage_and_abstract_only ` : List overridding and/or overridden suprograms
168
+ on dispatching calls and on abstract subprogram declarations.
169
+ * ` definition_only ` : List overridding and/or overridden suprograms on
170
+ declarations only.
171
+ * ` always ` : Always list overridding and/or overridden suprograms when
172
+ possible.
163
173
164
174
``` javascript
165
175
' displayMethodAncestryOnNavigation' : ' always'
166
176
```
167
177
168
178
## namedNotationThreshold
179
+
169
180
This setting defines the number of parameters/components at which point named
170
181
notation is used for subprogram/aggregate completion snippets.
171
182
The value is a number. The default value is ` 3 ` .
@@ -175,12 +186,14 @@ The value is a number. The default value is `3`.
175
186
```
176
187
177
188
## foldComments
189
+
178
190
When this setting is ` true ` the server sends blocks information for comments which can be used for folding comment blocks.
179
191
The value is a boolean. The default is ` true ` .
180
192
181
193
``` javascript
182
194
' foldComments' : false
183
195
```
196
+
184
197
## followSymlinks
185
198
186
199
When this setting is ` false ` the server doesn't do any attempts to normalize file names sent by a client.
@@ -193,6 +206,7 @@ The value is a boolean. The default is `true`.
193
206
```
194
207
195
208
## documentationStyle
209
+
196
210
The language server supports different styles to document entities in the source
197
211
code. This setting controls primary documentation style of entities. When
198
212
documentation for the entity is not found, the language server uses a few
@@ -201,10 +215,10 @@ declaration, extract documentation from subprogram's body, etc.)
201
215
202
216
Supported styles are:
203
217
204
- * ` gnat ` : Default style, based on GNAT coding standard with some
205
- enhancements.
206
- * ` leading ` : Documentation for the entities extracted from the comments
207
- before the entity declaration.
218
+ * ` gnat ` : Default style, based on GNAT coding standard with some
219
+ enhancements.
220
+ * ` leading ` : Documentation for the entities extracted from the comments
221
+ before the entity declaration.
208
222
209
223
For more information about documentation styles see GNATdoc User's Manual.
210
224
0 commit comments