Faker.js: why the major version bump?

[jnardone]

is there anything documented as to why faker went from 4.x->5.x? were there breaking changes with the previous API?

[jqueryisamonad]

@Marak hello

[johneas10]

Looking for this also...

Could do with a changelog?

[ohcibi]

The fastest way is by looking at the commit log from 4.x to 5.x. We are currently in the process of reworking the library. We will prepare shorter changelogs as soon as we have finished what we planned for this change. Until then commit Logs should do it.

https://github.com/Marak/faker.js/compare/v4.1.0...v5.1.0

You can use any commit ref(s) for that comparison url

_{Sent with GitHawk}

[jnardone]

The real problem is that existing code (for me at least) broke, with no
indication that function signatures had changed etc., and with no
documentation on how one would migrate from 4.x->5.x.

On Mon, Oct 5, 2020 at 5:24 AM Tobias Witt [e-mail] wrote:

The fastest way is by looking at the commit log from 4.x to 5.x. We are
currently in the process of reworking the library. We will prepare shorter
changelogs as soon as we have finished what we planned for this change.
Until then commit Logs should do it.

v4.1.0...v5.1.0
https://github.com/Marak/faker.js/compare/v4.1.0...v5.1.0

You can use any commit ref(s) for that comparison url

Sent with GitHawk http://githawk.com

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
https://github.com/Marak/faker.js/issues/1003#issuecomment-703513406,
or unsubscribe
https://github.com/notifications/unsubscribe-auth/AAKJ3JWIDTYAGOOUA4ESAC3SJGGFJANCNFSM4RNGV3IA
.

[adamgruber]

@ohcibi It doesn't seem reasonable to ask people to look over 428 commits that changed 710 files just to figure out why there was a major version bump.

We will prepare shorter changelogs as soon as we have finished what we planned for this change.

If this is the case, perhaps v5 was released too soon?

[ohcibi]

Sorry for being somewhat unspecific. I'll try to put things (somewhat) clearer

@ohcibi It doesn't seem reasonable to ask people to look over 428 commits that changed 710 files just to figure out why there was a major version bump.

I agree. I was just responding to the question for a changelog. Not to deduct a reason for this bump 👹 .

The main reason for this release is to ship as much features and bugfixes that lured in PRs for quite some time now as possible. Since it is so much it was a major release.

Regarding to soon releasing there is a misunderstanding. "what weve planned for that change" refers to the library reworks that are planned for the next releases. To list some of the biggest: esmodules, maybe(!!) typescript, allow tree shaking, deprecate obsolete helper functions.

The stuff that made up 4->5 is listed in the commit logs. Its a huge number of files and commits and in the future we try to keep it smaller if possible. If any it was released to late.

Currently we are still working through the numerous PRs and merge in as many useful features and bugfixes as possible.