microsoft / microsoft/monaco-editor

[Bug] colorizeElement method doesn't color the whole text if domNode has more than one #text child

Open Beginner friendly
#4,571 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
46.8k
Forks
4.1k
Avg merge
17h 58m
Merged PRs (30d)
1

Description

Reproducible in vscode.dev or in VS Code Desktop?
  • Not reproducible in vscode.dev or VS Code Desktop
Reproducible in the monaco editor playground?
Monaco Editor Playground Link

No response

Monaco Editor Playground Code

No response

Reproduction Steps

It can be reproduced whenever appending one or more text nodes with document.createTextNode to a givendomNode. Tested with the latest monaco's version.

Here's a reproducible fiddle: https://jsfiddle.net/xw5zc4Lo/.

Actual (Problematic) Behavior

If you create an element with at least two #text, monaco.editor.colorizeElement will just colorize the firstChild's nodeValue as seen in the colorizeElement implementation.

public static colorizeElement(themeService: IStandaloneThemeService, languageService: ILanguageService, domNode: HTMLElement, options: IColorizerElementOptions): Promise<void> {
    // ...
    const text = domNode.firstChild ? domNode.firstChild.nodeValue : '';
    // ...
    return this.colorize(languageService, text || '', languageId, options).then(render, (err) => console.error(err));
}

A simple example is shown below. There's an initial text node and another one that is appended. After it happens, the colorize method is triggered, but it strips the newly added text node and just colorizes the first one.
SuiTmEZ

Expected Behavior

It is expected that the attribute wholeText is used to color all text present in the node instead of nodeValue, because it will concatenate any following #text present after the firstChild. As per MDN,

The read-only wholeText property of the Text interface returns the full text of all Text nodes logically adjacent to the node. The text is concatenated in document order. This allows specifying any text node and obtaining all adjacent text as a single string.

Additional Context

No response

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

Start by locating the colorizeElement implementation shown in the issue and compare its firstChild.nodeValue handling with the linked jsfiddle reproduction. Update the text source so adjacent text nodes are included, then verify that appended text is preserved and colorized as expected.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.