winglang/wing

Eslint rule - check that all SDK APIs are exported

Open

#297 aperta il 19 ott 2022

Vedi su GitHub
 (4 commenti) (0 reazioni) (0 assegnatari)TypeScript (214 fork)github user discovery
good first issue🎨 sdk👷‍♀️ contributor-experience

Metriche repository

Star
 (5385 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Ricerca come creare una regola ESLint personalizzata usando TypeScript. Ispeziona la struttura di esportazione dell'SDK per capire quali file devono essere esportati. Scrivi una regola che attraversi l'AST per rilevare esportazioni mancanti nei file index.ts, escludendo le directory interne e i file *.util.ts.
Tech stack
typescript
Dominio
developer experiencetooling
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
TypeScript
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60