microsoft / microsoft/TypeScript

Better intellisense for unions of tuple types

Open
#38,603 2 comments 14 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Awaiting More Feedback Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

VSCode - Version 1.45.1
Typescript - Version 3.8.3

Search Terms

intellisense tuple

Suggestion

Have the suggestions of unions of tuple types only suggest valid things

Use Cases

I have a function which takes a 'path' to a property in a fixed object, say the object is like { a: { b: 1 } }, allowed paths are ["a"], or ["a", "b"].

I have some type which generates for me the union of allowed tuples, which is to be the type of the 'path'.

The fixed object the function takes paths in is very large and I don't want to have to remember the names of things, when I use the union, the intellisense correctly identifies if a path is invalid, but when using ctrl + space to get the suggestions, it suggests strings which if used are immediately afterwards recognised as invalid.

Examples

Consider a type like

type X = ["A"] | ["A", "B"]

Then if I write something like const x: X = [], when pressing ctrl + space in the array I would like to just be suggested "A" (in fact this is already the behaviour), after filling in "A", if I try to add another element it would just suggest "B", not "A", "B"

Checklist

My suggestion meets these guidelines:

  • [x ] This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • [x ] This wouldn't change the runtime behavior of existing JavaScript code
  • [x ] This could be implemented without emitting different JS based on the types of the expressions
  • [x ] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
  • [x ] This feature would agree with the rest of TypeScript's Design Goals.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No implementation file or test is named. Reproduce the tuple-union example in VS Code with the stated TypeScript versions, then identify the completion entry point involved; done means an array containing "A" suggests only "B" for its next element while preserving the existing validity checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
developer-experience
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.