You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
172 lines
6.3 KiB
172 lines
6.3 KiB
<?php |
|
/** |
|
* @link http://www.yiiframework.com/ |
|
* @copyright Copyright (c) 2008 Yii Software LLC |
|
* @license http://www.yiiframework.com/license/ |
|
*/ |
|
|
|
namespace yii\cs; |
|
|
|
use PhpCsFixer\Config; |
|
use yii\helpers\ArrayHelper; |
|
|
|
/** |
|
* Basic rules used by Yii 2 ecosystem. |
|
* |
|
* @author Robert Korulczyk <robert@korulczyk.pl> |
|
* @since 2.0.0 |
|
*/ |
|
class YiiConfig extends Config |
|
{ |
|
/** |
|
* {@inheritdoc} |
|
*/ |
|
public function __construct($name = 'yii-cs-config') |
|
{ |
|
parent::__construct($name); |
|
|
|
$this->setRiskyAllowed(true); |
|
|
|
$this->setRules([ |
|
'@PSR2' => true, |
|
'array_syntax' => [ |
|
'syntax' => 'short', |
|
], |
|
'binary_operator_spaces' => [ |
|
'align_double_arrow' => false, |
|
'align_equals' => false, |
|
], |
|
'blank_line_after_opening_tag' => true, |
|
'cast_spaces' => true, |
|
'concat_space' => [ |
|
'spacing' => 'one', |
|
], |
|
'dir_constant' => true, |
|
'ereg_to_preg' => true, |
|
'function_typehint_space' => true, |
|
'hash_to_slash_comment' => true, |
|
'include' => true, |
|
'heredoc_to_nowdoc' => true, |
|
'is_null' => [ |
|
'use_yoda_style' => false, |
|
], |
|
'linebreak_after_opening_tag' => true, |
|
'lowercase_cast' => true, |
|
'magic_constant_casing' => true, |
|
// 'mb_str_functions' => true, // needs more discussion |
|
// 'method_separation' => true, // conflicts with current Yii style with double line between properties and methods |
|
'modernize_types_casting' => true, |
|
'native_function_casing' => true, |
|
'new_with_braces' => true, |
|
'no_alias_functions' => true, |
|
'no_blank_lines_after_class_opening' => true, |
|
'no_blank_lines_after_phpdoc' => true, |
|
'no_empty_comment' => true, |
|
'no_empty_phpdoc' => true, |
|
'no_empty_statement' => true, |
|
'no_extra_consecutive_blank_lines' => [ |
|
'tokens' => [ |
|
'break', |
|
'continue', |
|
// 'extra', // conflicts with current Yii style with double line between properties and methods |
|
'return', |
|
'throw', |
|
'use', |
|
'use_trait', |
|
// 'curly_brace_block', // breaks namespaces blocks |
|
'parenthesis_brace_block', |
|
'square_brace_block', |
|
], |
|
], |
|
'no_leading_import_slash' => true, |
|
'no_leading_namespace_whitespace' => true, |
|
'no_mixed_echo_print' => true, |
|
'no_multiline_whitespace_around_double_arrow' => true, |
|
'no_multiline_whitespace_before_semicolons' => true, |
|
'no_php4_constructor' => true, |
|
'no_short_bool_cast' => true, |
|
'no_singleline_whitespace_before_semicolons' => true, |
|
'no_spaces_around_offset' => true, |
|
'no_trailing_comma_in_list_call' => true, |
|
'no_trailing_comma_in_singleline_array' => true, |
|
'no_unneeded_control_parentheses' => true, |
|
'no_unused_imports' => true, |
|
'no_useless_else' => true, |
|
'no_useless_return' => true, |
|
'no_whitespace_before_comma_in_array' => true, |
|
'no_whitespace_in_blank_line' => true, |
|
'non_printable_character' => true, |
|
'normalize_index_brace' => true, |
|
'object_operator_without_whitespace' => true, |
|
// 'ordered_class_elements' => [ // needs more discussion |
|
// 'order' => [ |
|
// 'use_trait', |
|
// 'constant_public', |
|
// 'constant_protected', |
|
// 'constant_private', |
|
// 'property_public', |
|
// 'property_protected', |
|
// 'property_private', |
|
// 'construct', |
|
// 'destruct', |
|
// 'magic', |
|
// ], |
|
// ], |
|
'ordered_imports' => [ |
|
'sortAlgorithm' => 'alpha', |
|
'importsOrder' => [ |
|
'const', |
|
'function', |
|
'class', |
|
], |
|
], |
|
'php_unit_construct' => true, |
|
'php_unit_dedicate_assert' => true, |
|
'php_unit_fqcn_annotation' => true, |
|
// 'php_unit_strict' => true, // needs more attention |
|
'phpdoc_add_missing_param_annotation' => true, |
|
'phpdoc_indent' => true, |
|
// 'phpdoc_inline_tag' => true, // see https://github.com/yiisoft/yii2/issues/11635 |
|
'phpdoc_no_access' => true, |
|
'phpdoc_no_empty_return' => true, |
|
'phpdoc_no_package' => true, |
|
'phpdoc_no_useless_inheritdoc' => true, |
|
// 'phpdoc_order', // may be useful, but should be configurable: https://github.com/FriendsOfPHP/PHP-CS-Fixer/issues/1602 |
|
'phpdoc_return_self_reference' => true, |
|
'phpdoc_scalar' => true, |
|
'phpdoc_single_line_var_spacing' => true, |
|
'phpdoc_summary' => true, |
|
// 'phpdoc_to_comment' => true, // breaks phpdoc for define('CONSTANT', $value); |
|
'phpdoc_trim' => true, |
|
'phpdoc_types' => true, |
|
'phpdoc_var_without_name' => true, |
|
'protected_to_private' => true, |
|
'psr4' => true, |
|
'self_accessor' => true, |
|
'short_scalar_cast' => true, |
|
'single_blank_line_before_namespace' => true, |
|
'single_quote' => true, |
|
'standardize_not_equals' => true, |
|
'ternary_operator_spaces' => true, |
|
'trailing_comma_in_multiline_array' => true, |
|
'trim_array_spaces' => true, |
|
'unary_operator_spaces' => true, |
|
'whitespace_after_comma_in_array' => true, |
|
]); |
|
} |
|
|
|
/** |
|
* Merge current rules config with provided list of rules. |
|
* |
|
* @param array $rules |
|
* @return $this |
|
* @see setRules() |
|
* @see ArrayHelper::merge() |
|
*/ |
|
public function mergeRules(array $rules) |
|
{ |
|
$this->setRules(ArrayHelper::merge($this->getRules(), $rules)); |
|
|
|
return $this; |
|
} |
|
}
|
|
|