winglang/wing

Eslint rule - check that all SDK APIs are exported

Open

#297 ouverte le 19 oct. 2022

Voir sur GitHub
 (4 commentaires) (0 réactions) (0 assignés)TypeScript (214 forks)github user discovery
good first issue🎨 sdk👷‍♀️ contributor-experience

Métriques du dépôt

Stars
 (5 385 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Recherchez comment créer une règle ESLint personnalisée en utilisant TypeScript. Inspectez la structure d'exportation du SDK pour comprendre quels fichiers doivent être exportés. Écrivez une règle qui parcourt l'AST pour détecter les exportations manquantes dans les fichiers index.ts, en excluant les répertoires internes et les fichiers *.util.ts.
Stack technique
typescript
Domaine
developer experiencetooling
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
TypeScript
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60