-
Notifications
You must be signed in to change notification settings - Fork 0
/
.php_cs.dist
397 lines (293 loc) · 14.9 KB
/
.php_cs.dist
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
<?php
/**
* For more information about PHP-CS-Fixer configuration files and options, check
* https://github.com/FriendsOfPHP/PHP-CS-Fixer.
*/
if (!file_exists(__DIR__ . '/src')) {
exit(0);
}
return PhpCsFixer\Config::create()
->setUsingCache(false)
->setRiskyAllowed(true)
->setRules([
'@PSR2' => true,
'@Symfony' => true,
'@Symfony:risky' => false,
// Binary operators should be surrounded by space as configured.
'binary_operator_spaces' => [
'operators' => ['=>' => 'align_single_space_minimal'],
],
// There MUST be one blank line after the namespace declaration.
'blank_line_after_namespace' => true,
// Ensure there is no code on the same line as the PHP open tag and it is followed by a blank line.
'blank_line_after_opening_tag' => true,
/*
* An empty line feed must precede any configured statement.
* Configuration: ['statements' => ['return']]
*/
'blank_line_before_statement' => true,
/*
* The body of each structure MUST be enclosed by braces. Braces should be properly placed.
* Body of braces should be properly indented.
* Configuration: ['allow_single_line_closure' => true]
*/
'braces' => true,
// A single space or none should be between cast and variable.
'cast_spaces' => false,
/*
* Whitespace around the keywords of a class, trait or interfaces definition should be one space.
* Configuration: ['singleLine' => true]
*/
'class_definition' => true,
/* Concatenation should be spaced according configuration. */// Configuration: ['spacing' => 'none']
'concat_space' => true,
// Equal sign in declare statement should be surrounded by spaces or not following configuration.
'declare_equal_normalize' => true,
/*
* The keyword `elseif` should be used instead of `else if` so that all control keywords look
* like single words.
*/
'elseif' => true,
// PHP code MUST use only UTF-8 without BOM (remove BOM).
'encoding' => true,
// PHP code must use the long `<?php` tags or short-echo `<?=` tags and not other tag variations.
'full_opening_tag' => true,
// Spaces should be properly placed in a function declaration.
'function_declaration' => true,
// Add missing space between function's argument and its typehint.
'function_typehint_space' => true,
/*
* Include/Require and file path should be divided with a single space.
* File path should not be placed under brackets.
*/
'include' => true,
// Pre- or post-increment and decrement operators should be used if possible.
'increment_style' => true,
// Code MUST use configured indentation type.
'indentation_type' => true,
// All PHP files must use same line ending.
'line_ending' => true,
// Cast should be written in lower case.
'lowercase_cast' => true,
// The PHP constants `true`, `false`, and `null` MUST be in lower case.
'lowercase_constants' => true,
// PHP keywords MUST be in lower case.
'lowercase_keywords' => true,
// Magic constants should be referred to using the correct casing.
'magic_constant_casing' => true,
/*
* In method arguments and method call, there MUST NOT be a space before each comma
* and there MUST be one space after each comma. Argument lists MAY be split across multiple lines,
* where each subsequent line is indented once.
* When doing so, the first item in the list MUST be on the next line,
* and there MUST be only one argument per line.
*/
'method_argument_space' => true,
// Methods must be separated with one blank line.
'method_separation' => true,
// Function defined by PHP should be called using the correct casing.
'native_function_casing' => true,
// All instances created with new keyword must be followed by braces.
'new_with_braces' => true,
// There should be no empty lines after class opening brace.
'no_blank_lines_after_class_opening' => true,
// There should not be blank lines between docblock and the documented element.
'no_blank_lines_after_phpdoc' => true,
// There must be a comment when fall-through is intentional in a non-empty case body.
'no_break_comment' => true,
// The closing `\?\>` tag MUST be omitted from files containing only PHP.
'no_closing_tag' => true,
// There should not be any empty comments.
'no_empty_comment' => true,
// There should not be empty PHPDoc blocks.
'no_empty_phpdoc' => true,
// Remove useless semicolon statements.
'no_empty_statement' => true,
/*
* Removes extra blank lines and/or blank lines following configuration.
* Configuration:
* ['tokens' => ['curly_brace_block', 'extra', 'parenthesis_brace_block', 'square_brace_block', 'throw', 'use']]
*/
'no_extra_blank_lines' => ['tokens' => ['extra']],
// Remove leading slashes in use clauses.
'no_leading_import_slash' => true,
// The namespace declaration line shouldn't contain leading whitespace.
'no_leading_namespace_whitespace' => true,
// Either language construct `print` or `echo` should be used. Configuration: ['use' => 'echo']
'no_mixed_echo_print' => true,
// Operator `=>` should not be surrounded by multi-line whitespaces.
'no_multiline_whitespace_around_double_arrow' => true,
// Short cast `bool` using double exclamation mark should not be used.
'no_short_bool_cast' => true,
// Single-line whitespace before closing semicolon are prohibited.
'no_singleline_whitespace_before_semicolons' => true,
/*
* When making a method or function call, there MUST NOT be a space between the method or function name
* and the opening parenthesis. */
'no_spaces_after_function_name' => true,
// There MUST NOT be spaces around offset braces.
'no_spaces_around_offset' => true,
/*
* There MUST NOT be a space after the opening parenthesis.
* There MUST NOT be a space before the closing parenthesis.
*/
'no_spaces_inside_parenthesis' => true,
// Remove trailing commas in list function calls.
'no_trailing_comma_in_list_call' => true,
// PHP single-line arrays should not have trailing comma.
'no_trailing_comma_in_singleline_array' => true,
// Remove trailing whitespace at the end of non-blank lines.
'no_trailing_whitespace' => true,
// There MUST be no trailing spaces inside comments and phpdocs.
'no_trailing_whitespace_in_comment' => true,
// Removes unneeded parentheses around control statements.
'no_unneeded_control_parentheses' => true,
// Removes unneeded curly braces that are superfluous and aren't part of a control structure's body.
'no_unneeded_curly_braces' => true,
// A final class must not have final methods.
'no_unneeded_final_method' => true,
// Unused use statements must be removed.
'no_unused_imports' => false,
// In array declaration, there MUST NOT be a whitespace before each comma.
'no_whitespace_before_comma_in_array' => true,
// Remove trailing whitespace at the end of blank lines.
'no_whitespace_in_blank_line' => true,
// Array index should always be written by using square braces.
'normalize_index_brace' => true,
// There should not be space before or after object `T_OBJECT_OPERATOR` `->`.
'object_operator_without_whitespace' => true,
// Orders the elements of classes/interfaces/traits.
'ordered_class_elements' => true,
/*
* Ordering use statements.
* Fixer is configurable using following options:
* sortAlgorithm ('alpha', 'length'): whether the statements should be sorted alphabetically or by length;
* defaults to 'alpha'
* importsOrder (array, null): defines the order of import types; defaults to null
*/
'ordered_imports' => ['imports_order' => ['const', 'function', 'class'], 'sortAlgorithm' => 'alpha'],
// PHPUnit annotations should be a FQCNs including a root namespace.
'php_unit_fqcn_annotation' => true,
// Phpdoc should contain @param for all params.
'phpdoc_add_missing_param_annotation' => true,
// All items of the given phpdoc tags must be aligned vertically.
'phpdoc_align' => true,
// Phpdocs annotation descriptions should not be a sentence.
'phpdoc_annotation_without_dot' => true,
// Docblocks should have the same indentation as the documented subject.
'phpdoc_indent' => true,
// Fix phpdoc inline tags, make inheritdoc always inline.
'phpdoc_inline_tag' => true,
// @access annotations should be omitted from phpdocs.
'phpdoc_no_access' => true,
// No alias PHPDoc tags should be used.
'phpdoc_no_alias_tag' => true,
// @return void and @return null annotations should be omitted from phpdocs.
'phpdoc_no_empty_return' => true,
// @package and @subpackage annotations should be omitted from phpdocs.
'phpdoc_no_package' => true,
// Classy that does not inherit must not have inheritdoc tags.
'phpdoc_no_useless_inheritdoc' => true,
/**
* Annotations in phpdocs should be ordered so that param annotations come first, then throws annotations,
* then return annotations.
*/
'phpdoc_order' => true,
// The type of `@return` annotations of methods returning a reference to itself must the configured one.
'phpdoc_return_self_reference' => true,
/*
* Scalar types should always be written in the same form. * `int` not `integer`, `bool` not `boolean`,
*`float` not `real` or `double`.
*/
'phpdoc_scalar' => true,
/*
* Annotations in phpdocs should be grouped together so that annotations of the same type immediately
* follow each other, and annotations of a different type are separated by a single blank line.
*/
'phpdoc_separation' => true,
// Single line @var PHPDoc should have proper spacing.
'phpdoc_single_line_var_spacing' => true,
// Phpdocs summary should end in either a full stop, exclamation mark, or question mark.
'phpdoc_summary' => false,
// Docblocks should only be used on structural elements.
'phpdoc_to_comment' => false,
// Phpdocs should start and end with content, excluding the very first and last line of the docblocks.
'phpdoc_trim' => true,
// The correct case must be used for standard PHP types in phpdoc.
'phpdoc_types' => true,
// \@var and \@type annotations should not contain the variable name.
'phpdoc_var_without_name' => false,
// Converts `protected` variables and methods to `private` where possible.
'protected_to_private' => false,
/*
* There should be one or no space before colon, and one space after it in return type declarations,
* according to configuration.
*/
'return_type_declaration' => true,
// Inside a classy element "self" should be preferred to the class name itself.
'self_accessor' => true,
// Instructions must be terminated with a semicolon.
'semicolon_after_instruction' => true,
/*
* Cast `(boolean)` and `(integer)` should be written as `(bool)` and `(int)`,
* `(double)` and `(real)` as `(float)`.
*/
'short_scalar_cast' => true,
// A PHP file without end tag must always end with a single empty line feed.
'single_blank_line_at_eof' => true,
// There should be exactly one blank line before a namespace declaration.
'single_blank_line_before_namespace' => true,
// There MUST NOT be more than one property or constant declared per statement.
'single_class_element_per_statement' => true,
// There MUST be one use keyword per declaration.
'single_import_per_statement' => true,
// Each namespace use MUST go on its own line and there MUST be one blank line after the use statements block.
'single_line_after_imports' => true,
/*
* Single-line comments and multi-line comments with only one line of actual content should use the `//` syntax.
* Configuration: ['comment_types' => ['hash']]
*/
'single_line_comment_style' => false,
// Convert double quotes to single quotes for simple strings.
'single_quote' => true,
/* Fix whitespace after a semicolon. */// Configuration: ['remove_in_empty_for_expressions' => true]
'space_after_semicolon' => true,
// Replace all `<>` with `!=`.
'standardize_not_equals' => true,
// A case should be followed by a colon and not a semicolon.
'switch_case_semicolon_to_colon' => true,
// Removes extra spaces between colon and case value.
'switch_case_space' => true,
// Standardize spaces around ternary operator.
'ternary_operator_spaces' => true,
// PHP multi-line arrays should have a trailing comma.
'trailing_comma_in_multiline_array' => true,
// Arrays should be formatted like function/method arguments, without leading or trailing single line space.
'trim_array_spaces' => true,
// Unary operators should be placed adjacent to their operands.
'unary_operator_spaces' => true,
/*
* Visibility MUST be declared on all properties and methods; abstract and final MUST be declared
* before the visibility; static MUST be declared after the visibility.
*/
'visibility_required' => true,
// In array declaration, there MUST be a whitespace after each comma.
'whitespace_after_comma_in_array' => true,
/*
* Write conditions in Yoda style (`true`), non-Yoda style (`false`)
* or ignore those conditions (`null`) based on configuration.
*/
'yoda_style' => false,
/*
* PHP arrays should be declared using the configured syntax.
* Fixer is configurable using following option:
* syntax ('long', 'short'): whether to use the `long` or `short` array syntax; defaults to 'long'
*/
'array_syntax' => ['syntax' => 'short'],
'concat_space' => ['spacing' => 'one'],
])
->setFinder(
PhpCsFixer\Finder::create()
->in(__DIR__ . '/src')
->append([__FILE__])
);