Nozbe/WatermelonDB

Help us improve 🍉's TypeScript support

Open

#1516 opened on Feb 2, 2023

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

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

Tech stack
typescriptjavascriptreactreact native
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.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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.
mostly clear
Prerequisites
TypeScript basicsfamiliarity with WatermelonDB
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Focus on one item from the checklist, such as removing outdated TS dependencies in package.json or adding more API usage examples in examples/typescript. Review existing .d.ts files and the examples directory to understand the current setup. Check comments for maintainer guidance, particularly around prettier configuration for .d.ts files.