Rule Change: make no-return-await suggestable

[dbartholomae]

What rule do you want to change?

no-return-await

What change to do you want to make?

Implement autofix

How do you think the change should be implemented?

A new option

Example code

async function foo {
  return await Promise.resolve("bar")
}

What does the rule currently do for this code?

// Error, but don't change:
async function foo {
return await Promise.resolve("bar")
}

What will the rule do after it's changed?

// Fix it
async function foo {
return Promise.resolve("bar")
}

Participation

• I am willing to submit a pull request to implement this change.

Additional comments

Hi! There have been discussions about whether no-return-await should be a core rule. These are resolved - and, consequently, I would argue that the rule should be auto-fixable.

[yeonjuan]

Hi @dbartholomae This proposal has been made in the past (#7593).
And it was not accepted due to the removing await can change the behavior of code.

[mdjermanovic]

I agree with @yeonjuan, per #7593 (comment) this doesn't seem safe for autofixing.

Perhaps we could consider implementing this as suggestions?

[dbartholomae]

Thanks, I didn't find that issue when searching.

[dbartholomae]

Happy to close this, unless it makes sense to discuss implementing this as a suggestion here

[nzakas]

I'd be fine with implementing a suggestion. Just so everyone is aware: suggestions have no effect on the command line, they are just displayed inside of editors like Visual Studio Code as potential fixes. If that's what you're interested in, then we can move forward.

[dbartholomae]

Is it possible to auto-fix suggestions via eslint --fix --fix-type suggestion? I'm looking for a way to autofix this in a large codebase, so suggestions without a way to auto fix wouldn't help me and then I would implement a codemod instead.

[dbartholomae]

If there is interest in some way to auto-fix suggestions, that would also be something that I would be willing to contribute - or set up as a separate open-source repo that uses eslint machine-readable output.

[nzakas]

No, there is no way to autofix suggestions. The --fix-type option is unfortunately named because it means fixing rules that are described as suggestions rather than editor suggestions. A naming collision we can't quite escape.

And no, we don't want to auto-fix suggestions in the core. As already explained, autofixes must not change the meaning of the code being fixed as otherwise there can be side effects that are difficult to identify.

[dbartholomae]

Thanks! I haven't tried it yet, but it seems that eslint-interactive already allows to auto-fix suggestions. I'll check it, and if it works, I would love to contribute a suggestion for this rule :)

[dbartholomae]

Looks good! If you are interested, I'm happy to provide a PR on this. Thanks for all the support and the patience with my questions!

[mdjermanovic]

Yes, PR is welcome!

[dbartholomae]

I've opened #16637 to fix this.