microsoft / microsoft/monaco-editor

[Bug] Wrong syntax highlighting for reStructuredText

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

Nobody has claimed this yet.

bug help wanted tokenization
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
.. 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

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 and the provided reStructuredText example, then inspect how its tokenizer classifies directive names and optional arguments. Compare the actual and expected highlighting for the listed directive forms; done means valid directives are no longer treated as comments.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.