anuraghazra/github-readme-stats

Migrate codebase to Typescript

Open

#2,052 opened on Sep 25, 2022

View on GitHub
 (35 comments) (2 reactions) (3 assignees)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.

Contributor guide

Tech stack
javascripttypescript
Domain
backenddeveloper experience
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
5
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
JavaScript knowledgeTypeScript familiarityUnderstanding of codebase structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
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.