anuraghazra/github-readme-stats

Migrate codebase to Typescript

Open

#2 052 ouverte le 25 sept. 2022

Voir sur GitHub
 (35 commentaires) (2 réactions) (3 assignés)JavaScript (79 424 stars) (33 282 forks)batch import
enhancementhacktoberfesthelp wanted

Description

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.

Guide contributeur

Stack technique
javascripttypescript
Domaine
backenddeveloper experience
Type d'issue
refactor
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
5
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
over 1 week
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
mostly clear
Prérequis
JavaScript knowledgeTypeScript familiarityUnderstanding of codebase structure
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
20
Direction de recherche
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.