egoist/majo

Convert to TypeScript

Open

#13 opened on Jun 10, 2019

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (53 stars) (13 forks)user submission
:dollar: Funded on Issuehuntenhancementhelp wanted

Description

Currently it's written in JS and documented in jsdoc, we should convert the codebase to TypeScript and automatically generate type definitions.

Backers (Total: $100.00)

Submitted pull Requests

Become a backer now!

Or submit a pull request to get the deposits!

Tips

IssueHunt has been backed by the following sponsors. Become a sponsor

Contributor guide

Tech stack
typescript
Domain
developer experiencetooling
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
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.
clear
Prerequisites
basic knowledge of TypeScriptfamiliarity with JavaScriptunderstanding of the project's file manipulation API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Study the current JavaScript codebase in the src/ directory. Look at the linked PR #17 on IssueHunt for initial conversion attempts. Understand the project's file manipulation API to ensure accurate type definitions. Use tsconfig.json with strict options and enable declaration: true to auto generate type definitions.