Add support for syntax-based folding (#191)

Regions, comment blocks, and heredocs can now be folded.
Additionally, region names are now searchable using ctrl-r.

Author: matteocoder

Fold.tmPreferences

@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<plist version="1.0">
+<dict>
+    <key>scope</key>
+    <string>source.powershell</string>
+    <key>settings</key>
+    <dict>
+        <key>foldScopes</key>
+        <array>
+            <dict>
+                <key>begin</key>
+                <string>meta.fold.begin</string>
+                <key>end</key>
+                <string>meta.fold.end</string>
+            </dict>
+            <dict>
+                <key>begin</key>
+                <string>punctuation.definition.comment.block.begin</string>
+                <key>end</key>
+                <string>punctuation.definition.comment.block.end</string>
+                <key>excludeTrailingNewlines</key>
+                <false/>
+            </dict>
+            <dict>
+                <key>begin</key>
+                <string>string.quoted.double.heredoc punctuation.definition.string.begin</string>
+                <key>end</key>
+                <string>string.quoted.double.heredoc punctuation.definition.string.end</string>
+                <key>excludeTrailingNewlines</key>
+                <false/>
+            </dict>
+            <dict>
+                <key>begin</key>
+                <string>string.quoted.single.heredoc punctuation.definition.string.begin</string>
+                <key>end</key>
+                <string>string.quoted.single.heredoc punctuation.definition.string.end</string>
+                <key>excludeTrailingNewlines</key>
+                <false/>
+            </dict>
+            <dict>
+                <key>begin</key>
+                <string>punctuation.section.group.begin</string>
+                <key>end</key>
+                <string>punctuation.section.group.end</string>
+                <key>excludeTrailingNewlines</key>
+                <false/>
+            </dict>
+            <dict>
+                <key>begin</key>
+                <string>punctuation.section.braces.begin</string>
+                <key>end</key>
+                <string>punctuation.section.braces.end</string>
+                <key>excludeTrailingNewlines</key>
+                <false/>
+            </dict>
+        </array>
+    </dict>
+</dict>
+</plist>

PowerShell.sublime-syntax

@@ -35,6 +35,7 @@ contexts:
       pop: true
 
   main:
+    - include: regions
     - include: comments
     - include: expressions
 
@@ -808,3 +809,18 @@ contexts:
         - match: (?=\()
           pop: true
         - include: comment-line
+
+  regions:
+    - match: ^\s*((#)\s*(region\b)(?:\s*(\S.*))?(\n?))
+      captures:
+        1: comment.line.powershell
+        2: punctuation.definition.comment.powershell
+        3: keyword.other.region.begin.powershell
+        4: meta.toc-list.powershell entity.name.section.powershell
+        5: meta.fold.begin.powershell
+    - match: ^\s*((#)\s*(endregion\b).*(\n?))
+      captures:
+        1: comment.line.powershell
+        2: punctuation.definition.comment.powershell
+        3: keyword.other.region.end.powershell
+        4: meta.fold.end.powershell

Tests/syntax_test_PowerShell.ps1

@@ -469,6 +469,11 @@ There is no @platting here!
 "@
 # <- string.quoted.double.heredoc
  # <- string.quoted.double.heredoc
+@'
+#<- meta.string string.quoted.single.heredoc punctuation.definition.string.begin
+A 'single quoted' "heredoc"
+'@
+#<- meta.string string.quoted.single.heredoc punctuation.definition.string.end
 
 # Numeric constants
 
@@ -1805,3 +1810,27 @@ function get-number {}
 #<- comment.block comment.documentation.embedded punctuation.definition.keyword.documentation
 #^^^^^^^^^^^^ keyword.other.documentation
 #>
+
+#region Test
+#<- punctuation.definition.comment
+#^^^^^^ keyword.other.region.begin
+#<- comment.line.powershell
+#       ^^^^ meta.toc-list entity.name.section
+#       @@@@ local-definition
+#           ^ meta.fold.begin
+#endregion (More comments)
+#<- punctuation.definition.comment.powershell
+#^^^^^^^^^ keyword.other.region.end.powershell
+#<- comment.line
+#                         ^ meta.fold.end
+
+#region
+#<- punctuation.definition.comment
+#^^^^^^ keyword.other.region.begin
+#<- comment.line.powershell
+#      ^ meta.fold.begin
+#endregion (More comments)
+#<- punctuation.definition.comment.powershell
+#^^^^^^^^^ keyword.other.region.end.powershell
+#<- comment.line
+#                         ^ meta.fold.end