A sizable refactor

Tests/syntax_test_DSC.ps1

@@ -0,0 +1,116 @@
+# SYNTAX TEST "Packages/PowerShell/PowerShell.sublime-syntax"
+
+"<- Exit the imports context block"
+
+    Configuration MyDscConfiguration {
+#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.function.powershell
+#   ^^^^^^^^^^^^^ keyword.declaration.function.powershell
+#                 ^^^^^^^^^^^^^^^^^^ entity.name.function.powershell
+#                                    ^ punctuation.section.block.begin.powershell
+        Node "TEST-PC1" {
+#^^^^^^^^^^^^^^^^^^^^^^^^ meta.function.powershell
+#       ^^^^ keyword.context.block.powershell
+#            ^^^^^^^^^^ meta.string.interpolated.powershell string.quoted.double.powershell
+#            ^ punctuation.definition.string.begin.powershell
+#                     ^ punctuation.definition.string.end.powershell
+#                       ^ punctuation.section.block.begin.powershell
+            WindowsFeature MyFeatureInstance {
+#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.function.powershell
+#           ^^^^^^^^^^^^^^ keyword.other.powershell
+#                          ^^^^^^^^^^^^^^^^^ entity.name.label.powershell
+#                                            ^ meta.block.powershell punctuation.section.braces.begin.powershell
+                Ensure = 'Present'
+#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.function.powershell meta.block.powershell
+#                      ^ keyword.operator.assignment.powershell
+#                        ^^^^^^^^^ meta.string.powershell string.quoted.single.powershell
+#                        ^ punctuation.definition.string.begin.powershell
+#                                ^ punctuation.definition.string.end.powershell
+                Name = 'RSAT'
+            }
+            WindowsFeature My2ndFeatureInstance {
+#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.function.powershell
+#           ^^^^^^^^^^^^^^ keyword.other.powershell
+#                          ^^^^^^^^^^^^^^^^^^^^ entity.name.label.powershell
+#                                               ^ meta.block.powershell punctuation.section.braces.begin.powershell
+                Ensure = 'Present'
+                Name = 'Bitlocker'
+            }
+#^^^^^^^^^^^^ meta.function.powershell meta.block.powershell
+#           ^ punctuation.section.braces.end.powershell
+        }
+    }
+    MyDscConfiguration
+
+
+    Configuration MyDscConfiguration
+    {
+        param
+#^^^^^^^^^^^^ meta.function.powershell
+#       ^^^^^ keyword.declaration.parameter.powershell
+        (
+            [string[]]$ComputerName='localhost'
+#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.function.powershell
+#           ^ punctuation.section.brackets.begin.powershell
+#            ^^^^^^ storage.type.powershell
+#                  ^ punctuation.section.brackets.begin.powershell
+#                   ^^ punctuation.section.brackets.end.powershell
+#                     ^^^^^^^^^^^^^ variable.other.readwrite.powershell
+#                     ^ punctuation.definition.variable.powershell
+#                                  ^ keyword.operator.assignment.powershell
+#                                   ^^^^^^^^^^^ meta.string.powershell string.quoted.single.powershell
+#                                   ^ punctuation.definition.string.begin.powershell
+#                                             ^ punctuation.definition.string.end.powershell
+        )
+
+        Node $ComputerName
+        {
+            WindowsFeature MyFeatureInstance
+            {
+                Ensure = 'Present'
+                Name = 'RSAT'
+            }
+
+            WindowsFeature My2ndFeatureInstance
+            {
+                Ensure = 'Present'
+                Name = 'Bitlocker'
+            }
+        }
+    }
+    MyDscConfiguration
+
+
+    Configuration MyDscConfiguration
+    {
+        Node @('localhost', 'Server01')
+#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.function.powershell
+#       ^^^^ keyword.context.block.powershell
+#            ^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.group.array-expression.powershell
+#            ^ keyword.other.array.begin.powershell
+#             ^ punctuation.section.group.begin.powershell
+#              ^^^^^^^^^^^ meta.string.powershell string.quoted.single.powershell
+#              ^ punctuation.definition.string.begin.powershell
+#                        ^ punctuation.definition.string.end.powershell
+#                         ^ punctuation.separator.sequence.powershell
+#                           ^^^^^^^^^^ meta.string.powershell string.quoted.single.powershell
+#                           ^ punctuation.definition.string.begin.powershell
+#                                    ^ punctuation.definition.string.end.powershell
+#                                     ^ punctuation.section.group.end.powershell
+        {
+            WindowsFeature MyFeatureInstance
+#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.function.powershell
+#           ^^^^^^^^^^^^^^ keyword.other.powershell
+#                          ^^^^^^^^^^^^^^^^^ entity.name.label.powershell
+            {
+                Ensure = 'Present'
+                Name = 'RSAT'
+            }
+
+            WindowsFeature My2ndFeatureInstance
+            {
+                Ensure = 'Present'
+                Name = 'Bitlocker'
+            }
+        }
+    }
+    MyDscConfiguration

Tests/syntax_test_Function.ps1

@@ -1,9 +1,11 @@
 # SYNTAX TEST "Packages/PowerShell/PowerShell.sublime-syntax"
 
 using module Microsoft.Management
-# <- keyword.control.using
-#     ^ keyword.other
-#            ^ variable.parameter
+#^^^^ keyword.control.import.powershell
+#     ^^^^^^ keyword.control.import.powershell
+#            ^^^^^^^^^^^^^^^^^^^^ meta.path.powershell
+#                     ^ punctuation.accessor.dot.powershell
+#                      ^^^^^^^^^^ support.type.powershell
 
 function Test-Path {}
 #        @@@@@@@@@ definition
@@ -49,16 +51,34 @@ function Test-Path {}
     # <- punctuation.definition.keyword
     # ^ keyword.other.documentation
         The functionality that best describes this cmdlet
+    .ForwardHelpCategory Alias
+#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ comment.block.powershell comment.documentation.embedded.powershell
+#   ^ punctuation.definition.keyword.documentation.powershell
+#    ^^^^^^^^^^^^^^^^^^^ keyword.other.documentation.powershell
+#                        ^^^^^ support.type.powershell
+
+    .parameter foo
+#^^^^^^^^^^^^^^^^^ comment.block.powershell comment.documentation.embedded.powershell
+#   ^ punctuation.definition.keyword.documentation.powershell
+#    ^^^^^^^^^ keyword.other.documentation.param.powershell
+#              ^^^ variable.parameter.powershell
+
+    .LINK https://example.com
+#^^^^^^^^^^^^^^^^^^^^^^^^^^^^ comment.block.powershell comment.documentation.embedded.powershell
+#   ^ punctuation.definition.keyword.documentation.powershell
+#    ^^^^ keyword.other.documentation.powershell
+#         ^^^^^^^^^^^^^^^^^^^ markup.underline.link.powershell
 
     This should not be considered documentaton -> .role
                                                   # ^ - keyword.operator.documentation
 #>
 # <- punctuation.definition.comment.block.end
 function Verb-Noun {
-#^^^^^^^^^^^^^^^^^ meta.function
-#^^^^^^^ storage.type
-#        ^^^^^^^^^ entity.name.function
+#^^^^^^^^^^^^^^^^^^^ meta.function.powershell
+#^^^^^^^ keyword.declaration.function.powershell
+#        ^^^^^^^^^ entity.name.function.powershell
 #        @@@@@@@@@ definition
+#                  ^ punctuation.section.block.begin.powershell
     [CmdletBinding(DefaultParameterSetName  = 'Parameter Set 1',
     # <- meta.attribute punctuation.section.brackets.begin
     # ^ meta.attribute support.function.attribute
@@ -93,18 +113,22 @@ function Verb-Noun {
     #      ^ meta.attribute punctuation.section.group.end
     #       ^ meta.attribute punctuation.section.brackets.end
     [OutputType([String])]
-    # <- meta.attribute punctuation.section.brackets.begin
-    # ^ meta.attribute support.function.attribute
-    #          ^ meta.attribute punctuation.section.group.begin
-    #           ^ meta.attribute punctuation.section.brackets.begin
-    #            ^^^^^^ meta.attribute storage.type
-    #                  ^ meta.attribute punctuation.section.brackets.end
-    #                   ^ meta.attribute punctuation.section.group.end
-    #                    ^ meta.attribute punctuation.section.brackets.end
+#^^^^^^^^^^^^^^^^^^^^^^^^^ meta.function.powershell
+#   ^^^^^^^^^^^^^^^^^^^^^^ meta.attribute.powershell
+#   ^ punctuation.section.brackets.begin.powershell
+#    ^^^^^^^^^^ support.function.attribute.powershell
+#              ^ punctuation.section.group.begin.powershell
+#               ^ punctuation.section.brackets.begin.powershell
+#                ^^^^^^ support.type.powershell
+#                      ^ punctuation.section.brackets.end.powershell
+#                       ^ punctuation.section.group.end.powershell
+#                        ^ punctuation.section.brackets.end.powershell
     Param
-   #^^^^^ keyword.declaration.parameter
+#^^^^^^^^ meta.function.powershell
+#   ^^^^^ keyword.declaration.parameter.powershell
     (
-    # <- punctuation.section.group.begin
+#^^^^ meta.function.powershell
+#   ^ punctuation.section.block.begin.powershell
         # Param1 help description
         # <- comment.line punctuation.definition.comment
         # ^^^^^^^^^^^^^^^^^^^^^^^ comment.line
@@ -264,13 +288,15 @@ function Verb-Noun {
         #                 ^ punctuation.section.group.end
         #                  ^ punctuation.section.brackets.end
         [int32]
-        # <- punctuation.section.brackets.begin
-        #^^^^^ storage.type
-        #     ^ punctuation.section.brackets.end
+#^^^^^^^^^^^^^^ meta.function.powershell
+#       ^ punctuation.section.brackets.begin.powershell
+#        ^^^^^ storage.type.powershell
+#             ^ punctuation.section.brackets.end.powershell
         $Param2,
-        # <- punctuation.definition.variable
-        # ^ variable.other.readwrite
-        #      ^ punctuation.separator
+#^^^^^^^^^^^^^^^ meta.function.powershell
+#       ^^^^^^^ variable.other.readwrite.powershell
+#       ^ punctuation.definition.variable.powershell
+#              ^ punctuation.separator.sequence.powershell
 
         # Param3 help description
         # <- comment.line punctuation.definition.comment
@@ -302,9 +328,10 @@ function Verb-Noun {
         #                   ^ meta.attribute punctuation.section.group.end
         #                    ^ meta.attribute punctuation.section.brackets.end
         [String]
-        # <- punctuation.section.brackets.begin
-        #^^^^^^ storage.type
-        #      ^ punctuation.section.brackets.end
+#^^^^^^^^^^^^^^^ meta.function.powershell
+#       ^ punctuation.section.brackets.begin.powershell
+#        ^^^^^^ support.type.powershell
+#              ^ punctuation.section.brackets.end.powershell
         $Param3,
         # <- punctuation.definition.variable
         #^^^^^^ variable.other.readwrite
@@ -335,9 +362,10 @@ function Verb-Noun {
         #                             ^ meta.attribute punctuation.section.group.end
         #                              ^ meta.attribute punctuation.section.brackets.end
         [string]
-        # <- punctuation.section.brackets.begin
-        # ^ storage.type
-        #      ^ punctuation.section.brackets.end
+#^^^^^^^^^^^^^^^ meta.function.powershell
+#       ^ punctuation.section.brackets.begin.powershell
+#        ^^^^^^ storage.type.powershell
+#              ^ punctuation.section.brackets.end.powershell
         $Param4,
         # <- punctuation.definition.variable
         # ^ variable.other.readwrite
@@ -365,38 +393,61 @@ function Verb-Noun {
         #                                                                                            ^ comment.line punctuation.definition.comment
         #                                                                                             ^ comment.line
         [string]
-        # <- punctuation.section.brackets.begin
-        # ^ storage.type
-        #      ^ punctuation.section.brackets.end
+#^^^^^^^^^^^^^^^ meta.function.powershell
+#       ^ punctuation.section.brackets.begin.powershell
+#        ^^^^^^ storage.type.powershell
+#              ^ punctuation.section.brackets.end.powershell
         $Param5
         # <- punctuation.definition.variable
         # ^ variable.other.readwrite
-        )
-        # <- punctuation.section.group.end
+    )
+#^^^^ meta.function.powershell
+#   ^ punctuation.section.block.end.powershell
 
     Begin
-   #^^^^^ keyword.context.block.begin
+#^^^^^^^^ meta.function.powershell
+#   ^^^^^ keyword.context.block.powershell
     {
+#^^^^ meta.function.powershell
+#   ^ punctuation.section.block.begin.powershell
     }
     Process {
-    # <- keyword.context.block.process
+#^^^^^^^^^^^^ meta.function.powershell
+#   ^^^^^^^ keyword.context.block.powershell
+#           ^ punctuation.section.block.begin.powershell
         if ($pscmdlet.ShouldProcess("Target", "Operation")) {
-        # <- keyword.control
-        #  ^ punctuation.section.group.begin
-        #   ^ punctuation.definition.variable
-        #    ^^^^^^^^ variable.language
-        #             ^^^^^^^^^^^^^ variable.function
-        #             @@@@@@@@@@@@@ reference
-        #                          ^ punctuation.section.arguments.begin
-        #                           ^^^^^^^^ string.quoted.double
-        #                                   ^ punctuation.separator
-        #                                     ^^^^^^^^^^^ string.quoted.double
-        #                                                ^ punctuation.section.arguments.end
-        #                                                 ^ punctuation.section.group.end
+#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.function.powershell
+#       ^^ keyword.control.conditional.if.powershell
+#          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.group.powershell
+#          ^ punctuation.section.group.begin.powershell
+#           ^^^^^^^^^ variable.language.powershell
+#           ^ punctuation.definition.variable.powershell
+#                    ^ punctuation.accessor.dot.powershell
+#                     ^^^^^^^^^^^^^ meta.function-call.powershell variable.function.powershell
+#                     @@@@@@@@@@@@@ reference
+#                                  ^^^^^^^^^^^^^^^^^^^^^^^ meta.function-call.arguments.powershell
+#                                  ^ punctuation.section.arguments.begin.powershell
+#                                   ^^^^^^^^ meta.string.interpolated.powershell string.quoted.double.powershell
+#                                   ^ punctuation.definition.string.begin.powershell
+#                                          ^ punctuation.definition.string.end.powershell
+#                                           ^ punctuation.separator.sequence.powershell
+#                                             ^^^^^^^^^^^ meta.string.interpolated.powershell string.quoted.double.powershell
+#                                             ^ punctuation.definition.string.begin.powershell
+#                                                       ^ punctuation.definition.string.end.powershell
+#                                                        ^ punctuation.section.arguments.end.powershell
+#                                                         ^ punctuation.section.group.end.powershell
+#                                                           ^ meta.block.powershell punctuation.section.braces.begin.powershell
         }
     }
     End {
-   #^^^ keyword.context.block.end
+#^^^^^^^^ meta.function.powershell
+#   ^^^ keyword.context.block.powershell
+#       ^ punctuation.section.block.begin.powershell
 
     }
+    clean { }
+#^^^^^^^^^^^^ meta.function.powershell
+#   ^^^^^ keyword.context.block.powershell
+#         ^ punctuation.section.block.begin.powershell
+#           ^ punctuation.section.block.end.powershell
 }

Tests/syntax_test_Pester.ps1

@@ -0,0 +1,61 @@
+# SYNTAX TEST "Packages/PowerShell/PowerShell.sublime-syntax"
+
+BeforeAll {
+    # your function
+    function Get-Planet ([string]$Name='*')
+#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.block.powershell meta.function.powershell
+#   ^^^^^^^^ keyword.declaration.function.powershell
+#            ^^^^^^^^^^ entity.name.function.powershell
+#                       ^ punctuation.section.parameters.begin.powershell
+#                        ^ punctuation.section.brackets.begin.powershell
+#                         ^^^^^^ storage.type.powershell
+#                               ^ punctuation.section.brackets.end.powershell
+#                                ^^^^^ variable.parameter.powershell
+#                                ^ punctuation.definition.variable.begin.powershell
+#                                     ^ keyword.operator.assignment.powershell
+#                                      ^^^ meta.string.powershell string.quoted.single.powershell
+#                                      ^ punctuation.definition.string.begin.powershell
+#                                        ^ punctuation.definition.string.end.powershell
+#                                         ^ punctuation.section.parameters.end.powershell
+    {
+        $planets = @(
+            @{ Name = 'Mercury' }
+            @{ Name = 'Venus'   }
+            @{ Name = 'Earth'   }
+            @{ Name = 'Mars'    }
+            @{ Name = 'Jupiter' }
+            @{ Name = 'Saturn'  }
+            @{ Name = 'Uranus'  }
+            @{ Name = 'Neptune' }
+        ) | foreach { [PSCustomObject]$_ }
+
+        $planets | where { $_.Name -like $Name }
+    }
+}
+
+# Pester tests
+Describe 'Get-Planet' {
+  It "Given no parameters, it lists all 8 planets" {
+    $allPlanets = Get-Planet
+    $allPlanets.Count | Should -Be 8
+  }
+
+  Context "Filtering by Name" {
+    It "Given valid -Name '<Filter>', it returns '<Expected>'" -TestCases @(
+      @{ Filter = 'Earth'; Expected = 'Earth' }
+      @{ Filter = 'ne*'  ; Expected = 'Neptune' }
+      @{ Filter = 'ur*'  ; Expected = 'Uranus' }
+      @{ Filter = 'm*'   ; Expected = 'Mercury', 'Mars' }
+    ) {
+      param ($Filter, $Expected)
+
+      $planets = Get-Planet -Name $Filter
+      $planets.Name | Should -Be $Expected
+    }
+
+    It "Given invalid parameter -Name 'Alpha Centauri', it returns `$null" {
+      $planets = Get-Planet -Name 'Alpha Centauri'
+      $planets | Should -Be $null
+    }
+  }
+}