Nozbe/WatermelonDB

Help us improve 🍉's TypeScript support

Open

#1,516 opened on Feb 2, 2023

View on GitHub
 (19 comments) (6 reactions) (0 assignees)JavaScript (570 forks)batch import
Hacktoberfestgood first issue

Repository metrics

Stars
 (9,633 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

0.25 came with a huge improvement in the quality and maintainability of 🍉's TypeScript types. There were some teething problems, requiring a few patch releases, and no doubt the increased type coverage revealed new TS errors that weren't there before.

Anyway, thanks a lot to @sidferreira @paulrostorp @enahum @mlecoq for their contributions

You can help. Here's a few TS maintenance items that need to be done:

  • hook up prettier to run over .d.ts
  • in package.json there are outdated TS-related dependencies… I'm not even sure that all of them should be there, given that much of the TS checking lives in examples/typescript
  • remove // @flow comments from d.ts's
  • there's tslint, but I don't think it's hooked up to run anywhere? shouldn't it be a part of yarn ci:check ?
  • add usage of more 🍉 APIs to examples/typescript to test type-checking
  • add typescript types to documentation

Contributor guide

Research direction
Pick one of the listed tasks (e.g., remove // @flow comments from .d.ts files), examine the current .d.ts files, and make the necessary changes. Then run type checking to verify.
Tech stack
javascripttypescript
Domain
developer experiencetooling
Issue type
Chore
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.
1-2 days
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
TypeScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65