anuraghazra/github-readme-stats

Migrate codebase to Typescript

Open

#2.052 geöffnet am 25. Sept. 2022

Auf GitHub ansehen
 (35 Kommentare) (2 Reaktionen) (3 zugewiesene Personen)JavaScript (79.424 Stars) (33.282 Forks)batch import
enhancementhacktoberfesthelp wanted

Beschreibung

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.

Contributor Guide

Tech Stack
javascripttypescript
Domain
backenddeveloper experience
Issue Type
refactor
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
5
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
over 1 week
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
JavaScript knowledgeTypeScript familiarityUnderstanding of codebase structure
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
20
Research-Richtung
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.