flarum/framework

Convert core JS to Typescript

Open

#3,533 opened on Oct 2, 2020

View on GitHub
 (21 comments) (1 reaction) (2 assignees)PHP (6,111 stars) (830 forks)batch import
Good first issue

Description

This should be done in small, maximally isolated PRs: no more than a few files updated per PR so that we can slowly review and phase these in over time. Community contributions appreciated!

For overall progress, see the GitHub Project board: https://github.com/orgs/flarum/projects/21

Contributor guide

Tech stack
javascripttypescript
Domain
full stack
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScriptTypeScriptFamiliarity with Flarum's codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue outlines a plan to convert core JavaScript files to TypeScript in small, isolated PRs. Look at the linked GitHub Project board (https://github.com/orgs/flarum/projects/21) for overall progress. Check the repository's `/js` directory for existing TypeScript files and configuration (tsconfig.json). Consider starting with a simple utility file to demonstrate the conversion process as a pilot. Engage with the maintainers in the issue comments for guidance on preferred file order.