Skip to content

docs: fix error type for RolldownBuild.generate and others#8490

Merged
graphite-app[bot] merged 1 commit intomainfrom
02-27-docs_fix_error_type_for_rolldownbuild.generate_and_others
Feb 27, 2026
Merged

docs: fix error type for RolldownBuild.generate and others#8490
graphite-app[bot] merged 1 commit intomainfrom
02-27-docs_fix_error_type_for_rolldownbuild.generate_and_others

Conversation

@sapphi-red
Copy link
Member

@sapphi-red sapphi-red commented Feb 27, 2026

@throws {@linkcode RolldownError} When an error occurs during the build.

should be

@throws {@linkcode BundleError} When an error occurs during the build.

. BundleError here is

export type BundleError = Error & {
  errors?: RolldownError[];
};

Copy link
Member Author


How to use the Graphite Merge Queue

Add the label graphite: merge-when-ready 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.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@netlify
Copy link

netlify bot commented Feb 27, 2026

Deploy Preview for rolldown-rs canceled.

Name Link
🔨 Latest commit ca146ac
🔍 Latest deploy log https://app.netlify.com/projects/rolldown-rs/deploys/69a19802b5fcc90008969dbe

@sapphi-red sapphi-red force-pushed the 02-27-docs_fix_error_type_for_rolldownbuild.generate_and_others branch from b02bc80 to 40b3e91 Compare February 27, 2026 11:05
@sapphi-red sapphi-red marked this pull request as ready for review February 27, 2026 11:14
Copilot AI review requested due to automatic review settings February 27, 2026 11:14
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates error type documentation to use the newly introduced BundleError type instead of RolldownError for build-level errors. The BundleError type is a more accurate description of the error object that is thrown by Rolldown, which includes an errors property containing individual RolldownError instances.

Changes:

  • Introduces a new BundleError type that extends Error with an optional errors property containing RolldownError[]
  • Updates JSDoc documentation in RolldownBuild.generate() and RolldownBuild.write() to reference BundleError
  • Updates JSDoc documentation in plugin hooks (buildEnd, renderError) to reference BundleError
  • Exports the new BundleError type from the main package entry point

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
packages/rolldown/src/utils/error.ts Defines the new BundleError type and updates the return type of aggregateBindingErrorsIntoJsError()
packages/rolldown/src/plugin/index.ts Updates JSDoc comments for buildEnd and renderError hooks to reference BundleError
packages/rolldown/src/index.ts Exports the new BundleError type for public API consumers
packages/rolldown/src/api/rolldown/rolldown-build.ts Updates JSDoc @throws tags for generate() and write() methods to reference BundleError

Copilot AI review requested due to automatic review settings February 27, 2026 11:19
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

Copy link
Member Author

sapphi-red commented Feb 27, 2026

Merge activity

  • Feb 27, 1:02 PM UTC: The merge label 'graphite: merge-when-ready' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
  • Feb 27, 1:03 PM UTC: sapphi-red added this pull request to the Graphite merge queue.
  • Feb 27, 1:24 PM UTC: Merged by the Graphite merge queue.

graphite-app bot pushed a commit that referenced this pull request Feb 27, 2026
```
@throws {@linkcode RolldownError} When an error occurs during the build.
```
should be
```
@throws {@linkcode BundleError} When an error occurs during the build.
```
. `BundleError` here is
```ts
export type BundleError = Error & {
  errors?: RolldownError[];
};
```
@graphite-app graphite-app bot force-pushed the 02-27-docs_fix_error_type_for_rolldownbuild.generate_and_others branch from d3785ea to 56e1d04 Compare February 27, 2026 13:03
```
@throws {@linkcode RolldownError} When an error occurs during the build.
```
should be
```
@throws {@linkcode BundleError} When an error occurs during the build.
```
. `BundleError` here is
```ts
export type BundleError = Error & {
  errors?: RolldownError[];
};
```
Copilot AI review requested due to automatic review settings February 27, 2026 13:11
@graphite-app graphite-app bot force-pushed the 02-27-docs_fix_error_type_for_rolldownbuild.generate_and_others branch from 56e1d04 to ca146ac Compare February 27, 2026 13:11
@sapphi-red sapphi-red review requested due to automatic review settings February 27, 2026 13:11
@graphite-app graphite-app bot merged commit ca146ac into main Feb 27, 2026
31 of 32 checks passed
@graphite-app graphite-app bot deleted the 02-27-docs_fix_error_type_for_rolldownbuild.generate_and_others branch February 27, 2026 13:24
This was referenced Mar 4, 2026
shulaoda added a commit that referenced this pull request Mar 5, 2026
## [1.0.0-rc.7] - 2026-03-05

⚡ Smarter Code Generation Defaults
- DCE-only minification and smart constant inlining are now enabled by default
- Produces cleaner, smaller output bundles without requiring explicit configuration

💡 LLM-Friendly Bundle Analyzer Reports
- New markdown output format for the bundle analyzer plugin with bundle summaries, module graphs, dependency chains, and optimization suggestions
- Optimization suggestions now also recommend using the entriesAware option when common chunks contain modules only reachable from specific entries


### 💥 BREAKING CHANGES

- enable minify: 'dce-only' by default (#8465) by @IWANABETHATGUY
- settings `inlineConst: { mode: 'smart', pass: 1}`  by default (#8444) by @IWANABETHATGUY

### 🚀 Features

- binding: add original getter to BindingMagicString (#8533) by @IWANABETHATGUY
- native-magic-string: add `offset` property support (#8531) by @IWANABETHATGUY
- add `output.strict` option to control `"use strict"` directive emission (#8489) by @Copilot
- watch: expose `watcher.compareContentsForPolling` (#8526) by @hyf0
- watch: use new watcher to support watch mode (#8475) by @hyf0
- rust/watch: handle bulk-change (#8466) by @hyf0
- add LLM-friendly markdown output format to bundle analyzer plugin (#8242) by @IWANABETHATGUY

### 🐛 Bug Fixes

- expose `plugins` on `NormalizedInputOptions` for `buildStart` hook (#8521) by @Copilot
- only uppercase facade symbols in JSX preserve mode (#8519) by @IWANABETHATGUY
- binding: export BindingResult in generated dts header (#8537) by @minsoo-web
- pre-resolve paths option to avoid `invoke_sync` deadlock (#8518) by @IWANABETHATGUY
- remove debug-only jsx_preset and UntranspiledSyntaxError (#8511) by @IWANABETHATGUY
- apply `topLevelVar` to exported `const`/`let` declarations (#8507) by @IWANABETHATGUY
- rolldown_plugin_vite_web_worker_post: avoid replacing `new.target` (#8488) by @sapphi-red
- update copyright year to 2026 (#8486) by @maciekzygmunt

### 🚜 Refactor

- rust: use Oxc's SymbolFlags::ConstVariable instead of custom IsConst flag (#8543) by @Dunqing
- rust: remove FacadeScoping, use Scoping::create_symbol for facade symbols (#8540) by @Dunqing
- rust/watch: remove hacky `reset_closed_for_watch_mode` (#8530) by @hyf0
- binding: return &str instead of String in filename() getter (#8534) by @IWANABETHATGUY
- rust: remove old watch mode implementation (#8525) by @hyf0
- rust/watch: simply watch logic in the binding layer (#8516) by @hyf0
- rust/watch: tweak struct/function names (#8464) by @hyf0

### 📚 Documentation

- explain how external modules work in rolldown (#8457) by @sapphi-red
- add some diagrams using graphviz (#8499) by @sapphi-red
- use `vitepress-plugin-graphviz` (#8498) by @sapphi-red
- list s390x/ppc64le prebuilt binaries (#8495) by @crusty-voidzero
- fix error type for `RolldownBuild.generate` and others (#8490) by @sapphi-red

### ⚡ Performance

- string_wizard: reduce allocations and add ASCII fast paths (#8541) by @IWANABETHATGUY
- use IndexBitSet to replace IndexVec<XXXIdx, bool> for module/stmt inclusion tracking (#8503) by @IWANABETHATGUY
- plugin: use IndexBitSet to optimize skipped plugins checking (#8497) by @ShroXd
- rust/tla: skip compute_tla if there is no module use TLA (#8487) by @ShroXd

### 🧪 Testing

- node/watch: make watch tests run in concurrent and retry-able (#8512) by @hyf0
- add test case for static flag tree-shaking (#8476) by @IWANABETHATGUY
- migrate post-banner sourcemap-with-shebang to Rust (#8477) by @Copilot

### ⚙️ Miscellaneous Tasks

- vscode: `formatOnSave` for markdown files using oxc formatter (#8536) by @minsoo-web
- deps: update test262 submodule for tests (#8528) by @sapphi-red
- remove `retry` workaround from output paths test fixtures (#8520) by @Copilot
- docs: add Shuyuan Wang (h-a-n-a) and remove from acknowledgements (#8509) by @Copilot
- consolidate top_level_var test cases using configVariants (#8508) by @IWANABETHATGUY
- add s390x and ppc64le linux gnu targets (#8493) by @Brooooooklyn

### ◀️ Revert

- fix(rolldown): increase tokio blocking threads size for watch mode (#8517) by @hyf0

### ❤️ New Contributors

* @minsoo-web made their first contribution in [#8536](#8536)
* @crusty-voidzero made their first contribution in [#8495](#8495)
* @maciekzygmunt made their first contribution in [#8486](#8486)

Co-authored-by: shulaoda <165626830+shulaoda@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants