-
-
Notifications
You must be signed in to change notification settings - Fork 794
feat(napi)!: standardize function naming with sync suffixes #15661
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
How to use the Graphite Merge QueueAdd either label to this PR to merge it via 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. |
There was a problem hiding this 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 standardizes the naming convention for synchronous and asynchronous functions across all NAPI packages (parser, transform, minify), establishing a consistent pattern where async functions use the base verb name and sync functions use a Sync suffix.
Key Changes
- Renamed async functions:
parseAsync→parse,transformAsync→transform, and introduced new asyncminify,isolatedDeclaration, andmoduleRunnerTransformfunctions - Renamed sync functions:
transform→transformSync,minify→minifySync,isolatedDeclaration→isolatedDeclarationSync,moduleRunnerTransform→moduleRunnerTransformSync - Enhanced documentation: Added comprehensive API documentation to all README files with clear function signatures and usage guidance
Reviewed Changes
Copilot reviewed 29 out of 33 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| napi/transform/src/transformer.rs | Refactored to extract shared logic into transform_impl and module_runner_transform_impl; renamed functions to follow new convention |
| napi/transform/src/isolated_declaration.rs | Refactored to extract shared logic into isolated_declaration_impl; added async variant |
| napi/transform/test/*.ts | Updated all test files to use new function names; simplified async tests to verify equivalence with sync |
| napi/transform/*.js | Updated all exports to include both sync and async function variants |
| napi/parser/src/lib.rs | Renamed parse_async to parse; refactored to use parse_impl |
| napi/parser/src/raw_transfer.rs | Renamed parse_async_raw to parse_raw |
| napi/parser/src-js/*.js | Updated parser exports and raw transfer implementations to use new naming |
| napi/parser/test/*.ts | Updated all parser tests to use parse instead of parseAsync |
| napi/minify/src/lib.rs | Refactored to extract shared logic into minify_impl; added async variant |
| napi/minify/test/*.ts | Updated all minify tests to use new function names |
| napi/minify/*.js | Updated all exports to include both sync and async function variants |
| napi/*/README.md | Added comprehensive API documentation with function signatures and usage guidance |
| napi/*/index.d.ts | Updated TypeScript definitions to reflect new function names and return types |
| napi/playground/index.d.ts | Added new properties to OxcSortImportsOptions (unrelated to main PR purpose) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
cd459e7 to
d86e3de
Compare
9f3c8eb to
8eac59c
Compare
4b812c7 to
c0a268e
Compare
Merge activity
|
closes #15576 ## Summary Standardizes function naming across all NAPI packages (parser, transform, minify) with a consistent pattern: - Async functions: `verb` (no suffix) - Sync functions: `verbSync` (with Sync suffix) ## Changes ### Breaking Changes **napi/parser:** - `parseAsync` → `parse` (async) - `parseSync` remains unchanged (sync) **napi/transform:** - `transformAsync` → `transform` (async) - `transform` → `transformSync` (sync) - `isolatedDeclaration` → `isolatedDeclarationSync` (sync) - Added new `isolatedDeclaration` function (async) - `moduleRunnerTransform` → `moduleRunnerTransformSync` (sync) - Added new `moduleRunnerTransform` function (async) **napi/minify:** - `minify` → `minifySync` (sync) - Added new `minify` function (async) 🤖 Generated with [Claude Code](https://claude.com/claude-code)
c0a268e to
ea51b0b
Compare
### 💥 BREAKING CHANGES - ea51b0b napi: [**BREAKING**] Standardize function naming with sync suffixes (#15661) (Boshen) ### 🚀 Features - 77efb76 parser: Improve error message for invalid switch clauses (#15728) (sapphi-red) - 5691727 parser: Improve `import source` `from` error message (#15727) (sapphi-red) - b7404bc parser: Improve error message for missing function body (#15726) (sapphi-red) - 71c2fb0 parser: Improve error message when JSX is found while not enabled (#15725) (sapphi-red) - 56e7e44 minifier: Disable removal of unnecessary `use strict` directives for DCE (#15691) (sapphi-red) - 8a61cfd allocator, ast: Introduce `UnstableAddress` trait (#15700) (overlookmotel) - f5ce55a napi: Export all options using wildcard exports (Boshen) - 68703b9 minifier: Rotate binary expressions to remove parentheses (#15473) (sapphi-red) ### 🐛 Bug Fixes - c023ba6 semantic: Do not duplicate statements in temp `Vec` when binding `TSModuleDeclaration`s (#15724) (overlookmotel) - d60ca81 parser: Reject `import something 'source'` (#15746) (sapphi-red) - e0728fa ast: Exclude comment end position from `is_inside_comment` check (#15753) (camc314) - 9f54a36 semantic: Error on `\00` in strict mode (#15743) (sapphi-red) - 440a977 ast: Include rest properties when using `get_binding_identifiers` (#15710) (camc314) ### ⚡ Performance - 1f09d3c parser: Faster checking for invalid modifiers (#15717) (overlookmotel) - d8d4e31 ast: Use loop instead of recursion in `TSModuleDeclarationBody::as_module_block_mut` (#15713) (overlookmotel) ### 📚 Documentation - e033d50 ast: Clarify behavior of `TSModuleDeclaration::has_use_strict_directive` (#15730) (overlookmotel) - 9eda70f allocator: Improve docs for `Address` methods (#15697) (overlookmotel)
### 💥 BREAKING CHANGES - ea51b0b napi: [**BREAKING**] Standardize function naming with sync suffixes (#15661) (Boshen) ### 🚀 Features - 77efb76 parser: Improve error message for invalid switch clauses (#15728) (sapphi-red) - 5691727 parser: Improve `import source` `from` error message (#15727) (sapphi-red) - b7404bc parser: Improve error message for missing function body (#15726) (sapphi-red) - 71c2fb0 parser: Improve error message when JSX is found while not enabled (#15725) (sapphi-red) - 56e7e44 minifier: Disable removal of unnecessary `use strict` directives for DCE (#15691) (sapphi-red) - 8a61cfd allocator, ast: Introduce `UnstableAddress` trait (#15700) (overlookmotel) - f5ce55a napi: Export all options using wildcard exports (Boshen) - 68703b9 minifier: Rotate binary expressions to remove parentheses (#15473) (sapphi-red) ### 🐛 Bug Fixes - c023ba6 semantic: Do not duplicate statements in temp `Vec` when binding `TSModuleDeclaration`s (#15724) (overlookmotel) - d60ca81 parser: Reject `import something 'source'` (#15746) (sapphi-red) - e0728fa ast: Exclude comment end position from `is_inside_comment` check (#15753) (camc314) - 9f54a36 semantic: Error on `\00` in strict mode (#15743) (sapphi-red) - 440a977 ast: Include rest properties when using `get_binding_identifiers` (#15710) (camc314) ### ⚡ Performance - 1f09d3c parser: Faster checking for invalid modifiers (#15717) (overlookmotel) - d8d4e31 ast: Use loop instead of recursion in `TSModuleDeclarationBody::as_module_block_mut` (#15713) (overlookmotel) ### 📚 Documentation - e033d50 ast: Clarify behavior of `TSModuleDeclaration::has_use_strict_directive` (#15730) (overlookmotel) - 9eda70f allocator: Improve docs for `Address` methods (#15697) (overlookmotel)
### 💥 BREAKING CHANGES - ea51b0b napi: [**BREAKING**] Standardize function naming with sync suffixes (oxc-project#15661) (Boshen) ### 🚀 Features - 77efb76 parser: Improve error message for invalid switch clauses (oxc-project#15728) (sapphi-red) - 5691727 parser: Improve `import source` `from` error message (oxc-project#15727) (sapphi-red) - b7404bc parser: Improve error message for missing function body (oxc-project#15726) (sapphi-red) - 71c2fb0 parser: Improve error message when JSX is found while not enabled (oxc-project#15725) (sapphi-red) - 56e7e44 minifier: Disable removal of unnecessary `use strict` directives for DCE (oxc-project#15691) (sapphi-red) - 8a61cfd allocator, ast: Introduce `UnstableAddress` trait (oxc-project#15700) (overlookmotel) - f5ce55a napi: Export all options using wildcard exports (Boshen) - 68703b9 minifier: Rotate binary expressions to remove parentheses (oxc-project#15473) (sapphi-red) ### 🐛 Bug Fixes - c023ba6 semantic: Do not duplicate statements in temp `Vec` when binding `TSModuleDeclaration`s (oxc-project#15724) (overlookmotel) - d60ca81 parser: Reject `import something 'source'` (oxc-project#15746) (sapphi-red) - e0728fa ast: Exclude comment end position from `is_inside_comment` check (oxc-project#15753) (camc314) - 9f54a36 semantic: Error on `\00` in strict mode (oxc-project#15743) (sapphi-red) - 440a977 ast: Include rest properties when using `get_binding_identifiers` (oxc-project#15710) (camc314) ### ⚡ Performance - 1f09d3c parser: Faster checking for invalid modifiers (oxc-project#15717) (overlookmotel) - d8d4e31 ast: Use loop instead of recursion in `TSModuleDeclarationBody::as_module_block_mut` (oxc-project#15713) (overlookmotel) ### 📚 Documentation - e033d50 ast: Clarify behavior of `TSModuleDeclaration::has_use_strict_directive` (oxc-project#15730) (overlookmotel) - 9eda70f allocator: Improve docs for `Address` methods (oxc-project#15697) (overlookmotel)
closes #15576
Summary
Standardizes function naming across all NAPI packages (parser, transform, minify) with a consistent pattern:
verb(no suffix)verbSync(with Sync suffix)Changes
Breaking Changes
napi/parser:
parseAsync→parse(async)parseSyncremains unchanged (sync)napi/transform:
transformAsync→transform(async)transform→transformSync(sync)isolatedDeclaration→isolatedDeclarationSync(sync)isolatedDeclarationfunction (async)moduleRunnerTransform→moduleRunnerTransformSync(sync)moduleRunnerTransformfunction (async)napi/minify:
minify→minifySync(sync)minifyfunction (async)🤖 Generated with Claude Code