microsoft / microsoft/monaco-editor

[Bug] YAML keyword values affected by comments

Open
#3,030 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug grammars help wanted
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 Code
monaco.editor.create(document.getElementById('container'), {
	value: "keyword-control: null\nstring-control: string\n\nexample1: null #Highlights as string but evaluates null\nexample2: null#Highlights as keyword but evaluates as string\n",
	language: 'yaml'
});
Actual Behavior

Keywords (null, true, false, etc) are incorrectly highlighted as strings if a there is a comment on the same line as the keyword (example1). If the comment is touching the keyword, the highlighting is correct but the value is interpreted as a string when parsed (example2).

Expected Behavior

I would expect that in both examples, the null would highlight as a keyword and that the value would be evaluated as null, not a 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 with the Monaco Editor Playground code and reproduce both YAML examples, checking syntax highlighting and the resulting value interpretation. Trace the YAML language support from the language: 'yaml' entry point; done means null remains a keyword and is evaluated as null both with a separated comment and with a touching comment.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.