Proposal: Implement autofix for `no-return-await`

Versions

• ESLint: 3.10
• Node: 7.1
• npm: 4.0.2

Description

I propose to implement an auto-fixer for the new no-return-await rule. Since return await value has the same meaning as return value in async functions, an auto-fix can be implemented which simply removes the await keyword.

There is currently one known exception to this - try/catch blocks. See pending issue #7581 (PR with fix also pending merge).

---

I have an implementation of the auto-fixer ready - if you are interested you may see it here. Once this issue gets accepted I will open a PR with the actual implementation for further review.

[platinumazure]

@isiahmeadows @not-an-aardvark This is interesting discussion, but can we please keep this issue focused to autofixing (or not) for no-return-await? Please feel free to visit our Gitter chat if you wish to continue the general auto-fix discussion, or please feel free to open an issue if you believe you have identified an issue with one of our other rules.

[dead-claudia]

Oh. I didn’t realize strict limited itself to that.

I’ll also point out that it’s generally a bad idea to rely on the resolution order of two independent promises, so I’d be shocked if they would actually break anything in practice. (The above sample already warns, and the autofixer doesn’t touch ignored lines IIUC).

If you actually wish for that kind of behavior, it’s best to make it explicit, though, so ESLint doesn’t complain.

// Option 1
const p = Promise.resolve();

async function foo() {
  // I know it seems odd, but it's intentional.
  return await p; // eslint-disable-line no-return-await
}

async function bar() {
  return p;
}

// Option 2
const p = Promise.resolve();

async function foo() {
  // Very obviously intentional.
  return Promise.resolve().then(() => p);
}

async function bar() {
  return p;
}