Skip to content

docs(parser/napi, linter/plugins): add JSDoc comments to raw transfer constants#20286

Merged
graphite-app[bot] merged 1 commit intomainfrom
om/03-12-docs_parser_napi_linter_plugins_add_jsdoc_comments_to_raw_transfer_constants
Mar 12, 2026
Merged

docs(parser/napi, linter/plugins): add JSDoc comments to raw transfer constants#20286
graphite-app[bot] merged 1 commit intomainfrom
om/03-12-docs_parser_napi_linter_plugins_add_jsdoc_comments_to_raw_transfer_constants

Conversation

@overlookmotel
Copy link
Member

@overlookmotel overlookmotel commented Mar 12, 2026

Comments-only change. Add JSDoc comments to the constants related to raw transfer in generated files constants.js / constants.ts. There are now a lot of constants, and it wasn't clear what they all mean.

@github-actions github-actions bot added A-linter Area - Linter A-parser Area - Parser A-cli Area - CLI A-ast-tools Area - AST tools A-linter-plugins Area - Linter JS plugins labels Mar 12, 2026
Copy link
Member Author


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • 0-merge - adds this PR to the back of the merge queue
  • hotfix - for urgent changes, fast-track this PR to the front of 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.

@github-actions github-actions bot added the C-docs Category - Documentation. Related to user-facing or internal documentation label Mar 12, 2026
@overlookmotel overlookmotel marked this pull request as ready for review March 12, 2026 12:15
@overlookmotel overlookmotel requested a review from camc314 as a code owner March 12, 2026 12:15
Copilot AI review requested due to automatic review settings March 12, 2026 12:15
@overlookmotel overlookmotel self-assigned this Mar 12, 2026
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

Adds JSDoc documentation for the raw-transfer buffer layout constants so consumers of the generated constants.js / constants.ts can more easily understand sizes/alignments and field offsets.

Changes:

  • Add JSDoc blocks to the raw-transfer constants template in raw_transfer.rs.
  • Regenerate napi/parser JS constants output with the new comments.
  • Regenerate apps/oxlint TS constants output with the new comments.

Reviewed changes

Copilot reviewed 1 out of 3 changed files in this pull request and generated 1 comment.

File Description
tasks/ast_tools/src/generators/raw_transfer.rs Updates the generator template to emit JSDoc for each raw-transfer constant.
napi/parser/src-js/generated/constants.js Regenerated output containing the new JSDoc comments for buffer/offset constants.
apps/oxlint/src-js/generated/constants.ts Regenerated output containing the same JSDoc comments for TS consumers.

@overlookmotel overlookmotel force-pushed the om/03-12-docs_parser_napi_linter_plugins_add_jsdoc_comments_to_raw_transfer_constants branch from 8b941c0 to fbe3a9d Compare March 12, 2026 12:34
@overlookmotel overlookmotel added the 0-merge Merge with Graphite Merge Queue label Mar 12, 2026
Copy link
Member Author

overlookmotel commented Mar 12, 2026

Merge activity

… constants (#20286)

Comments-only change. Add JSDoc comments to the constants related to raw transfer in generated files `constants.js` / `constants.ts`. There are now a lot of constants, and it wasn't clear what they all mean.
@graphite-app graphite-app bot force-pushed the om/03-12-docs_parser_napi_linter_plugins_add_jsdoc_comments_to_raw_transfer_constants branch from fbe3a9d to e4aa5b5 Compare March 12, 2026 12:46
@graphite-app graphite-app bot merged commit e4aa5b5 into main Mar 12, 2026
19 checks passed
@graphite-app graphite-app bot deleted the om/03-12-docs_parser_napi_linter_plugins_add_jsdoc_comments_to_raw_transfer_constants branch March 12, 2026 12:57
graphite-app bot pushed a commit that referenced this pull request Mar 12, 2026
# Oxlint
### 🐛 Bug Fixes

- 6b46ce8 oxlint: Ignore inherited root-only options in nested configs (#20291) (camc314)
- bc20217 oxlint,oxfmt: Omit useless `| null` for `Option<T>` field from schema (#20273) (leaysgur)
- f26e6ab linter: Make `generate-plugin-eslint` script work on windows (#20246) (camc314)

### 📚 Documentation

- e4aa5b5 parser/napi, linter/plugins: Add JSDoc comments to raw transfer constants (#20286) (overlookmotel)
- f339f10 linter/plugins: Promote JS plugins to alpha status (#20281) (overlookmotel)
# Oxfmt
### 🐛 Bug Fixes

- 96f761f oxfmt: Ensure stdin blocking mode is set for non-TTY environments (#20289) (camc314)
- bc20217 oxlint,oxfmt: Omit useless `| null` for `Option<T>` field from schema (#20273) (leaysgur)
Boshen added a commit that referenced this pull request Mar 14, 2026
### 🚀 Features

- e7163b6 ecmascript: Add known-globals to side-effect-free property
reads (#20212) (Dunqing)
- 139ab68 ecmascript: Add `property_write_side_effects` to
`MayHaveSideEffectsContext` (#20217) (Dunqing)

### 🐛 Bug Fixes

- 78c264a parser: Fix conditional expressions with arrow-function
alternates in TS (#20356) (camc314)
- 5c97b14 minifier: Recognize object spread of object literals as
side-effect-free (#20299) (Boshen)
- 1ff5c1d transformer/typescript: Rewrite extensions in dynamic
`import()` expressions (#20121) (Sverre Johansen)
- 1c07b3b diagnostics: Handle `WouldBlock` in stdout writes to prevent
panic (#20295) (Boshen)
- ade14d4 ecmascript: Enhance side-effect detection for classes,
TypedArrays, computed members, and spread (#20213) (Dunqing)

### ⚡ Performance

- 5474d0a semantic: V8-style walk-up reference resolution (#20292)
(Boshen)

### 📚 Documentation

- e4aa5b5 parser/napi, linter/plugins: Add JSDoc comments to raw
transfer constants (#20286) (overlookmotel)

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

Labels

0-merge Merge with Graphite Merge Queue A-ast-tools Area - AST tools A-cli Area - CLI A-linter Area - Linter A-linter-plugins Area - Linter JS plugins A-parser Area - Parser C-docs Category - Documentation. Related to user-facing or internal documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants