microsoft / microsoft/TypeScript

Use context to prioritize or only show `case` and `default` in a `switch` statement

Open
#52,234 0 comments 1 reaction 1 assignee View on GitHub

Nobody has claimed this yet.

Domain: LS: Completion Lists In Discussion Suggestion
Dominant language
Go
Stars
111k
Forks
14.4k
Avg merge
1d 19h
Merged PRs (30d)
117

Description

While playing around with switch/case snippets, I ran into the following:

switch (someValue) {
    /**/
}

Request completions at /**/

The only completions that should be offered here are case and default (along with corresponding snippet completions). It's bad that we don't do that because these keywords are always sorted to come after any other invalid completions.

Fixing just this is one small case. If we wanted to go deeper, I would propose that we use the line and column of the current case or default clause to inform what completions we offer.

Some test cases I would want to remain the same or change:

// same - show all completions
switch (thing) {
  case 42:
  /*$*/
}
// same - show all completions
switch (thing) {
  case 42:
  break;
  /*$*/
}
// same - show all completions
switch (thing) {
  case 42:
  if (Math.random()) {
  }
  else {
  }
  /*$*/
}
// NEW - prioritize `case`/`default`
switch (thing) {
  case 42:
    break;
  /*$*/
}
// NEW - prioritize `case`/`default`
switch (thing) {
  case 42: break;
  /*$*/
}
// NEW - prioritize `case`/`default`
switch (thing) {
  case 42: {
  }
  break;
  /*$*/
}

The current closest approximation I can think of is:

  • the cursor is at the same column as the containing clause's case/default keyword, but on a different line, and
  • there is at least one statement in the clause, and any of the following are true:
    • the last statement is one that would jump out of the current control flow (e.g. break/return/throw/continue)
    • the start of the last statement's token is on a different line and column as the containing clause's case/default keyword

then we should actually ensure case and default appear at the top.

This case:

// NEW - prioritize `case`/`default`/`break`
switch (thing) {
  case 42: {
    // ...
  }
  /*$*/
}

is one that might get another special-case where we'd possibly want to provide break if we don't see it as the last statement of the block. But I'm curious to hear others' thoughts.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.