From time to time, we'll deprecate and then remove functionality. This is not done lightly, and is normally a means to help move the project forward in a way that the old functionality is at odds with. We do this in a controlled way, to minimise disruption and give users plenty of time to adapt to the change.
Assuming a current major version of N:
- A minor version (e.g.
N.x.x) is released with the deprecation. This will normally involve:- A
@deprecatedcomment in our code and types, which IDEs and other tools will recognise - A runtime warning the first time the deprecated functionality is invoked, where possible
- A
- Later, a major version (e.g.
N+1.0.0) is released; the deprecation is highlighted in the release notes - Later still, another major version (e.g.
N+2.0.0) is released with the deprecated functionality removed
Deprecated in 8.7.0, will be removed in 10.0.0.
The Cli class is used internally to represent an instance of the command-line program invoked via cucumber-js. It can be used to run Cucumber programmatically, but is poorly suited for this.
To adapt, pivot to the runCucumber function from the JavaScript API, or raise an issue if you feel your use case isn't catered for.
Deprecated in 8.3.0, will be removed in 10.0.0.
defineStep is a way to generically define a step without tying it to any of the Given, When or Then keywords. This leads to ambiguity in the business language and is considered an antipattern; steps should be clearly applicable to one of those keywords, being a context, action or outcome respectively.
To adapt, review your steps and define them with the appropriate keyword, or just switch to Given as a starting point. We're working on adding an opt-in "strict mode" for keywords which will yield an error when the keyword in the Gherkin text doesn't match that of the step definition, and could be used to pinpoint such issues in your project.
Deprecated in 8.0.0, will be removed in 10.0.0.
parseGherkinMessageStream is a way to process a stream of envelopes from Gherkin and resolve to an array of filtered, ordered pickle Ids. Its interface includes internal implementation details from Cucumber which are difficult to assemble.
To adapt, pivot to the loadSources function from the JavaScript API, or raise an issue if you feel your use case isn't catered for.
Deprecated in 8.7.0, will be removed in 10.0.0.
The PickleFilter class is used to provide a filter to the parseGherkinMessageStream function above.
To adapt, pivot to the loadSources function from the JavaScript API, or raise an issue if you feel your use case isn't catered for.
Deprecated in 8.7.0, will be removed in 10.0.0.
The Runtime class is used internally to represent an instance of the serial test case runner. Its interface includes internal implementation details from Cucumber which are difficult to assemble.
To adapt, pivot to the runCucumber function from the JavaScript API, or raise an issue if you feel your use case isn't catered for.
For deprecations that have been completed (i.e. the functionality removed), see UPGRADING.md.