Skip to content

Comments

refactor: rename other to jsdoc in comments options#8256

Merged
graphite-app[bot] merged 1 commit intomainfrom
02-09-refactor_use_jsdoc_instead_of_other
Feb 9, 2026
Merged

refactor: rename other to jsdoc in comments options#8256
graphite-app[bot] merged 1 commit intomainfrom
02-09-refactor_use_jsdoc_instead_of_other

Conversation

@IWANABETHATGUY
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.

@IWANABETHATGUY IWANABETHATGUY changed the title refactor: use jsdoc instead of other refactor: rename other to jsdoc in comments options Feb 9, 2026
@IWANABETHATGUY IWANABETHATGUY marked this pull request as ready for review February 9, 2026 11:46
Copilot AI review requested due to automatic review settings February 9, 2026 11:47
@netlify
Copy link

netlify bot commented Feb 9, 2026

Deploy Preview for rolldown-rs canceled.

Name Link
🔨 Latest commit 76d08ed
🔍 Latest deploy log https://app.netlify.com/projects/rolldown-rs/deploys/6989d1d29431310008f5a583

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 renames the comment-category option key other to jsdoc across Rolldown’s TypeScript options, runtime validators, Rust core/binding types, and test/config schemas to better reflect its purpose (controlling preservation of JSDoc comments).

Changes:

  • Rename comments.othercomments.jsdoc in TS option types, normalization, and validation schemas.
  • Rename the corresponding Rust option fields and plumbing through compiler/codegen/minifier/HMR stages.
  • Update JSON schemas and test configs to use the new key.

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
packages/rolldown/src/utils/validator.ts Updates output options validation schema to expect comments.jsdoc.
packages/rolldown/src/options/output-options.ts Renames the public CommentsOptions field and updates option docs.
packages/rolldown/src/options/normalized-output-options.ts Normalizes comment options using jsdoc flag.
crates/rolldown_testing/_config.schema.json Updates generated config schema property name to jsdoc.
crates/rolldown_ecmascript/src/ecma_compiler.rs Wires jsdoc comment option through compiler and renames a public struct field.
crates/rolldown_common/src/inner_bundler_options/types/comments.rs Renames Rust common options fields and deserialization object field to jsdoc.
crates/rolldown_binding/src/utils/normalize_binding_options.rs Updates binding normalization mapping to jsdoc.
crates/rolldown_binding/src/types/binding_normalized_options.rs Exposes normalized binding comments option as jsdoc.
crates/rolldown_binding/src/options/binding_output_options/binding_comments_options.rs Renames N-API binding comments option field to jsdoc.
crates/rolldown/tests/rolldown/function/comments/none_with_legal_inline/_config.json Updates test config to use jsdoc.
crates/rolldown/src/stages/generate_stage/minify_chunks.rs Uses options.comments.jsdoc for minify comment preservation logic.
crates/rolldown/src/hmr/hmr_stage.rs Renames print options field usage from other to jsdoc.

@IWANABETHATGUY IWANABETHATGUY force-pushed the 02-09-refactor_use_jsdoc_instead_of_other branch from 9c8b55f to fce1302 Compare February 9, 2026 12:00
@github-actions
Copy link
Contributor

github-actions bot commented Feb 9, 2026

Benchmarks Rust

  • target: main(18c40ed)
  • pr: 02-09-refactor_use_jsdoc_instead_of_other(76d08ed)
group                                                        pr                                     target
-----                                                        --                                     ------
bundle/bundle@multi-duplicated-top-level-symbol              1.03     70.1±1.69ms        ? ?/sec    1.00     68.1±2.01ms        ? ?/sec
bundle/bundle@multi-duplicated-top-level-symbol-sourcemap    1.01     75.9±2.37ms        ? ?/sec    1.00     74.9±1.92ms        ? ?/sec
bundle/bundle@rome_ts                                        1.01    100.6±2.84ms        ? ?/sec    1.00     99.8±1.96ms        ? ?/sec
bundle/bundle@rome_ts-sourcemap                              1.02    112.0±1.88ms        ? ?/sec    1.00    110.1±1.68ms        ? ?/sec
bundle/bundle@threejs                                        1.03     36.2±2.51ms        ? ?/sec    1.00     35.1±0.84ms        ? ?/sec
bundle/bundle@threejs-sourcemap                              1.03     40.5±0.60ms        ? ?/sec    1.00     39.5±0.64ms        ? ?/sec
bundle/bundle@threejs10x                                     1.00    358.8±3.95ms        ? ?/sec    1.01    363.7±5.97ms        ? ?/sec
bundle/bundle@threejs10x-sourcemap                           1.00    416.3±5.69ms        ? ?/sec    1.01    421.9±3.96ms        ? ?/sec
scan/scan@rome_ts                                            1.00     79.8±2.35ms        ? ?/sec    1.01     80.4±2.33ms        ? ?/sec
scan/scan@threejs                                            1.00     28.0±1.88ms        ? ?/sec    1.00     27.9±1.71ms        ? ?/sec
scan/scan@threejs10x                                         1.00    285.3±4.58ms        ? ?/sec    1.00    284.1±3.74ms        ? ?/sec

@graphite-app
Copy link
Contributor

graphite-app bot commented Feb 9, 2026

Merge activity

@graphite-app graphite-app bot force-pushed the 02-09-refactor_use_jsdoc_instead_of_other branch from fce1302 to 76d08ed Compare February 9, 2026 12:23
@graphite-app graphite-app bot merged commit 76d08ed into main Feb 9, 2026
34 checks passed
@graphite-app graphite-app bot deleted the 02-09-refactor_use_jsdoc_instead_of_other branch February 9, 2026 12:33
This was referenced Feb 11, 2026
shulaoda added a commit that referenced this pull request Feb 11, 2026
## [1.0.0-rc.4] - 2026-02-11

💡 Granular `comments` Option
- New `output.comments` option provides fine-grained control over comment preservation
- The `output.legalComments` option is now deprecated and use `comments.legal` instead

### 🚀 Features

- rename error name to `RolldownError` from `RollupError` (#8262) by @sapphi-red
- add hidden `resolve_tsconfig` function for Vite (#8257) by @sapphi-red
- rust: introduce `rolldown_watcher` (#8161) by @hyf0
- unify `comments` and `legalComments` into a single granular `comments` option (#8229) by @IWANABETHATGUY
- add builtin plugin for visualizing chunk graph (#8162) by @IWANABETHATGUY
- show import declaration location in AssignToImport errors (#8222) by @Copilot
- show import declaration span in CannotCallNamespace error (#8223) by @Copilot
- emit error when plugin accidentally removes runtime module symbols (#8203) by @IWANABETHATGUY
- support tsconfig loading & inputMap for `transform` (#8180) by @sapphi-red
- rolldown_plugin_vite_reporter: update warning message to link to Rolldown docs (#8205) by @sapphi-red

### 🐛 Bug Fixes

- avoid panic on untranspiled JSX syntax by reporting a diagnostic error (#8226) by @IWANABETHATGUY
- rolldown_plugin_vite_import_glob: relax absolute path check and improve invalid glob warning (#8219) by @shulaoda
- merge chunks after detect circular reference (#8154) by @IWANABETHATGUY
- rust: detect runtime module side effects based on its content (#8209) by @hyf0

### 🚜 Refactor

- rename `other` to `jsdoc` in comments options (#8256) by @IWANABETHATGUY
- rename chunk-visualize plugin with bundle-analyzer plugin (#8255) by @IWANABETHATGUY
- remove EXPORT_UNDEFINED_VARIABLE error (#8228) by @Copilot
- consolidate missing runtime symbol errors into a single diagnostic (#8220) by @IWANABETHATGUY
- stabilize `parse` and `parseSync` (#8215) by @sapphi-red
- return errors instead of panicking on builtin plugin conversion failure (#8217) by @shulaoda
- expose `parse` / `minify` / `transform` from `rolldown/utils` (#8214) by @sapphi-red
- prepare defer chunk merging (#8153) by @IWANABETHATGUY

### 📚 Documentation

- remove `<script>` escape behavior difference note from `platform` option (#8253) by @sapphi-red
- TypeScript & JSX support by plugins (#8183) by @sapphi-red

### 🧪 Testing

- ensure runtime module is preserved even if it's not used but has side effects (#8213) by @hyf0

### ⚙️ Miscellaneous Tasks

- deps: update oxc to v0.113.0 (#8267) by @renovate[bot]
- deps: update dependency oxlint-tsgolint to v0.12.0 (#8272) by @renovate[bot]
- deps: update oxc apps (#8269) by @renovate[bot]
- deps: update test262 submodule for tests (#8261) by @sapphi-red
- deps: update crate-ci/typos action to v1.43.4 (#8260) by @renovate[bot]
- deps: update dependency esbuild to v0.27.3 (#8250) by @renovate[bot]
- deps: update rust crates (#8244) by @renovate[bot]
- deps: update dependency semver to v7.7.4 (#8247) by @renovate[bot]
- deps: update github-actions (#8243) by @renovate[bot]
- deps: update npm packages (#8245) by @renovate[bot]
- deps: update oxc resolver to v11.17.1 (#8240) by @renovate[bot]
- deps: update rust crate oxc_sourcemap to v6.0.2 (#8241) by @renovate[bot]
- rust: handle ignored `RUSTSEC-2025-0141` cargo check error (#8235) by @hyf0
- deps: update dependency oxlint-tsgolint to v0.11.5 (#8233) by @renovate[bot]
- deps: update dependency rolldown-plugin-dts to ^0.22.0 (#8232) by @renovate[bot]
- deps: update crate-ci/typos action to v1.43.3 (#8225) by @renovate[bot]
- deps: update dependency rolldown-plugin-dts to v0.21.9 (#8224) by @renovate[bot]
- deps: update crate-ci/typos action to v1.43.2 (#8212) by @renovate[bot]
- remove rolldown_plugin_vite_wasm_helper (#8207) by @shulaoda
- build docs for production (#8206) by @sapphi-red

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.

2 participants