Microsoft/monaco-editor

[Bug] YAML keyword values affected by comments

Open

#3,030 opened on Mar 22, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (1,283 forks)batch import
buggrammarshelp wanted

Repository metrics

Stars
 (14,836 stars)
PR merge metrics
 (Avg merge 6h 26m) (15 merged PRs in 30d)

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

Research direction
Inspect the YAML tokenizer grammar in Monaco's source to understand how comments and keywords are classified. Trace the parsing path for a line with a keyword and comment.
Tech stack
typescript
Domain
frontendtooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70