lint promise-function-async

[turadg]

refs: #10809

Description

Functions that return Promises should do so always. If they are synchronous and throw, the caller will get an exception instead of a rejected promise.

This enables https://typescript-eslint.io/rules/promise-function-async/ to ensure that promise-returning functions are marked async. Its level is "warn" until we are confident to always require this.

Marking this draft because the ergonomics aren't great. We might want to add some features upstream before enabling this.

Security Considerations

Scaling Considerations

Documentation Considerations

Testing Considerations

Upgrade Considerations

[mhofman]

Marking this draft because the ergonomics aren't great. We might want to add some features upstream before enabling this.

Yeah I hate 99% of the changes. We need to configure some exceptions. Let's discuss offline.