Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: deprecate things from the entry point #2136

Merged
merged 16 commits into from
Oct 16, 2022
Merged

Conversation

davidjgoss
Copy link
Contributor

@davidjgoss davidjgoss commented Sep 9, 2022

🤔 What's changed?

  • Several things newly deprecated, where use cases are better served by the new JavaScript API
    • Cli
    • PickleFilter
    • Runtime
  • Standardised the way we deprecate things - many of them are still used internally (for now) and we just want to stop exposing them to consumers, so we handle the deprecations on the entry point
  • Documented the deprecations and what our process is

⚡️ What's your motivation?

We need to pare down what's exported so we can funnel people to use the new API and we can be free to refactor internals which currently difficult with things like Cli and Runtime being effectively part of the interface contract.

🏷️ What kind of change is this?

  • 🏦 Refactoring/debt/DX (improvement to code design, tooling, documentation etc. without changing behaviour)

📋 Checklist:

  • I agree to respect and uphold the Cucumber Community Code of Conduct
  • I've changed the behaviour of the code
    • I have added/updated tests to cover my changes.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
  • Users should know about my change
    • I have added an entry to the "Unreleased" section of the CHANGELOG, linking to this pull request.

This text was originally generated from a template, then edited by hand. You can modify the template here.

@coveralls
Copy link

coveralls commented Sep 9, 2022

Coverage Status

Coverage increased (+0.002%) to 98.255% when pulling 954340d on deprecations-before-9 into 7f43644 on main.

@davidjgoss davidjgoss marked this pull request as ready for review September 10, 2022 07:56
@davidjgoss davidjgoss merged commit 6081893 into main Oct 16, 2022
@davidjgoss davidjgoss deleted the deprecations-before-9 branch October 16, 2022 10:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants