Add "Writing a custom Behat formatter" cookbook #149
Conversation
There was a problem hiding this comment.
@jdeniau thanks very much for this, it's a great addition to the documentation.
I've made some suggestions for style / grammar things that it would be good to fix - I feel bad picking them out, as there's no way I could write anything like this in French!
If you're OK with my suggestions I'd be happy to apply them for you.
|
@acoulton do not feel bad, English is not my main language and I make a lot of errors. I make typos too 🙂 I'm OK with all your suggestions. I'm not on a computer right now, so if you want to make the changes yourself no problem for me. If not, I will commit this in the next days. |
There was a problem hiding this comment.
It's a really good addition. The only changes I'd request would be to replace "behat" with "Behat" and try and stay away from terms like "simple" when trying to explain a step. It's not a "must solve" on my end, but something that's simple to a lot of people might not be simple for others.
|
Thanks @ttomdewit I missed some of the I'll take another pass later unless @jdeniau gets there first. |
acoulton
force-pushed
the
behat-formatter-cookbook
branch
from
8223594
to
fb03842
Compare
|
@ttomdewit I pulled it into my IDE to find and replace all the lowercase |
| - any stdin, coupled with an "errorformat" (a Vim inspired format that can convert text string to machine-readable errors), | ||
| - a `"Reviewdog Diagnostic Format" <https://github.com/reviewdog/reviewdog/tree/48b25a0aafb8494e751387e16f729faee9522c46/proto/rdf>`__: a JSON with error data that reviewdog can parse. | ||
|
|
||
| In my case, I tried parsing Behat's output with errorformat, but I do not know this language, and the multi-line Behat output with "dots" didn't make it easy. |
There was a problem hiding this comment.
I don't think the documentation should by using I here. this looks fine for a blog post (where I refers to the author of the post), but not so much for documentation.
| * | ||
| * There are a lot of other events that can be found here in the Behat\Testwork\EventDispatcher\Event class | ||
| */ | ||
| public static function getSubscribedEvents() |
There was a problem hiding this comment.
| public static function getSubscribedEvents() | |
| public static function getSubscribedEvents(): array |
This way, this will be compatible with the next major version of Symfony which will make the return type mandatory.
| Create the extension | ||
| ~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Any Behat extensions must implement ``Behat\Testwork\ServiceContainer\Extension``. Under the hood, it implements Symfony ``CompilerPass``. |
There was a problem hiding this comment.
I would remove the mention of CompilerPass here, especially as the extension in this example implements an empty process method (which is the only method related to CompilerPass)
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace JDeniau\BehatReviewdogFormatter; |
There was a problem hiding this comment.
I would suggest using a generic namespace instead of your own namespace here, as this is going to be rendered in the official Behat documentation. #146 used HelloWorld as namespace
|
|
||
| default: | ||
| extensions: | ||
| JDeniau\BehatReviewdogFormatter\ReviewdogFormatterExtension: ~ |
There was a problem hiding this comment.
if you put your extension class in a ServiceContainer subnamespace, with a name matching the last section of your namespace, this unlocks using the shortcut.
|
|
||
| That's how you can write a basic custom Behat formatter! | ||
|
|
||
| If you have much more complex logic, and you need the formatter to be more dynamic, Behat do provide a FormatterFactory interface. |
There was a problem hiding this comment.
| If you have much more complex logic, and you need the formatter to be more dynamic, Behat do provide a FormatterFactory interface. | |
| If you have much more complex logic, and you need the formatter to be more dynamic, Behat provides a FormatterFactory interface. |
Fixes #143