louislam/uptime-kuma

Typescript functionality?

Open

#2,436 opened on Dec 19, 2022

View on GitHub
 (1 comment) (1 reaction) (0 assignees)JavaScript (86,760 stars) (7,844 forks)batch import
A:corefeature-requesthelp wanted

Description

⚠️ Please verify that this feature request has NOT been suggested before.

  • I checked and didn't find similar feature request

🏷️ Feature Request Type

Other

🔖 Feature description

What is the feeling for enabling typescript support? JSDoc is fine and good, but nothing beats typescript, it should of course be an opt in instead of converting everything to typescript at once.

I spent some time looking into it and it should be quite easy to enable, some Eslint issues was my main issues.

  • I would be willing to spend some more time investigating typescript and creating a PR if people actually want typescript.

EDIT: I see that enabling typescript will be a breaking change as it requires modifications to the current release process and all docker images as they do not use built code, only source code with npm ci for downloading node_modules. So the task is bigger than I thought

Contributor guide

Tech stack
typescriptjavascript
Domain
backendtooling
Issue type
feature
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScriptNode.jsDockerCI/CD
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Investigate the current build pipeline in package.json, Dockerfiles, and CI configuration (e.g., .github/workflows). The issue notes that switching to TypeScript would require changes to the release process and Docker images. Look for existing discussions in the comments (one comment, possibly from maintainer) and assess if maintainers are open to a gradual migration. Propose a plan for opt in TypeScript that minimizes breakage, such as adding tsconfig and building both JS and TS.
Typescript functionality? · louislam/uptime-kuma#2436 | Good First Issue