Skip to content
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.

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

Turn on eslint rule to disallow "floating promises" #1564

Merged

Conversation

corasaurus-hex
Copy link
Contributor

@corasaurus-hex corasaurus-hex commented Feb 26, 2022

What has Changed?

I turned on an ESLint rule to enforce the await or then+catch of all promises, or if not doing those then at least sticking void in front of them to signal that you're not awaiting/fully handling them on purpose.

This change does not affect how things run at all since adding void is just documentation stating to other developers "I am intentionally not handling this promise fully". Whether to change any of these to be awaited or then+catch was not evaluated for this PR and is outside of the scope of it.

@PEZ requested this change here: #1562 (comment)

My Calva PR Checklist

I have:

  • Read How to Contribute.
  • Directed this pull request at the dev branch. (Or have specific reasons to target some other branch.)
  • Made sure I have changed the PR base branch, so that it is not published. (Sorry for the nagging.)
  • Updated the [Unreleased] entry in CHANGELOG.md, linking the issue(s) that the PR is addressing.
  • Figured if anything about the fix warrants tests on Mac/Linux/Windows/Remote/Whatever, and either tested it there if so, or mentioned it in the PR.
  • Added to or updated docs in this branch, if appropriate
  • [~] Tests
    • [~] Tested the particular change
    • Figured if the change might have some side effects and tested those as well.
    • [~] Smoke tested the extension as such.
    • Tested the VSIX built from the PR (so, after you've submitted the PR). You'll find the artifacts by clicking Show all checks in the CI section of the PR page, and then Details on the ci/circleci: build test.
  • [~] Referenced the issue I am fixing/addressing in a commit message for the pull request.
    • [~] If I am fixing the issue, I have used GitHub's fixes/closes syntax
    • [~] If I am fixing just part of the issue, I have just referenced it w/o any of the "fixes” keywords.
  • [~] Created the issue I am fixing/addressing, if it was not present.
  • Formatted all JavaScript and TypeScript code that was changed. (use the prettier extension or run npm run prettier-format)
  • Confirmed that there are no linter warnings or errors (use the eslint extension, run npm run eslint before creating your PR, or run npm run eslint-watch to eslint as you go).

@corasaurus-hex corasaurus-hex changed the title Wip/no floating promises Turn on eslint rule to disallow "floating promises" Feb 26, 2022
@corasaurus-hex
Copy link
Contributor Author

Thanks, @bpringe!

@bpringe
Copy link
Member

bpringe commented Feb 26, 2022

Thanks!

@bpringe bpringe merged commit 568109d into BetterThanTomorrow:dev Feb 26, 2022
@PEZ
Copy link
Collaborator

PEZ commented Feb 26, 2022

Awesome. ❤️

@corasaurus-hex corasaurus-hex deleted the wip/no-floating-promises branch March 1, 2022 21:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants