Php-cs-fixer: blank_line_before_statement fails with array of values

Created on 2 Mar 2018  ·  2Comments  ·  Source: FriendsOfPHP/PHP-CS-Fixer

Changing the configuration for blank_line_before_statement to something else than true I get the following error:

Loaded config default from ".php_cs".
Using cache file ".php_cs.cache".

In AbstractFixer.php line 146:
  [blank_line_before_statement] Invalid configuration: The options "0", "1", "2", "3", "4", "5" do not exist. Defined options are: "st
  atements".

In OptionsResolver.php line 667:
  The options "0", "1", "2", "3", "4", "5" do not exist. Defined options are: "statements".
````


#### The PHP version you are using (`$ php -v`):
7.0.24

#### PHP CS Fixer version you are using (`$ php-cs-fixer -V`):
2.10.3

#### The command you use to run PHP CS Fixer:
php-cs-fixer fix --config=".php_cs" myfile.php

#### The configuration file you are using, if any:
```php
<?php

return PhpCsFixer\Config::create()
    ->setRules(array(
        '@PSR2' => true,
        'array_syntax' => array('syntax' => 'long'),
        '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' => false,
        'blank_line_before_statement' => array(
            'break', 'continue', 'declare', 'return', 'throw', 'try'
        ),
        'braces' => array(
            'allow_single_line_closure' => true,
            'position_after_control_structures' => 'same',
            'position_after_functions_and_oop_constructs' => 'same'
        ),
        // 'cast_spaces' => true,
        // 'class_definition' => array('singleLine' => true),
        'concat_space' => array('spacing' => 'one'),
        'declare_equal_normalize' => array('space' => 'single'),
        '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")
;
kinquestion

All 2 comments

true means "default configuration". If you want to use your own configuration, you must pass an array with option names as keys, i.e.:

'blank_line_before_statement' => [
    'statements' => ['break', 'continue', 'declare', 'return', 'throw', 'try'],
]

Ah okay, you need to return an array with a statements key which holds the actual statements. The documentation is a bit opaque, and the error message does not really point to what "statements" are either.

This solves it for me when I try with the syntax you point out.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

amitbisht511 picture amitbisht511  ·  3Comments

BackEndTea picture BackEndTea  ·  3Comments

UksusoFF picture UksusoFF  ·  3Comments

ndench picture ndench  ·  3Comments

kcloze picture kcloze  ·  3Comments