fix(promise-function-async): use suggestion instead of auto-fix for hybrid return types#618
Merged
graphite-app[bot] merged 1 commit intomainfrom Jan 30, 2026
Conversation
Contributor
Author
How to use the Graphite Merge QueueAdd the label 0-merge 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. |
camc314
force-pushed
the
c/01-30-fix_promise-function-async_use_suggestion_instead_of_auto-fix_for_hybrid_return_types
branch
from
adcef89 to
f55fd8f
Compare
camc314
force-pushed
the
c/01-30-fix_promise-function-async_use_different_error_message_for_hybrid_return_types
branch
from
d365700 to
8026590
Compare
Contributor
Author
Merge activity
|
There was a problem hiding this comment.
Pull request overview
Adjusts the promise-function-async rule so that hybrid return types (promise ∪ non-promise) without an explicit return type annotation produce a suggestion rather than an auto-fix, giving users control over whether to add async or instead add/clarify a return type annotation (per #18732).
Changes:
- Add a dedicated suggestion message (
missingAsyncHybridReturnSuggestion) for addingasync. - Report hybrid return type cases via
ReportNodeWithSuggestions(no auto-fix), while keepingReportNodeWithFixesfor non-hybrid cases. - Update rule tests to assert suggestions (instead of
Output) for hybrid return type scenarios.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| internal/rules/promise_function_async/promise_function_async.go | Switch hybrid return type handling from auto-fix to suggestion; add suggestion message. |
| internal/rules/promise_function_async/promise_function_async_test.go | Update invalid cases to validate suggestion-based behavior for hybrid return types. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
graphite-app
Bot
changed the base branch from
c/01-30-fix_promise-function-async_use_different_error_message_for_hybrid_return_types
to
graphite-base/618
camc314
force-pushed
the
c/01-30-fix_promise-function-async_use_suggestion_instead_of_auto-fix_for_hybrid_return_types
branch
from
f55fd8f to
4069660
Compare
…ybrid return types (#618) For functions with hybrid return types (union of promise and non-promise types without explicit return type annotation), use a suggestion instead of an auto-fix. This gives users more control since adding async may not always be the intended fix - they might want to add an explicit return type annotation instead. fixes oxc-project/oxc#18732
graphite-app
Bot
force-pushed
the
c/01-30-fix_promise-function-async_use_suggestion_instead_of_auto-fix_for_hybrid_return_types
branch
from
4069660 to
f84cafa
Compare
graphite-app
Bot
deleted the
c/01-30-fix_promise-function-async_use_suggestion_instead_of_auto-fix_for_hybrid_return_types
branch
ghost
mentioned this pull request
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
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.
For functions with hybrid return types (union of promise and non-promise types without explicit return type annotation), use a suggestion instead of an auto-fix. This gives users more control since adding async may not always be the intended fix - they might want to add an explicit return type annotation instead.
fixes oxc-project/oxc#18732