vega/vega-lite-api

Output Typescript Code

Open

#9 opened on May 13, 2019

View on GitHub
 (7 comments) (9 reactions) (0 assignees)JavaScript (20 forks)auto 404
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (219 stars)
PR merge metrics
 (PR metrics pending)

Description

The code for generating the API could still be Javascript, since it only affects us.

However, a lot of people may want to use the output JS API in Typescript projects (which offer superior autocompletion than vanilla JS). Thus, it might be worth making sure that our output code is in TS.

cc: @domoritz

Contributor guide

Research direction
Explore how the API currently generates JavaScript code and investigate adding TypeScript declaration generation or direct TypeScript output. Look at existing TypeScript integration patterns in similar projects.
Tech stack
javascripttypescript
Domain
tooling
Issue type
Feature
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.
Half day
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
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60