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

feat(adapter): rename config helper to createConfig #37

Merged
merged 2 commits into from
Apr 16, 2024

Conversation

tanner-reits
Copy link
Contributor

@tanner-reits tanner-reits commented Apr 12, 2024

What is the current behavior?

Helper is currently names createStencilPlaywrightConfig which is a bit wordy

GitHub Issue Number: N/A

What is the new behavior?

Renames the helper to createConfig. The util is already in context/scope of the adapter package, so don't need to worry about confusion on its purpose. Developers can alias the import if they desire.

Documentation

stenciljs/site#1398

Does this introduce a breaking change?

  • Yes
  • No

Technically, it would be, but this is a pre-1.0 experimental package.

Testing

Updated automated tests and confirmed tests execute correctly in a Stencil component starter project

Other information

@rwaskiewicz
Copy link
Contributor

FWIW, I agree this is a breaking change - it's fine to make in pre-1.0, but I think we should document this somewhere. The way I see it, we could:

  1. Create a BREAKING_CHANGES.md doc that mirrors what we have in Stencil today (although we'd have to manually update this).
  2. Wait until we do the next minor release, and put it in the GH release notes

I don't have a strong preference, although I think with everything else we're working on, it'd probably be best to collect these things somewhere in the event someone other than Tanner does the release

Copy link
Member

@christian-bromann christian-bromann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Alternatively we could keep createStencilPlaywrightConfig as an alias, deprecate it and remove it later on as a breaking change.

@tanner-reits
Copy link
Contributor Author

@rwaskiewicz I created a breaking changes file to track these for now. This might go away depending on some release tooling discovery since those tools would be able to generate changelogs for us.

@tanner-reits tanner-reits added this pull request to the merge queue Apr 16, 2024
Merged via the queue into main with commit a054d67 Apr 16, 2024
3 checks passed
@tanner-reits tanner-reits deleted the tr/rename-create-config-helper branch April 16, 2024 15:02
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.

4 participants