Microsoft/monaco-editor

[Bug] Wrong syntax highlighting for reStructuredText

Open

#3,113 opened on May 20, 2022

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

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

.. math::

.. hello:: asd

.. line-block::

.. line-block:: aaa

.. lineQ-block:: aa
.. lineQQ-block:: aa
.. lineQQQ-block:: aa
.. lineQQQQ-block:: aa

.. lineblock:: aaa

    .. line-block::

Actual Behavior

Half of directives in the example code are treated as comments:

Выделение_159

Expected Behavior

All rst directives in the example code should be successfully determined by tokenizer.

Выделение_157

According to https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#directives:

Directive types are case-insensitive single words (alphanumerics plus isolated internal hyphens, underscores, plus signs, colons, and periods; no whitespace)

Also note that directive arguments are optional, thus a whitespace after "::" is optional too.

Additional Context

No response

Contributor guide

Research direction
Examine the reStructuredText tokenizer rules in the Monaco Editor codebase, focusing on how directives are parsed. Ensure the tokenizer correctly identifies directive types with optional arguments following '..'. Trace the logic for detecting directive names and handling whitespace after '::'.
Tech stack
typescriptjavascript
Domain
frontend
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70