search

gcanti / tcomb-form

Forms library for react
https://gcanti.github.io/tcomb-form
MIT License
1.16k stars 136 forks source link

follow semver #267

Closed k-sheth closed 8 years ago

k-sheth commented 8 years ago

Thanks for making this lib. It has definitely enhanced my productivity. One suggestion would be to follow semver when publishing to npm. I just synced to 0.7.8 from 0.7.6 and all hell broke loose on my custom templates. If its a breaking change, bumping up the major rather than patch would send the right signal in terms of impact to all users.

gcanti commented 8 years ago

I just synced to 0.7.8 from 0.7.6 and all hell broke loose on my custom templates

Hi, I'm sorry to hear that, it shouldn't happen. Actually I try to strictly follow semver, if there are breaking changes it's definitely my fault. Could you please report the breaking changes? I can try to fix them

k-sheth commented 8 years ago

I have some custom templates, which I have forked from your bootstrap list and textbox templates but with some styling and other changes to accomdate for my app. The first issue I encountered was that the templates needed to have toReactElement now. I tried to grok through your refactored bootstrap template, but I think it will take me some time to understand your changes and apply them. A suggestion, maybe if toReactElement is not present, then you could fall back to assuming its uvdom, for now, until users like me have had a chance to catch up with the changes ? Thanks

gcanti commented 8 years ago

if toReactElement is not present, then you could fall back to assuming its uvdom

Actually it's what I've done in https://github.com/gcanti/tcomb-form/blob/master/src/components.js#L263

I also added a warning in development env suggesting to add a toReactElement static function if is missing. But.. it's just a warning, your custom templates should still work fine. Let me know if it's not the case.

EDIT: More info here (v0.7.8 release notes) https://github.com/gcanti/tcomb-form/releases/tag/v0.7.8

k-sheth commented 8 years ago

Thanks for the explanation. I understand the changes and I am in the process of upgrading my code. But wouldn't it make sense to bump up version, instead of incrementing patch version ?

gcanti commented 8 years ago

The goal was to provide a smooth migration path towards v0.8:

My big concern now is: maybe I failed doing 1). Could you confirm that you are receiving only warnings and your custom templates are not broken?

k-sheth commented 8 years ago

It actually did break. I will try and put together a gist to show how it breaks. Pls give me a couple of days to put it together though.

I was using tcomb-form 0.7.6 and upgraded to 0.7.8.

gcanti commented 8 years ago

Ok, thanks for your help @k-sheth

gcanti commented 8 years ago

Closing for inactivity. Feel free to reopen.