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

Add named export for CucumberHtmlStream #320

Merged
merged 2 commits into from
Aug 5, 2024

Conversation

davidjgoss
Copy link
Contributor

@davidjgoss davidjgoss commented Aug 3, 2024

🤔 What's changed?

Adds a named export CucumberHtmlStream, which was previously (and still is but deprecated) the default export.

⚡️ What's your motivation?

Currently the implementation of this formatter is split between here (the stream and template) and cucumber-js (forwarding messages, rewriting attachments). As we move to the new model with formatters as plugins, we'll shift the implementation left to here, and we'll want it to be the default export since that will be the standard for plugins. So, moving the stream to a separate named export now to give consumers a chance to switch and avoid a hard breaking change down the line.

🏷️ What kind of change is this?

  • 🏦 Refactoring/debt/DX (improvement to code design, tooling, 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.

@davidjgoss davidjgoss merged commit 5ea8e16 into main Aug 5, 2024
13 checks passed
@davidjgoss davidjgoss deleted the feat/js-stream-named-export branch August 5, 2024 20:16
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.

1 participant