-
-
Save maxalmonte14/07dcfb3c91139a2b761da7a5d001f1c0 to your computer and use it in GitHub Desktop.
php-cs-fixer PSR-2 git pre commit hook
This file contains hidden or 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 | |
return PhpCsFixer\Config::create() | |
->setRules(array( | |
'@PSR2' => true, | |
'array_syntax' => array('syntax' => 'short'), | |
'combine_consecutive_unsets' => true, | |
'method_separation' => true, | |
'no_multiline_whitespace_before_semicolons' => true, | |
'single_quote' => true, | |
'binary_operator_spaces' => array( | |
'align_double_arrow' => false, | |
'align_equals' => false, | |
), | |
// 'blank_line_after_opening_tag' => true, | |
// 'blank_line_before_return' => true, | |
'braces' => array( | |
'allow_single_line_closure' => true, | |
), | |
// 'cast_spaces' => true, | |
// 'class_definition' => array('singleLine' => true), | |
'concat_space' => array('spacing' => 'one'), | |
'declare_equal_normalize' => true, | |
'function_typehint_space' => true, | |
'hash_to_slash_comment' => true, | |
'include' => true, | |
'lowercase_cast' => true, | |
// 'native_function_casing' => true, | |
// 'new_with_braces' => 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' => array( | |
'curly_brace_block', | |
'extra', | |
'parenthesis_brace_block', | |
'square_brace_block', | |
'throw', | |
'use', | |
), | |
// 'no_leading_import_slash' => true, | |
// 'no_leading_namespace_whitespace' => true, | |
// 'no_mixed_echo_print' => array('use' => 'echo'), | |
'no_multiline_whitespace_around_double_arrow' => 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_whitespace_before_comma_in_array' => true, | |
'no_whitespace_in_blank_line' => true, | |
// 'normalize_index_brace' => true, | |
'object_operator_without_whitespace' => true, | |
// 'php_unit_fqcn_annotation' => true, | |
// 'phpdoc_align' => true, | |
// 'phpdoc_annotation_without_dot' => true, | |
// 'phpdoc_indent' => true, | |
// 'phpdoc_inline_tag' => true, | |
// 'phpdoc_no_access' => true, | |
// 'phpdoc_no_alias_tag' => true, | |
// 'phpdoc_no_empty_return' => true, | |
// 'phpdoc_no_package' => true, | |
// 'phpdoc_no_useless_inheritdoc' => true, | |
// 'phpdoc_return_self_reference' => true, | |
// 'phpdoc_scalar' => true, | |
// 'phpdoc_separation' => true, | |
// 'phpdoc_single_line_var_spacing' => true, | |
// 'phpdoc_summary' => true, | |
// 'phpdoc_to_comment' => true, | |
// 'phpdoc_trim' => true, | |
// 'phpdoc_types' => true, | |
// 'phpdoc_var_without_name' => true, | |
// 'pre_increment' => true, | |
// 'return_type_declaration' => true, | |
// 'self_accessor' => true, | |
// 'short_scalar_cast' => true, | |
'single_blank_line_before_namespace' => true, | |
// 'single_class_element_per_statement' => true, | |
// 'space_after_semicolon' => 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, | |
)) | |
//->setIndent("\t") | |
->setLineEnding("\n") | |
; |
This file contains hidden or 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
#!/usr/bin/env bash | |
CONFIG_FILE="path/to/.php_cs/file" | |
echo "php-cs-fixer pre commit hook start" | |
PHP_CS_FIXER="path/to/php-cs-fixer/file" | |
HAS_PHP_CS_FIXER=false | |
if hash php-cs-fixer 2>/dev/null; then | |
HAS_PHP_CS_FIXER=true | |
fi | |
if $HAS_PHP_CS_FIXER; then | |
git status --porcelain | grep -e '^[AM]\(.*\).php$' | cut -c 3- | while read line; do | |
$PHP_CS_FIXER fix --config=$CONFIG_FILE --verbose "$line"; | |
git add "$line"; | |
done | |
else | |
echo "" | |
echo "Please install php-cs-fixer, e.g.:" | |
echo "" | |
echo "composer global require friendsofphp/php-cs-fixer" | |
echo "" | |
fi | |
echo "php-cs-fixer pre commit hook finish" |
Thanks! it is a good hook.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Instructions to get working:
1 - Be sure you have globally installed the friendsofphp/php-cs-fixer package, If you don't just type
composer global require friendsofphp/php-cs-fixer
.2 - Put the
.php_cs
anywhere you like, also you can comment/uncomment any rule you want.3 - Put the
pre-commit
file into the.git/hooks
folder of the project you want.4 - Replace the
CONFIG_FILE
variable value to point at your.php_cs
file, for example/c/Users/maxalmonte14/projects/awesome-project/.vscode/.php_cs
5 - Replace the PHP_CS_FIXER variable value to point at your
php-cs-fixer
executable, for example/c/Users/maxalmonte14/AppData/Roaming/Composer/vendor/bin/php-cs-fixer
6 - You're done, enjoy!