Migration guide from v1 to v2?

rhansen commented 2 years ago

Support plan

which support plan is this issue covered by? (e.g. Community, Sponsor, or Enterprise): Community
is this issue currently blocking your project? (yes/no): no
is this issue affecting a production system? (yes/no): no

Context

node version: v16.13.0
module (formidable) version: v1.2.6
environment (e.g. node, browser, native, OS): node
used with (i.e. popular names of modules):
any other relevant information:

What problem are you trying to solve?

What changes are needed to migrate from v1.2.6 to v2.0.1? CHANGELOG.md is not very readable, and VERSION_NOTES.md doesn't mention any compatibility-breaking changes other than Node.js 10+. Can we simply upgrade to v2.0.1 and expect everything to work without any changes?

Do you have a new or modified API suggestion to solve the problem?

GrosSacASac commented 2 years ago

PR welcome :)

It depends on what features you used. The interface of certain objects has changed.

tunnckoCore commented 2 years ago

Can we simply upgrade to v2.0.1 and expect everything to work without any changes?

Almost, yes. I think it's just the resulted "File" object propeties. See #773 for the different names of props.

I can add a diff codeblock in the v2 part of the version notes, based on that 773.

karlhorky commented 1 year ago

Looks like now that v3 is latest on npm, a guide from v2 to v3 will also be needed...

GrosSacASac commented 1 year ago

The changelog is the migration guide. If almost no compatibility changes are mentioned , well it is because there are very few.

If something specific is missing then open an issue about that specific thing.

I am closing this issue but if someone wants to volunteer and write a hand holding guide then by all means PR are opens

node-formidable / formidable