microsoft / microsoft/TypeScript

Function identifiers no longer receive semantic highlighting tokens

Open
#44,099 2 comments 0 reactions 1 assignee View on GitHub

@orta is already working on this.

Since May 14, 2021.

Needs Investigation Rescheduled
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

Bug Report

Function identifiers (including methods) don't appear to be receiving semantic highlighting tokens from the LSP as of TS 4.2.x.

This is important to me because I prefer the terser style of passing callbacks directly by identifier instead of always wrapping them in anonymous lambdas (e.g., myArray.filter(myPredicate) instead of myArray.filter(it => myPredicate(it))), but with the semantic colorization missing, it's much harder to recognize where this is happening when scanning code.

🔎 Search Terms

semantic highlight, highlighting, function, token

🕗 Version & Regression Information
  • Semantic function tokens worked as expected in 4.1.5
  • They appear to be missing in 4.2.4 (VS Code's version at time of writing)
💻 Code

CodeSnap with TS v4.0.7:
ts40-func-tokens

CodeSnap with TS v.4.2.4:
ts42-func-tokens

Textual representation for the sake of screen-readers and whatnot:

let result = [...newFiles];

const compareFileName: Comparator<INewFile|IDisplayFile> = (a, b) => a.FileName === b.FileName;
const isDisplayFile = (item: INewFile|IDisplayFile): item is IDisplayFile => !!item.ExternalId;

const currentFiles = this._displayFiles$.value ?? [];
const dupes = intersectionWith(compareFileName, newFiles, currentFiles);

if (!dupes.length) {
	return result;
}

// Find the sets of current files and new uploads that are unique.
const [currentUniques, newUniques] = flow(
	xorWith(compareFileName),
	partition(isDisplayFile),
)(currentFiles, newFiles);
🙁 Actual behavior

In the newer snap, notice that references to compareFileName and isDisplayFile are colored as ordinary variables after their declarations. Invoking VS Code's "Inspect Editor Tokens and Scopes" command on those tokens indicates that they're falling back to their TextMate scopes instead of using the semantic information.

🙂 Expected behavior

In the older snap, all references to the function names are colored as functions, making it easier to spot which arguments are callbacks when scanning the code. Invoking the "Inspect..." command on these shows that they're marked with the function semantic token type, with readonly and local modifiers.

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.