-
Notifications
You must be signed in to change notification settings - Fork 16
/
CsFixerConfig.php
147 lines (129 loc) · 4.85 KB
/
CsFixerConfig.php
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
<?php
declare(strict_types=1);
/*
* This file is part of the TYPO3 project.
*
* (c) 2019-2022 Benni Mack
* Simon Gilli
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
namespace TYPO3\CodingStandards;
use PhpCsFixer\Config;
class CsFixerConfig extends Config implements CsFixerConfigInterface
{
/**
* @var string
*/
protected static $defaultHeader = <<<EOF
{header}
It is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License, either version 2
of the License, or any later version.
For the full copyright and license information, please read the
LICENSE.txt file that was distributed with this source code.
The TYPO3 project - inspiring people to share!
EOF;
/**
* @var array<string, array<string, mixed>|bool>
*/
protected static $typo3Rules = [
'@DoctrineAnnotation' => true,
'@PER' => true,
'array_syntax' => ['syntax' => 'short'],
'blank_line_after_opening_tag' => true,
'braces' => ['allow_single_line_closure' => true],
'cast_spaces' => ['space' => 'none'],
'compact_nullable_typehint' => true,
'concat_space' => ['spacing' => 'one'],
'declare_equal_normalize' => ['space' => 'none'],
'dir_constant' => true,
'function_to_constant' => ['functions' => ['get_called_class', 'get_class', 'get_class_this', 'php_sapi_name', 'phpversion', 'pi']],
'function_typehint_space' => true,
'lowercase_cast' => true,
'method_argument_space' => ['on_multiline' => 'ensure_fully_multiline'],
'modernize_strpos' => true,
'modernize_types_casting' => true,
'native_function_casing' => true,
'new_with_braces' => true,
'no_alias_functions' => true,
'no_blank_lines_after_phpdoc' => true,
'no_empty_phpdoc' => true,
'no_empty_statement' => true,
'no_extra_blank_lines' => true,
'no_leading_import_slash' => true,
'no_leading_namespace_whitespace' => true,
'no_null_property_initialization' => true,
'no_short_bool_cast' => true,
'no_singleline_whitespace_before_semicolons' => true,
'no_superfluous_elseif' => true,
'no_trailing_comma_in_singleline' => true,
'no_unneeded_control_parentheses' => true,
'no_unused_imports' => true,
'no_useless_else' => true,
'no_useless_nullsafe_operator' => true,
'no_whitespace_in_blank_line' => true,
'ordered_imports' => true,
'php_unit_construct' => ['assertions' => ['assertEquals', 'assertSame', 'assertNotEquals', 'assertNotSame']],
'php_unit_mock_short_will_return' => true,
'php_unit_test_case_static_method_calls' => ['call_type' => 'self'],
'phpdoc_no_access' => true,
'phpdoc_no_empty_return' => true,
'phpdoc_no_package' => true,
'phpdoc_scalar' => true,
'phpdoc_trim' => true,
'phpdoc_types' => true,
'phpdoc_types_order' => ['null_adjustment' => 'always_last', 'sort_algorithm' => 'none'],
'return_type_declaration' => ['space_before' => 'none'],
'single_quote' => true,
'single_line_comment_style' => ['comment_types' => ['hash']],
'single_trait_insert_per_statement' => true,
'trailing_comma_in_multiline' => ['elements' => ['arrays']],
'whitespace_after_comma_in_array' => ['ensure_single_space' => true],
'yoda_style' => ['equal' => false, 'identical' => false, 'less_and_greater' => false],
];
public function __construct(string $name = 'TYPO3')
{
parent::__construct($name);
}
public static function create(): self
{
$static = new static();
$static
->setRiskyAllowed(true)
->setRules(self::$typo3Rules)
;
$finder = $static->getFinder();
$finder->exclude(['vendor', 'typo3temp', 'var', '.build']);
return $static;
}
/**
* @param array<string, mixed> $rules
*/
public function addRules(array $rules): self
{
$rules = array_replace_recursive($this->getRules(), $rules);
$this->setRules($rules);
return $this;
}
public function setHeader(
string $header = 'This file is part of the TYPO3 CMS project.',
bool $replaceAll = false
): self {
if (!$replaceAll) {
$header = str_replace('{header}', $header, self::$defaultHeader);
}
$rules = $this->getRules();
$rules['header_comment'] = [
'header' => $header,
'comment_type' => 'comment',
'location' => 'after_declare_strict',
'separate' => 'both',
];
$this->setRules($rules);
return $this;
}
}