winglang/wing

Eslint rule - check that all SDK APIs are exported

Open

#297 geöffnet am 19. Okt. 2022

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (214 Forks)github user discovery
good first issue🎨 sdk👷‍♀️ contributor-experience

Repository-Metriken

Stars
 (5.385 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

It would be handy to have a custom eslint plugin that asserts that all typescript files are exported to the root of the SDK. Any exported APIs inside a directory named internal or with the pattern *.util.ts can be excluded.

In my experience it's pretty easy to forget to re-export a module in index.ts, so a linter rule would help.

Contributor Guide

Research-Richtung
Recherchieren Sie, wie Sie mit TypeScript eine benutzerdefinierte ESLint Regel erstellen. Untersuchen Sie die Exportstruktur des SDK, um zu verstehen, welche Dateien exportiert werden müssen. Schreiben Sie eine Regel, die das AST durchläuft, um fehlende Exporte in index.ts Dateien zu erkennen, wobei interne Verzeichnisse und *.util.ts Dateien ausgeschlossen werden.
Tech Stack
typescript
Domain
developer experiencetooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
TypeScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60