anuraghazra/github-readme-stats

Migrate codebase to Typescript

Open

Aperta il 25 set 2022

Vedi su GitHub
 (35 commenti) (2 reazioni) (3 assegnatari)JavaScript (79.424 star) (33.282 fork)batch import
enhancementhacktoberfesthelp wanted

Descrizione

Is your feature request related to a problem? Please describe.

We currently use javascript + type definitions. I, however, think migrating the project to typescript will significantly improve the development experience since it allows us to catch errors earlier.

Extra information

There were some attempts in the past that people can build upon if they want to take on this issue:

Additionally, @HwangTaehyun translated part of the codebase to typescript when creating https://github.com/HwangTaehyun/github-contributor-stats.

Guida contributor

Tech stack
javascripttypescript
Dominio
backenddeveloper experience
Tipo issue
refactor
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
5
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
over 1 week
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
mostly clear
Prerequisiti
JavaScript knowledgeTypeScript familiarityUnderstanding of codebase structure
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
20
Direzione di ricerca
Review previous migration attempts in PRs #1288 and #832, as well as the fork by HwangTaehyun (github contributor stats). The existing type definitions in src/fetchers/types.d.ts should be leveraged. The migration involves converting all .js files to .ts, updating imports, and ensuring type safety across the entire codebase. Examine the comments and diff of the linked PRs to understand the blockers and progress made.