doc: update bundler recommendation #3763
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
With the switch to ESM, Browserify will no longer work with Uppy. I'm also removing Webpack from the list as it doesn't seem like a good fit to me. Instead, I suggest we recommend bundlers that we actually test with.
Murderlon
approved these changes
May 23, 2022
aduh95
commented
May 23, 2022
README.md
Outdated
| @@ -67,9 +67,9 @@ const uppy = new Uppy({ autoProceed: false }) | |||
| $ npm install @uppy/core @uppy/dashboard @uppy/tus | |||
| ``` | |||
|
|
|||
| We recommend installing from npm and then using a module bundler such as [Webpack](https://webpack.js.org/), [Browserify](http://browserify.org/) or [Rollup.js](http://rollupjs.org/). | |||
| We recommend installing from npm and then using a module bundler such as [Vite](https://vitejs.dev/), [Parcel](https://parceljs.org/), or [Rollup](https://rollupjs.org). | |||
There was a problem hiding this comment.
Let's remove this from the readme, to avoid having to maintain a list of bundlers.
There was a problem hiding this comment.
maybe just keep one, and the one we are using ourselves at that point? i do think there is value in recommending people a bundler here, and linking to one
There was a problem hiding this comment.
We've discussed this during the Uppy call, and we decided that the README was not the place to recommend bundlers, instead we can keep doing that in the docs, so don't have to update 38 files each time we want to update the list. wdyt?
Murderlon
added a commit
that referenced
this pull request
May 24, 2022
* main: meta: split Companion CI between Node.js legacy and supported versions (#3776) doc: update bundler recommendation (#3763) Setup Cypress Dashboard (#3691) @uppy/image-editor: remove CJS-interop hack in the source code (#3778) meta: remove `vite-plugin-jsx-commonjs` plugin on dev env (#3749) Add onKeyPress event handler to capture e.shiftKey, unavailable in onChange (#3768) meta: remove CJS-related hack in `build:locale-pack` script (#3764) meta: prepare test files for lint rule hardening (#3761) meta: prepare internal script files for lint rune hardening (#3760)
github-actions bot
added a commit
that referenced
this pull request
May 30, 2022
| Package | Version | Package | Version | | ------------------------- | ------- | ------------------------- | ------- | | @uppy/angular | 0.3.1 | @uppy/progress-bar | 2.1.1 | | @uppy/audio | 0.3.2 | @uppy/provider-views | 2.1.1 | | @uppy/aws-s3 | 2.2.0 | @uppy/react | 2.2.1 | | @uppy/aws-s3-multipart | 2.4.0 | @uppy/react-native | 0.3.1 | | @uppy/box | 1.0.7 | @uppy/redux-dev-tools | 2.1.0 | | @uppy/companion | 3.6.0 | @uppy/screen-capture | 2.1.1 | | @uppy/companion-client | 2.2.0 | @uppy/status-bar | 2.2.1 | | @uppy/compressor | 0.3.0 | @uppy/store-default | 2.1.0 | | @uppy/core | 2.3.0 | @uppy/store-redux | 2.1.0 | | @uppy/dashboard | 2.3.0 | @uppy/thumbnail-generator | 2.2.0 | | @uppy/drag-drop | 2.1.1 | @uppy/transloadit | 2.3.0 | | @uppy/dropbox | 2.0.7 | @uppy/tus | 2.4.0 | | @uppy/facebook | 2.0.7 | @uppy/unsplash | 2.1.0 | | @uppy/file-input | 2.1.1 | @uppy/url | 2.1.1 | | @uppy/form | 2.0.6 | @uppy/utils | 4.1.0 | | @uppy/golden-retriever | 2.1.0 | @uppy/vue | 0.4.8 | | @uppy/google-drive | 2.1.1 | @uppy/webcam | 2.2.1 | | @uppy/image-editor | 1.3.0 | @uppy/xhr-upload | 2.1.1 | | @uppy/informer | 2.1.0 | @uppy/zoom | 1.1.1 | | @uppy/instagram | 2.1.1 | @uppy/robodog | 2.7.0 | | @uppy/onedrive | 2.1.1 | uppy | 2.11.0 | - doc: update bundler recommendation (Antoine du Hamel / #3763) - @uppy/aws-s3-multipart: refactor to ESM (Antoine du Hamel / #3672) - @uppy/aws-s3: fix JSDoc type error (Antoine du Hamel / #3785) - @uppy/aws-s3: refactor to ESM (Antoine du Hamel / #3673) - @uppy/companion-client: Revert "Revert "@uppy/companion-client: refactor to ESM"" (Antoine du Hamel / #3730) - @uppy/companion: expire redis keys after 1 day (Mikael Finstad / #3771) - @uppy/companion: fix some linter warnings (Antoine du Hamel / #3752) - @uppy/compressor: Fix Compressor docs, pass files array to compressor:complete event (Artur Paikin / #3682) - @uppy/core: refactor to ESM (Antoine du Hamel / #3744) - @uppy/dashboard: refactor to ESM (Antoine du Hamel / #3701) - @uppy/dashboard: use webkitRelativePath when querying a file's relative path (Eduard Müller / taktik / #3766) - @uppy/golden-retriever: refactor to ESM (Antoine du Hamel / #3731) - @uppy/image-editor: remove CJS-interop hack in the source code (Antoine du Hamel / #3778) - @uppy/informer: @uppy/Informer: refactor to ESM (Antoine du Hamel / #3732) - @uppy/informer: remove remaining `require` call (Antoine du Hamel / #3737) - @uppy/provider-views: Add onKeyPress event handler to capture e.shiftKey, unavailable in onChange (Artur Paikin / #3768) - @uppy/redux-dev-tools: refactor to ESM (Antoine du Hamel / #3733) - @uppy/screen-capture: don't install when unsupported (Artur Paikin / #3795) - @uppy/store-default: refactor to ESM (Antoine du Hamel / #3746) - @uppy/store-redux: refactor to ESM (Antoine du Hamel / #3745) - @uppy/thumbnail-generator: refactor to ESM (Antoine du Hamel / #3734) - @uppy/transloadit: refactor to ESM (Antoine du Hamel / #3725) - @uppy/transloadit: transloadit: propagate error details when creating Assembly fails (Renée Kooi / #3794) - @uppy/tus: Add `onShouldRetry` as option to @uppy/tus (Merlijn Vos / #3720) - @uppy/tus: fix broken import (Antoine du Hamel / #3729) - @uppy/tus: fixup! @uppy/tus: wait for user promise on beforeRequest (Antoine du Hamel / #3712) - @uppy/tus: wait for user promise on beforeRequest (Antoine du Hamel / #3712) - @uppy/unsplash: refactor to ESM (Antoine du Hamel / #3728) - @uppy/utils: refactor to ESM (Antoine du Hamel / #3721) - dev: fix dev env Vite's config (Antoine du Hamel) - dev: fix return type of generateSignatureIfSecret (Renée Kooi / #3793) - dev: remove `vite-plugin-jsx-commonjs` plugin on dev env (Antoine du Hamel / #3749) - dev: remove CJS-related hack in `build:locale-pack` script (Antoine du Hamel / #3764) - meta: e2e: run CI on PRs that modify the workflow file (Antoine du Hamel / #3740) - meta: fix linter warnings (Antoine du Hamel / #3753) - meta: fix more linter warnings (Antoine du Hamel / #3757) - meta: resolve warnings in `.d.ts` files (Antoine du Hamel / #3754) - meta: uppy: add Zoom plugin to the bundle and fix ESM exports (Antoine du Hamel / #3747) - test: Apply bin/update-yarn.sh (Merlijn Vos / #3775) - test: fix e2e dependency conflict (Merlijn Vos / #3779) - test: fixup! e2e: run CI on PRs that modify the workflow file (Antoine du Hamel / #3740) - test: prepare internal script files for lint rune hardening (Antoine du Hamel / #3760) - test: prepare test files for lint rule hardening (Antoine du Hamel / #3761) - test: Setup Cypress Dashboard (Merlijn Vos / #3691) - test: split Companion CI between Node.js legacy and supported versions (Antoine du Hamel / #3776) - website: disable linter warnings (Antoine du Hamel / #3759)
HeavenFox
pushed a commit
to docsend/uppy
that referenced
this pull request
Jun 27, 2023
| Package | Version | Package | Version | | ------------------------- | ------- | ------------------------- | ------- | | @uppy/angular | 0.3.1 | @uppy/progress-bar | 2.1.1 | | @uppy/audio | 0.3.2 | @uppy/provider-views | 2.1.1 | | @uppy/aws-s3 | 2.2.0 | @uppy/react | 2.2.1 | | @uppy/aws-s3-multipart | 2.4.0 | @uppy/react-native | 0.3.1 | | @uppy/box | 1.0.7 | @uppy/redux-dev-tools | 2.1.0 | | @uppy/companion | 3.6.0 | @uppy/screen-capture | 2.1.1 | | @uppy/companion-client | 2.2.0 | @uppy/status-bar | 2.2.1 | | @uppy/compressor | 0.3.0 | @uppy/store-default | 2.1.0 | | @uppy/core | 2.3.0 | @uppy/store-redux | 2.1.0 | | @uppy/dashboard | 2.3.0 | @uppy/thumbnail-generator | 2.2.0 | | @uppy/drag-drop | 2.1.1 | @uppy/transloadit | 2.3.0 | | @uppy/dropbox | 2.0.7 | @uppy/tus | 2.4.0 | | @uppy/facebook | 2.0.7 | @uppy/unsplash | 2.1.0 | | @uppy/file-input | 2.1.1 | @uppy/url | 2.1.1 | | @uppy/form | 2.0.6 | @uppy/utils | 4.1.0 | | @uppy/golden-retriever | 2.1.0 | @uppy/vue | 0.4.8 | | @uppy/google-drive | 2.1.1 | @uppy/webcam | 2.2.1 | | @uppy/image-editor | 1.3.0 | @uppy/xhr-upload | 2.1.1 | | @uppy/informer | 2.1.0 | @uppy/zoom | 1.1.1 | | @uppy/instagram | 2.1.1 | @uppy/robodog | 2.7.0 | | @uppy/onedrive | 2.1.1 | uppy | 2.11.0 | - doc: update bundler recommendation (Antoine du Hamel / transloadit#3763) - @uppy/aws-s3-multipart: refactor to ESM (Antoine du Hamel / transloadit#3672) - @uppy/aws-s3: fix JSDoc type error (Antoine du Hamel / transloadit#3785) - @uppy/aws-s3: refactor to ESM (Antoine du Hamel / transloadit#3673) - @uppy/companion-client: Revert "Revert "@uppy/companion-client: refactor to ESM"" (Antoine du Hamel / transloadit#3730) - @uppy/companion: expire redis keys after 1 day (Mikael Finstad / transloadit#3771) - @uppy/companion: fix some linter warnings (Antoine du Hamel / transloadit#3752) - @uppy/compressor: Fix Compressor docs, pass files array to compressor:complete event (Artur Paikin / transloadit#3682) - @uppy/core: refactor to ESM (Antoine du Hamel / transloadit#3744) - @uppy/dashboard: refactor to ESM (Antoine du Hamel / transloadit#3701) - @uppy/dashboard: use webkitRelativePath when querying a file's relative path (Eduard Müller / taktik / transloadit#3766) - @uppy/golden-retriever: refactor to ESM (Antoine du Hamel / transloadit#3731) - @uppy/image-editor: remove CJS-interop hack in the source code (Antoine du Hamel / transloadit#3778) - @uppy/informer: @uppy/Informer: refactor to ESM (Antoine du Hamel / transloadit#3732) - @uppy/informer: remove remaining `require` call (Antoine du Hamel / transloadit#3737) - @uppy/provider-views: Add onKeyPress event handler to capture e.shiftKey, unavailable in onChange (Artur Paikin / transloadit#3768) - @uppy/redux-dev-tools: refactor to ESM (Antoine du Hamel / transloadit#3733) - @uppy/screen-capture: don't install when unsupported (Artur Paikin / transloadit#3795) - @uppy/store-default: refactor to ESM (Antoine du Hamel / transloadit#3746) - @uppy/store-redux: refactor to ESM (Antoine du Hamel / transloadit#3745) - @uppy/thumbnail-generator: refactor to ESM (Antoine du Hamel / transloadit#3734) - @uppy/transloadit: refactor to ESM (Antoine du Hamel / transloadit#3725) - @uppy/transloadit: transloadit: propagate error details when creating Assembly fails (Renée Kooi / transloadit#3794) - @uppy/tus: Add `onShouldRetry` as option to @uppy/tus (Merlijn Vos / transloadit#3720) - @uppy/tus: fix broken import (Antoine du Hamel / transloadit#3729) - @uppy/tus: fixup! @uppy/tus: wait for user promise on beforeRequest (Antoine du Hamel / transloadit#3712) - @uppy/tus: wait for user promise on beforeRequest (Antoine du Hamel / transloadit#3712) - @uppy/unsplash: refactor to ESM (Antoine du Hamel / transloadit#3728) - @uppy/utils: refactor to ESM (Antoine du Hamel / transloadit#3721) - dev: fix dev env Vite's config (Antoine du Hamel) - dev: fix return type of generateSignatureIfSecret (Renée Kooi / transloadit#3793) - dev: remove `vite-plugin-jsx-commonjs` plugin on dev env (Antoine du Hamel / transloadit#3749) - dev: remove CJS-related hack in `build:locale-pack` script (Antoine du Hamel / transloadit#3764) - meta: e2e: run CI on PRs that modify the workflow file (Antoine du Hamel / transloadit#3740) - meta: fix linter warnings (Antoine du Hamel / transloadit#3753) - meta: fix more linter warnings (Antoine du Hamel / transloadit#3757) - meta: resolve warnings in `.d.ts` files (Antoine du Hamel / transloadit#3754) - meta: uppy: add Zoom plugin to the bundle and fix ESM exports (Antoine du Hamel / transloadit#3747) - test: Apply bin/update-yarn.sh (Merlijn Vos / transloadit#3775) - test: fix e2e dependency conflict (Merlijn Vos / transloadit#3779) - test: fixup! e2e: run CI on PRs that modify the workflow file (Antoine du Hamel / transloadit#3740) - test: prepare internal script files for lint rune hardening (Antoine du Hamel / transloadit#3760) - test: prepare test files for lint rule hardening (Antoine du Hamel / transloadit#3761) - test: Setup Cypress Dashboard (Merlijn Vos / transloadit#3691) - test: split Companion CI between Node.js legacy and supported versions (Antoine du Hamel / transloadit#3776) - website: disable linter warnings (Antoine du Hamel / transloadit#3759)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
With the switch to ESM, Browserify will no longer work with Uppy. I'm also removing Webpack from the list as it doesn't seem like a good fit to me. Instead, I suggest we recommend bundlers that we actually test with.