Faire / mjml-react

React component library to generate the HTML emails on the fly
https://www.npmjs.com/package/@faire/mjml-react
MIT License
375 stars 16 forks source link

feat(simplify): prevent mjml-style from breaking css and relax type safety #78

Closed emmclaughlin closed 1 year ago

emmclaughlin commented 1 year ago

https://github.com/Faire/mjml-react/pull/38 is a rather big change that makes it difficult to migrate from mjml-react v2 to mjml-react v3. The original goal of v3 was to pick up support of mjml-react and migrate to typescript. Admittedly, we got a bit carried away and added features that make it more difficult than necessary to migrate.

This PR reverts the changes in https://github.com/Faire/mjml-react/pull/38 and makes the mjml-style backwards compatible with v2 of mjml-react. In doing so, we hope that it is easier for users to migrate to v3 of mjml-react.

We plan to start a v4 alpha branch to still allow users who want these cutting edge features, such as the type safety.

emmclaughlin commented 1 year ago

My understanding is that feat will result in a 3.1.0 release. Is that your understanding?

Should we do a revert of this and release as a 4.0.0-alpha-1 so anyone who's upgraded to version 3.0.0 can upgrade to the get typesafety?

Yes that was my plan. I'm realizing it is probably a good idea to have that 4.0.0-alpha-1 setup before moving forward with this PR, and maybe to add a migration note into the README. I will work on setting that up, unless there are any objections.

IanEdington commented 1 year ago

sounds good to me

emmclaughlin commented 1 year ago

@IanEdington v4-alpha is live for those that want to continue use of the latest features: https://www.npmjs.com/package/@faire/mjml-react/v/4.0.0-main-alpha.1

Also updated the readme to talk briefly about v3 and v4. Welcome any suggestions there

github-actions[bot] commented 1 year ago

:tada: This PR is included in version 3.1.0 :tada:

The release is available on:

Your semantic-release bot :package::rocket:

github-actions[bot] commented 1 year ago

:tada: This PR is included in version 4.0.0-main-alpha.2 :tada:

The release is available on:

Your semantic-release bot :package::rocket: