Add support for comments

Hubro · May 13, 2022 · f1142bf · f1142bf
1 parent a9aa7aa
commit f1142bf
Show file tree

Hide file tree

Showing 5 changed files with 3,925 additions and 3,321 deletions.
diff --git a/grammar.js b/grammar.js
@@ -65,7 +65,7 @@ function setting(name) {
 module.exports = grammar({
   name: "robot",
 
-  extras: $ => [],
+  extras: $ => [$.comment],
 
   rules: {
     source_file: $ => seq(
@@ -320,7 +320,12 @@ module.exports = grammar({
     variable_name: $ => /[^{}]+/,
 
     text_chunk: $ => token(seq(
-      repeat1(choice(
+      choice(
+        /[^\s$@&{#]/,   // Can't start with a #, since that would be a comment
+        /[$@&][^{]/,
+        /[^$@&]\{/,
+      ),
+      repeat(choice(
         /[^\s$@&{]/,
         /[$@&][^{]/,
         /[^$@&]\{/,
@@ -335,6 +340,8 @@ module.exports = grammar({
       )),
     )),
 
+    comment: $ => token(seq(optional(/[ \t]+/), "#", /[^\n]+/)),
+
     _separator: $ => token(seq(/[ ]{2}|\t/, optional(/[ \t]+/))),
 
     _whitespace: $ => /[ \t]+/,

diff --git a/src/grammar.json b/src/grammar.json
@@ -904,10 +904,6 @@
         }
       ]
     },
-    "section_header_extra_text": {
-      "type": "PATTERN",
-      "value": "[^\\r\\n]+"
-    },
     "test_case_definition": {
       "type": "SEQ",
       "members": [
@@ -1698,7 +1694,24 @@
         "type": "SEQ",
         "members": [
           {
-            "type": "REPEAT1",
+            "type": "CHOICE",
+            "members": [
+              {
+                "type": "PATTERN",
+                "value": "[^\\s$@&{#]"
+              },
+              {
+                "type": "PATTERN",
+                "value": "[$@&][^{]"
+              },
+              {
+                "type": "PATTERN",
+                "value": "[^$@&]\\{"
+              }
+            ]
+          },
+          {
+            "type": "REPEAT",
             "content": {
               "type": "CHOICE",
               "members": [
@@ -1752,6 +1765,34 @@
         ]
       }
     },
+    "comment": {
+      "type": "TOKEN",
+      "content": {
+        "type": "SEQ",
+        "members": [
+          {
+            "type": "CHOICE",
+            "members": [
+              {
+                "type": "PATTERN",
+                "value": "[ \\t]+"
+              },
+              {
+                "type": "BLANK"
+              }
+            ]
+          },
+          {
+            "type": "STRING",
+            "value": "#"
+          },
+          {
+            "type": "PATTERN",
+            "value": "[^\\n]+"
+          }
+        ]
+      }
+    },
     "_separator": {
       "type": "TOKEN",
       "content": {
@@ -1806,7 +1847,12 @@
       ]
     }
   },
-  "extras": [],
+  "extras": [
+    {
+      "type": "SYMBOL",
+      "name": "comment"
+    }
+  ],
   "conflicts": [],
   "precedences": [],
   "externals": [],

diff --git a/src/node-types.json b/src/node-types.json
@@ -453,6 +453,10 @@
     "type": "@{",
     "named": false
   },
+  {
+    "type": "comment",
+    "named": true
+  },
   {
     "type": "ellipses",
     "named": true