microsoft / microsoft/TypeScript

Catch when callbacks are missing a return.

Offen
#36,472 5 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Needs Proposal Suggestion
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.3k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
117

Beschreibung

Search Terms

  • array callback return
  • eslint array-callback-return
  • catch missing return for callbacks

Suggestion

TypeScript does not recognise this as an error even though it clearly is - findIndex takes a callback which should return a boolean, returning an (implicit) undefined is IMO in 99% of cases a mistake.

[1,2,3].findIndex(e => {
  e === 1
})

I also think that if there is an explicit return of a falsey value such as null or undefined, then that should be fine. It's the lack of any return at all which should trigger an error, in my eyes.

I'm aware that ESLint can do this but not everyone uses ESLint, also ESLint can be a huge pain to configure sometimes, especially when Prettier, TypeScript and other things are involved.

Use Cases

It will definitely catch errors, IMHO, for people who don't use ESLint or do not have the rule array-callback-return.

Examples

No error:

[1,2,3].findIndex(e => 
  e === 1
)

No error:

[1,2,3].findIndex(e => e === 1)

A warning/errror: "Did you forget a return?"

[1,2,3].findIndex(e => {
  e === 1
})

Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit den Callback-Beispielen im Issue und prüfe, wie TypeScript derzeit Callbacks überprüft, die an Methoden wie findIndex übergeben werden. Definiere das Diagnoseverhalten für Callbacks mit Blockkörper ohne Rückgabe, wobei Callbacks mit Ausdruckskörper und explizite falsey-Rückgaben erhalten bleiben; als abgeschlossen gilt die Aufgabe, wenn die angeforderten Fälle konsistent unterschieden werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
compilers
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.