guardian/dotcom-rendering

Remove `index.d.ts`

Aperta

#7638 aperta il 26 apr 2023

Vedi su GitHubGuida contributor
 (3 commenti) (1 reazione) (1 assegnatario)TypeScript (35 fork)auto 404
Pick me upTeam Candidate: WebXgood first issue

Metriche repository

Star
 (271 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

Why?

Declaration files create ambient types, which appear in a global namespace across the project. We think it's preferable to avoid adding types to a global scope, and instead prefer to import them as needed.

How?

Migrate the types in the index.d.ts1 file into normal .ts files, and import them as needed:

Footnotes

  1. https://github.com/guardian/dotcom-rendering/blob/4ea272b55efa01ba88f0f5ff60f6bc9d14198147/dotcom-rendering/index.d.ts ↩

Guida contributor

Direzione di ricerca
Identifica tutti i tipi in index.d.ts e spostali in file .ts separati, quindi importali dove necessario.
Tech stack
typescript
Dominio
frontend
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
TypeScript
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75