microsoft / microsoft/fluentui

feat(eslint): add lint rules that will notify user on missing await when calling async functions

Open
#19,234 24 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Area: Build System Area: Linting Resolution: Soft Close
Dominant language
TypeScript
Stars
20.3k
Forks
2.9k
Avg merge
2d 9h
Merged PRs (30d)
46

Description

current

  • all good
await main();

function async main(){
  // logic
  doWork()
 // logic
}

function async doWork(){
 // ...logic
}

expected

await main();

function async main(){
  // logic
/* 🚨🚨🚨 async function call missing AWAIT */ doWork()
 // logic
}

function async doWork(){
 // ...logic
}
  • we should enable/write a lint rule that will let you know about this issues. Also if you're missing await (which is quite crucial and will crash our programs )

Originally posted by @Hotell in https://github.com/microsoft/fluentui/pull/19151#discussion_r681825086

Use cases caused by lack of tooling:

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Start by locating Fluent UI's existing ESLint rules and configuration, then reproduce the shown TypeScript cases; done means a rule reports async calls missing await and has coverage for the relevant cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
eslint, typescript
Domain
testing-qa, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.