Add possibility to opt-out from printing step attachments when scenario is not successful

[aurelien-reeves]

Description

Refs. #1136

I've added a scenario to show a new --format-options that would let the possibility to opt-out from the attachments being printed when a scenario is not successful.

That option is named printAttachments and is presumably true per default.

New contributors, welcome!

This is an easy one, and to help you through it, you'll find all the steps to fix that PR here: /~https://github.com/cucumber/cucumber-js/blob/17527667f70c64600adf1ac924336c64b65df66e/docs/first-time-contributor-tutorial.md

Motivation & context

Fixes #1136

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds new behaviour)

Checklist:

• My code follows the code style of this project.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• All new and existing tests passed.
• CHANGELOG has been updated

[davidjgoss]

That option is named printStepAttachments and is presumably true per default.

Given you can attach from hooks and these are also printed:

Potentially just printAttachments is a better name?

If the fix is not too complex, I plan to use this PR as a step-by-step tutorial for new contributors.

That sounds really good!

[aurelien-reeves]

@mattwynne @16sheep @artismarti any plan to go further with that one?

[aurelien-reeves]

@mattwynne @16sheep @artismarti do you plan to continue working on this?
If not, any hard feeling if I take care of it?

[artismarti]

@mattwynne @16sheep @artismarti do you plan to continue working on this? If not, any hard feeling if I take care of it?

None whatsoever, from me! :)

I had kinda forgotten about it, tbh.

[aurelien-reeves]

I'll finish implementation for that PR as it would be now difficult for a new comer to continue with this as it has been partially implemented

I hope there won't be hard feelings for this!?

[coveralls]

Coverage increased (+0.003%) to 98.13% when pulling 8bdef73 on opt-out-print-attachments-1136 into 5295a45 on main.

[artismarti]

None whatsoever! Thanks for finishing the work :)

[davidjgoss]

I think this content would sit better in formatters.md under the "Options" heading; this doc will shrink over time as we decouple config from the CLI.

[aurelien-reeves]

I have added some docs in formatters.md.
However I think keeping the one in cli.md could still be relevant?

[davidjgoss]

No problem!

[davidjgoss]

No problem!