Fix indentation of PHP code files with php-cs-fixer - Stack Overflow
What tools do you use to format code style in your company?
Laravel with php-cs-fixer and IDE formatting
What is the most common PHP code formatter?
Videos
Hi everyone,
I’ve been using chatGPT to assist me with my php/mysql CRUD app. I have some JS mixed in where needed. ChatGPT’s gotten me along to a point but seems to be a little more limited as the code gets more complicated. So, what AI assistant are you using to help with your PHP coding?
Are there different tools you use in series to create and change the code into a finished product?
You should use braces fixer to force indentation.
The body of each structure MUST be enclosed by braces. Braces should be properly placed. Body of braces should be properly indented.
indentation_type simply enforces consistency.
But since both the fixers are already included in @PSR2 so the code should be fixed correctly.
See the relevant sections in the README.
Using your code php-cs-fixer 2.6 produces the following code
<?php
$test= "abc";
$additional_studs = "";
if (date('m') == 12 and $term='SP') {
$yr_suffix = date('y') + 1;
} else {
$yr_suffix = date('y');
}
function dup_stud($id, $conn)
{//...
}
$i = 0;
where the indentation is only partly fixed.
I reduced it to the code below
<?php
echo "a";
echo "b";
echo "c";
It looks like a bug in php-cs-fixer.
I will answer my own question based on the findings that led me to a resolution.
While the formatting basically worked, the catch for me was the indentation. If there were some leading spaces or tabs, certain lines kept sticking out after the fix.
Since neither php-cs-fixer nor phpcbf was able to fix the indentation properly I took desperate measures and trimmed every leading whitespace from each line as preparatory step with sed in a script like this:
sed "s/^[ \t]*//" -i test.php
Then I processed some prepped files again with php-cs-fixer and phpcbf to find out which one does a better job formatting the files according to PSR-2. It's shameful, but both fixers failed again - now showing some different shortcomings (i.e. bugs). To cut a long story short, I finally learnt that coupling the two tools leads to properly formatted code files. What a mess.
So, after sed, I run phpcbf
phpcbf --standard="PSR2" test.php
followed by
php-cs-fixer fix test.php --rules=@PSR2
And all the sudden I have beautifully PSR-2 formatted PHP files. Not the most efficient way, but it does the job.
Some additional comments:
- If you would like to apply additional fixer rules, I would suggest to do this in a 4th step using a different, more complete php_cs configuration from a PSR-2 baseline formatting (because, you know, there are more fixer issues..).
- I suggest to use 4 spaces as indent, as required by PSR-2. According to my experience things get even more complicated if you insist to have tabs.
- The described procedure wouldn't be necessary if php-cs-fixer and phpcbf would not have so many issues. I will report them one after another, and hopefully, in the future the same can be achieved in one go.
In our company, we use the PhpStorm formatter. We have a codeStyle.xml file in our gitlab repository. Every PHP developer downloads it and configures PhpStorm with it. They run formatting locally before commit. We had a PhpStorm docker image that ran on CI and checked the code style.
PhpStorm has a great formatting tool, but:
it's hard to create a docker image with a license to use CI formatting
it's very slow compared to other formatting tools
some PHP developers prefer another IDE than PhpStorm
I have seen PHP-CS-Fixer and PHP_CodeSniffer but it doesn't have as many settings as PhpStorm.
What tools do you use to format code style in your company?