docs: revise Cucumber format option #3024
Conversation
|
Deploy preview ready for 3024! |
|
Deploy preview ready for 3024! |
1 similar comment
|
Deploy preview ready for 3024! |
| :::warning | ||
| Cucumber deprecated the previous `format` configuration without quotes in version **9.6.0** and will remove it in **11.0.0** or later. | ||
| If you're still using a `format` setting without quotes, migrate to the latest pattern. | ||
| For more details, see the [Cucumber.js Deprecations documentation](https://github.com/cucumber/cucumber-js/blob/main/docs/deprecations.md#ambiguous-colons-in-formats). | ||
|
|
||
| The `file://my_formatter/implementation:output_file` is an example of ambiguous colon usage and is not allowed in Sauce Labs now. You should migrate to the quoted pattern. | ||
| ::: |
There was a problem hiding this comment.
I think this level of detail makes things a little more confusing. Also, I'm not entirely sure what's written here is correct. The deprecation docs says:
Cucumber tries to detect and handle things like Windows drives and file:// URLs on a best-effort basis, but this logic is being removed
And that suggests to me its not unquoted values that will be deprecated, its the logic to handle ambiguous colons.
Plus if the runner handles all the quoting anyways, does the user need to know all this?
There was a problem hiding this comment.
hmm.. I agree adding this specific case here is confusing. But I have no idea whether I should point out the file://my_formatter/implementation:output_file can't be used anymore if some users did set it before. At least this is a breaking change. Besides, I don't want to put it in the YAML example to explicitly let them know there is a "file://" option, which could be potential issue.
How about we just mention Cucumber deprecated the previous format and leave a link to their docs? And use the latest pattern in our YAML example.
|
Deploy preview ready for 3024! |
There was a problem hiding this comment.
@tianfeng92 Do we actually need to update the docs on this?
Having to explicitly quote all this is pretty annoying as a user. And you already added the convenient logic in the runner that auto quotes for the user. So technically speaking, as long as our own users are using the upcoming runner, they won't really have to do any changes in our configuration going forward.
Description
Update docs for Cucumber
formatconfig after cucumber deprecated the no quote option.Motivation and Context
Types of Changes