Allow default value in function params

And refactor assignment a little

Author: michaelblyons

PowerShell.sublime-syntax

@@ -526,6 +526,7 @@ contexts:
       scope: variable.parameter.powershell
       captures:
         1: punctuation.definition.variable.begin.powershell
+    - include: assignment-normal
 
   function-body:
     - meta_scope: meta.function.powershell
@@ -583,8 +584,7 @@ contexts:
     - include: types-without-members
     - include: variables-without-members
     - include: literals
-    - match: '='
-      scope: keyword.operator.assignment.powershell
+    - include: assignment-normal
 
   attributes:
     - match: (\[)\s*({{attributes}})
@@ -876,8 +876,9 @@ contexts:
     # Symbol operators
     - match: \!
       scope: keyword.operator.logical.powershell
-    - match: '[+/*%-]?='
-      scope: keyword.operator.assignment.powershell
+    - include: assignment-normal
+    - match: (?:[+/*%-]|\?\?)=
+      scope: keyword.operator.assignment.augmented.powershell
     - match: (?:\+\+|--)(?![ \t]*\d|[[:alpha:]])
       scope: keyword.operator.assignment.powershell
     - match: '[+-](?=\.?\d)'  # This is sort of heuristic
@@ -908,6 +909,17 @@ contexts:
       # This is very imprecise. Is there a syntax for 'must come after...'?
       scope: keyword.operator.range.powershell
 
+  assignment-normal:
+    - match: =
+      scope: keyword.operator.assignment.powershell
+      push: in-assignment
+
+  in-assignment:
+    - include: command-ending-sequences
+    # INFO: Someday maybe we can nix the workflow stuff
+    - include: workflow-execution-contexts
+    - include: expressions
+
   redirection:
     # https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_redirection
     - match: ([2-6*])(>&)(1)

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
+    }
+  }
+}

Tests/syntax_test_PowerShell.ps1

@@ -1423,7 +1423,7 @@ class Vehicle {
 #       ^ punctuation.definition.variable.powershell
 #            ^ punctuation.accessor.dot.powershell
 #             ^^^^^^^ variable.other.member.powershell
-#                     ^^ keyword.operator.assignment.powershell
+#                     ^^ keyword.operator.assignment.augmented.powershell
 #                        ^^^^^^^^^^^^^^ variable.other.readwrite.powershell
 #                        ^ punctuation.definition.variable.powershell
 

Tests/syntax_test_Workflow.ps1

@@ -66,6 +66,19 @@
 
         ## $Using imports the variable and its current value.
         inlinescript {"Inline A1 = $Using:a"}
+#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.function.powershell
+#       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.block.powershell
+#       ^^^^^^^^^^^^ keyword.control.context.powershell
+#                    ^ punctuation.section.block.begin.powershell
+#                     ^^^^^^^^^^^^^^^^^^^^^^ meta.string.interpolated.powershell
+#                     ^^^^^^^^^^^^^ string.quoted.double.powershell
+#                     ^ punctuation.definition.string.begin.powershell
+#                                  ^^^^^^^^ meta.interpolation.powershell variable.other.readwrite.powershell
+#                                  ^ punctuation.definition.variable.powershell
+#                                   ^^^^^ storage.modifier.scope.powershell
+#                                        ^ punctuation.accessor.colon.powershell
+#                                          ^ string.quoted.double.powershell punctuation.definition.string.end.powershell
+#                                           ^ punctuation.section.block.end.powershell
     }
     Test-Workflow
 #   @@@@@@@@@@@@@ reference
@@ -86,6 +99,26 @@
         ##  To change the variable in workflow scope, return the
         ##  new value.
         $a = inlinescript {$b = $Using:a+1; $b}
+#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.function.powershell
+#       ^^ variable.other.readwrite.powershell
+#       ^ punctuation.definition.variable.powershell
+#          ^ keyword.operator.assignment.powershell
+#            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.block.powershell
+#            ^^^^^^^^^^^^ keyword.control.context.powershell
+#                         ^ punctuation.section.block.begin.powershell
+#                          ^^ variable.other.readwrite.powershell
+#                          ^ punctuation.definition.variable.powershell
+#                             ^ keyword.operator.assignment.powershell
+#                               ^^^^^^^^ variable.other.readwrite.powershell
+#                               ^ punctuation.definition.variable.powershell
+#                                ^^^^^ storage.modifier.scope.powershell
+#                                     ^ punctuation.accessor.colon.powershell
+#                                       ^ keyword.operator.unary.powershell
+#                                        ^ meta.number.integer.decimal.powershell constant.numeric.value.powershell
+#                                         ^ punctuation.terminator.statement.powershell
+#                                           ^^ variable.other.readwrite.powershell
+#                                           ^ punctuation.definition.variable.powershell
+#                                             ^ punctuation.section.block.end.powershell
         "Workflow New A = $a"
     }
     Test-Workflow