Skip to content

Commit

Permalink
Merge branch 'master' into dependabot/npm_and_yarn/compare-func-1.3.4
Browse files Browse the repository at this point in the history
  • Loading branch information
kodiakhq[bot] committed Jun 28, 2023
2 parents b717085 + 489a0bb commit 222c23f
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions VERSION_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,27 +14,30 @@ We highly recommend to use `v2` or `v3`. Both are already in use by many, especi
- Please move to at least **v2**!
- Try with installing `formidable@v2` and if still have the problem - report!

## v2 is the new `latest`
The `v2` will be simultaneously on two places for some time - `formidable@latest` and `formidable@v2`.
The source code be available **only** on [v2 branch][v2branch].
If you want to use v2, it's recommended to lock and use the v2 dist-tag `formidable@v2`.
## v2 is going to be deprecated

The `v2` is available as `formidable@v2`.
The source code is available **only** on [v2 branch][v2branch].
If you want to use v2, it's recommended to lock and use the v2 dist-tag `formidable@v2-latest`.

**Main Differences from v1:**

- Better organization and modernized code, requiring newer Node.js versions (>= v10).
- A lot of bugfixes, closed issues, merged or closed PRs.
- Better docs, new features (plugins, parsers, options) and optimizations.

## v3 - ESModules, Monorepo structure
We recommend to use `formidable@v3` to install, as it uses more modern Node.js Streams, has support for more stuff.

We recommend to use `formidable@latest` to install, as it uses more modern Node.js Streams, has support for more stuff.
You can see more info and track some ideas on [issue#635](https://github.com/node-formidable/formidable/issues/635).

- The source code can be found on the [master branch](https://github.com/node-formidable/formidable) on GitHub.
- It will be published on `formidable@latest` after some time.
- The source code can be found on the [master branch][v3branch] on GitHub.
- It is published as `formidable@latest`
- Dropping older Node.js versions, requiring higher than v12-v14.
- Dropping v1 compatibility.
- Rewritten to ESModules, more optimizations.
- Moving to monorepo structure, more plugins & helper utils.

[v1branch]: https://github.com/node-formidable/formidable/tree/v1-legacy
[v2branch]: https://github.com/node-formidable/formidable/tree/v2-latest
[v3branch]: https://github.com/node-formidable/formidable/tree/v3
[v3branch]: https://github.com/node-formidable/formidable/tree/master

0 comments on commit 222c23f

Please sign in to comment.