Skip to content

Commit 070dedb

Browse files
rijnbrijnb
committed
Added formatting rules for IntelliJ IDEA to README.md
1 parent 1c905a1 commit 070dedb

File tree

1 file changed

+271
-0
lines changed

1 file changed

+271
-0
lines changed

‎README.md‎

Lines changed: 271 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,3 +60,274 @@ regular compile, build or release commands, such as:
6060

6161
If you encounter any problems with this library, don't hesitate to use the `Issues` session to file your issues.
6262
Normally, one of our developers should be able to comment on them and fix.
63+
64+
# Code Style Settings in IntelliJ IDEA
65+
66+
In order to get consistent code layout for Scala files, source files should be reformatted in your IDE according to the
67+
settings below. These settings are describes as IntelliJ IDEA "Code Style" settings (and they can be copied directly
68+
into your `.idea/codeStyleSetting.xml` file, if you use IDEA):
69+
70+
```
71+
<?xml version="1.0" encoding="UTF-8"?>
72+
<project version="4">
73+
<component name="ProjectCodeStyleSettingsManager">
74+
<option name="PER_PROJECT_SETTINGS">
75+
<value>
76+
<option name="OTHER_INDENT_OPTIONS">
77+
<value>
78+
<option name="INDENT_SIZE" value="4" />
79+
<option name="CONTINUATION_INDENT_SIZE" value="4" />
80+
<option name="TAB_SIZE" value="8" />
81+
<option name="USE_TAB_CHARACTER" value="false" />
82+
<option name="SMART_TABS" value="false" />
83+
<option name="LABEL_INDENT_SIZE" value="0" />
84+
<option name="LABEL_INDENT_ABSOLUTE" value="false" />
85+
<option name="USE_RELATIVE_INDENTS" value="false" />
86+
</value>
87+
</option>
88+
<option name="LINE_SEPARATOR" value="&#10;" />
89+
<option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="9999" />
90+
<option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="9999" />
91+
<option name="IMPORT_LAYOUT_TABLE">
92+
<value>
93+
<package name="" withSubpackages="true" static="false" />
94+
<emptyLine />
95+
<package name="javax" withSubpackages="true" static="false" />
96+
<package name="java" withSubpackages="true" static="false" />
97+
<emptyLine />
98+
<package name="com.tomtom" withSubpackages="true" static="false" />
99+
<emptyLine />
100+
<package name="" withSubpackages="true" static="true" />
101+
</value>
102+
</option>
103+
<option name="WRAP_WHEN_TYPING_REACHES_RIGHT_MARGIN" value="true" />
104+
<option name="JD_P_AT_EMPTY_LINES" value="false" />
105+
<option name="JD_KEEP_EMPTY_PARAMETER" value="false" />
106+
<option name="JD_KEEP_EMPTY_EXCEPTION" value="false" />
107+
<option name="JD_KEEP_EMPTY_RETURN" value="false" />
108+
<option name="JD_PRESERVE_LINE_FEEDS" value="true" />
109+
<option name="KEEP_CONTROL_STATEMENT_IN_ONE_LINE" value="false" />
110+
<option name="BLANK_LINES_BEFORE_PACKAGE" value="1" />
111+
<option name="BLANK_LINES_AFTER_IMPORTS" value="3" />
112+
<option name="BLANK_LINES_AROUND_CLASS" value="3" />
113+
<option name="BLANK_LINES_AROUND_METHOD_IN_INTERFACE" value="0" />
114+
<option name="ELSE_ON_NEW_LINE" value="true" />
115+
<option name="WHILE_ON_NEW_LINE" value="true" />
116+
<option name="CATCH_ON_NEW_LINE" value="true" />
117+
<option name="FINALLY_ON_NEW_LINE" value="true" />
118+
<option name="ALIGN_MULTILINE_PARAMETERS" value="false" />
119+
<option name="ALIGN_GROUP_FIELD_DECLARATIONS" value="true" />
120+
<option name="CALL_PARAMETERS_WRAP" value="1" />
121+
<option name="RESOURCE_LIST_WRAP" value="1" />
122+
<option name="BINARY_OPERATION_WRAP" value="1" />
123+
<option name="TERNARY_OPERATION_WRAP" value="1" />
124+
<option name="KEEP_SIMPLE_METHODS_IN_ONE_LINE" value="true" />
125+
<option name="KEEP_SIMPLE_CLASSES_IN_ONE_LINE" value="true" />
126+
<option name="FOR_STATEMENT_WRAP" value="1" />
127+
<option name="ARRAY_INITIALIZER_WRAP" value="1" />
128+
<option name="ASSIGNMENT_WRAP" value="1" />
129+
<option name="WRAP_COMMENTS" value="true" />
130+
<option name="ASSERT_STATEMENT_WRAP" value="1" />
131+
<option name="IF_BRACE_FORCE" value="3" />
132+
<option name="DOWHILE_BRACE_FORCE" value="3" />
133+
<option name="WHILE_BRACE_FORCE" value="3" />
134+
<option name="FOR_BRACE_FORCE" value="3" />
135+
<option name="ENUM_CONSTANTS_WRAP" value="2" />
136+
<XML>
137+
<option name="XML_LEGACY_SETTINGS_IMPORTED" value="true" />
138+
</XML>
139+
<ADDITIONAL_INDENT_OPTIONS fileType="gsp">
140+
<option name="CONTINUATION_INDENT_SIZE" value="4" />
141+
</ADDITIONAL_INDENT_OPTIONS>
142+
<codeStyleSettings language="CSS">
143+
<indentOptions>
144+
<option name="CONTINUATION_INDENT_SIZE" value="4" />
145+
<option name="TAB_SIZE" value="8" />
146+
</indentOptions>
147+
</codeStyleSettings>
148+
<codeStyleSettings language="CoffeeScript">
149+
<option name="ALIGN_MULTILINE_PARAMETERS" value="false" />
150+
<option name="ALIGN_MULTILINE_ARRAY_INITIALIZER_EXPRESSION" value="false" />
151+
<option name="ARRAY_INITIALIZER_LBRACE_ON_NEXT_LINE" value="true" />
152+
<option name="ARRAY_INITIALIZER_RBRACE_ON_NEXT_LINE" value="true" />
153+
<option name="PARENT_SETTINGS_INSTALLED" value="true" />
154+
<indentOptions>
155+
<option name="TAB_SIZE" value="8" />
156+
</indentOptions>
157+
</codeStyleSettings>
158+
<codeStyleSettings language="Groovy">
159+
<option name="KEEP_CONTROL_STATEMENT_IN_ONE_LINE" value="false" />
160+
<option name="BLANK_LINES_BEFORE_PACKAGE" value="1" />
161+
<option name="BLANK_LINES_AFTER_IMPORTS" value="3" />
162+
<option name="BLANK_LINES_AROUND_CLASS" value="3" />
163+
<option name="BLANK_LINES_AROUND_METHOD_IN_INTERFACE" value="0" />
164+
<option name="ELSE_ON_NEW_LINE" value="true" />
165+
<option name="CATCH_ON_NEW_LINE" value="true" />
166+
<option name="FINALLY_ON_NEW_LINE" value="true" />
167+
<option name="ALIGN_MULTILINE_PARAMETERS" value="false" />
168+
<option name="ALIGN_GROUP_FIELD_DECLARATIONS" value="true" />
169+
<option name="CALL_PARAMETERS_WRAP" value="1" />
170+
<option name="BINARY_OPERATION_WRAP" value="1" />
171+
<option name="TERNARY_OPERATION_WRAP" value="1" />
172+
<option name="FOR_STATEMENT_WRAP" value="1" />
173+
<option name="ASSIGNMENT_WRAP" value="1" />
174+
<option name="ASSERT_STATEMENT_WRAP" value="1" />
175+
<option name="IF_BRACE_FORCE" value="3" />
176+
<option name="WHILE_BRACE_FORCE" value="3" />
177+
<option name="FOR_BRACE_FORCE" value="3" />
178+
<option name="ENUM_CONSTANTS_WRAP" value="2" />
179+
<option name="PARENT_SETTINGS_INSTALLED" value="true" />
180+
<indentOptions>
181+
<option name="TAB_SIZE" value="8" />
182+
</indentOptions>
183+
</codeStyleSettings>
184+
<codeStyleSettings language="HOCON">
185+
<indentOptions>
186+
<option name="TAB_SIZE" value="8" />
187+
</indentOptions>
188+
</codeStyleSettings>
189+
<codeStyleSettings language="HTML">
190+
<indentOptions>
191+
<option name="TAB_SIZE" value="8" />
192+
</indentOptions>
193+
</codeStyleSettings>
194+
<codeStyleSettings language="JAVA">
195+
<option name="KEEP_CONTROL_STATEMENT_IN_ONE_LINE" value="false" />
196+
<option name="KEEP_BLANK_LINES_BEFORE_RBRACE" value="0" />
197+
<option name="BLANK_LINES_BEFORE_PACKAGE" value="1" />
198+
<option name="BLANK_LINES_AROUND_METHOD_IN_INTERFACE" value="0" />
199+
<option name="ELSE_ON_NEW_LINE" value="true" />
200+
<option name="WHILE_ON_NEW_LINE" value="true" />
201+
<option name="CATCH_ON_NEW_LINE" value="true" />
202+
<option name="FINALLY_ON_NEW_LINE" value="true" />
203+
<option name="ALIGN_MULTILINE_PARAMETERS" value="false" />
204+
<option name="ALIGN_GROUP_FIELD_DECLARATIONS" value="true" />
205+
<option name="CALL_PARAMETERS_WRAP" value="1" />
206+
<option name="RESOURCE_LIST_WRAP" value="1" />
207+
<option name="BINARY_OPERATION_WRAP" value="1" />
208+
<option name="TERNARY_OPERATION_WRAP" value="1" />
209+
<option name="FOR_STATEMENT_WRAP" value="1" />
210+
<option name="ARRAY_INITIALIZER_WRAP" value="1" />
211+
<option name="ASSIGNMENT_WRAP" value="1" />
212+
<option name="ASSERT_STATEMENT_WRAP" value="1" />
213+
<option name="IF_BRACE_FORCE" value="3" />
214+
<option name="DOWHILE_BRACE_FORCE" value="3" />
215+
<option name="WHILE_BRACE_FORCE" value="3" />
216+
<option name="FOR_BRACE_FORCE" value="3" />
217+
<option name="FIELD_ANNOTATION_WRAP" value="0" />
218+
<option name="PARENT_SETTINGS_INSTALLED" value="true" />
219+
<indentOptions>
220+
<option name="CONTINUATION_INDENT_SIZE" value="4" />
221+
<option name="TAB_SIZE" value="8" />
222+
<option name="LABEL_INDENT_ABSOLUTE" value="true" />
223+
</indentOptions>
224+
</codeStyleSettings>
225+
<codeStyleSettings language="JSP">
226+
<indentOptions>
227+
<option name="CONTINUATION_INDENT_SIZE" value="4" />
228+
<option name="TAB_SIZE" value="8" />
229+
</indentOptions>
230+
</codeStyleSettings>
231+
<codeStyleSettings language="JSPX">
232+
<indentOptions>
233+
<option name="TAB_SIZE" value="8" />
234+
</indentOptions>
235+
</codeStyleSettings>
236+
<codeStyleSettings language="JavaScript">
237+
<option name="ELSE_ON_NEW_LINE" value="true" />
238+
<option name="WHILE_ON_NEW_LINE" value="true" />
239+
<option name="CATCH_ON_NEW_LINE" value="true" />
240+
<option name="FINALLY_ON_NEW_LINE" value="true" />
241+
<option name="CALL_PARAMETERS_WRAP" value="1" />
242+
<option name="BINARY_OPERATION_WRAP" value="1" />
243+
<option name="TERNARY_OPERATION_WRAP" value="1" />
244+
<option name="KEEP_SIMPLE_METHODS_IN_ONE_LINE" value="true" />
245+
<option name="FOR_STATEMENT_WRAP" value="1" />
246+
<option name="ARRAY_INITIALIZER_WRAP" value="1" />
247+
<option name="ASSIGNMENT_WRAP" value="1" />
248+
<option name="IF_BRACE_FORCE" value="3" />
249+
<option name="DOWHILE_BRACE_FORCE" value="3" />
250+
<option name="WHILE_BRACE_FORCE" value="3" />
251+
<option name="FOR_BRACE_FORCE" value="3" />
252+
<option name="PARENT_SETTINGS_INSTALLED" value="true" />
253+
<indentOptions>
254+
<option name="TAB_SIZE" value="8" />
255+
</indentOptions>
256+
</codeStyleSettings>
257+
<codeStyleSettings language="Python">
258+
<option name="BLANK_LINES_AFTER_IMPORTS" value="3" />
259+
<option name="BLANK_LINES_AROUND_CLASS" value="3" />
260+
<option name="ALIGN_MULTILINE_PARAMETERS" value="false" />
261+
<option name="PARENT_SETTINGS_INSTALLED" value="true" />
262+
<indentOptions>
263+
<option name="TAB_SIZE" value="8" />
264+
</indentOptions>
265+
</codeStyleSettings>
266+
<codeStyleSettings language="Scala">
267+
<option name="KEEP_BLANK_LINES_IN_DECLARATIONS" value="1" />
268+
<option name="KEEP_BLANK_LINES_IN_CODE" value="1" />
269+
<option name="KEEP_BLANK_LINES_BEFORE_RBRACE" value="0" />
270+
<option name="BLANK_LINES_BEFORE_PACKAGE" value="1" />
271+
<option name="BLANK_LINES_AROUND_METHOD_IN_INTERFACE" value="0" />
272+
<option name="ELSE_ON_NEW_LINE" value="true" />
273+
<option name="WHILE_ON_NEW_LINE" value="true" />
274+
<option name="CATCH_ON_NEW_LINE" value="true" />
275+
<option name="FINALLY_ON_NEW_LINE" value="true" />
276+
<option name="ALIGN_MULTILINE_PARAMETERS" value="false" />
277+
<option name="ALIGN_GROUP_FIELD_DECLARATIONS" value="true" />
278+
<option name="CALL_PARAMETERS_WRAP" value="1" />
279+
<option name="BINARY_OPERATION_WRAP" value="1" />
280+
<option name="FOR_STATEMENT_WRAP" value="1" />
281+
<option name="DOWHILE_BRACE_FORCE" value="3" />
282+
<option name="WHILE_BRACE_FORCE" value="3" />
283+
<option name="FOR_BRACE_FORCE" value="3" />
284+
<option name="PARENT_SETTINGS_INSTALLED" value="true" />
285+
<indentOptions>
286+
<option name="INDENT_SIZE" value="4" />
287+
<option name="CONTINUATION_INDENT_SIZE" value="4" />
288+
<option name="TAB_SIZE" value="8" />
289+
</indentOptions>
290+
</codeStyleSettings>
291+
<codeStyleSettings language="TypeScript">
292+
<option name="ELSE_ON_NEW_LINE" value="true" />
293+
<option name="WHILE_ON_NEW_LINE" value="true" />
294+
<option name="CATCH_ON_NEW_LINE" value="true" />
295+
<option name="FINALLY_ON_NEW_LINE" value="true" />
296+
<option name="ALIGN_MULTILINE_PARAMETERS" value="false" />
297+
<option name="CALL_PARAMETERS_WRAP" value="1" />
298+
<option name="BINARY_OPERATION_WRAP" value="1" />
299+
<option name="TERNARY_OPERATION_WRAP" value="1" />
300+
<option name="KEEP_SIMPLE_METHODS_IN_ONE_LINE" value="true" />
301+
<option name="FOR_STATEMENT_WRAP" value="1" />
302+
<option name="ARRAY_INITIALIZER_WRAP" value="1" />
303+
<option name="ASSIGNMENT_WRAP" value="1" />
304+
<option name="IF_BRACE_FORCE" value="3" />
305+
<option name="DOWHILE_BRACE_FORCE" value="3" />
306+
<option name="WHILE_BRACE_FORCE" value="3" />
307+
<option name="FOR_BRACE_FORCE" value="3" />
308+
<option name="PARENT_SETTINGS_INSTALLED" value="true" />
309+
<indentOptions>
310+
<option name="TAB_SIZE" value="8" />
311+
</indentOptions>
312+
</codeStyleSettings>
313+
<codeStyleSettings language="XML">
314+
<indentOptions>
315+
<option name="CONTINUATION_INDENT_SIZE" value="4" />
316+
<option name="TAB_SIZE" value="8" />
317+
</indentOptions>
318+
</codeStyleSettings>
319+
<codeStyleSettings language="ruby">
320+
<option name="ALIGN_MULTILINE_PARAMETERS" value="false" />
321+
<option name="ALIGN_GROUP_FIELD_DECLARATIONS" value="true" />
322+
<option name="PARENT_SETTINGS_INSTALLED" value="true" />
323+
<indentOptions>
324+
<option name="TAB_SIZE" value="8" />
325+
</indentOptions>
326+
</codeStyleSettings>
327+
</value>
328+
</option>
329+
<option name="USE_PER_PROJECT_SETTINGS" value="true" />
330+
<option name="PREFERRED_PROJECT_CODE_STYLE" value="Clear Code Style" />
331+
</component>
332+
</project>
333+
```

0 commit comments

Comments
 (0)