Skip to content

Comments

docs: add more examples and details#8054

Merged
sapphi-red merged 3 commits intomainfrom
01-26-docs_add_more_examples_and_details
Jan 26, 2026
Merged

docs: add more examples and details#8054
sapphi-red merged 3 commits intomainfrom
01-26-docs_add_more_examples_and_details

Conversation

@sapphi-red
Copy link
Member

No description provided.

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 Jan 26, 2026

Deploy Preview for rolldown-rs ready!

Name Link
🔨 Latest commit d8100a0
🔍 Latest deploy log https://app.netlify.com/projects/rolldown-rs/deploys/6976ff901c6c9d00084a1207
😎 Deploy Preview https://deploy-preview-8054--rolldown-rs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@sapphi-red sapphi-red marked this pull request as ready for review January 26, 2026 05:37
Copilot AI review requested due to automatic review settings January 26, 2026 05:37
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 adds more documentation examples and details throughout the codebase. The changes primarily enhance existing documentation with code examples, detailed explanations, and improved cross-references.

Changes:

  • Added JSDoc examples and improved descriptions for configuration functions (defineConfig, watch) and interfaces (ResolveIdExtraOptions, RolldownWatcher)
  • Enhanced documentation for transform, output, and input options with more detailed examples and external links to Oxc documentation
  • Created new markdown documentation files explaining various features (output format types, checks options, banner/footer usage patterns)
  • Updated generator code to ensure generated documentation has consistent punctuation (periods at end of sentences)
  • Reorganized external.md documentation for better readability

Reviewed changes

Copilot reviewed 35 out of 36 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
tasks/generator/src/generators/checks.rs Added period to generated documentation strings and trims periods when needed for validation schema
packages/rolldown/src/utils/define-config.ts Added example usage in JSDoc
packages/rolldown/src/plugin/index.ts Documented custom and kind properties in ResolveIdExtraOptions with detailed examples
packages/rolldown/src/options/transform-options.ts Fixed code block syntax, added links to Oxc documentation, fixed indentation
packages/rolldown/src/options/output-options.ts Added documentation links and includes for various output options
packages/rolldown/src/options/normalized-output-options.ts Added JSDoc description linking to ModuleFormat
packages/rolldown/src/options/input-options.ts Enhanced documentation with better cross-references and examples
packages/rolldown/src/options/generated/checks-options.ts Updated generated documentation with periods and includes
packages/rolldown/src/api/watch/watch-emitter.ts Added JSDoc for RolldownWatcher interface methods
packages/rolldown/src/api/watch/index.ts Changed from const arrow function to function declaration for TypeDoc compatibility
packages/rolldown/src/options/docs/*.md Created multiple new documentation files with examples and detailed explanations
docs/guide/notable-features.md Updated links to use proper cross-references
docs/apis/plugin-api/hook-filters.md Added tip about @rolldown/pluginutils
crates/rolldown_error/src/types/event_kind.rs Updated documentation comments to match TypeScript changes

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <[email protected]>
Signed-off-by: 翠 <[email protected]>
Copilot AI review requested due to automatic review settings January 26, 2026 05:44
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 35 out of 36 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link
Contributor

Benchmarks Rust

  • target: main(1d26877)
  • pr: 01-26-docs_add_more_examples_and_details(d8100a0)
group                                                        pr                                     target
-----                                                        --                                     ------
bundle/bundle@multi-duplicated-top-level-symbol              1.07     76.6±2.60ms        ? ?/sec    1.00     71.8±1.81ms        ? ?/sec
bundle/bundle@multi-duplicated-top-level-symbol-sourcemap    1.07     84.7±2.50ms        ? ?/sec    1.00     79.0±3.97ms        ? ?/sec
bundle/bundle@rome_ts                                        1.04    107.6±3.25ms        ? ?/sec    1.00    103.7±1.96ms        ? ?/sec
bundle/bundle@rome_ts-sourcemap                              1.04    119.6±2.73ms        ? ?/sec    1.00    115.3±2.39ms        ? ?/sec
bundle/bundle@threejs                                        1.03     38.7±3.21ms        ? ?/sec    1.00     37.5±1.08ms        ? ?/sec
bundle/bundle@threejs-sourcemap                              1.02     43.3±0.83ms        ? ?/sec    1.00     42.6±0.79ms        ? ?/sec
bundle/bundle@threejs10x                                     1.01    385.6±5.72ms        ? ?/sec    1.00    381.2±6.13ms        ? ?/sec
bundle/bundle@threejs10x-sourcemap                           1.03    444.9±5.99ms        ? ?/sec    1.00    433.9±6.13ms        ? ?/sec
scan/scan@rome_ts                                            1.00     82.3±1.64ms        ? ?/sec    1.03     84.4±2.13ms        ? ?/sec
scan/scan@threejs                                            1.00     29.1±1.79ms        ? ?/sec    1.01     29.3±1.95ms        ? ?/sec
scan/scan@threejs10x                                         1.00    290.4±4.08ms        ? ?/sec    1.02    295.6±4.12ms        ? ?/sec

@sapphi-red sapphi-red merged commit 4240918 into main Jan 26, 2026
35 checks passed
@sapphi-red sapphi-red deleted the 01-26-docs_add_more_examples_and_details branch January 26, 2026 06:22
This was referenced Jan 28, 2026
shulaoda added a commit that referenced this pull request Jan 28, 2026
## [1.0.0-rc.2] - 2026-01-28

⚡ Lazy Barrel Optimization

- Skips compilation of unused re-export modules in side-effect-free barrel modules
- Particularly beneficial for projects importing from large component libraries

For large component libraries like Ant Design, when you import just one component:

```js
import { Button } from 'antd';
Button;
```

| Metric                    | Without lazy barrel | With lazy barrel |
| -------------------- | --------------------- | ---------------- |
| Modules compiled | 2986                       | 250              |
| Build time               | ~210ms                  | ~50ms            |

By enabling lazy barrel, Rolldown reduces the number of compiled modules by 90% and speeds up the build by 2-4x. 

Enable it in your config:

```js
export default {
  experimental: {
    lazyBarrel: true,
  },
};
```

For more details, see the https://rolldown.rs/in-depth/lazy-barrel-optimization

### 💥 BREAKING CHANGES

- expose `\0rolldown/runtime` in transform hook (#8068) by @hyf0
- rename `rolldown:runtime` to `\0rolldown/runtime.js` (#8067) by @hyf0

### 🚀 Features

- remove inlined constants in smart mode (#8085) by @sapphi-red
- allow more options for `this.emitFile` with `type: 'prebuilt-chunk'` (#8062) by @sapphi-red
- warn when both code and postBanner contain shebang (#8039) by @Copilot

### 🐛 Bug Fixes

- update the links to Rolldown docs in the error messages (#8103) by @sapphi-red
- handle tsconfig.json load errors (#8105) by @sapphi-red
- include inlined constants in namespace object (#8099) by @sapphi-red
- vite test ci (#8084) by @IWANABETHATGUY
- renamer: nested binding shadowing external module namespace in UMD/IIFE formats (#8083) by @Dunqing
- deduplicate ESM chunk imports by canonical symbol (#8059) by @IWANABETHATGUY
- refine side-effect detection for BigInt and RegExp (#8060) by @IWANABETHATGUY
- rust: use string literal span for `new URL` error diagnostic (#8043) by @valadaptive
- rust: use ModuleType::Asset for `new URL` imports (#8035) by @valadaptive
- CJS-ESM interop - property assignment on CJS module exports (#8006) by @IWANABETHATGUY
- eliminate the facade chunk if the dynamic entry module has been merged into common chunk (#8046) by @IWANABETHATGUY
- Inlining dynamic imports broken with multiple entry points (#8037) by @IWANABETHATGUY
- devtools: revert `Chunk#id` to `Chunk#chunk_id` (#8040) by @hyf0
- invert `__exportAll` parameter logic to reduce default output size (#8036) by @Copilot
- `</script` tag search should be case insensitive (#8033) by @IWANABETHATGUY
- use directory name as-is for the variable name even if the name contained `.` (#8029) by @Copilot
- dev/lazy: remove unnecessary rewrite from top level `this` to `undefined` (#8020) by @hyf0
- dev/lazy: should keep lazy entries imports for patch file (#8019) by @hyf0
- `output.generatedCode.preset: 'es2015'` was not set by default (#8026) by @sapphi-red
- node: align option validator to types (#8023) by @sapphi-red
- node: allow `output.strictExecutionOrder` by the option validator (#8022) by @sapphi-red
- types: return `this` from on / off methods of `RolldownWatcher` (#8015) by @sapphi-red

### 🚜 Refactor

- rolldown_plugin_vite_dynamic_import_vars: remove v1 implementation (#8096) by @shulaoda
- rolldown_plugin_vite_import_glob: remove v1 implementation (#8095) by @shulaoda
- lazy-barrel: restructure lazy barrel implementation (#8070) by @shulaoda
- remove `use_built_ins` and `use_spread` from internal JSX options (#8079) by @sapphi-red
- remove `experimental.transformHiresSourcemap` (#8055) by @Copilot
- rust: use `is_data_url` more consistently (#8042) by @valadaptive
- use `FxIndexMap` to store EntryPoint (#8032) by @IWANABETHATGUY
- node: add type checks that ensures validator schema is up to date with types (#8024) by @sapphi-red

### 📚 Documentation

- link to vite plugin registry (#8086) by @sapphi-red
- lazy-barrel: improve documentation and enable in sidebar (#8072) by @shulaoda
- add more examples and details (#8054) by @sapphi-red
- in-depth: add dead code elimination page (#8007) by @sapphi-red
- update status from beta to release candidate (#8012) by @shulaoda

### ⚡ Performance

- run inline-const pass for modules that are affected by inlining (#8064) by @sapphi-red

### 🧪 Testing

- lazy-barrel: use package.json sideEffects instead of plugin hook (#8077) by @shulaoda
- lazy-barrel: enable tests and add treeshake-behavior cases (#8071) by @shulaoda

### ⚙️ Miscellaneous Tasks

- deps: update crate-ci/typos action to v1.42.3 (#8087) by @renovate[bot]
- deps: update rollup submodule for tests to v4.56.0 (#8073) by @sapphi-red
- deps: update oxc to v0.111.0 (#8063) by @renovate[bot]
- deps: update dependency rolldown-plugin-dts to v0.21.6 (#8076) by @renovate[bot]
- deps: update test262 submodule for tests (#8074) by @sapphi-red
- deps: update crate-ci/typos action to v1.42.2 (#8069) by @renovate[bot]
- deps: update oxc apps (#8066) by @renovate[bot]
- remove `{@include ./foo.md}` from d.ts files (#8056) by @sapphi-red
- deps: update dependency oxlint-tsgolint to v0.11.2 (#8057) by @renovate[bot]
- deps: update github-actions (#8050) by @renovate[bot]
- deps: update npm packages (#8051) by @renovate[bot]
- deps: update rust crates (#8049) by @renovate[bot]
- debug: add IdxExt debug trait for human-readable index debugging (#8045) by @IWANABETHATGUY
- deps: update dependency rolldown-plugin-dts to v0.21.5 (#8034) by @renovate[bot]
- deps: update oxc resolver to v11.16.4 (#8031) by @renovate[bot]
- deps: update dependency rolldown-plugin-dts to v0.21.4 (#8030) by @renovate[bot]
- deps: update dependency rust to v1.93.0 (#8018) by @renovate[bot]
- archive 2025 beta changelog (#8014) by @shulaoda
- update release workflow version pattern from beta to rc (#8013) by @shulaoda

### ❤️ New Contributors

* @valadaptive made their first contribution in [#8043](#8043)

Co-authored-by: shulaoda <[email protected]>
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.

1 participant