cube-js/cube

Use tsd for type testing

Open

#4,369 opened on Apr 12, 2022

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Rust (1,965 forks)batch import
help wanted

Repository metrics

Stars
 (19,563 stars)
PR merge metrics
 (Avg merge 5d 16h) (138 merged PRs in 30d)

Description

Issues #4160 (PR #4366) and #4202 involve changing some of the declared types in the API. To minimize the risk of regressions (i.e. type errors in code that previously did not produce them), it would be helpful to explicitly test API types. I'm testing out tsd, and it seems to work quite well, but unfortunately I ran into dependency conflicts, and someone more familiar with the codebase would probably be in a better position to resolve them.

Contributor guide

Research direction
Set up tsd for type testing and resolve dependency conflicts.
Tech stack
typescript
Domain
backendapi
Issue type
Test
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
TypeScripttsd
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60