这是indexloc提供的服务，不要输入任何密码
Skip to content

feat: add options schema for return-await #414

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 12, 2025
Merged

feat: add options schema for return-await #414

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions internal/rules/return_await/options.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

35 changes: 8 additions & 27 deletions internal/rules/return_await/return_await.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,19 +38,6 @@ func buildRequiredPromiseAwaitSuggestionMessage() rule.RuleMessage {
}
}

type ReturnAwaitOption uint8

const (
ReturnAwaitOptionAlways ReturnAwaitOption = iota
ReturnAwaitOptionErrorHandlingCorrectnessOnly
ReturnAwaitOptionInTryCatch
ReturnAwaitOptionNever
)

type ReturnAwaitOptions struct {
Option *ReturnAwaitOption
}

type scopeInfo struct {
hasAsync bool
owningFunc *ast.Node
Expand All @@ -73,37 +60,31 @@ const (
whetherToAwaitNoAwait
)

func getWhetherToAwait(affectsErrorHandling bool, option ReturnAwaitOption) whetherToAwait {
func getWhetherToAwait(affectsErrorHandling bool, option ReturnAwaitOptionsOption) whetherToAwait {
switch option {
case ReturnAwaitOptionAlways:
case ReturnAwaitOptionsOptionAlways:
return whetherToAwaitAwait
case ReturnAwaitOptionErrorHandlingCorrectnessOnly:
case ReturnAwaitOptionsOptionErrorHandlingCorrectnessOnly:
if affectsErrorHandling {
return whetherToAwaitAwait
}
return whetherToAwaitDontCare
case ReturnAwaitOptionInTryCatch:
case ReturnAwaitOptionsOptionInTryCatch:
if affectsErrorHandling {
return whetherToAwaitAwait
}
return whetherToAwaitNoAwait
case ReturnAwaitOptionNever:
case ReturnAwaitOptionsOptionNever:
return whetherToAwaitNoAwait
default:
panic("unexpected ReturnAwaitOption")
panic("unexpected ReturnAwaitOptionsOption")
}
}

var ReturnAwaitRule = rule.Rule{
Name: "return-await",
Run: func(ctx rule.RuleContext, options any) rule.RuleListeners {
opts, ok := options.(ReturnAwaitOptions)
if !ok {
opts = ReturnAwaitOptions{}
}
if opts.Option == nil {
opts.Option = utils.Ref(ReturnAwaitOptionInTryCatch)
}
opts := utils.UnmarshalOptions[ReturnAwaitOptions](options, "return-await")

var scope *scopeInfo

Expand Down Expand Up @@ -259,7 +240,7 @@ var ReturnAwaitRule = rule.Rule{
affectsErrorHandling := affectsExplicitErrorHandling(node) || affectsExplicitResourceManagement(node)
useAutoFix := !affectsErrorHandling

shouldAwaitInCurrentContext := getWhetherToAwait(affectsErrorHandling, *opts.Option)
shouldAwaitInCurrentContext := getWhetherToAwait(affectsErrorHandling, opts.Option)

switch shouldAwaitInCurrentContext {
case whetherToAwaitAwait:
Expand Down
Loading