Php-cs-fixer: Missing docs for creating custom fixers
In documentation, there are no information about creating custom fixers whatsoever. We had a really tough time figuring out what is wrong with our custom fixers after upgrading from 1.* to 2.*. I have created new pull request for adding information about configuration changes in UPGRADE.md but I believe that basic tutorial for creating custom fixers in documentation could be very useful.
topidocumentation
vitek-rostislav
👍1
All 3 comments
To clarify the situation: There already is doc/COOKBOOK-FIXERS.md file that explains how to develop a new fixer but it focuses on creating internal fixers.
The documentation currently lacks two points:
- How to register and enable a custom fixer
- The convention for return value of
getName()method of custom fixers - see FixerNameValidator which says that custom fixer name must be in format:FirstPart/second_partbut comment in FixerInterface says just that the name should be all lowercase.
sustmi
on 25 Oct 2017
👍2
Hi ;)
Looks like some valid points,
could you please send a PR ?
keradus
on 26 Oct 2017
Hi, I believe so, but it will probably take a while :)
vitek-rostislav
on 26 Oct 2017
❤1
Was this page helpful?
0 / 5 - 0 ratings
Related issues
UksusoFF
路
3Comments
Bilge
路
3Comments
teohhanhui
路
3Comments
sennewood
路
3Comments
carusogabriel
路
3Comments
Most helpful comment
To clarify the situation: There already is doc/COOKBOOK-FIXERS.md file that explains how to develop a new fixer but it focuses on creating internal fixers.
The documentation currently lacks two points:
getName()method of custom fixers - see FixerNameValidator which says that custom fixer name must be in format:FirstPart/second_partbut comment in FixerInterface says just that the name should be all lowercase.