feat(v2): add CLI option for polling #2630
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
Some environments (specifically docker containers) can have issues with file watching for live reloads. [Webpack Dev Server provides a polling alternative](https://webpack.js.org/configuration/watch/#watchoptionspoll) option for this
|
Deploy preview for docusaurus-2 ready! Built with commit ddb7e51 |
lex111
reviewed
Apr 20, 2020
| .action((siteDir = '.', {port, host, hotOnly, open}) => { | ||
| .option( | ||
| '--poll', | ||
| 'Use polling rather than wathcing for reload (default: false)', |
lex111
changed the title
yangshun
approved these changes
Apr 20, 2020
|
Cheers, sorry for the typos. The remote-containers are really cool when you have a slightly complicated project and want people to be able to just pick up and go like GitPod but local I guess |
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.
Motivation
I've been working with a project that likes to have repos contain VS Code devcontainers so that you can simply open the repo in VS code, load up a configured Docker container and away you go. I have this working 99 % with our Docusaurus 2 repos but live reloading does not work use the
fseventsandinotifymethods used to watch for file changes in this case. Webpack Dev Server provides a polling alternative option for this and it is noted that this is recommended for such environments.Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
yarn startto check works with no flag provide. Make some minor edits and check there is an instant reload. It does ✔yarn start --pollwhich uses the newly add--polloption to setwatchOptions.polltotrue. Make some minor edits and see a reload after a small delay from the 1 s polling time. It does ✔Related PRs
Docs are (I think) updated correctly. I could not quite ascertain the convention for adding to the changelog so I'm guessing that that is done at release?