docs(options): add descriptions for output options#7821
Merged
graphite-app[bot] merged 1 commit intomainfrom Jan 9, 2026
Merged
Conversation
Member
Author
How to use the Graphite Merge QueueAdd 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. |
✅ Deploy Preview for rolldown-rs canceled.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive JSDoc documentation for output options in Rolldown, based on Rollup's documentation. The changes improve the developer experience by providing clear descriptions, examples, and default values for various configuration options.
Key Changes
- Added detailed JSDoc comments to all output options in
OutputOptionsinterface - Extracted inline group documentation into a separate
AdvancedChunksGrouptype for better reusability - Created several markdown documentation files for complex options with in-depth explanations
- Added parameter descriptions to type definitions in
misc.ts - Enhanced the
RenderedChunkinterface documentation
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
packages/rolldown/src/options/output-options.ts |
Added comprehensive JSDoc comments for all output options, extracted AdvancedChunksGroup type, and added @inline tags for function types |
packages/rolldown/src/types/rolldown-output.ts |
Enhanced JSDoc comment for RenderedChunk interface with detailed explanation |
packages/rolldown/src/types/misc.ts |
Added @inline tags and parameter descriptions for sourcemap-related type definitions |
packages/rolldown/src/options/docs/output-exports.md |
Created detailed documentation explaining export modes with CommonJS/ESM interoperability examples |
packages/rolldown/src/options/docs/output-external-live-bindings.md |
Added documentation with code examples showing the difference between live bindings enabled/disabled |
packages/rolldown/src/options/docs/output-minify-internal-exports.md |
Created in-depth documentation with before/after examples of minified internal exports |
packages/rolldown/src/options/docs/output-name.md |
Added documentation explaining namespace support in bundle names |
packages/rolldown/src/options/docs/output-preserve-modules.md |
Created comprehensive documentation with entry point designation examples using tinyglobby |
packages/rolldown/src/options/docs/output-preserve-modules-root.md |
Added documentation with configuration example for preserving module root structure |
packages/rolldown/src/options/docs/output-top-level-var.md |
Created documentation explaining performance benefits and TDZ-related issues |
packages/rolldown/src/index.ts |
Added export for the new AdvancedChunksGroup type |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
packages/rolldown/src/options/docs/output-minify-internal-exports.md
Outdated
Show resolved
Hide resolved
sapphi-red
force-pushed
the
01-09-docs_options_add_descriptions_for_output_options
branch
from
699aa57 to
0ffae79
Compare
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
sapphi-red
force-pushed
the
01-09-docs_options_add_descriptions_for_output_options
branch
from
0ffae79 to
18ed771
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
sapphi-red
force-pushed
the
01-09-docs_options_add_descriptions_for_output_options
branch
from
18ed771 to
59fa2ea
Compare
hyf0
approved these changes
Jan 9, 2026
Member
Author
Merge activity
|
Based on Rollup's documentation.
graphite-app
bot
force-pushed
the
01-09-docs_options_add_descriptions_for_output_options
branch
from
59fa2ea to
66957b4
Compare
graphite-app
bot
deleted the
01-09-docs_options_add_descriptions_for_output_options
branch
This was referenced Jan 14, 2026
shulaoda
added a commit
that referenced
this pull request
Jan 14, 2026
## [1.0.0-beta.60] - 2026-01-14 ### 💥 BREAKING CHANGES - tsconfig: enable auto-discovery by default (#7817) by @shulaoda ### 🚀 Features - distinguish transformer diagnostics from parse errors (#7872) by @shulaoda - emit transformer warnings instead of ignoring them (#7850) by @shulaoda - node: add `output.codeSplitting` option and deprecate `output.advancedChunks` (#7855) by @hyf0 - nativeMagicString reset (#7828) by @IWANABETHATGUY - nativeMagicString lastChar (#7819) by @IWANABETHATGUY - dev/lazy: inject lazy compilation runtime automatically (#7816) by @hyf0 - nativeMagicString snip (#7818) by @IWANABETHATGUY - nativeMagicString construct with options (#7814) by @IWANABETHATGUY - nativeMagicString clone (#7813) by @IWANABETHATGUY - nativeMagicString `insert` (#7812) by @IWANABETHATGUY - nativeMagicString `slice` (#7807) by @IWANABETHATGUY - nativeMagicString trim methods (#7800) by @IWANABETHATGUY - make closeBundle hook receive the last error (#7278) by @Copilot ### 🐛 Bug Fixes - when package only contains export default, cjsDefault didn't resolve correctly (#7873) by @IWANABETHATGUY - inline __name calls for default exports (#7862) by @IWANABETHATGUY - improve variable renaming to avoid unnecessary shadowing in nested scopes (#7859) by @IWANABETHATGUY - use correct index when inserting keepNames statements during export default transformation (#7853) by @IWANABETHATGUY - transform non-static dynamic imports when `dynamicImportInCjs` is `false` (#7823) by @shulaoda - dev/lazy: should include imported and non-executed modules in the patch (#7815) by @hyf0 - set ExportsKind to Esm when json is none object literal (#7808) by @IWANABETHATGUY - nativeMagicString move api (#7796) by @IWANABETHATGUY - remove unnecessary exports after merging into commong and user defined entry (#7789) by @IWANABETHATGUY - use output.name instead of chunk.name in mixed export warning (#7788) by @Copilot ### 🚜 Refactor - generalize ParseError to OxcError with dynamic EventKind (#7868) by @shulaoda - rust: rename `advanced_chunks` to `manual_code_splitting` (#7856) by @hyf0 - string_wizard error hanlding (#7830) by @IWANABETHATGUY - remove `experimental.disableLiveBindings` option (#7820) by @sapphi-red - node/test: run fixture tests in concurrent (#7790) by @hyf0 - move ConfigExport and RolldownOptionsFunction types to define-config (#7799) by @shulaoda - cli: validate config after resolving and improve error message (#7798) by @shulaoda ### 📚 Documentation - rebrand (#7670) by @yyx990803 - fix incorrect default value for propertyReadSideEffects (#7847) by @Copilot - remove options pages and redirect to reference pages (#7834) by @sapphi-red - options: inline types to option property pages (#7831) by @sapphi-red - options: port checks.pluginTimings content from options page to reference page (#7832) by @sapphi-red - options: use `@linkcode` where possible (#7824) by @sapphi-red - options: port content from options page to reference page (#7822) by @sapphi-red - options: add descriptions for output options (#7821) by @sapphi-red - options: add description for input options (#7802) by @sapphi-red - options: add description for `checks.*` (#7801) by @sapphi-red - apis: add hook graph (#7671) by @sapphi-red ### 🧪 Testing - add all valid combination of chunk exports related test (#7851) by @IWANABETHATGUY - enable MagicString test after api return type alignment (#7797) by @IWANABETHATGUY - init magic-string test (#7794) by @IWANABETHATGUY ### ⚙️ Miscellaneous Tasks - vite-tests: configure git user for rebase operation (#7875) by @shulaoda - rolldown_binding: remove v3 native plugins (#7837) by @shulaoda - rolldown_binding: allow crate-type as lib (#7866) by @Brooooooklyn - README.md: adjust position and size of rolldown logo (#7861) by @hyf0 - deps: update test262 submodule for tests (#7857) by @sapphi-red - deps: update oxc to v0.108.0 (#7845) by @renovate[bot] - deps: update dependency oxlint to v1.39.0 (#7849) by @renovate[bot] - deps: update dependency oxfmt to ^0.24.0 (#7844) by @renovate[bot] - deps: update npm packages (#7841) by @renovate[bot] - deps: update rust crates (#7839) by @renovate[bot] - deps: update github-actions (#7840) by @renovate[bot] - use workspace edition for all crates (#7829) by @IWANABETHATGUY - deps: update dependency oxlint-tsgolint to v0.11.0 (#7827) by @renovate[bot] - deps: update napi to v3.8.2 (#7810) by @renovate[bot] - remove outdated snapshot files (#7806) by @shulaoda - deps: update crate-ci/typos action to v1.42.0 (#7792) by @renovate[bot] Co-authored-by: shulaoda <[email protected]>
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
2 participants
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.
Based on Rollup's documentation.