feat(langserver): highlight some formatting tags in documentation like bold and italics for englisch language

Author: d-biehl

package.json

@@ -315,6 +315,9 @@
           ],
           "var": [
             "storage.type.robotframework"
+          ],
+          "documentation": [
+            "markup.robotframework"
           ]
         }
       }
@@ -1487,4 +1490,4 @@
     "webpack": "^5.90.3",
     "webpack-cli": "^5.1.4"
   }
-}
+}

packages/language_server/src/robotcode/language_server/robotframework/parts/semantic_tokens.py

@@ -23,11 +23,9 @@
 from robot.parsing.lexer.tokens import Token
 from robot.parsing.model.statements import (
     Arguments,
-    Documentation,
     Fixture,
     KeywordCall,
     LibraryImport,
-    Metadata,
     ResourceImport,
     Statement,
     Template,
@@ -116,6 +114,7 @@ class RobotSemTokenTypes(Enum):
     CONFIG = "config"
     NAMED_ARGUMENT = "namedArgument"
     VAR = "var"
+    DOCUMENTATION = "documentation"
 
 
 class RobotSemTokenModifiers(Enum):
@@ -345,7 +344,7 @@ def generate_sem_sub_tokens(
         if sem_info is not None:
             sem_type, sem_mod = sem_info
 
-            if isinstance(node, (Documentation, Metadata)):
+            if token.type in [Token.DOCUMENTATION, Token.METADATA]:
                 sem_mod = {SemanticTokenModifiers.DOCUMENTATION}
 
             if token.type in [Token.VARIABLE, Token.ASSIGN]:
@@ -368,14 +367,6 @@ def generate_sem_sub_tokens(
                             sem_mod,
                         )
 
-                        # yield SemTokenInfo.from_token(
-                        #     token,
-                        #     RobotSemTokenTypes.VARIABLE_EXPRESSION if is_expr else sem_type,
-                        #     sem_mod,
-                        #     col_offset + (3 if is_expr else 2),
-                        #     last_index - (4 if is_expr else 2),
-                        # )
-
                         yield SemTokenInfo(
                             token.lineno,
                             col_offset + ((last_index - 1) if is_expr else last_index),
@@ -398,19 +389,6 @@ def generate_sem_sub_tokens(
                 else:
                     yield SemTokenInfo.from_token(token, sem_type, sem_mod)
 
-            elif token.type == Token.ARGUMENT and "\\" in token.value:
-                if col_offset is None:
-                    col_offset = token.col_offset
-
-                for g in cls.ESCAPE_REGEX.finditer(token.value):
-                    if g.group("x") is not None:
-                        yield SemTokenInfo.from_token(
-                            token,
-                            sem_type if g.group("x") is None else RobotSemTokenTypes.ESCAPE,
-                            sem_mod,
-                            col_offset + g.start(),
-                            g.end() - g.start(),
-                        )
             elif token.type in [Token.KEYWORD, ROBOT_KEYWORD_INNER] or (
                 token.type == Token.NAME and isinstance(node, (Fixture, Template, TestTemplate))
             ):

syntaxes/robotframework.tmLanguage.json

@@ -1,5 +1,5 @@
 {
-	"$schema": "https://raw.githubusercontent.com/martinring/tmlanguage/master/tmlanguage.json",
+	"$schema": "https://raw.githubusercontent.com/RedCMD/TmLanguage-Syntax-Highlighter/main/vscode.tmLanguage.schema.json",
 	"repository": {
 		"header": {
 			"name": "keyword.other.header.robotframework",
@@ -71,12 +71,68 @@
 			"patterns": [ { "include": "#variables" } ]
 		},
 		"comment": {
-			"name": "comment.robotframework",
+			"name": "comment.block.robotframework",
 			"match": "(?:^ *|\\t+| {2,})(#.*)$",
 			"captures": { "1": { "name": "comment.line.robotframework" } }
 		},
 		"setting": {
-			"contentName": "variable.parameter.argument.robotframework",
+			"patterns": [
+				{ "include": "#documentation_setting" },
+				{ "include": "#other_setting" }
+			]
+		},
+		"escape": {
+			"patterns": [
+				{ "include": "#escape-sequence-unicode" },
+				{ "include": "#escape-sequence" }
+			]
+		},
+		"documentation_setting": {
+			"contentName": "markup.robotframework",
+			"begin": "(?i)^(documentation|dokumentation|Tài liệu hướng dẫn)(?= {2}| ?\\t| ?$)",
+			"beginCaptures": { "1": { "name": "keyword.control.settings.robotframework" } },
+			"end": "^(?!\\s*\\.\\.\\.)",
+			"patterns": [
+				{ "include": "#documentation_italic" },
+				{ "include": "#documentation_bold" },
+				{ "include": "#escape" },
+				{ "include": "#comment" },
+				{ "include": "#variables" },
+				{ "include": "#line_continuation" }
+			]
+		},
+		"documentation_bold": {
+			"contentName": "markup.bold.documentation.robotframework",
+			"begin": "\\*",
+			"end": "\\*|$",
+			"beginCaptures": { "0": { "name": "markup.robotframework" } },
+			"endCaptures": { "0": { "name": "markup.robotframework" } },
+			"patterns": [
+				{ "include": "#documentation_italic" },
+				{ "include": "#documentation_bold" },
+				{ "include": "#escape" },
+				{ "include": "#comment" },
+				{ "include": "#variables" },
+				{ "include": "#line_continuation" }
+			]
+		},
+		"documentation_italic": {
+			"contentName": "markup.italic.documentation.robotframework",
+			"begin": "_",
+			"end": "_|$",
+			"beginCaptures": { "0": { "name": "markup.robotframework" } },
+			"endCaptures": { "0": { "name": "markup.robotframework" } },
+			"patterns": [
+				{ "include": "#documentation_italic" },
+				{ "include": "#documentation_bold" },
+				{ "include": "#escape" },
+				{ "include": "#comment" },
+				{ "include": "#variables" },
+				{ "include": "#line_continuation" }
+			]
+		},
+		"other_setting": {
+			"contentName": "string.unquoted.argument.robotframework",
 			"begin": "(?i)^(\\S+( \\S+)*)(?= {2}| ?\\t| ?$)",
 			"beginCaptures": { "1": { "name": "keyword.control.settings.robotframework" } },
 			"end": "^(?!\\s*\\.\\.\\.)",
@@ -88,7 +144,27 @@
 			]
 		},
 		"testcase_settings": {
-			"contentName": "variable.parameter.argument.robotframework",
+			"patterns": [
+				{ "include": "#documentation_testcase_settings" },
+				{ "include": "#other_testcase_settings" }
+			]
+		},
+		"documentation_testcase_settings": {
+			"contentName": "markup.robotframework",
+			"begin": "(?i)(\\[(documentation|dokumentation|Tài liệu hướng dẫn)\\])(?= {2}| ?\\t| ?$)",
+			"beginCaptures": { "0": { "name": "keyword.control.settings.robotframework" } },
+			"end": "^(?!\\s*\\.\\.\\.)",
+			"patterns": [
+				{ "include": "#documentation_italic" },
+				{ "include": "#documentation_bold" },
+				{ "include": "#escape" },
+				{ "include": "#comment" },
+				{ "include": "#variables" },
+				{ "include": "#line_continuation" }
+			]
+		},
+		"other_testcase_settings": {
+			"contentName": "string.unquoted.argument.robotframework",
 			"begin": "(\\[.*?\\])(?= {2}| ?\\t| ?$)",
 			"beginCaptures": { "0": { "name": "keyword.control.settings.robotframework" } },
 			"end": "^(?!\\s*\\.\\.\\.)",