Official PHP formatting configuration for Flarum development

rafaucau

Whenever I make a Pull Request to Flarum or any extension, I struggle with PHP code formatting. Currently, Flarum uses StyleCi, which reports formatting errors only after creating a Pull Request. It would be good to replace StyleCi with something that works directly in the IDE. For the frontend, Flarum has a Prettier configuration (https://www.npmjs.com/package/@flarum/prettier-config).
Laravel Pint (https://laravel.com/docs/10.x/pint) could be used for backend. The configuration is quite simple and involves defining formatting rules in a pint.json file. This way, code can be formatted locally and formatting can be checked in Github Actions during Pull Requests using the same configuration.
https://www.jetbrains.com/help/phpstorm/using-laravel-pint.html

luceos

rafaucau Currently, Flarum uses StyleCi, which reports formatting errors only after creating a Pull Request

I was under the impression we had set up StyleCI to automatically correct formatting and thus there is no need for contributors to adhere to our conventions, as long as code is somewhat readable that is.

Darkle

I remembered a PR on this topic, here is some additional info flarum/framework3871