Update to better way of doing completions from trackd

ShaunLawrie · Nov 26, 2023 · e7a98cf · e7a98cf
1 parent b392af2
commit e7a98cf
Show file tree

Hide file tree

Showing 22 changed files with 137 additions and 107 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -1,6 +1,13 @@
 {
   "version": "0.2.0",
   "configurations": [
+    {
+      "name": "PowerShell Launch Current File",
+      "type": "PowerShell",
+      "request": "launch",
+      "script": "${file}",
+      "cwd": "${cwd}"
+    },
     {
       "command": "./node_modules/.bin/astro dev",
       "cwd": "${workspaceFolder}/PwshSpectreConsole.Docs",

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,2 +1,3 @@
 {
+    "powershell.codeFormatting.preset": "OTBS"
 }
diff --git a/PwshSpectreConsole/PwshSpectreConsole.psm1 b/PwshSpectreConsole/PwshSpectreConsole.psm1
@@ -1,6 +1,4 @@
-using module ".\private\attributes\ColorAttributes.psm1"
-using module ".\private\attributes\BorderAttributes.psm1"
-using module ".\private\attributes\SpinnerAttributes.psm1"
+using module ".\private\completions\Completers.psm1"
 
 $script:AccentColor = [Spectre.Console.Color]::Blue
 $script:DefaultValueColor = [Spectre.Console.Color]::Grey

diff --git a/PwshSpectreConsole/private/Convert-ToSpectreColor.ps1 b/PwshSpectreConsole/private/Convert-ToSpectreColor.ps1
@@ -1,4 +1,4 @@
-using module ".\attributes\ColorAttributes.psm1"
+using module ".\completions\Completers.psm1"
 
 <#
 .SYNOPSIS

diff --git a/PwshSpectreConsole/private/attributes/BorderAttributes.psm1 b/PwshSpectreConsole/private/attributes/BorderAttributes.psm1
diff --git a/PwshSpectreConsole/private/attributes/ColorAttributes.psm1 b/PwshSpectreConsole/private/attributes/ColorAttributes.psm1
diff --git a/PwshSpectreConsole/private/attributes/SpinnerAttributes.psm1 b/PwshSpectreConsole/private/attributes/SpinnerAttributes.psm1
diff --git a/PwshSpectreConsole/private/completions/Completers.psm1 b/PwshSpectreConsole/private/completions/Completers.psm1
@@ -0,0 +1,60 @@
+using namespace Spectre.Console
+using namespace System.Management.Automation
+
+class ValidateSpectreColor : ValidateArgumentsAttribute {
+    ValidateSpectreColor() : base() { }
+    [void]Validate([object] $Color, [EngineIntrinsics]$EngineIntrinsics) {
+        # Handle hex colors
+        if ($Color -match '^#[A-Fa-f0-9]{6}$') {
+            return
+        }
+        $spectreColors = [Color] | Get-Member -Static -Type Properties | Select-Object -ExpandProperty Name
+        $result = $spectreColors -contains $Color
+        if ($result -eq $false) {
+            throw "'$Color' is not in the list of valid Spectre colors ['$($spectreColors -join ''', ''')']"
+        }
+    }
+}
+
+class ArgumentCompletionsSpectreColors : ArgumentCompleterAttribute {
+    ArgumentCompletionsSpectreColors() : base({
+            param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameters)
+            $options = [Color] | Get-Member -Static -Type Properties | Select-Object -ExpandProperty Name
+            return $options | Where-Object { $_ -like "$wordToComplete*" }
+        }) { }
+}
+
+class SpectreConsoleTableBorder : IValidateSetValuesGenerator {
+    [String[]] GetValidValues() {
+        $lookup = [TableBorder] | Get-Member -Static -MemberType Properties | Select-Object -ExpandProperty Name
+        return $lookup
+    }
+}
+
+class SpectreConsoleBoxBorder : IValidateSetValuesGenerator {
+    [String[]] GetValidValues() {
+        $lookup = [BoxBorder] | Get-Member -Static -MemberType Properties | Select-Object -ExpandProperty Name
+        return $lookup
+    }
+}
+
+class SpectreConsoleJustify : IValidateSetValuesGenerator {
+    [String[]] GetValidValues() {
+        $lookup = [Justify].GetEnumNames()
+        return $lookup
+    }
+}
+
+class SpectreConsoleSpinner : IValidateSetValuesGenerator {
+    [String[]] GetValidValues() {
+        $lookup = [Spinner+Known] | Get-Member -Static -MemberType Properties | Select-Object -ExpandProperty Name
+        return $lookup
+    }
+}
+
+class SpectreConsoleTreeGuide : IValidateSetValuesGenerator {
+    [String[]] GetValidValues() {
+        $lookup = [TreeGuide] | Get-Member -Static -MemberType Properties | Select-Object -ExpandProperty Name
+        return $lookup
+    }
+}
diff --git a/PwshSpectreConsole/public/config/Set-SpectreColors.ps1 b/PwshSpectreConsole/public/config/Set-SpectreColors.ps1
@@ -1,4 +1,4 @@
-using module "..\..\private\attributes\ColorAttributes.psm1"
+using module "..\..\private\completions\Completers.psm1"
 
 function Set-SpectreColors {
     <#

diff --git a/PwshSpectreConsole/public/demo/Get-SpectreColorDemo.ps1 b/PwshSpectreConsole/public/demo/Get-SpectreColorDemo.ps1
@@ -0,0 +1,44 @@
+function Get-SpectreColorDemo {
+    [Reflection.AssemblyMetadata("title", "Start-SpectreDemo")]
+    param ()
+
+    $colors = [Spectre.Console.Color] | Get-Member -Static -Type Properties | Select-Object -ExpandProperty Name
+    $colors  = $colors | ForEach-Object {
+        $prefix = ($_ -replace '[_0-9]+', '')
+        $numeric = ($_ -replace '^[^0-9]+', '')
+        $value = 0
+        if([string]::IsNullOrEmpty($numeric)) {
+            $value = 0.0
+        } else {
+            $numericParts = $numeric.Split('_')
+            if($numericParts.Count -lt 2) {
+                $value = [double]"$($numericParts[0]).9"
+            } else {
+                $value = [double]"$($numericParts[0]).$($numericParts[1])"
+            }
+        }
+        return [pscustomobject]@{
+            Name = $_
+            Prefix = $prefix
+            Numeric = $value
+        }
+    } | Sort-Object -Property @{Expression = "Prefix"}, @{Expression = "Numeric"} | Select-Object -ExpandProperty Name
+
+    $maxLength = $colors | Measure-Object -Maximum -Property Length | Select-Object -ExpandProperty Maximum
+
+    foreach($color in $colors) {
+        $total = [Spectre.Console.Color]::$color | Select-Object @{ Name = "Total"; Expression = {$_.R + $_.G + $_.B} } | Select-Object -ExpandProperty Total
+        $textColor = "white"
+        if($total -gt 280) {
+            $textColor = "black"
+        }
+
+        Write-SpectreHost -NoNewline "[$textColor on $color] $($color.PadRight($maxLength)) [/] "
+        Write-SpectreHost ("[$color]$color[/]")
+    }
+
+    Write-Host "`nThe colors can be passed as the -Color parameter for most commands or used in Spectre Console markup like so:`n"
+    Write-Host "  Input:  I am [Red]colored text[/] using [Yellow1 on Turquoise4]Spectre markdown[/]!"
+    Write-SpectreHost "  Output: I am [Red]colored text[/] using [Yellow1 on Turquoise4]Spectre markdown[/]!"
+    Write-SpectreHost "`nFor more markdown hints see [link]https://spectreconsole.net/markup[/]`n"
+}
diff --git a/...ectreConsole/public/Start-SpectreDemo.ps1 → ...Console/public/demo/Start-SpectreDemo.ps1 b/...ectreConsole/public/Start-SpectreDemo.ps1 → ...Console/public/demo/Start-SpectreDemo.ps1
diff --git a/PwshSpectreConsole/public/formatting/Format-SpectrePanel.ps1 b/PwshSpectreConsole/public/formatting/Format-SpectrePanel.ps1
@@ -1,5 +1,4 @@
-using module "..\..\private\attributes\ColorAttributes.psm1"
-using module "..\..\private\attributes\BorderAttributes.psm1"
+using module "..\..\private\completions\Completers.psm1"
 
 function Format-SpectrePanel {
     <#
@@ -33,16 +32,15 @@ function Format-SpectrePanel {
         [Parameter(ValueFromPipeline, Mandatory)]
         [string] $Data,
         [string] $Title,
-        [ValidateSpectreBorder()]
-        [ArgumentCompletionsSpectreBorders()]
+        [ValidateSet([SpectreConsoleBoxBorder], ErrorMessage = "Value '{0}' is invalid. Try one of: {1}")]
         [string] $Border = "Rounded",
-        [switch] $Expand, 
+        [switch] $Expand,
         [ValidateSpectreColor()]
         [ArgumentCompletionsSpectreColors()]
         [string] $Color = $script:AccentColor.ToMarkup()
     )
     $panel = [Spectre.Console.Panel]::new($Data)
-    if($Title) {
+    if ($Title) {
         $panel.Header = [Spectre.Console.PanelHeader]::new($Title)
     }
     $panel.Expand = $Expand

diff --git a/PwshSpectreConsole/public/formatting/Format-SpectreTable.ps1 b/PwshSpectreConsole/public/formatting/Format-SpectreTable.ps1
@@ -1,5 +1,4 @@
-using module "..\..\private\attributes\ColorAttributes.psm1"
-using module "..\..\private\attributes\BorderAttributes.psm1"
+using module "..\..\private\completions\Completers.psm1"
 
 function Format-SpectreTable {
     <#
@@ -30,8 +29,7 @@ function Format-SpectreTable {
     param (
         [Parameter(ValueFromPipeline, Mandatory)]
         [array] $Data,
-        [ValidateSpectreBorder()]
-        [ArgumentCompletionsSpectreBorders()]
+        [ValidateSet([SpectreConsoleTableBorder],ErrorMessage = "Value '{0}' is invalid. Try one of: {1}")]
         [string] $Border = "Double",
         [ValidateSpectreColor()]
         [ArgumentCompletionsSpectreColors()]

diff --git a/PwshSpectreConsole/public/formatting/Format-SpectreTree.ps1 b/PwshSpectreConsole/public/formatting/Format-SpectreTree.ps1
@@ -1,5 +1,4 @@
-using module "..\..\private\attributes\ColorAttributes.psm1"
-using module "..\..\private\attributes\BorderAttributes.psm1"
+using module "..\..\private\completions\Completers.psm1"
 
 function Format-SpectreTree {
     <#
@@ -49,15 +48,15 @@ function Format-SpectreTree {
     param (
         [Parameter(ValueFromPipeline, Mandatory)]
         [hashtable] $Data,
-        [ValidateSpectreBorder()]
-        [ArgumentCompletionsSpectreBorders()]
-        [string] $Border = "Rounded",
+        [ValidateSet([SpectreConsoleTreeGuide],ErrorMessage = "Value '{0}' is invalid. Try one of: {1}")]
+        [string] $Guide = "Line",
         [ValidateSpectreColor()]
         [ArgumentCompletionsSpectreColors()]
         [string] $Color = $script:AccentColor.ToMarkup()
     )
 
     $tree = [Spectre.Console.Tree]::new($Data.Label)
+    $tree.Guide = [Spectre.Console.TreeGuide]::$Guide
 
     Add-SpectreTreeNode -Node $tree -Children $Data.Children
 

diff --git a/PwshSpectreConsole/public/formatting/New-SpectreChartItem.ps1 b/PwshSpectreConsole/public/formatting/New-SpectreChartItem.ps1
@@ -1,5 +1,5 @@
 using module "..\..\private\models\SpectreChartItem.psm1"
-using module "..\..\private\attributes\ColorAttributes.psm1"
+using module "..\..\private\completions\Completers.psm1"
 
 <#
 .SYNOPSIS

diff --git a/PwshSpectreConsole/public/progress/Invoke-SpectreCommandWithStatus.ps1 b/PwshSpectreConsole/public/progress/Invoke-SpectreCommandWithStatus.ps1
@@ -1,5 +1,4 @@
-using module "..\..\private\attributes\ColorAttributes.psm1"
-using module "..\..\private\attributes\SpinnerAttributes.psm1"
+using module "..\..\private\completions\Completers.psm1"
 
 function Invoke-SpectreCommandWithStatus {
     <#
@@ -19,7 +18,7 @@ function Invoke-SpectreCommandWithStatus {
     The title to display above the spinner.
 
     .PARAMETER Color
-    The color of the spinner. Valid values are "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "gray", "brightRed", "brightGreen", "brightYellow", "brightBlue", "brightMagenta", "brightCyan", "brightWhite".
+    The color of the spinner. Valid values can be found with Get-SpectreColorDemo.
 
     .EXAMPLE
     # Starts a Spectre status spinner with the "dots" spinner type, a yellow color, and the title "Waiting for process to complete". The spinner will continue to spin for 5 seconds.
@@ -29,8 +28,7 @@ function Invoke-SpectreCommandWithStatus {
     param (
         [Parameter(Mandatory)]
         [scriptblock] $ScriptBlock,
-        [ValidateSpectreSpinner()]
-        [ArgumentCompletionsSpectreSpinners()]
+        [ValidateSet([SpectreConsoleSpinner],ErrorMessage = "Value '{0}' is invalid. Try one of: {1}")]
         [string] $Spinner = "Dots",
         [Parameter(Mandatory)]
         [string] $Title,

diff --git a/PwshSpectreConsole/public/prompts/Read-SpectreConfirm.ps1 b/PwshSpectreConsole/public/prompts/Read-SpectreConfirm.ps1
@@ -1,4 +1,4 @@
-using module "..\..\private\attributes\ColorAttributes.psm1"
+using module "..\..\private\completions\Completers.psm1"
 
 function Read-SpectreConfirm {
     <#

diff --git a/PwshSpectreConsole/public/prompts/Read-SpectreMultiSelection.ps1 b/PwshSpectreConsole/public/prompts/Read-SpectreMultiSelection.ps1
@@ -1,4 +1,4 @@
-using module "..\..\private\attributes\ColorAttributes.psm1"
+using module "..\..\private\completions\Completers.psm1"
 
 function Read-SpectreMultiSelection {
     <#

diff --git a/PwshSpectreConsole/public/prompts/Read-SpectreMultiSelectionGrouped.ps1 b/PwshSpectreConsole/public/prompts/Read-SpectreMultiSelectionGrouped.ps1
@@ -1,4 +1,4 @@
-using module "..\..\private\attributes\ColorAttributes.psm1"
+using module "..\..\private\completions\Completers.psm1"
 
 function Read-SpectreMultiSelectionGrouped {
     <#

diff --git a/PwshSpectreConsole/public/prompts/Read-SpectreSelection.ps1 b/PwshSpectreConsole/public/prompts/Read-SpectreSelection.ps1
@@ -1,4 +1,4 @@
-using module "..\..\private\attributes\ColorAttributes.psm1"
+using module "..\..\private\completions\Completers.psm1"
 
 function Read-SpectreSelection {
     <#

diff --git a/PwshSpectreConsole/public/writing/Write-SpectreFigletText.ps1 b/PwshSpectreConsole/public/writing/Write-SpectreFigletText.ps1
@@ -1,4 +1,4 @@
-using module "..\..\private\attributes\ColorAttributes.psm1"
+using module "..\..\private\completions\Completers.psm1"
 
 function Write-SpectreFigletText {
     <#
@@ -24,7 +24,7 @@ function Write-SpectreFigletText {
     [Reflection.AssemblyMetadata("title", "Write-SpectreFigletText")]
     param (
         [string] $Text = "Hello Spectre!",
-        [ValidateSet("Left", "Right", "Center")]
+        [ValidateSet([SpectreConsoleJustify], ErrorMessage = "Value '{0}' is invalid. Try one of: {1}")]
         [string] $Alignment = "Left",
         [ValidateSpectreColor()]
         [ArgumentCompletionsSpectreColors()]

diff --git a/PwshSpectreConsole/public/writing/Write-SpectreRule.ps1 b/PwshSpectreConsole/public/writing/Write-SpectreRule.ps1
@@ -1,4 +1,4 @@
-using module "..\..\private\attributes\ColorAttributes.psm1"
+using module "..\..\private\completions\Completers.psm1"
 
 function Write-SpectreRule {
     <#
@@ -25,7 +25,7 @@ function Write-SpectreRule {
     param (
         [Parameter(Mandatory)]
         [string] $Title,
-        [ValidateSet("Left", "Right", "Center")]
+        [ValidateSet([SpectreConsoleJustify], ErrorMessage = "Value '{0}' is invalid. Try one of: {1}")]
         [string] $Alignment = "Left",
         [ValidateSpectreColor()]
         [ArgumentCompletionsSpectreColors()]