80ea72960c3071d41725c817f3c511a30ebf7547
[Packages/TYPO3.CMS.git] / Build / .php_cs
1 <?php
2 /*
3  * This file is part of the TYPO3 CMS project.
4  *
5  * It is free software; you can redistribute it and/or modify it under
6  * the terms of the GNU General Public License, either version 2
7  * of the License, or any later version.
8  *
9  * For the full copyright and license information, please read the
10  * LICENSE.txt file that was distributed with this source code.
11  *
12  * The TYPO3 project - inspiring people to share!
13  */
14 /**
15  * This file represents the configuration for Code Sniffing PSR-2-related
16  * automatic checks of coding guidelines
17  * Install @fabpot's great php-cs-fixer tool via
18  *
19  *  $ composer global require friendsofphp/php-cs-fixer
20  *
21  * And then simply run
22  *
23  *  $ php-cs-fixer fix --config ../Build/.php_cs
24  *
25  * inside the TYPO3 directory. Warning: This may take up to 10 minutes.
26  *
27  * For more information read:
28  *       http://www.php-fig.org/psr/psr-2/
29  *       http://cs.sensiolabs.org
30  */
31 if (PHP_SAPI !== 'cli') {
32     die('This script supports command line usage only. Please check your command.');
33 }
34 // Define in which folders to search and which folders to exclude
35 // Exclude some directories that are excluded by Git anyways to speed up the sniffing
36 $finder = PhpCsFixer\Finder::create()
37     ->exclude('vendor')
38     ->exclude('typo3conf')
39     ->exclude('typo3temp')
40     ->in(__DIR__ . '/../');
41 // Return a Code Sniffing configuration using
42 // all sniffers needed for PSR-2
43 // and additionally:
44 //  - Remove leading slashes in use clauses.
45 //  - PHP single-line arrays should not have trailing comma.
46 //  - Single-line whitespace before closing semicolon are prohibited.
47 //  - Remove unused use statements in the PHP source code
48 //  - Ensure Concatenation to have at least one whitespace around
49 //  - Remove trailing whitespace at the end of blank lines.
50 return PhpCsFixer\Config::create()
51     ->setRiskyAllowed(true)
52     ->setRules([
53         '@PSR2' => true,
54         'no_leading_import_slash' => true,
55         'no_trailing_comma_in_singleline_array' => true,
56         'no_singleline_whitespace_before_semicolons' => true,
57         'no_unused_imports' => true,
58         'concat_space' => ['spacing' => 'one'],
59         'no_whitespace_in_blank_line' => true,
60         'ordered_imports' => true,
61         'single_quote' => true,
62         'no_empty_statement' => true,
63         'no_extra_consecutive_blank_lines' => true,
64         'phpdoc_no_package' => true,
65         'phpdoc_scalar' => true,
66         'no_blank_lines_after_phpdoc' => true,
67         'array_syntax' => ['syntax' => 'short'],
68         'whitespace_after_comma_in_array' => true,
69         'function_typehint_space' => true,
70         'hash_to_slash_comment' => true,
71         'no_alias_functions' => true,
72         'lowercase_cast' => true,
73         'no_leading_namespace_whitespace' => true,
74         'native_function_casing' => true,
75         'self_accessor' => true,
76         'no_short_bool_cast' => true,
77         'no_unneeded_control_parentheses' => true,
78         'phpdoc_no_empty_return' => true,
79         'no_blank_lines_after_phpdoc' => true,
80         'phpdoc_trim' => true,
81         'no_superfluous_elseif' => true,
82         'no_useless_else' => true,
83         'phpdoc_types' => true,
84     ])
85     ->setFinder($finder);