Help with rules for method chain indentation

[mzur]

Hi all, I'm in the process of setting up the CS Fixer in my project and have a question regarding method chain indentation. Maybe there is no set of rules that matches the way I did things before or I just couldn't find the correct rules.

Here are examples for the changes that CS Fixer wants to apply to my code:

         $this->putJson('/api/v1/import/abc123', [
-                'parent_conflicts' => [1 => 'import', 2 => 'existing'],
-            ])
+            'parent_conflicts' => [1 => 'import', 2 => 'existing'],
+        ])
             ->assertStatus(200);

         $parentConflicts = $mergeLabels->filter(function ($label) {
-                return array_key_exists('conflicting_parent_id', $label);
-            })
+            return array_key_exists('conflicting_parent_id', $label);
+        })
             ->each(function ($label) use ($parentConflictResolution) {

So basically with a multi-line array or a closure, CS Fixer wants to unindent the part to the same level than the original method call. However, I would like this to be on the same level than the following method in the chain. Can this be accomplished somehow? My configured CS Fixer rules are below.

[
    '@PSR2' => true,
    'ordered_imports' => true,
    'single_space_around_construct' => true,
    'array_indentation' => true,
    'array_syntax' => ['syntax' => 'short'],
    'combine_consecutive_unsets' => true,
    'class_attributes_separation' => ['elements' => ['method' => 'one', ]],
    'no_whitespace_before_comma_in_array' => true,
    'unary_operator_spaces' => true,
    'whitespace_after_comma_in_array' => true,
    'method_chaining_indentation' => true,
]

[Wirone]

Did you try this?

$this
    ->putJson('/api/v1/import/abc123', [
        'parent_conflicts' => [1 => 'import', 2 => 'existing'],
    ])
    ->assertStatus(200);

The problem here is caused by array_indentation, not method_chaining_indentation itself. Since second argument of putJson() is an multiline array, it finds the initial indentation of the line (not opening [), which is $this', and tries to align the rest to it. If you add new line for the first call in the chain, it works properly:

I am not sure if we should consider this as a bug in array_indentation 🤔...

[mzur]

Thanks! And do you have an idea what happens with the second example which is not an array?

[Wirone]

It's moved by statement_indentation with exactly the same reason - it finds initial indentation for {, which in fact is taken from $parentConflicts' (beginning of the line). You can always print which fixer were applied when you add --verbose flag 🙂.

You may be interested in use_arrow_functions, because with one-line arrow function it won't be indented incorrectly.

For multiline closures you would need move ->filter() to new line.

[mzur]

Thanks again! The arrow function would work here but I also have cases that don't fit into an arrow function.

So it looks like both issues would be fixed with a newline after $this or the other variable. I could live with this as a coding style in my code base. Is there by any chance a CS Fixer rule for this? 🙂

[Wirone]

I'm afraid we don't have rule for enforcing new line for chained calls. Depending on the amount of affected places in your codebase, I would try running Fixer, then add new line where code was "fixed" and then re-run fixer again, so indentation would become correct. If there are too many occurrences, I would try find & replace based on regex in IDE.

[mzur]

Thanks a lot for the quick help!