DX: new config filename

[keradus]

old files are still allowed. will be disallowed with upgrade msg in #5609

[mvorisek]

I propose .php_cs.php and .php_cs.local.php

[keradus]

dist is common pattern for other tools, let's not introducing something new
php_cs was constantly confused with CodeSniffer, let's get rid of that once and for all

[coveralls]

Coverage decreased (-0.007%) to 91.886% when pulling c704d13 on keradus:new_config_format into 3dff24b on FriendsOfPHP:master.

[mvorisek]

But .local. can be much easily ignored in .gitignore, .php_cs (or new equivalent) has priority over dist, but this name is very often not ignored thus not helpful. Let's think big and set the new standard 🚀 🍾

Example of universal & easily understandable .gitignore with good naming:

local
*.local
*.local.*
cache
*.cache
*.cache.*

[julienfalque]

Do we actually need to support having a "dist" file though? I never saw a valid use case and still fail to imagine one.

[mvorisek]

Do we actually need to support having a "dist" file though? I never saw a valid use case and still fail to imagine one.

That is the case. We should be simple filename (without dist) and optionally support one prioritized name for local override.

See my suggestion: https://github.com/FriendsOfPHP/PHP-CS-Fixer/pull/5609/files#r609648455

[julienfalque]

That is the case.

Please elaborate :)

[mvorisek]

That is the case.

Please elaborate :)

see above, dist was used to support local override, but naming is not optimal and thus requires this explanation :) Therefore I think https://github.com/FriendsOfPHP/PHP-CS-Fixer/pull/5609/files#r609648455 is better and allow also more generic exclude, see #5607 (comment)

[julienfalque]

I know it allows local override, but why is that needed? The point of this tool is to enforce consistent code style between multiple code contributors. When would one need to diverge from that locally (i.e. apply a different code style)?

[mvorisek]

I know it allows local override, but why is that needed? The point of this tool is to enforce consistent code style between multiple code contributors. When would one need to diverge from that locally (i.e. apply a different code style)?

I belive to support one DEFAULT local/prioritized name, ie. one name that does not have to be specified explicitly to override the config.

[keradus]

@julienfalque , i know you are not in favour of multiple config files approach ;)

what is dist for: https://stackoverflow.com/a/44764078
don't like dist, don't use it ;) symfony/recipes#41 (comment)

[KacerCZ]

@mvorisek Use of dist (short from 'distribute') configurations is common in PHP tools. I don't think it is good idea to change this pattern unless you want to change it in all other tools also.

@julienfalque My typical use case for local and dist config is introduction of new rules to project.
Repository contains only dist configuration and CI uses it to check code.
My local configuration is copy of dist with one or more rules enabled.
So when I modify code it allows me to fix more errors.
I don't have time to fix all errors at once (specially risky rules).

[mvorisek]

want to change it in all other tools also

I would be happy to do so witch CS Fixer taking the lead :)