xref: /dokuwiki/_test/rector.php (revision 26dfc2323f8f70cb69aac4c8c51bf7997809f2ca) 
1<?php
2
3declare(strict_types=1);
4
5use dokuwiki\test\rector\DokuWikiPtlnRector;
6use dokuwiki\test\rector\DokuWikiRenamePrintToEcho;
7use Rector\Caching\ValueObject\Storage\FileCacheStorage;
8use Rector\CodeQuality\Rector\Array_\CallableThisArrayToAnonymousFunctionRector;
9use Rector\CodeQuality\Rector\Concat\JoinStringConcatRector;
10use Rector\CodeQuality\Rector\FunctionLike\SimplifyUselessVariableRector;
11use Rector\CodeQuality\Rector\If_\CombineIfRector;
12use Rector\CodeQuality\Rector\If_\ExplicitBoolCompareRector;
13use Rector\CodeQuality\Rector\If_\SimplifyIfElseToTernaryRector;
14use Rector\CodeQuality\Rector\If_\SimplifyIfReturnBoolRector;
15use Rector\CodeQuality\Rector\Isset_\IssetOnPropertyObjectToPropertyExistsRector;
16use Rector\CodingStyle\Rector\Catch_\CatchExceptionNameMatchingTypeRector;
17use Rector\CodingStyle\Rector\Class_\AddArrayDefaultToArrayPropertyRector;
18use Rector\CodingStyle\Rector\Closure\StaticClosureRector;
19use Rector\CodingStyle\Rector\Encapsed\EncapsedStringsToSprintfRector;
20use Rector\CodingStyle\Rector\Encapsed\WrapEncapsedVariableInCurlyBracesRector;
21use Rector\CodingStyle\Rector\FuncCall\StrictArraySearchRector;
22use Rector\CodingStyle\Rector\PostInc\PostIncDecToPreIncDecRector;
23use Rector\CodingStyle\Rector\Stmt\NewlineAfterStatementRector;
24use Rector\CodingStyle\Rector\String_\SymplifyQuoteEscapeRector;
25use Rector\Config\RectorConfig;
26use Rector\DeadCode\Rector\ClassMethod\RemoveUselessParamTagRector;
27use Rector\DeadCode\Rector\If_\RemoveAlwaysTrueIfConditionRector;
28use Rector\DeadCode\Rector\If_\RemoveUnusedNonEmptyArrayBeforeForeachRector;
29use Rector\DeadCode\Rector\Property\RemoveUselessVarTagRector;
30use Rector\DeadCode\Rector\StaticCall\RemoveParentCallWithoutParentRector;
31use Rector\DeadCode\Rector\Stmt\RemoveUnreachableStatementRector;
32use Rector\Php71\Rector\FuncCall\CountOnNullRector;
33use Rector\Php71\Rector\FuncCall\RemoveExtraParametersRector;
34use Rector\Renaming\Rector\FuncCall\RenameFunctionRector;
35use Rector\Renaming\Rector\Name\RenameClassRector;
36use Rector\Set\ValueObject\LevelSetList;
37use Rector\Set\ValueObject\SetList;
38use Rector\Strict\Rector\Empty_\DisallowedEmptyRuleFixerRector;
39use Rector\TypeDeclaration\Rector\Property\TypedPropertyFromAssignsRector;
40
41return static function (RectorConfig $rectorConfig): void {
42    // FIXME we may want to autoload these later
43    require_once __DIR__ . '/rector/DokuWikiPtlnRector.php';
44    require_once __DIR__ . '/rector/DokuWikiRenamePrintToEcho.php';
45
46    $rectorConfig->paths([
47        __DIR__ . '/../inc/',
48        __DIR__ . '/../lib/',
49        __DIR__ . '/../bin/',
50        __DIR__ . '/../*.php',
51    ]);
52
53    $rectorConfig->bootstrapFiles([
54        __DIR__ . '/../inc/init.php',
55    ]);
56
57    $rectorConfig->importNames();
58    $rectorConfig->importShortClasses(false);
59    $rectorConfig->cacheClass(FileCacheStorage::class);
60    $rectorConfig->cacheDirectory(__DIR__ . '/.rector-cache');
61
62    // define sets of rules
63    $rectorConfig->sets([
64        LevelSetList::UP_TO_PHP_74,
65        SetList::CODE_QUALITY,
66        SetList::DEAD_CODE,
67        SetList::CODING_STYLE,
68    ]);
69
70    $rectorConfig->skip([
71        // skip paths
72        __DIR__ . '/../inc/lang/*',
73        __DIR__ . '/../lib/plugins/*/_test/*',
74        __DIR__ . '/../lib/tpl/*/_test/*',
75        __DIR__ . '/../lib/plugins/*/lang/*',
76        __DIR__ . '/../lib/tpl/*/lang/*',
77        __DIR__ . '/../lib/plugins/*/conf/*', // maybe later
78        __DIR__ . '/../lib/tpl/*/conf/*',  // maybe later
79        __DIR__ . '/../lib/plugins/*/vendor/*',
80        __DIR__ . '/../lib/tpl/*/vendor/*',
81        __DIR__ . '/../lib/plugins/*/skel/*', // dev plugin
82        __DIR__ . '/../inc/deprecated.php',
83        __DIR__ . '/../inc/form.php',
84
85        // third party libs, not yet moved to composer
86        __DIR__ . '/../inc/DifferenceEngine.php',
87        __DIR__ . '/../inc/JpegMeta.php',
88        __DIR__ . '/../lib/plugins/authad/adLDAP',
89
90        // skip rules
91        SimplifyIfElseToTernaryRector::class,
92        NewlineAfterStatementRector::class,
93        CombineIfRector::class,
94        ExplicitBoolCompareRector::class,
95        IssetOnPropertyObjectToPropertyExistsRector::class, // maybe?
96        SymplifyQuoteEscapeRector::class,
97        CatchExceptionNameMatchingTypeRector::class,
98        EncapsedStringsToSprintfRector::class,
99        CallableThisArrayToAnonymousFunctionRector::class,
100        StaticClosureRector::class,
101        SimplifyUselessVariableRector::class, // seems to strip constructor property initializations
102        PostIncDecToPreIncDecRector::class,
103        RemoveUselessParamTagRector::class,
104        DisallowedEmptyRuleFixerRector::class,
105        CountOnNullRector::class, // adds unwanted is_countable checks?
106        RemoveParentCallWithoutParentRector::class,
107        WrapEncapsedVariableInCurlyBracesRector::class,
108        SimplifyIfReturnBoolRector::class,
109        StrictArraySearchRector::class, // we cannot assume strict search is always wanted
110        AddArrayDefaultToArrayPropertyRector::class, // may break code differentiating between null and empty array
111        RemoveUselessVarTagRector::class,
112        TypedPropertyFromAssignsRector::class, // maybe?
113        JoinStringConcatRector::class, // this does not count variables, so it creates overlong lines
114        RemoveExtraParametersRector::class, // this actually broke code
115        RemoveUnusedNonEmptyArrayBeforeForeachRector::class, // seems unreliable when checking on array keys
116        RemoveAlwaysTrueIfConditionRector::class, // fails with if(defined(...)) constructs
117        RemoveUnreachableStatementRector::class, // fails GOTO in authpdo -> should be rewritten with exceptions
118    ]);
119
120    $rectorConfig->ruleWithConfiguration(RenameClassRector::class, [
121        // see inc/deprecated.php
122        'RemoteAccessDeniedException' => 'dokuwiki\Remote\AccessDeniedException',
123        'RemoteException' => 'dokuwiki\Remote\RemoteException',
124        'setting' => 'dokuwiki\plugin\config\core\Setting\Setting',
125        'setting_authtype' => 'dokuwiki\plugin\config\core\Setting\SettingAuthtype',
126        'setting_string' => 'dokuwiki\plugin\config\core\Setting\SettingString',
127        'PageChangelog' => 'dokuwiki\ChangeLog\PageChangeLog',
128        'MediaChangelog' => 'dokuwiki\ChangeLog\MediaChangeLog',
129        'Input' => 'dokuwiki\Input\Input',
130        'PostInput' => 'dokuwiki\Input\Post',
131        'GetInput' => 'dokuwiki\Input\Get',
132        'ServerInput' => 'dokuwiki\Input\Server',
133        'PassHash' => 'dokuwiki\PassHash',
134        'HTTPClientException' => 'dokuwiki\HTTP\HTTPClientException',
135        'HTTPClient' => 'dokuwiki\HTTP\HTTPClient',
136        'DokuHTTPClient' => 'dokuwiki\HTTP\DokuHTTPClient',
137        'Doku_Plugin_Controller' => 'dokuwiki\Extension\PluginController',
138        'Doku_Indexer' => 'dokuwiki\Search\Indexer',
139        'IXR_Client' => 'dokuwiki\Remote\IXR\Client',
140        'IXR_ClientMulticall' => 'IXR\Client\ClientMulticall',
141        'IXR_Server' => 'IXR\Server\Server',
142        'IXR_IntrospectionServer' => 'IXR\Server\IntrospectionServer',
143        'IXR_Request' => 'IXR\Request\Request',
144        'IXR_Message' => 'R\Message\Message',
145        'IXR_Error' => 'XR\Message\Error',
146        'IXR_Date' => 'IXR\DataType\Date',
147        'IXR_Base64' => 'IXR\DataType\Base64',
148        'IXR_Value' => 'IXR\DataType\Value',
149
150        // see inc/legacy.php
151        'Doku_Event_Handler' => 'dokuwiki\Extension\EventHandler',
152        'Doku_Event' => 'dokuwiki\Extension\Event',
153        'DokuWiki_Action_Plugin' => 'dokuwiki\Extension\ActionPlugin',
154        'DokuWiki_Admin_Plugin' => 'dokuwiki\Extension\AdminPlugin',
155        'DokuWiki_Auth_Plugin' => 'dokuwiki\Extension\AuthPlugin',
156        'DokuWiki_CLI_Plugin' => 'dokuwiki\Extension\CLIPlugin',
157        'DokuWiki_Plugin' => 'dokuwiki\Extension\Plugin',
158        'DokuWiki_Remote_Plugin' => 'dokuwiki\Extension\RemotePlugin',
159        'DokuWiki_Syntax_Plugin' => 'dokuwiki\Extension\SyntaxPlugin',
160    ]);
161
162    $rectorConfig->ruleWithConfiguration(RenameFunctionRector::class, [
163        // see inc/deprecated.php
164        'Doku_Lexer_Escape' => 'dokuwiki\Parsing\Lexer\Lexer::escape',
165
166        // see inc/utf8.php
167        'utf8_isASCII' => 'dokuwiki\Utf8\Clean::isASCII',
168        'utf8_strip' => 'dokuwiki\Utf8\Clean::strip',
169        'utf8_check' => 'dokuwiki\Utf8\Clean::isUtf8',
170        'utf8_basename' => 'dokuwiki\Utf8\PhpString::basename',
171        'utf8_strlen' => 'dokuwiki\Utf8\PhpString::strlen',
172        'utf8_substr' => 'dokuwiki\Utf8\PhpString::substr',
173        'utf8_substr_replace' => 'dokuwiki\Utf8\PhpString::substr_replace',
174        'utf8_ltrim' => 'dokuwiki\Utf8\PhpString::ltrim',
175        'utf8_rtrim' => 'dokuwiki\Utf8\PhpString::rtrim',
176        'utf8_trim' => 'dokuwiki\Utf8\PhpString::trim',
177        'utf8_strtolower' => 'dokuwiki\Utf8\PhpString::strtolower',
178        'utf8_strtoupper' => 'dokuwiki\Utf8\PhpString::strtoupper',
179        'utf8_ucfirst' => 'dokuwiki\Utf8\PhpString::ucfirst',
180        'utf8_ucwords' => 'dokuwiki\Utf8\PhpString::ucwords',
181        'utf8_deaccent' => 'dokuwiki\Utf8\Clean::deaccent',
182        'utf8_romanize' => 'dokuwiki\Utf8\Clean::romanize',
183        'utf8_stripspecials' => 'dokuwiki\Utf8\Clean::stripspecials',
184        'utf8_strpos' => 'dokuwiki\Utf8\PhpString::strpos',
185        'utf8_tohtml' => 'dokuwiki\Utf8\Conversion::toHtml',
186        'utf8_unhtml' => 'dokuwiki\Utf8\Conversion::fromHtml',
187        'utf8_to_unicode' => 'dokuwiki\Utf8\Conversion::fromUtf8',
188        'unicode_to_utf8' => 'dokuwiki\Utf8\Conversion::toUtf8',
189        'utf8_to_utf16be' => 'dokuwiki\Utf8\Conversion::toUtf16be',
190        'utf16be_to_utf8' => 'dokuwiki\Utf8\Conversion::fromUtf16be',
191        'utf8_bad_replace' => 'dokuwiki\Utf8\Clean::replaceBadBytes',
192        'utf8_correctIdx' => 'dokuwiki\Utf8\Clean::correctIdx',
193    ]);
194
195    $rectorConfig->rule(DokuWikiPtlnRector::class);
196    $rectorConfig->rule(DokuWikiRenamePrintToEcho::class);
197};
198