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
|
<?php
declare(strict_types=1);
use dokuwiki\test\rector\DokuWikiPtlnRector;
use dokuwiki\test\rector\DokuWikiRenamePrintToEcho;
use Rector\Caching\ValueObject\Storage\FileCacheStorage;
use Rector\CodeQuality\Rector\ClassMethod\ExplicitReturnNullRector;
use Rector\CodeQuality\Rector\Concat\JoinStringConcatRector;
use Rector\CodeQuality\Rector\Equal\UseIdenticalOverEqualWithSameTypeRector;
use Rector\CodeQuality\Rector\FunctionLike\SimplifyUselessVariableRector;
use Rector\CodeQuality\Rector\If_\CombineIfRector;
use Rector\CodeQuality\Rector\If_\CompleteMissingIfElseBracketRector;
use Rector\CodeQuality\Rector\If_\ExplicitBoolCompareRector;
use Rector\CodeQuality\Rector\If_\SimplifyIfElseToTernaryRector;
use Rector\CodeQuality\Rector\If_\SimplifyIfReturnBoolRector;
use Rector\CodeQuality\Rector\Isset_\IssetOnPropertyObjectToPropertyExistsRector;
use Rector\CodingStyle\Rector\Catch_\CatchExceptionNameMatchingTypeRector;
use Rector\CodingStyle\Rector\Encapsed\EncapsedStringsToSprintfRector;
use Rector\CodingStyle\Rector\Encapsed\WrapEncapsedVariableInCurlyBracesRector;
use Rector\CodingStyle\Rector\FuncCall\StrictArraySearchRector;
use Rector\CodingStyle\Rector\Stmt\NewlineAfterStatementRector;
use Rector\CodingStyle\Rector\String_\SymplifyQuoteEscapeRector;
use Rector\Config\RectorConfig;
use Rector\DeadCode\Rector\ClassMethod\RemoveUnusedConstructorParamRector;
use Rector\DeadCode\Rector\ClassMethod\RemoveUselessParamTagRector;
use Rector\DeadCode\Rector\ClassMethod\RemoveUselessReturnTagRector;
use Rector\DeadCode\Rector\If_\RemoveAlwaysTrueIfConditionRector;
use Rector\DeadCode\Rector\If_\RemoveUnusedNonEmptyArrayBeforeForeachRector;
use Rector\DeadCode\Rector\Property\RemoveUselessVarTagRector;
use Rector\DeadCode\Rector\StaticCall\RemoveParentCallWithoutParentRector;
use Rector\DeadCode\Rector\Stmt\RemoveUnreachableStatementRector;
use Rector\Php71\Rector\FuncCall\RemoveExtraParametersRector;
use Rector\Php80\Rector\Identical\StrEndsWithRector;
use Rector\Php80\Rector\Identical\StrStartsWithRector;
use Rector\Php80\Rector\NotIdentical\StrContainsRector;
use Rector\Renaming\Rector\FuncCall\RenameFunctionRector;
use Rector\Renaming\Rector\Name\RenameClassRector;
use Rector\Set\ValueObject\LevelSetList;
use Rector\Set\ValueObject\SetList;
use Rector\Strict\Rector\Empty_\DisallowedEmptyRuleFixerRector;
use Rector\TypeDeclaration\Rector\ClassMethod\ReturnNeverTypeRector;
use Rector\DeadCode\Rector\If_\ReduceAlwaysFalseIfOrRector;
return static function (RectorConfig $rectorConfig): void {
// FIXME we may want to autoload these later
require_once __DIR__ . '/rector/DokuWikiPtlnRector.php';
require_once __DIR__ . '/rector/DokuWikiRenamePrintToEcho.php';
// tune parallel task settings (see rectorphp/rector#8396)
$rectorConfig->parallel(120, 16, 10);
$rectorConfig->paths([
__DIR__ . '/../inc/',
__DIR__ . '/../lib/',
__DIR__ . '/../bin/',
__DIR__ . '/../*.php',
]);
$rectorConfig->bootstrapFiles([
__DIR__ . '/../inc/init.php',
]);
$rectorConfig->importNames();
$rectorConfig->importShortClasses(false);
$rectorConfig->cacheClass(FileCacheStorage::class);
$rectorConfig->cacheDirectory(__DIR__ . '/.rector-cache');
// supported minimum PHP version can be overridden by environment variable
[$major, $minor] = explode('.', $_SERVER['RECTOR_MIN_PHP'] ?? '' ?: '7.4');
$phpset = LevelSetList::class . '::UP_TO_PHP_' . $major . $minor;
fwrite(STDERR, "Using PHP set $phpset\n");
// define sets of rules
$rectorConfig->sets([
constant($phpset),
SetList::CODE_QUALITY,
SetList::DEAD_CODE,
SetList::CODING_STYLE,
]);
// future rules for which we have polyfills
$rectorConfig->rule(StrContainsRector::class);
$rectorConfig->rule(StrEndsWithRector::class);
$rectorConfig->rule(StrStartsWithRector::class);
$rectorConfig->skip([
// skip paths
__DIR__ . '/../inc/lang/*',
__DIR__ . '/../lib/plugins/*/_test/*',
__DIR__ . '/../lib/tpl/*/_test/*',
__DIR__ . '/../lib/plugins/*/lang/*',
__DIR__ . '/../lib/tpl/*/lang/*',
__DIR__ . '/../lib/plugins/*/conf/*', // maybe later
__DIR__ . '/../lib/tpl/*/conf/*', // maybe later
__DIR__ . '/../lib/plugins/*/vendor/*',
__DIR__ . '/../lib/tpl/*/vendor/*',
__DIR__ . '/../lib/plugins/*/skel/*', // dev plugin
__DIR__ . '/../inc/deprecated.php',
__DIR__ . '/../inc/form.php',
// third party libs, not yet moved to composer
__DIR__ . '/../inc/DifferenceEngine.php',
__DIR__ . '/../inc/JpegMeta.php',
__DIR__ . '/../lib/plugins/authad/adLDAP',
// skip rules
CompleteMissingIfElseBracketRector::class, // keep one-line guardians
SimplifyIfElseToTernaryRector::class,
NewlineAfterStatementRector::class,
CombineIfRector::class,
ExplicitBoolCompareRector::class,
IssetOnPropertyObjectToPropertyExistsRector::class, // maybe?
SymplifyQuoteEscapeRector::class,
CatchExceptionNameMatchingTypeRector::class,
EncapsedStringsToSprintfRector::class,
SimplifyUselessVariableRector::class, // seems to strip constructor property initializations
DisallowedEmptyRuleFixerRector::class,
RemoveParentCallWithoutParentRector::class,
WrapEncapsedVariableInCurlyBracesRector::class,
SimplifyIfReturnBoolRector::class,
StrictArraySearchRector::class, // we cannot assume strict search is always wanted
JoinStringConcatRector::class, // this does not count variables, so it creates overlong lines
RemoveExtraParametersRector::class, // this actually broke code
RemoveUnusedConstructorParamRector::class, // see rectorphp/rector#8580
RemoveUnusedNonEmptyArrayBeforeForeachRector::class, // seems unreliable when checking on array keys
RemoveAlwaysTrueIfConditionRector::class, // fails with if(defined(...)) constructs
RemoveUnreachableStatementRector::class, // fails GOTO in authpdo -> should be rewritten with exceptions
ReturnNeverTypeRector::class,
RemoveUselessParamTagRector::class, // keep doc blocks
RemoveUselessVarTagRector::class, // keep doc blocks
RemoveUselessReturnTagRector::class, // keep doc blocks
ExplicitReturnNullRector::class, // we sometimes return void or string intentionally
UseIdenticalOverEqualWithSameTypeRector::class, // probably a good idea, maybe later
ReduceAlwaysFalseIfOrRector::class, // see rectorphp/rector#8916
]);
$rectorConfig->ruleWithConfiguration(RenameClassRector::class, [
// see inc/deprecated.php
'RemoteAccessDeniedException' => 'dokuwiki\Remote\AccessDeniedException',
'RemoteException' => 'dokuwiki\Remote\RemoteException',
'setting' => 'dokuwiki\plugin\config\core\Setting\Setting',
'setting_authtype' => 'dokuwiki\plugin\config\core\Setting\SettingAuthtype',
'setting_string' => 'dokuwiki\plugin\config\core\Setting\SettingString',
'PageChangelog' => 'dokuwiki\ChangeLog\PageChangeLog',
'MediaChangelog' => 'dokuwiki\ChangeLog\MediaChangeLog',
'Input' => 'dokuwiki\Input\Input',
'PostInput' => 'dokuwiki\Input\Post',
'GetInput' => 'dokuwiki\Input\Get',
'ServerInput' => 'dokuwiki\Input\Server',
'PassHash' => 'dokuwiki\PassHash',
'HTTPClientException' => 'dokuwiki\HTTP\HTTPClientException',
'HTTPClient' => 'dokuwiki\HTTP\HTTPClient',
'DokuHTTPClient' => 'dokuwiki\HTTP\DokuHTTPClient',
'Doku_Plugin_Controller' => 'dokuwiki\Extension\PluginController',
'Doku_Indexer' => 'dokuwiki\Search\Indexer',
'IXR_Client' => 'dokuwiki\Remote\IXR\Client',
'IXR_ClientMulticall' => 'IXR\Client\ClientMulticall',
'IXR_Server' => 'IXR\Server\Server',
'IXR_IntrospectionServer' => 'IXR\Server\IntrospectionServer',
'IXR_Request' => 'IXR\Request\Request',
'IXR_Message' => 'R\Message\Message',
'IXR_Error' => 'XR\Message\Error',
'IXR_Date' => 'IXR\DataType\Date',
'IXR_Base64' => 'IXR\DataType\Base64',
'IXR_Value' => 'IXR\DataType\Value',
// see inc/legacy.php
'Doku_Event_Handler' => 'dokuwiki\Extension\EventHandler',
'Doku_Event' => 'dokuwiki\Extension\Event',
'DokuWiki_Action_Plugin' => 'dokuwiki\Extension\ActionPlugin',
'DokuWiki_Admin_Plugin' => 'dokuwiki\Extension\AdminPlugin',
'DokuWiki_Auth_Plugin' => 'dokuwiki\Extension\AuthPlugin',
'DokuWiki_CLI_Plugin' => 'dokuwiki\Extension\CLIPlugin',
'DokuWiki_Plugin' => 'dokuwiki\Extension\Plugin',
'DokuWiki_Remote_Plugin' => 'dokuwiki\Extension\RemotePlugin',
'DokuWiki_Syntax_Plugin' => 'dokuwiki\Extension\SyntaxPlugin',
]);
$rectorConfig->ruleWithConfiguration(RenameFunctionRector::class, [
// see inc/deprecated.php
'Doku_Lexer_Escape' => 'dokuwiki\Parsing\Lexer\Lexer::escape',
// see inc/utf8.php
'utf8_isASCII' => 'dokuwiki\Utf8\Clean::isASCII',
'utf8_strip' => 'dokuwiki\Utf8\Clean::strip',
'utf8_check' => 'dokuwiki\Utf8\Clean::isUtf8',
'utf8_basename' => 'dokuwiki\Utf8\PhpString::basename',
'utf8_strlen' => 'dokuwiki\Utf8\PhpString::strlen',
'utf8_substr' => 'dokuwiki\Utf8\PhpString::substr',
'utf8_substr_replace' => 'dokuwiki\Utf8\PhpString::substr_replace',
'utf8_ltrim' => 'dokuwiki\Utf8\PhpString::ltrim',
'utf8_rtrim' => 'dokuwiki\Utf8\PhpString::rtrim',
'utf8_trim' => 'dokuwiki\Utf8\PhpString::trim',
'utf8_strtolower' => 'dokuwiki\Utf8\PhpString::strtolower',
'utf8_strtoupper' => 'dokuwiki\Utf8\PhpString::strtoupper',
'utf8_ucfirst' => 'dokuwiki\Utf8\PhpString::ucfirst',
'utf8_ucwords' => 'dokuwiki\Utf8\PhpString::ucwords',
'utf8_deaccent' => 'dokuwiki\Utf8\Clean::deaccent',
'utf8_romanize' => 'dokuwiki\Utf8\Clean::romanize',
'utf8_stripspecials' => 'dokuwiki\Utf8\Clean::stripspecials',
'utf8_strpos' => 'dokuwiki\Utf8\PhpString::strpos',
'utf8_tohtml' => 'dokuwiki\Utf8\Conversion::toHtml',
'utf8_unhtml' => 'dokuwiki\Utf8\Conversion::fromHtml',
'utf8_to_unicode' => 'dokuwiki\Utf8\Conversion::fromUtf8',
'unicode_to_utf8' => 'dokuwiki\Utf8\Conversion::toUtf8',
'utf8_to_utf16be' => 'dokuwiki\Utf8\Conversion::toUtf16be',
'utf16be_to_utf8' => 'dokuwiki\Utf8\Conversion::fromUtf16be',
'utf8_bad_replace' => 'dokuwiki\Utf8\Clean::replaceBadBytes',
'utf8_correctIdx' => 'dokuwiki\Utf8\Clean::correctIdx',
]);
$rectorConfig->rule(DokuWikiPtlnRector::class);
$rectorConfig->rule(DokuWikiRenamePrintToEcho::class);
};
|
