[codex] Clarify async watcher cleanup timing#3396
Open
Sean-Kenneth-Doherty wants to merge 1 commit into
Open
Conversation
✅ Deploy Preview for vuejs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description of Problem
The watcher guide states that
onWatcherCleanup()must be called synchronously, but the async callback case is easy to misread without a concrete before/after example.Closes #3222.
Proposed Solution
Add examples showing that async watcher callbacks should register
onWatcherCleanup()before the firstawait, and that calling it after an awaited operation is too late to register cleanup.Additional Information
Validation:
pnpm install --frozen-lockfilegit diff --checkNODE_OPTIONS=--no-experimental-webstorage pnpm run buildAlso ran
pnpm run type; it fails on an existing.vitepress/config.tsplugin typing issue where a plugin tuple is cast to a singlePlugin.