Updating PipeScript.HelpOut.ps1 (including topics, re #132)

Author: StartAutomating

docs/README.md

@@ -1,12 +1,211 @@
-Files in this directory and it's subdirectories generate wrappers for PipeScript and PowerShell.
+This directory and it's subdirectories contain syntax changes that enable common programming scenarios in PowerShell and PipeScript.
 
-These wrappers allow PipeScript or PowerShell to be called from other programming languages.
 
+|DisplayName                                     |Synopsis                                                 |
+|------------------------------------------------|---------------------------------------------------------|
+|[Dot](Dot.psx.ps1)                              |[Dot Notation](Dot.psx.ps1)                              |
+|[EqualityComparison](EqualityComparison.psx.ps1)|[Allows equality comparison.](EqualityComparison.psx.ps1)|
+|[PipedAssignment](PipedAssignment.psx.ps1)      |[Piped Assignment Transpiler](PipedAssignment.psx.ps1)   |
+|[RegexLiteral](RegexLiteral.psx.ps1)            |[Regex Literal Transpiler](RegexLiteral.psx.ps1)         |
 
-|DisplayName                               |Synopsis                                                             |
-|------------------------------------------|---------------------------------------------------------------------|
-|[Bash](Bash.psx.ps1)                      |[Wraps PowerShell in a Bash Script](Bash.psx.ps1)                    |
-|[Batch](Batch.psx.ps1)                    |[Wraps PowerShell in a Windows Batch Script](Batch.psx.ps1)          |
-|[BatchPowerShell](BatchPowerShell.psx.ps1)|[Wraps PowerShell in a Windows Batch Script](BatchPowerShell.psx.ps1)|
 
 
+
+## Dot Example 1
+
+
+~~~PowerShell
+    .> {
+        [DateTime]::now | .Month .Day .Year
+    }
+~~~
+
+## Dot Example 2
+
+
+~~~PowerShell
+    .> {
+        "abc", "123", "abc123" | .Length
+    }
+~~~
+
+## Dot Example 3
+
+
+~~~PowerShell
+    .> { 1.99 | .ToString 'C' [CultureInfo]'gb-gb' }
+~~~
+
+## Dot Example 4
+
+
+~~~PowerShell
+    .> { 1.99 | .ToString('C') }
+~~~
+
+## Dot Example 5
+
+
+~~~PowerShell
+    .> { 1..5 | .Number { $_ } .Even { -not ($_ % 2) } .Odd { ($_ % 2) -as [bool]} }
+~~~
+
+## Dot Example 6
+
+
+~~~PowerShell
+    .> { .ID { Get-Random } .Count { 0 } .Total { 10 }}
+~~~
+
+## Dot Example 7
+
+
+~~~PowerShell
+    .> {
+        # Declare a new object
+        .Property = "ConstantValue" .Numbers = 1..100 .Double = {
+            param($n)
+            $n * 2
+        } .EvenNumbers = {
+            $this.Numbers | Where-Object { -not ($_ % 2)}
+        } .OddNumbers = {
+            $this.Numbers | Where-Object { $_ % 2}
+        }
+    }
+~~~
+
+## EqualityComparison Example 1
+
+
+~~~PowerShell
+    Invoke-PipeScript -ScriptBlock {
+        $a = 1    
+        if ($a == 1 ) {
+            "A is $a"
+        }
+    }
+~~~
+
+## EqualityComparison Example 2
+
+
+~~~PowerShell
+    {
+        $a == "b"
+    } | .>PipeScript
+~~~
+
+## PipedAssignment Example 1
+
+
+~~~PowerShell
+    {
+        $Collection |=| Where-Object Name -match $Pattern
+    } | .>PipeScript
+
+    # This will become:
+
+    $Collection = $Collection | Where-Object Name -match $pattern
+~~~
+
+## PipedAssignment Example 2
+
+
+~~~PowerShell
+    {
+        $Collection |=| Where-Object Name -match $pattern | Select-Object -ExpandProperty Name
+    } | .>PipeScript
+
+    # This will become
+
+    $Collection = $Collection |
+            Where-Object Name -match $pattern |
+            Select-Object -ExpandProperty Name
+~~~
+
+## RegexLiteral Example 1
+
+
+~~~PowerShell
+    {
+        '/[a|b]/'
+    } | .>PipeScript
+
+    # This will become:
+
+    [regex]::new('[a|b]', 'IgnoreCase')
+~~~
+
+## RegexLiteral Example 2
+
+
+~~~PowerShell
+    Invoke-PipeScript {
+        '/[a|b]/'.Matches('ab')
+    }
+~~~
+
+## RegexLiteral Example 3
+
+
+~~~PowerShell
+    {
+        "/[$a|$b]/"
+    } | .>PipeScript
+
+    # This will become:
+
+    [regex]::new("[$a|$b]", 'IgnoreCase')
+~~~
+
+## RegexLiteral Example 4
+
+
+~~~PowerShell
+    {
+@'
+/
+# Heredocs Regex literals will have IgnorePatternWhitespace by default, which allows comments
+^ # Match the string start
+(?<indent>\s{0,1})
+/
+'@
+    } | .>PipeScript
+
+    # This will become:
+
+    [regex]::new(@'
+# Heredocs Regex literals will have IgnorePatternWhitespace by default, which allows comments
+^ # Match the string start
+(?<indent>\s{0,1})
+'@, 'IgnorePatternWhitespace,IgnoreCase')
+~~~
+
+## RegexLiteral Example 5
+
+
+~~~PowerShell
+    $Keywords = "looking", "for", "these", "words"
+
+    {
+@"
+/
+# Double quoted heredocs can still contain variables
+[\s\p{P}]{0,1}         # Whitespace or punctuation
+$($Keywords -join '|') # followed by keywords
+[\s\p{P}]{0,1}         # followed by whitespace or punctuation
+/
+"@
+    } | .>PipeScript
+
+
+    # This will become:
+
+    [regex]::new(@"
+# Double quoted heredocs can still contain variables
+[\s\p{P}]{0,1}         # Whitespace or punctuation
+$($Keywords -join '|') # followed by keywords
+[\s\p{P}]{0,1}         # followed by whitespace or punctuation
+"@, 'IgnorePatternWhitespace,IgnoreCase')
+~~~
+