Merge pull request #265 from wise0704/with

Allow comment before initializer
dotnet · Aug 2, 2023 · 9439e96 · 9439e96
2 parents 7163532 + d830c0f
commit 9439e96
Show file tree

Hide file tree

Showing 6 changed files with 192 additions and 16 deletions.
diff --git a/grammars/csharp.tmLanguage b/grammars/csharp.tmLanguage
@@ -1719,7 +1719,7 @@
 )
 (?&lt;interface_name&gt;\g&lt;type_name&gt;\s*\.\s*)?
 (?&lt;property_name&gt;\g&lt;identifier&gt;)\s*
-(?=\{|=&gt;|$)</string>
+(?=\{|=&gt;|//|/\*|$)</string>
         <key>beginCaptures</key>
         <dict>
           <key>1</key>
@@ -1899,7 +1899,7 @@
 )
 (?&lt;interface_name&gt;\g&lt;type_name&gt;\s*\.\s*)?
 (?&lt;event_names&gt;\g&lt;identifier&gt;(?:\s*,\s*\g&lt;identifier&gt;)*)\s*
-(?=\{|;|$)</string>
+(?=\{|;|//|/\*|$)</string>
         <key>beginCaptures</key>
         <dict>
           <key>1</key>
@@ -3024,7 +3024,7 @@
       <key>with-expression</key>
       <dict>
         <key>begin</key>
-        <string>(?&lt;!\.)\b(with)\b\s*(?=\{|$)</string>
+        <string>(?&lt;!\.)\b(with)\b\s*(?=\{|//|/\*|$)</string>
         <key>beginCaptures</key>
         <dict>
           <key>1</key>
@@ -3037,6 +3037,10 @@
         <string>(?&lt;=\})</string>
         <key>patterns</key>
         <array>
+          <dict>
+            <key>include</key>
+            <string>#comment</string>
+          </dict>
           <dict>
             <key>include</key>
             <string>#initializer-expression</string>
@@ -6252,7 +6256,7 @@
     )*
   )
 )\s*
-(?=\{|$)</string>
+(?=\{|//|/\*|$)</string>
         <key>captures</key>
         <dict>
           <key>1</key>
@@ -6331,7 +6335,7 @@
       <key>anonymous-object-creation-expression</key>
       <dict>
         <key>begin</key>
-        <string>\b(new)\b\s*(?=\{|$)</string>
+        <string>\b(new)\b\s*(?=\{|//|/\*|$)</string>
         <key>beginCaptures</key>
         <dict>
           <key>1</key>
@@ -6344,6 +6348,10 @@
         <string>(?&lt;=\})</string>
         <key>patterns</key>
         <array>
+          <dict>
+            <key>include</key>
+            <string>#comment</string>
+          </dict>
           <dict>
             <key>include</key>
             <string>#initializer-expression</string>

diff --git a/grammars/csharp.tmLanguage.cson b/grammars/csharp.tmLanguage.cson
@@ -1091,7 +1091,7 @@ repository:
       )
       (?<interface_name>\\g<type_name>\\s*\\.\\s*)?
       (?<property_name>\\g<identifier>)\\s*
-      (?=\\{|=>|$)
+      (?=\\{|=>|//|/\\*|$)
     '''
     beginCaptures:
       "1":
@@ -1227,7 +1227,7 @@ repository:
       )
       (?<interface_name>\\g<type_name>\\s*\\.\\s*)?
       (?<event_names>\\g<identifier>(?:\\s*,\\s*\\g<identifier>)*)\\s*
-      (?=\\{|;|$)
+      (?=\\{|;|//|/\\*|$)
     '''
     beginCaptures:
       "1":
@@ -1888,12 +1888,15 @@ repository:
       }
     ]
   "with-expression":
-    begin: "(?<!\\.)\\b(with)\\b\\s*(?=\\{|$)"
+    begin: "(?<!\\.)\\b(with)\\b\\s*(?=\\{|//|/\\*|$)"
     beginCaptures:
       "1":
         name: "keyword.other.with.cs"
     end: "(?<=\\})"
     patterns: [
+      {
+        include: "#comment"
+      }
       {
         include: "#initializer-expression"
       }
@@ -3763,7 +3766,7 @@ repository:
           )*
         )
       )\\s*
-      (?=\\{|$)
+      (?=\\{|//|/\\*|$)
     '''
     captures:
       "1":
@@ -3818,12 +3821,15 @@ repository:
       }
     ]
   "anonymous-object-creation-expression":
-    begin: "\\b(new)\\b\\s*(?=\\{|$)"
+    begin: "\\b(new)\\b\\s*(?=\\{|//|/\\*|$)"
     beginCaptures:
       "1":
         name: "keyword.other.new.cs"
     end: "(?<=\\})"
     patterns: [
+      {
+        include: "#comment"
+      }
       {
         include: "#initializer-expression"
       }

diff --git a/src/csharp.tmLanguage.yml b/src/csharp.tmLanguage.yml
@@ -584,7 +584,7 @@ repository:
       )
       (?<interface_name>\g<type_name>\s*\.\s*)?
       (?<property_name>\g<identifier>)\s*
-      (?=\{|=>|$)
+      (?=\{|=>|//|/\*|$)
     beginCaptures:
       '1':
         patterns:
@@ -691,7 +691,7 @@ repository:
       )
       (?<interface_name>\g<type_name>\s*\.\s*)?
       (?<event_names>\g<identifier>(?:\s*,\s*\g<identifier>)*)\s*
-      (?=\{|;|$)
+      (?=\{|;|//|/\*|$)
     beginCaptures:
       '1': { name: keyword.other.event.cs }
       '2':
@@ -1122,11 +1122,12 @@ repository:
       - include: '#punctuation-comma'
 
   with-expression:
-    begin: (?<!\.)\b(with)\b\s*(?=\{|$)
+    begin: (?<!\.)\b(with)\b\s*(?=\{|//|/\*|$)
     beginCaptures:
       '1': { name: keyword.other.with.cs }
     end: (?<=\})
     patterns:
+    - include: '#comment'
     - include: '#initializer-expression'
 
   switch-pattern:
@@ -2501,7 +2502,7 @@ repository:
           )*
         )
       )\s*
-      (?=\{|$)
+      (?=\{|//|/\*|$)
     captures:
       '1': { name: keyword.other.new.cs }
       '2':
@@ -2545,11 +2546,12 @@ repository:
     - include: '#bracketed-argument-list'
 
   anonymous-object-creation-expression:
-    begin: \b(new)\b\s*(?=\{|$)
+    begin: \b(new)\b\s*(?=\{|//|/\*|$)
     beginCaptures:
       '1': { name: keyword.other.new.cs }
     end: (?<=\})
     patterns:
+    - include: '#comment'
     - include: '#initializer-expression'
 
   bracketed-parameter-list:

diff --git a/test/event.tests.ts b/test/event.tests.ts
@@ -244,5 +244,49 @@ event EventHandler E
                 Token.Punctuation.Semicolon,
                 Token.Punctuation.CloseBrace]);
         });
+
+        it("comment before initializer - single line (issue #264)", async () => {
+            const input = Input.InClass(`event EventHandler Event /* comment */ { add; remove; }`);
+            const tokens = await tokenize(input);
+
+            tokens.should.deep.equal([
+                Token.Keywords.Event,
+                Token.Type("EventHandler"),
+                Token.Identifiers.EventName("Event"),
+                Token.Comment.MultiLine.Start,
+                Token.Comment.MultiLine.Text(" comment "),
+                Token.Comment.MultiLine.End,
+                Token.Punctuation.OpenBrace,
+                Token.Keywords.Add,
+                Token.Punctuation.Semicolon,
+                Token.Keywords.Remove,
+                Token.Punctuation.Semicolon,
+                Token.Punctuation.CloseBrace,
+            ]);
+        });
+
+        it("comment before initializer - multiple lines (issue #264)", async () => {
+            const input = Input.InClass(`
+event EventHandler Event // comment
+{
+    add;
+    remove;
+}`);
+            const tokens = await tokenize(input);
+
+            tokens.should.deep.equal([
+                Token.Keywords.Event,
+                Token.Type("EventHandler"),
+                Token.Identifiers.EventName("Event"),
+                Token.Comment.SingleLine.Start,
+                Token.Comment.SingleLine.Text(" comment"),
+                Token.Punctuation.OpenBrace,
+                Token.Keywords.Add,
+                Token.Punctuation.Semicolon,
+                Token.Keywords.Remove,
+                Token.Punctuation.Semicolon,
+                Token.Punctuation.CloseBrace,
+            ]);
+        });
     });
-});
+});
diff --git a/test/expressions.tests.ts b/test/expressions.tests.ts
@@ -91,6 +91,31 @@ describe("Expressions", () => {
           Token.Punctuation.Semicolon
         ]);
       });
+
+      it("comment before initializer (issue #264)", async () => {
+        const input = Input.InMethod(`
+var a = new A // comment
+{
+  X = 1
+};`);
+        const tokens = await tokenize(input);
+
+        tokens.should.deep.equal([
+          Token.Keywords.Var,
+          Token.Identifiers.LocalName("a"),
+          Token.Operators.Assignment,
+          Token.Keywords.New,
+          Token.Type("A"),
+          Token.Comment.SingleLine.Start,
+          Token.Comment.SingleLine.Text(" comment"),
+          Token.Punctuation.OpenBrace,
+          Token.Variables.ReadWrite("X"),
+          Token.Operators.Assignment,
+          Token.Literals.Numeric.Decimal("1"),
+          Token.Punctuation.CloseBrace,
+          Token.Punctuation.Semicolon,
+        ]);
+      });
     });
 
     describe("Anonymous Methods", () => {
@@ -1149,6 +1174,30 @@ var x = new
           Token.Punctuation.Semicolon
         ]);
       });
+
+      it("comment before initializer (issue #264)", async () => {
+        const input = Input.InMethod(`
+var x = new // comment
+{
+    ID = 42
+};`);
+        const tokens = await tokenize(input);
+
+        tokens.should.deep.equal([
+          Token.Keywords.Var,
+          Token.Identifiers.LocalName("x"),
+          Token.Operators.Assignment,
+          Token.Keywords.New,
+          Token.Comment.SingleLine.Start,
+          Token.Comment.SingleLine.Text(" comment"),
+          Token.Punctuation.OpenBrace,
+          Token.Variables.ReadWrite("ID"),
+          Token.Operators.Assignment,
+          Token.Literals.Numeric.Decimal("42"),
+          Token.Punctuation.CloseBrace,
+          Token.Punctuation.Semicolon,
+        ]);
+      });
     });
 
     describe("Arithmetic", () => {
@@ -4964,6 +5013,31 @@ var p2 = p1 with
           Token.Punctuation.Semicolon,
         ]);
       });
+
+      it("comment before initializer (issue #264)", async () => {
+        const input = Input.InMethod(`
+var p2 = p1 with // comment
+{
+  X = 5
+};`);
+        const tokens = await tokenize(input);
+
+        tokens.should.deep.equal([
+          Token.Keywords.Var,
+          Token.Identifiers.LocalName("p2"),
+          Token.Operators.Assignment,
+          Token.Variables.ReadWrite("p1"),
+          Token.Keywords.With,
+          Token.Comment.SingleLine.Start,
+          Token.Comment.SingleLine.Text(" comment"),
+          Token.Punctuation.OpenBrace,
+          Token.Variables.ReadWrite("X"),
+          Token.Operators.Assignment,
+          Token.Literals.Numeric.Decimal("5"),
+          Token.Punctuation.CloseBrace,
+          Token.Punctuation.Semicolon,
+        ]);
+      });
     });
   });
 });
diff --git a/test/property.tests.ts b/test/property.tests.ts
@@ -441,5 +441,47 @@ public int Timeout
                 Token.Punctuation.Semicolon,
                 Token.Punctuation.CloseBrace]);
         });
+
+        it("comment before initializer - multiple lines (issue #264)", async () => {
+            const input = Input.InClass(`
+int Property // comment
+{
+    get;
+    set;
+}`);
+            const tokens = await tokenize(input);
+
+            tokens.should.deep.equal([
+                Token.PrimitiveType.Int,
+                Token.Identifiers.PropertyName("Property"),
+                Token.Comment.SingleLine.Start,
+                Token.Comment.SingleLine.Text(" comment"),
+                Token.Punctuation.OpenBrace,
+                Token.Keywords.Get,
+                Token.Punctuation.Semicolon,
+                Token.Keywords.Set,
+                Token.Punctuation.Semicolon,
+                Token.Punctuation.CloseBrace,
+            ]);
+        });
+
+        it("comment before initializer - single line (issue #264)", async () => {
+            const input = Input.InClass(`int Property /* comment */ { get; set; }`);
+            const tokens = await tokenize(input);
+
+            tokens.should.deep.equal([
+                Token.PrimitiveType.Int,
+                Token.Identifiers.PropertyName("Property"),
+                Token.Comment.MultiLine.Start,
+                Token.Comment.MultiLine.Text(" comment "),
+                Token.Comment.MultiLine.End,
+                Token.Punctuation.OpenBrace,
+                Token.Keywords.Get,
+                Token.Punctuation.Semicolon,
+                Token.Keywords.Set,
+                Token.Punctuation.Semicolon,
+                Token.Punctuation.CloseBrace,
+            ]);
+        });
     });
 });