anuraghazra/github-readme-stats

Migrate codebase to Typescript

Open

#2,052 创建于 2022年9月25日

在 GitHub 查看
 (35 评论) (2 反应) (3 负责人)JavaScript (79,424 star) (33,282 fork)batch import
enhancementhacktoberfesthelp wanted

描述

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.

贡献者指南

技术栈
javascripttypescript
领域
backenddeveloper experience
议题类型
refactor
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
5
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
over 1 week
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
JavaScript knowledgeTypeScript familiarityUnderstanding of codebase structure
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
20
研究方向
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.