Skip to content

Commit

Permalink
Enhancement: Add rule set for PHPUnit
Browse files Browse the repository at this point in the history
  • Loading branch information
localheinz committed Dec 18, 2020
1 parent 0109e4a commit edefb8a
Show file tree
Hide file tree
Showing 4 changed files with 719 additions and 0 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

For a full diff see [`2.7.0...main`][2.7.0...main].

### Changed

* Added `Ergebnis\PhpCsFixer\Config\RuleSet\PhpUnit`, a rule set for `phpunit/phpunit` ([#300]), by [@localheinz]

## [`2.7.0`][2.7.0]

For a full diff see [`2.6.1...2.7.0`][2.6.1...2.7.0].
Expand Down Expand Up @@ -257,6 +261,7 @@ For a full diff see [`d899e77...1.0.0`][d899e77...1.0.0].
[#289]: https://github.com/ergebnis/php-cs-fixer-config/pull/289
[#290]: https://github.com/ergebnis/php-cs-fixer-config/pull/290
[#291]: https://github.com/ergebnis/php-cs-fixer-config/pull/291
[#300]: https://github.com/ergebnis/php-cs-fixer-config/pull/300

[@dependabot]: https://github.com/apps/dependabot
[@linuxjuggler]: https://github.com/linuxjuggler
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Pick one of the rule sets:
* [`Ergebnis\PhpCsFixer\RuleSet\Php71`](src/RuleSet/Php74.php)
* [`Ergebnis\PhpCsFixer\RuleSet\Php73`](src/RuleSet/Php73.php)
* [`Ergebnis\PhpCsFixer\RuleSet\Php74`](src/RuleSet/Php74.php)
* [`Ergebnis\PhpCsFixer\RuleSet\PhpUnit`](src/RuleSet/PhpUnit.php)

Create a configuration file `.php_cs` in the root of your project:

Expand Down
355 changes: 355 additions & 0 deletions src/RuleSet/PhpUnit.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,355 @@
<?php

declare(strict_types=1);

/**
* Copyright (c) 2019-2020 Andreas Möller
*
* For the full copyright and license information, please view
* the LICENSE.md file that was distributed with this source code.
*
* @see https://github.com/ergebnis/php-cs-fixer-config
*/

namespace Ergebnis\PhpCsFixer\Config\RuleSet;

/**
* @see https://github.com/sebastianbergmann/phpunit/blob/master/.php_cs.dist
*/
final class PhpUnit extends AbstractRuleSet
{
protected $name = 'phpunit (PHP 7.4)';

protected $rules = [
'align_multiline_comment' => true,
'array_indentation' => true,
'array_push' => false,
'array_syntax' => [
'syntax' => 'short',
],
'backtick_to_shell_exec' => false,
'binary_operator_spaces' => [
'operators' => [
'=' => 'align_single_space_minimal',
'=>' => 'align_single_space_minimal',
],
],
'blank_line_after_namespace' => true,
'blank_line_after_opening_tag' => false,
'blank_line_before_statement' => [
'statements' => [
'break',
'continue',
'declare',
'default',
'die',
'do',
'exit',
'for',
'foreach',
'goto',
'if',
'include',
'include_once',
'require',
'require_once',
'return',
'switch',
'throw',
'try',
'while',
'yield',
],
],
'braces' => true,
'cast_spaces' => true,
'class_attributes_separation' => [
'elements' => [
'const',
'method',
'property',
],
],
'class_definition' => false,
'class_keyword_remove' => false,
'clean_namespace' => false,
'combine_consecutive_issets' => true,
'combine_consecutive_unsets' => true,
'combine_nested_dirname' => false,
'comment_to_phpdoc' => false,
'compact_nullable_typehint' => true,
'concat_space' => [
'spacing' => 'one',
],
'constant_case' => true,
'date_time_immutable' => false,
'declare_equal_normalize' => [
'space' => 'none',
],
'declare_strict_types' => true,
'dir_constant' => true,
'doctrine_annotation_array_assignment' => false,
'doctrine_annotation_braces' => false,
'doctrine_annotation_indentation' => false,
'doctrine_annotation_spaces' => false,
'echo_tag_syntax' => true,
'elseif' => true,
'encoding' => true,
'ereg_to_preg' => false,
'error_suppression' => false,
'escape_implicit_backslashes' => false,
'explicit_indirect_variable' => true,
'explicit_string_variable' => true,
'final_class' => false,
'final_internal_class' => false,
'final_public_method_for_abstract_class' => false,
'fopen_flag_order' => false,
'fopen_flags' => false,
'full_opening_tag' => true,
'fully_qualified_strict_types' => true,
'function_declaration' => true,
'function_to_constant' => false,
'function_typehint_space' => false,
'general_phpdoc_annotation_remove' => false,
'general_phpdoc_tag_rename' => false,
'global_namespace_import' => [
'import_classes' => true,
'import_constants' => true,
'import_functions' => true,
],
'group_import' => false,
'header_comment' => false,
'heredoc_indentation' => false,
'heredoc_to_nowdoc' => true,
'implode_call' => false,
'include' => false,
'increment_style' => [
'style' => 'post',
],
'indentation_type' => true,
'is_null' => true,
'lambda_not_used_import' => false,
'line_ending' => true,
'linebreak_after_opening_tag' => false,
'list_syntax' => [
'syntax' => 'short',
],
'logical_operators' => true,
'lowercase_cast' => false,
'lowercase_keywords' => true,
'lowercase_static_reference' => true,
'magic_constant_casing' => true,
'magic_method_casing' => true,
'mb_str_functions' => false,
'method_argument_space' => [
'ensure_fully_multiline' => true,
],
'method_chaining_indentation' => false,
'modernize_types_casting' => true,
'multiline_comment_opening_closing' => true,
'multiline_whitespace_before_semicolons' => true,
'native_constant_invocation' => false,
'native_function_casing' => false,
'native_function_invocation' => false,
'native_function_type_declaration_casing' => true,
'new_with_braces' => false,
'no_alias_functions' => true,
'no_alias_language_construct_call' => false,
'no_alternative_syntax' => true,
'no_binary_string' => false,
'no_blank_lines_after_class_opening' => true,
'no_blank_lines_after_phpdoc' => true,
'no_blank_lines_before_namespace' => true,
'no_break_comment' => false,
'no_closing_tag' => true,
'no_empty_comment' => true,
'no_empty_phpdoc' => true,
'no_empty_statement' => true,
'no_extra_blank_lines' => true,
'no_homoglyph_names' => true,
'no_leading_import_slash' => true,
'no_leading_namespace_whitespace' => true,
'no_mixed_echo_print' => [
'use' => 'print',
],
'no_multiline_whitespace_around_double_arrow' => true,
'no_null_property_initialization' => true,
'no_php4_constructor' => 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_superfluous_elseif' => true,
'no_superfluous_phpdoc_tags' => [
'allow_mixed' => 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_trailing_whitespace_in_string' => false,
'no_unneeded_control_parentheses' => true,
'no_unneeded_curly_braces' => true,
'no_unneeded_final_method' => true,
'no_unreachable_default_argument_value' => true,
'no_unset_cast' => false,
'no_unset_on_property' => true,
'no_unused_imports' => true,
'no_useless_else' => true,
'no_useless_return' => true,
'no_useless_sprintf' => false,
'no_whitespace_before_comma_in_array' => true,
'no_whitespace_in_blank_line' => true,
'non_printable_character' => true,
'normalize_index_brace' => true,
'not_operator_with_space' => false,
'not_operator_with_successor_space' => false,
'nullable_type_declaration_for_default_null_value' => false,
'object_operator_without_whitespace' => true,
'operator_linebreak' => false,
'ordered_class_elements' => [
'order' => [
'use_trait',
'constant_public',
'constant_protected',
'constant_private',
'property_public_static',
'property_protected_static',
'property_private_static',
'property_public',
'property_protected',
'property_private',
'method_public_static',
'construct',
'destruct',
'magic',
'phpunit',
'method_public',
'method_protected',
'method_private',
'method_protected_static',
'method_private_static',
],
],
'ordered_imports' => [
'imports_order' => [
'const',
'function',
'class',
],
],
'ordered_interfaces' => [
'direction' => 'ascend',
'order' => 'alpha',
],
'ordered_traits' => false,
'php_unit_construct' => false,
'php_unit_dedicate_assert' => false,
'php_unit_dedicate_assert_internal_type' => false,
'php_unit_expectation' => false,
'php_unit_fqcn_annotation' => false,
'php_unit_internal_class' => false,
'php_unit_method_casing' => false,
'php_unit_mock' => false,
'php_unit_mock_short_will_return' => false,
'php_unit_namespaced' => false,
'php_unit_no_expectation_annotation' => false,
'php_unit_set_up_tear_down_visibility' => false,
'php_unit_size_class' => false,
'php_unit_strict' => false,
'php_unit_test_annotation' => false,
'php_unit_test_case_static_method_calls' => false,
'php_unit_test_class_requires_covers' => false,
'phpdoc_add_missing_param_annotation' => false,
'phpdoc_align' => true,
'phpdoc_annotation_without_dot' => true,
'phpdoc_indent' => true,
'phpdoc_inline_tag_normalizer' => false,
'phpdoc_line_span' => false,
'phpdoc_no_access' => true,
'phpdoc_no_alias_tag' => false,
'phpdoc_no_empty_return' => true,
'phpdoc_no_package' => true,
'phpdoc_no_useless_inheritdoc' => false,
'phpdoc_order' => true,
'phpdoc_order_by_value' => false,
'phpdoc_return_self_reference' => true,
'phpdoc_scalar' => true,
'phpdoc_separation' => true,
'phpdoc_single_line_var_spacing' => true,
'phpdoc_summary' => true,
'phpdoc_tag_casing' => false,
'phpdoc_tag_type' => false,
'phpdoc_to_comment' => true,
'phpdoc_to_param_type' => false,
'phpdoc_to_return_type' => false,
'phpdoc_trim' => true,
'phpdoc_trim_consecutive_blank_line_separation' => true,
'phpdoc_types' => [
'groups' => [
'simple',
'meta',
],
],
'phpdoc_types_order' => true,
'phpdoc_var_annotation_correct_order' => false,
'phpdoc_var_without_name' => true,
'pow_to_exponentiation' => true,
'protected_to_private' => true,
'psr_autoloading' => false,
'random_api_migration' => false,
'regular_callable_call' => false,
'return_assignment' => true,
'return_type_declaration' => [
'space_before' => 'none',
],
'self_accessor' => true,
'self_static_accessor' => true,
'semicolon_after_instruction' => true,
'set_type_to_cast' => true,
'short_scalar_cast' => true,
'simple_to_complex_string_variable' => true,
'simplified_if_return' => false,
'simplified_null_return' => false,
'single_blank_line_at_eof' => true,
'single_blank_line_before_namespace' => false,
'single_class_element_per_statement' => false,
'single_import_per_statement' => true,
'single_line_after_imports' => true,
'single_line_comment_style' => false,
'single_line_throw' => false,
'single_quote' => true,
'single_space_after_construct' => false,
'single_trait_insert_per_statement' => false,
'space_after_semicolon' => false,
'standardize_increment' => false,
'standardize_not_equals' => true,
'static_lambda' => false,
'strict_comparison' => false,
'strict_param' => true,
'string_line_ending' => false,
'switch_case_semicolon_to_colon' => false,
'switch_case_space' => false,
'switch_continue_to_break' => false,
'ternary_operator_spaces' => false,
'ternary_to_elvis_operator' => false,
'ternary_to_null_coalescing' => true,
'trailing_comma_in_multiline_array' => true,
'trim_array_spaces' => true,
'unary_operator_spaces' => true,
'use_arrow_functions' => false,
'visibility_required' => [
'elements' => [
'const',
'method',
'property',
],
],
'void_return' => true,
'whitespace_after_comma_in_array' => true,
'yoda_style' => false,
];

protected $targetPhpVersion = 70400;
}
Loading

0 comments on commit edefb8a

Please sign in to comment.