You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# This is manifest file for the Swift Package Index for it to
2
+
# auto-generate and host DocC documentation.
3
+
# For reference see https://swiftpackageindex.com/swiftpackageindex/spimanifest/documentation/spimanifest/commonusecases#Host-DocC-documentation-in-the-Swift-Package-Index.
4
+
5
+
version: 1
6
+
builder:
7
+
configs:
8
+
- documentation_targets:
9
+
# First item in the list is the "landing" (default) target
line breaks should be forced before and after multiline components of dot-chained
87
-
expressions, such as function calls and subscripts chained together through member
88
-
access (i.e. "." expressions). When any component is multiline and this option is
89
-
true, a line break is forced before the "." of the component and after the component's
90
-
closing delimiter (i.e. right paren, right bracket, right brace, etc.).
91
-
92
-
*`spacesAroundRangeFormationOperators`_(boolean)_: Determines whether whitespace should be forced
93
-
before and after the range formation operators `...` and `..<`.
94
-
95
-
*`multiElementCollectionTrailingCommas`_(boolean)_: Determines whether multi-element collection literals should have trailing commas.
96
-
Defaults to `true`.
97
-
98
-
*`indentBlankLines`_(boolean)_: Determines whether blank lines should be modified
99
-
to match the current indentation. When this setting is true, blank lines will be modified
100
-
to match the indentation level, adding indentation whether or not there is existing whitespace.
101
-
When false (the default), all whitespace in blank lines will be completely removed.
11
+
### `version`
12
+
**type:** number
13
+
14
+
**description:** The version of the configuration file. For now, this should always be `1`.
15
+
16
+
**default:**`1`
17
+
18
+
---
19
+
20
+
### `lineLength`
21
+
**type:** number
22
+
23
+
**description:** The maximum allowed length of a line, in characters.
24
+
25
+
**default:**`100`
26
+
27
+
---
28
+
29
+
### `indentation`
30
+
**type:** object
31
+
32
+
**description:** The kind and amount of whitespace that should be added when indenting one level. The object value of this property should have exactly one of the following properties:
33
+
34
+
-`spaces`_(number)_: One level of indentation is the given number of spaces.
35
+
-`tabs`_(number)_: One level of indentation is the given number of tabs.
36
+
37
+
**default:**`{ "spaces": 2 }`
38
+
39
+
---
40
+
41
+
### `tabWidth`
42
+
**type:** number
43
+
44
+
**description:** The number of spaces that should be considered equivalent to one tab character. This is used during line length calculations when tabs are used for indentation.
45
+
46
+
**default:**`8`
47
+
48
+
---
49
+
50
+
### `maximumBlankLines`
51
+
**type:** number
52
+
53
+
**description:** The maximum number of consecutive blank lines that are allowed to be present in a source file. Any number larger than this will be collapsed down to the maximum.
54
+
55
+
**default:**`1`
56
+
57
+
---
58
+
59
+
### `spacesBeforeEndOfLineComments`
60
+
**type:** number
61
+
62
+
**description:** The number of spaces between the last token on a non-empty line and a line comment starting with `//`.
63
+
64
+
**default:**`2`
65
+
66
+
---
67
+
68
+
### `respectsExistingLineBreaks`
69
+
**type:** boolean
70
+
71
+
**description:** Indicates whether or not existing line breaks in the source code should be honored (if they are valid according to the style guidelines being enforced). If this settings is `false`, then the formatter will be more "opinionated" by only inserting line breaks where absolutely necessary and removing any others, effectively canonicalizing the output.
72
+
73
+
**default:**`true`
74
+
75
+
---
76
+
77
+
### `lineBreakBeforeControlFlowKeywords`
78
+
**type:** boolean
79
+
80
+
**description:** Determines the line-breaking behavior for control flow keywords that follow a closing brace, like `else` and `catch`. If true, a line break will be added before the keyword, forcing it onto its own line. If `false`, the keyword will be placed after the closing brace (separated by a space).
81
+
82
+
**default:**`false`
83
+
84
+
---
85
+
86
+
### `lineBreakBeforeEachArgument`
87
+
**type:** boolean
88
+
89
+
**description:** Determines the line-breaking behavior for generic arguments and function arguments when a declaration is wrapped onto multiple lines. If true, a line break will be added before each argument, forcing the entire argument list to be laid out vertically. If `false`, arguments will be laid out horizontally first, with line breaks only being fired when the line length would be exceeded.
90
+
91
+
**default:**`false`
92
+
93
+
---
94
+
95
+
### `lineBreakBeforeEachGenericRequirement`
96
+
**type:** boolean
97
+
98
+
**description:** Determines the line-breaking behavior for generic requirements when the requirements list is wrapped onto multiple lines. If true, a line break will be added before each requirement, forcing the entire requirements list to be laid out vertically. If `false`, requirements will be laid out horizontally first, with line breaks only being fired when the line length would be exceeded.
99
+
100
+
**default:**`false`
101
+
102
+
---
103
+
104
+
### `lineBreakBetweenDeclarationAttributes`
105
+
**type:** boolean
106
+
107
+
**description:** Determines the line-breaking behavior for adjacent attributes on declarations. If true, a line break will be added between each attribute, forcing the attribute list to be laid out vertically. If `false`, attributes will be laid out horizontally first, with line breaks only being fired when the line length would be exceeded.
108
+
109
+
**default:**`false`
110
+
111
+
---
112
+
113
+
### `prioritizeKeepingFunctionOutputTogether`
114
+
**type:** boolean
115
+
116
+
**description:** Determines if function-like declaration outputs should be prioritized to be together with thefunction signature right (closing) parenthesis. If `false`, function output (i.e. throws, return type) is not prioritized to be together with the signature's right parenthesis, and when the line length would be exceeded,a line break will be fired after the function signature first, indenting the declaration output one additional level. If true, A line break will be fired further up in the function's declaration (e.g. generic parameters, parameters) before breaking on the function's output.
117
+
118
+
**default:**`false`
119
+
120
+
---
121
+
122
+
### `indentConditionalCompilationBlocks`
123
+
**type:** boolean
124
+
125
+
**description:** Determines if conditional compilation blocks are indented. If this setting is `false` the body of `#if`, `#elseif`, and `#else` is not indented.
**description:** Determines whether line breaks should be forced before and after multiline components of dot-chained expressions, such as function calls and subscripts chained together through member access (i.e. "." expressions). When any component is multiline and this option is true, a line break is forced before the "." of the component and after the component's closing delimiter (i.e. right paren, right bracket, right brace, etc.).
135
+
136
+
**default:**`false`
137
+
138
+
---
139
+
140
+
## FIXME: fileScopedDeclarationPrivacy
141
+
142
+
---
143
+
144
+
### FIXME: indentSwitchCaseLabels
145
+
146
+
---
147
+
148
+
### `spacesAroundRangeFormationOperators`
149
+
**type:** boolean
150
+
151
+
**description:** Determines whether whitespace should be forced before and after the range formation operators `...` and `..<`.
152
+
153
+
**default:**`false`
154
+
155
+
---
156
+
157
+
### FIXME: noAssignmentInExpressions
158
+
159
+
---
160
+
161
+
### `multiElementCollectionTrailingCommas`
162
+
**type:** boolean
163
+
164
+
**description:** Determines whether multi-element collection literals should have trailing commas.
165
+
166
+
**default:**`true`
167
+
168
+
---
169
+
170
+
### FIXME: reflowMultilineStringLiterals
171
+
172
+
---
173
+
174
+
### `indentBlankLines`
175
+
**type:** boolean
176
+
177
+
**description:** Determines whether blank lines should be modified to match the current indentation. When this setting is true, blank lines will be modified whitespace. If `false`, all whitespace in blank lines will be completely removed.
178
+
179
+
**default:**`false`
102
180
103
181
> TODO: Add support for enabling/disabling specific syntax transformations in
0 commit comments