Formatter - how to disable - removal of new line at EOF? - PHP Tools Community Forum

Formatter - how to disable - removal of new line at EOF?

ItsReddi

Hi,
some rule, seems to remove new lines at the end of file.
I tried to find any logs, to see, what rules are applied, but no success.

1) Where can i find that logs to find rules myself?

2) Which rule should we disable to keep the lines at EOF?

To clarify in pictures. This line should not be removed:

CSFixerRule, that would apply the new line:
PhpCsFixer\Fixer\Whitespace\SingleBlankLineAtEofFixer

MiloslavBeno

Hello,

Thank you for your post.

You're right, our formatter was removing the trailing lines by default and I think it should not do that. We're going to change that.

For now, there is a setting 'Files: Insert Final Newline'. It's not exactly what you want, but it might help.

To answer your question where you can find rules. You can open workspace settings and check the rules directly in the UI

Thank you

ItsReddi

MiloslavBeno For now, there is a setting 'Files: Insert Final Newline'. It's not exactly what you want, but it might help.

Thanks the workaround helps.

MiloslavBeno To answer your question where you can find rules. You can open workspace settings and check the rules directly in the UI

The question was about the logs from the formatter, to be able to find a rule to find a particular behavior.
Would be helpful, to trackdown such issues -
a) which format setting is doing xY
b) is the devsense extension doing it or any other extension..

As an example... the formatter could output a log each time it has formatted somenthing including the rules that changed something.

 11) tests/Feature/Http/Controllers/V1/UpdateTaskTest.php

    ---------- begin diff ----------
@@ -131,7 +131,9 @@
     $task = Task::factory()->create();
     $taskId = $task->id;

-    $patchData = ['title' => 'Patched Title'];
+    $patchData = [
+        'title' => 'Patched Title',
+    ];

     // Act
     $response = $this->patchJson(route('tasks.update', $taskId), $patchData);
@@ -141,10 +143,12 @@
     testAgainstSpec('patch', route('tasks.update', $taskId), $response, 'openapi.yaml');

     $putData = $task->getAttributes();
-    $putData = array_merge($putData, ['title' => 'Putted Title']);
+    $putData = array_merge($putData, [
+        'title' => 'Putted Title',
+    ]);
     $response = $this->putJson(route('tasks.update', $taskId), $putData);
     $response->assertStatus(204);

     //Will Throw an error if the response does not match the spec
     testAgainstSpec('put', route('tasks.update', $taskId), $response, 'openapi.yaml');
-});
\ No newline at end of file
+});
    ----------- end diff -----------


Applied checkers:

 * PhpCsFixer\Fixer\ControlStructure\TrailingCommaInMultilineFixer
 * PhpCsFixer\Fixer\Whitespace\ArrayIndentationFixer
 * PhpCsFixer\Fixer\Whitespace\SingleBlankLineAtEofFixer
 * Symplify\CodingStandard\Fixer\ArrayNotation\ArrayOpenerAndCloserNewlineFixer

MiloslavBeno

Hello,

Thanks for the idea. We'll discuss that.

Btw. the latest update maintains the final new lines as they were, so no default trimming takes place.

Thank you