Last active
September 17, 2020 13:38
-
-
Save ShahinSorkh/f8d9284950f2f073aaa2c2ff11300321 to your computer and use it in GitHub Desktop.
php-cs-fixer config to follow laravel style guides
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php | |
$finder = PhpCsFixer\Finder::create() | |
->in(__DIR__) | |
->name('*.php') | |
->notName('_ide_helper.php') | |
->notName('*.blade.php') | |
->notPath('bootstrap') | |
->notPath('node_modules') | |
->notPath('storage') | |
->notPath('vendor') | |
->ignoreDotFiles(true) | |
->ignoreVCS(true); | |
return PhpCsFixer\Config::create() | |
->setRules([ | |
'@PSR2' => true, | |
'array_syntax' => ['syntax' => 'short'], | |
'binary_operator_spaces' => true, | |
'blank_line_after_namespace' => true, | |
'blank_line_after_opening_tag' => true, | |
'blank_line_before_return' => true, | |
'braces' => true, | |
'cast_spaces' => true, | |
'class_attributes_separation' => true, | |
'class_definition' => true, | |
'concat_space' => ['spacing' => 'none'], | |
'declare_equal_normalize' => ['space' => 'single'], | |
'elseif' => true, | |
'encoding' => true, | |
'full_opening_tag' => true, | |
'function_declaration' => true, | |
'function_typehint_space' => true, | |
'heredoc_to_nowdoc' => true, | |
'include' => true, | |
'increment_style' => ['style' => 'post'], | |
'indentation_type' => true, | |
'line_ending' => true, | |
'line_ending' => true, | |
'lowercase_cast' => true, | |
'lowercase_constants' => true, | |
'lowercase_keywords' => true, | |
'magic_constant_casing' => true, | |
'method_argument_space' => ['ensure_fully_multiline' => true], | |
'native_function_casing' => true, | |
// 'no_alias_functions' => true, | |
'no_blank_lines_after_class_opening' => true, | |
'no_blank_lines_after_phpdoc' => true, | |
'no_break_comment' => true, | |
'no_closing_tag' => true, | |
'no_empty_phpdoc' => true, | |
'no_empty_statement' => true, | |
'no_extra_blank_lines' => ['tokens' => ['throw', 'use', 'use_trait', 'extra']], | |
'no_extra_consecutive_blank_lines' => true, | |
'no_leading_import_slash' => true, | |
'no_leading_namespace_whitespace' => true, | |
'no_mixed_echo_print' => ['use' => 'echo'], | |
'no_multiline_whitespace_around_double_arrow' => true, | |
'no_multiline_whitespace_before_semicolons' => true, | |
'no_short_bool_cast' => true, | |
'no_singleline_whitespace_before_semicolons' => true, | |
'no_spaces_after_function_name' => true, | |
'no_spaces_around_offset' => true, | |
'no_spaces_inside_parenthesis' => true, | |
'no_trailing_comma_in_list_call' => true, | |
'no_trailing_comma_in_singleline_array' => true, | |
'no_trailing_whitespace' => true, | |
'no_trailing_whitespace_in_comment' => true, | |
'no_unneeded_control_parentheses' => true, | |
// 'no_unreachable_default_argument_value' => true, | |
'no_unused_imports' => true, | |
'no_useless_return' => true, | |
'no_whitespace_before_comma_in_array' => true, | |
'no_whitespace_in_blank_line' => true, | |
'normalize_index_brace' => true, | |
'not_operator_with_successor_space' => true, | |
'object_operator_without_whitespace' => true, | |
'ordered_imports' => ['sort_algorithm' => 'length'], | |
'php_unit_fqcn_annotation' => true, | |
'php_unit_internal_class' => true, | |
'php_unit_method_casing' => ['case' => 'snake_case'], | |
'php_unit_size_class' => true, | |
'phpdoc_add_missing_param_annotation' => ['only_untyped' => false], | |
'phpdoc_align' => true, | |
'phpdoc_annotation_without_dot' => true, | |
'phpdoc_indent' => true, | |
'phpdoc_inline_tag' => true, | |
'phpdoc_no_access' => true, | |
'phpdoc_no_empty_return' => true, | |
'phpdoc_no_package' => true, | |
'phpdoc_no_useless_inheritdoc' => true, | |
'phpdoc_order' => true, | |
'phpdoc_scalar' => true, | |
'phpdoc_separation' => true, | |
'phpdoc_single_line_var_spacing' => true, | |
'phpdoc_summary' => true, | |
'phpdoc_to_comment' => true, | |
'phpdoc_trim' => true, | |
'phpdoc_trim_consecutive_blank_line_separation' => true, | |
'phpdoc_types' => true, | |
'phpdoc_types_order' => ['null_adjustment' => 'always_last'], | |
'phpdoc_var_annotation_correct_order' => true, | |
'phpdoc_var_without_name' => true, | |
'psr0' => false, | |
// 'psr4' => true, | |
'return_type_declaration' => true, | |
// 'self_accessor' => true, | |
'short_scalar_cast' => true, | |
'simplified_null_return' => true, | |
'single_blank_line_at_eof' => true, | |
'single_blank_line_before_namespace' => true, | |
'single_class_element_per_statement' => false, | |
'single_import_per_statement' => true, | |
'single_line_after_imports' => true, | |
'single_line_comment_style' => true, | |
'single_quote' => true, | |
'space_after_semicolon' => true, | |
'standardize_not_equals' => true, | |
'switch_case_semicolon_to_colon' => true, | |
'switch_case_space' => true, | |
'ternary_operator_spaces' => true, | |
'trailing_comma_in_multiline_array' => true, | |
'trim_array_spaces' => true, | |
'unary_operator_spaces' => true, | |
'visibility_required' => true, | |
'whitespace_after_comma_in_array' => true, | |
]) | |
->setLineEnding("\n") | |
->setFinder($finder); | |
// vim: ft=php |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The standards of laravel do not carry a space before the comments @return In addition to carrying two spaces after @param
How can I correct this?