gleam-lang/gleam

Add integration test for typescript type definitions (d.ts)

Open

#2,003 opened on Feb 14, 2023

View on GitHub
 (0 comments) (8 reactions) (0 assignees)Rust (21,417 stars) (960 forks)batch import
good first issuehelp wanted

Description

Issue #1998 was found when trying to use the type definitions with the TypeScript compiler. Maybe it would be a good idea to add add a small integration test that can be run in CI for testing the type definitions. A minimal JavaScript project that uses some type definitions generated from Gleam code and tries to compile with the TypeScript compiler. Probably this doesn't need to be done on all the cross-compilation targets, but unsure what is the easiest way to integrate this in the current CI pipeline.

Contributor guide

Tech stack
typescriptjavascript
Domain
testing
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.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
TypeScript basicsCI pipeline understanding
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
Examine the existing CI configuration (e.g., .github/workflows) to understand how tests are run. Create a minimal JavaScript/TypeScript project that imports the generated .d.ts files from Gleam and attempt to compile with tsc. The test should run in CI to verify type definitions compile correctly. Look at issue #1998 for context on the bug that prompted this.