search

DoneDeal0 / superdiff

Superdiff compares two arrays or objects and returns a full diff of their differences in a readable format.
https://www.npmjs.com/package/@donedeal0/superdiff
439 stars 3 forks source link

make changes backward compatible between minor releases #13

Closed AlexisAnzieu closed 1 year ago

AlexisAnzieu commented 1 year ago

Hey, Glad to see that the project is receiving continuous improvement!

I am using this lib in a CI / CD pipeline, so changing discardArrayOrder to ignoreArrayOrder in the last update broke the flow. Would it be possible to keep parameter names backward compatible between minor releases? Not a big deal but im wondering if we could beneficiate of code improvement without being worried about breaking change.

Thanks a lot!

DoneDeal0 commented 1 year ago

Hi @AlexisAnzieu,

First of all, thank you so much for the 3 coffees you bought to support Superdiff, I really appreciate it 👍!

As for the upgrade, I'm sorry it broke your pipeline. I always make sure to publish a note with a list of breaking changes for each release. I thought renaming discardArrayOrder to ignoreArrayOrder was necessary because the wording was poorly chosen. To avoid too frequent updates, I decided to include this change in v1.0.9.

However, I can assure you that I don't plan to introduce any more breaking changes in the future. You can use the current and upcoming versions of Superdiff with complete peace of mind^^.

Again, my apologies for the inconvenience.

AlexisAnzieu commented 1 year ago

Sounds great! Thank you 🙏