-
Notifications
You must be signed in to change notification settings - Fork 682
fix(clean-dir): advance clean outdir to allow generateBundle outputs
#6647
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
How to use the Graphite Merge QueueAdd the label graphite: merge to this PR to add it to the merge queue. You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. |
bundle_up called in bundle_writegenerateBundle outputs
hyf0
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM @IWANABETHATGUY cc
|
Already update with the main branch, but: This test (here), always takes a long time, which usually cause timeout that fail the tests. I've specified the timeout from 20s by default to 30s, but it's still not enough. So I modified it to 60s in the latest commit. Sorry that I don't have enough time to dive into the massive code in this repo to figure out why such tests takes so long time. But I guess perhaps there's some bug about loop somewhere in the codebase about those testing. |
The original timeout is 20_000ms by default, which is not long enough sometimes. This commit manually set it to 30_000ms to avoid some random test failures because of testing time not enough.
9972811 to
f553f90
Compare
✅ Deploy Preview for rolldown-rs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Add detailed JSDoc documentation for the `cleanDir` option in OutputOptions, including: - Clear description of functionality - Timing behavior explanation (cleans before generateBundle hook) - Safety warnings about recursive directory deletion - Usage example This documentation follows the established patterns in the codebase and will be automatically included in the generated documentation. Related PRs: - rolldown#6486: Initial implementation of output.cleanDir - rolldown#6647: Fixed timing to execute before bundle_up is called 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
…ity (#6682) ## Summary Updates the `output.cleanDir` documentation to clarify when directory cleanup occurs and how it affects plugin-generated files. ## Context PR #6486 introduced the `output.cleanDir` option to clean the output directory before emitting output. However, PR #6647 fixed an important timing issue where the cleanup was initially happening between `generateBundle` and `writeBundle` hooks, causing files created by plugins (like `@rollup/plugin-url` and `rollup-plugin-copy`) to be deleted. The fix moved the cleanup to occur **before** the `generateBundle` hook, ensuring all plugin-generated files are preserved. This documentation update clarifies this critical behavior for users. ## Changes ### Updated main description Changed from the vague "before `writeBundle` hooks are called" to explicitly state: > The cleanup happens before the `generateBundle` hook is called. This ensures that files created by plugins during `generateBundle` or `writeBundle` hooks are preserved. ### Added "In-depth" section Added a new section explaining the timing importance: - The cleanup occurs **before** the `generateBundle` hook - Files created by plugins in `generateBundle` or `writeBundle` hooks are **not** deleted - Guidance for advanced use cases with multiple outputs ## Why this matters Many plugins create files during the `generateBundle` hook (e.g., copying assets, generating additional files). Without clear documentation, users might be confused about why their plugin-generated files are or aren't being cleaned, leading to unexpected behavior in their build process. This update provides clarity on the execution order and helps users understand the plugin compatibility guarantees. ## References - Original feature: #6486 - Timing fix: #6647 - Issue comment: #6486 (comment) <!-- START COPILOT CODING AGENT SUFFIX --> <details> <summary>Original prompt</summary> > Read #6486 (comment) and #6647. Use concise words to describe the behavior and update related docs. Just point out new added behavior that #6647 emphasized and upadate the description in `/docs/options` </details> <!-- START COPILOT CODING AGENT TIPS --> --- ✨ Let Copilot coding agent [set things up for you](https://github.com/rolldown/rolldown/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo.
#6647) See: #6486 (comment) Advance the "clean dir" code before the `bundle_up` is called inside the `bundle_write` function: `fn generate_bundle` is called in `fn bundle_up`, and the "clean dir" code is advanced before the call of `fn bundle_up` in `fn bundle_write`. - [x] Fix the source code and pass all current tests. - [x] Create new behavior tests about the `generateBundle` and `writeBundle` hook. I also fix another bug about testing timeout configuration, which prevents the previous random failure when testing spent more time than the default 20s (20_000ms).
…ity (#6682) ## Summary Updates the `output.cleanDir` documentation to clarify when directory cleanup occurs and how it affects plugin-generated files. ## Context PR #6486 introduced the `output.cleanDir` option to clean the output directory before emitting output. However, PR #6647 fixed an important timing issue where the cleanup was initially happening between `generateBundle` and `writeBundle` hooks, causing files created by plugins (like `@rollup/plugin-url` and `rollup-plugin-copy`) to be deleted. The fix moved the cleanup to occur **before** the `generateBundle` hook, ensuring all plugin-generated files are preserved. This documentation update clarifies this critical behavior for users. ## Changes ### Updated main description Changed from the vague "before `writeBundle` hooks are called" to explicitly state: > The cleanup happens before the `generateBundle` hook is called. This ensures that files created by plugins during `generateBundle` or `writeBundle` hooks are preserved. ### Added "In-depth" section Added a new section explaining the timing importance: - The cleanup occurs **before** the `generateBundle` hook - Files created by plugins in `generateBundle` or `writeBundle` hooks are **not** deleted - Guidance for advanced use cases with multiple outputs ## Why this matters Many plugins create files during the `generateBundle` hook (e.g., copying assets, generating additional files). Without clear documentation, users might be confused about why their plugin-generated files are or aren't being cleaned, leading to unexpected behavior in their build process. This update provides clarity on the execution order and helps users understand the plugin compatibility guarantees. ## References - Original feature: #6486 - Timing fix: #6647 - Issue comment: #6486 (comment) <!-- START COPILOT CODING AGENT SUFFIX --> <details> <summary>Original prompt</summary> > Read #6486 (comment) and #6647. Use concise words to describe the behavior and update related docs. Just point out new added behavior that #6647 emphasized and upadate the description in `/docs/options` </details> <!-- START COPILOT CODING AGENT TIPS --> --- ✨ Let Copilot coding agent [set things up for you](https://github.com/rolldown/rolldown/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo.
## [1.0.0-beta.45] - 2025-10-27 ### 🚀 Features - plugin/vite-resolve: add `legacyInconsistentCjsInterop` option (#6687) by @sapphi-red - rolldown_plugin_vite_css_post: initialize `CSSStyles` (#6691) by @shulaoda - rolldown_plugin_manifest: align with `vitejs/vite#20585` (#6684) by @shulaoda - enabling mangle private class members (#6679) by @IWANABETHATGUY - rolldown_resolver: auto tsconfig discovery (#6602) by @Boshen - support named imports + CJS by optimization.inlineConst (#6644) by @IWANABETHATGUY ### 🐛 Bug Fixes - rolldown_binding: use Record instead of Map (#6715) by @shulaoda - validate valibot schema against existing type (#6703) by @ocavue - rolldown_plugin_vite_css_post: align some logic (#6697) by @shulaoda - node/options: should validate `transform.jsx` correctly (#6698) by @ocavue - inherit runtime helpers from eliminated dependencies (#6689) by @IWANABETHATGUY - clean-dir: advance clean outdir to allow `generateBundle` outputs (#6647) by @aprosail - rename variable to better reflect its purpose and fix CJS imports (#6663) by @IWANABETHATGUY - bailout tree shake commonjs export when it is defined multiple time (#6659) by @IWANABETHATGUY - rolldown_plugin_reporter: color dimmed text correctly (#6649) by @sapphi-red - don't inline json module when used as a namespace reference (#6652) by @IWANABETHATGUY - avoid `define` deprecation warning when loading a config file (#6641) by @sapphi-red ### 💼 Other - pluginutils: switch to tsc to solve the issue of loading conflicting binary (#6708) by @hyf0 ### 🚜 Refactor - node: only call `transformToRollupOutput` when needed (#6695) by @hyf0 - node: split `transformToRollupOutput` into mutable and immutable versions (#6693) by @hyf0 - remove unnecessaey lazy data passing for `BindingOutputs` (#6692) by @hyf0 - rolldown_plugin_utils: tweak `CSSEntriesCache` (#6685) by @shulaoda - rolldown_binding: use unified `BindingRenderBuiltUrl` (#6653) by @shulaoda ### 📚 Documentation - in-depth about `experimental.nativeMagicString` (#6713) by @IWANABETHATGUY - polish `optimization` (#6719) by @IWANABETHATGUY - clarify `output.cleanDir` timing behavior for plugin compatibility (#6682) by @Copilot - add Kevin Deng, 翠 (sapphi-red), and Alexander Lichter to team page with Bluesky links (#6664) by @Copilot - polish `preserveEntrySignature` doc (#6661) by @IWANABETHATGUY - set up redirects via netlify (#6654) by @TheAlexLichter - polish doc about `treeshake` (#6650) by @IWANABETHATGUY - rework options documentation first round (#6542) by @hyf0 ### ⚡ Performance - rolldown: upgrade sugar_path (#6646) by @Brooooooklyn ### 🧪 Testing - add live bindings test for default export snapshot semantics (#6538) by @Copilot ### ⚙️ Miscellaneous Tasks - deps: lock file maintenance npm packages (#6714) by @renovate[bot] - deps: update github-actions (#6710) by @renovate[bot] - deps: update dependency @vueuse/core to v14 (#6711) by @renovate[bot] - deps: update github-actions (major) (#6712) by @renovate[bot] - deps: update dependency tsdown to v0.15.10 (#6706) by @renovate[bot] - remove `typedoc` dependency and cleanup unused documentation generation (#6686) by @Copilot - deps: update dependency rolldown-plugin-dts to v0.17.1 (#6690) by @renovate[bot] - lint: `oxlint --type-aware` (#5660) by @Boshen - rolldown: update napi and js binding (#6676) by @Brooooooklyn - deps: update vitest to v4 (#6673) by @sapphi-red - test: support `DevTestMeta#dev` (#6672) by @hyf0 - deps: update dependency rolldown-plugin-dts to ^0.17.0 (#6671) by @renovate[bot] - test: move dev related options to rolldown_dev_common (#6667) by @hyf0 - test: add `DevTestMeta` under `TestMeta#dev` to control dev related behaviors (#6666) by @hyf0 - deps: update dependency vite to v7.1.11 [security] (#6645) by @renovate[bot] - pluginutils: use rolldown to build plugutils (#6642) by @Brooooooklyn - deps: update dependency tsdown to v0.15.9 (#6643) by @renovate[bot] ### ❤️ New Contributors * @ocavue made their first contribution in [#6703](#6703) Co-authored-by: shulaoda <165626830+shulaoda@users.noreply.github.com>
See: #6486 (comment)
Advance the "clean dir" code before the
bundle_upis called inside thebundle_writefunction:fn generate_bundleis called infn bundle_up, and the "clean dir" code is advanced before the call offn bundle_upinfn bundle_write.generateBundleandwriteBundlehook.I also fix another bug about testing timeout configuration, which prevents the previous random failure when testing spent more time than the default 20s (20_000ms).