Style scheme for PHP Storm

luceos

I was sick and tired of all the nitpick comments on my PR's, now that StyleCI has joined the regiments on that side, I decided to set up a style setting for Flarum in PHP Storm.

You can find it as gist: https://gist.github.com/Luceos/063c15027f2433f87063

Just save the file and use it from your settings > Editor > Code Style > PHP > manage > import

You can now more safely use the Code > Reformat Code option to match the choosen format of Flarum.

Please note this does not cover the javascript formatting.

jordanjay29

FYI, this is in an XML format while PHP Storm seems to only accept JSCS files to import.

Kyrne

Holy crap, glad I found this, StyleCI PRs are super annoying.

Is there a way I can get it to recognize Flarum and get auto complete?

luceos

Kyrne no there is not. In addition I haven't been using the above style settings for ages. The Flagrow projects (and professional projects) I work on all use the native PSR-2 standard you can select inside PHPstorm.

I'm still hoping @Toby or @Franz will one day enable auto StyleCI patches ?

Kyrne

luceos Same, I try to use PSR-1/2 as much as possible. That's one of the reasons I love PHPstrom and JetBrains in general.

Toby

luceos I'm still hoping @Toby or @Franz will one day enable auto StyleCI patches ?

@Franz are you happy for this? My only concern would be the rare occasion where styleci might break something, but I don't think this has ever happened and probably won't ever happen.

Toby

luceos For the record, Flarum's style is PSR-2 plus additional rules. Because PSR-2 isn't really specific enough to enforce much consistency.

Franz

Toby If it truly annoys contributors, then sure. (Although I don't like the idea of giving such a bot direct push access).

luceos

Franz
Toby

I had the same anxiety about those permissions, so far they have never become true nor has it caused issues. Having it patch even simple PR's automatically is a breather.

I understand the additional settings you, for the core team love to have. And it's valid for you to enforce them. But having to set up these settings can be frustrating if you are used to one specific style or not familiar with style settings in general. Taking away these constraints for contributors is very simple with StyleCI and would possibly increase adoption.

Kyrne

luceos if it automatically patches it, contributers don't even have to worry about it, they can code as horribly as they want to (not saying it's a good thing).