cssinjs/jss

[all] Add tests for Typescript definition files

Open

#964 opened on Dec 31, 2018

View on GitHub
 (5 comments) (0 reactions) (1 assignee)JavaScript (7,000 stars) (434 forks)batch import
complexity:moderatehelp wantedimportanttypescript

Description

Expected behavior: Any typescript definitions exported from this library should be tested, otherwise it can cause real pain and doubt for ts users.

Describe the bug: https://github.com/cssinjs/jss/pull/889#issuecomment-447220080 was integrated without tests. It did not start with @types/jss package and we have no guarantee compatibility.

Versions (please complete the following information):

  • jss: 9 to 10.alpha.3

Context Changelog from 9->10 should address user's removal of @types/jss as a requirement otherwise conflicts will arise. As-is, I am seeing app errors downstream of material-ui 3.8.1 because of a mix of type use between 9.x and 10.x. It is not easy or apparent there, but is within our app. Investigating in material-ui, different packages require different versions of jss, but ultimately the root of the yarn workspace has 10.alpha.3 and @types/jss. It just so happens that the tests/usage there passes, but does not in the downstream app.

For samples of typescript testing, check out material-ui https://github.com/mui-org/material-ui and usage tests such as https://github.com/mui-org/material-ui/tree/master/packages/material-ui/test/typescript

/cc @appsforartists @HenriBeck

Contributor guide

Tech stack
typescriptjavascript
Domain
testingdeveloper experience
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScript basicstesting type definitionsfamiliarity with JSS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Review the linked PR #889 and the existing type tests in material ui (e.g., https://github.com/mui org/material ui/tree/master/packages/material ui/test/typescript). Examine current TypeScript definitions in the JSS repository to understand what needs testing. Identify a testing framework like dtslint or similar. The issue has an assignee, but no recent activity; check if the assignee is still working on it. The main deliverable is a set of tests that validate TypeScript definitions for all exported APIs.