openbolt/documentation/templates/bolt_project_reference.md.erb at main · OpenVoxProject/openbolt · GitHub

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
# `bolt-project.yaml` options

This page lists the configuration options that are available in the `bolt-project.yaml`.
For more information, see [Configuring Bolt](configuring_bolt.md).

## Options

<% @opts.each do |option, data| -%>
### <% if data.key?(:_deprecation) %>⛔ <% end %>`<%= option %>`

<% if data.key?(:_deprecation) -%>
_This option is deprecated._
<% end -%>

<%= data[:description] %>

- **Type:** <%= data[:type] %>
<% if data.key?(:enum) -%>
- **Available values:** `<%= data[:enum].join('`, `') %>`
<% end -%>
<% if data.key?(:_default) -%>
- **Default:** `<%= data[:_default] %>`
<% end -%>
<% if data[:_plugin] == true -%>
- **Pluggable:** true
<% end -%>

<% if data.key?(:properties) -%>
<% data[:properties].each do |option, data| -%>
#### <% if data.key?(:_deprecation) %>⛔ <% end %>`<%= option %>`

<% if data.key?(:_deprecation) -%>
_This option is deprecated._
<% end -%>

<%= data[:description] %>

- **Type:** <%= data[:type] %>
<% if data.key?(:enum) -%>
- **Available values:** `<%= data[:enum].join('`, `') %>`
<% end -%>
<% if data.key?(:_default) -%>
- **Default:** `<%= data[:_default] %>`
<% end -%>
<% if data[:_plugin] == true -%>
- **Pluggable:** true
<% end -%>
<% end %>
<% end -%>

```yaml
<%= @yaml.slice(option).to_yaml(indentation: 2).split("\n").drop(1).join("\n") %>
```
<% end -%>

## Example file

```yaml
# bolt-project.yaml
<%= @yaml.to_yaml(indentation: 2).split("\n").drop(1).join("\n") %>
```

📖 **Related information**

- [Bolt projects](projects.md)