🎨 Move to EZOut for formatting (#382)

* 🎨 initial commit for formatting

- Add format view for result object
- Add build code to generate xml

* 🎨 add detailed view

* 🎨 Adjust detailed formatting

* 🎨 Update formatters

+ Refactoring on some controls
+ Added formatting for PSKoans.CompleteResult
+ All cases tested and looking fancy!

* 🔥 Remove unneeded code

- Removed Show-MeditationPrompt

* ♻️ tidy up ezformat file

* 🚀 Fix build script

* ✅ Update tests & build script

* 🚀 Enable verbose logging in format builder

* 🚀 Add verbose logging

* 🚀 Tinkering with format generation

* 🚀 use built module instead of repo

* ✅ Update tests

+ Remove mocks and checks for Show-MeditationPrompt
+ Other small fixes for slight behaviour changes

* 🚀 -AllowClobber needed for EZOut install

Author: vexx32

.gitignore

@@ -1,4 +1,5 @@
 .vs/
 .DS_Store/
 *.temppoint.*
+*.format.ps1xml
 PSKoans.psproj

Build/Build-Module.ps1

@@ -1,6 +1,9 @@
 # Grab nuget bits, set build variables, start build.
 Get-PackageProvider -Name NuGet -ForceBootstrap > $null
 
+# Create format.ps1xml file
+& "$PSScriptRoot/../PSKoans.ezformat.ps1"
+
 Import-Module "$env:PROJECTROOT/PSKoans"
 
 Set-BuildEnvironment

Build/Invoke-ModuleTests.ps1

@@ -6,10 +6,6 @@ Write-Host "STATUS: Testing with PowerShell v$($PSVersionTable.PSVersion)"
 Write-Host $Lines
 
 # Import the module and add temporary entry to PSModulePath for build/test purposes
-$env:PSModulePath = @(
-    $env:PROJECTROOT
-    $env:PSModulePath
-) -join [IO.Path]::PathSeparator
 
 Import-Module 'PSKoans'
 

PSKoans.ezformat.ps1

@@ -0,0 +1,38 @@
+#Requires -Modules EZOut
+# Install-Module EZOut
+# or https://github.com/StartAutomating/EZOut
+
+$VerbosePreference = 'Continue'
+
+$ModuleName = $MyInvocation.MyCommand.Name -replace '\.ezformat\.ps1', ''
+$ModuleFolder = Get-Item -Path "$PSScriptRoot/PSKoans" | Select-Object -ExpandProperty FullName
+
+Write-Verbose "Building format file for '$ModuleName' in '$ModuleFolder'"
+
+$formatting = @(
+    foreach ($potentialDirectory in 'formatting', 'views') {
+        $path = Join-Path $PSScriptRoot -ChildPath $potentialDirectory
+        if (Test-Path $path) {
+            Get-ChildItem -Path $path | ForEach-Object {
+                Write-Verbose "Processing file '$($_.FullName)'"
+                Import-FormatView -FilePath $_.FullName
+            }
+        }
+    }
+)
+
+if ($formatting) {
+    $formatFilePath = Join-Path $ModuleFolder -ChildPath "$ModuleName.format.ps1xml"
+    Write-Verbose "Writing format file to '$formatFilePath'"
+    $formatting | Out-FormatData -Module $ModuleName | Set-Content $formatFilePath -Encoding UTF8
+}
+
+$types = @(
+    # Add your own Write-TypeView statements here
+)
+
+if ($types) {
+    $TypesFile = Join-Path $PSScriptRoot "$ModuleName.types.ps1xml"
+    Write-Verbose "Writing types file to '$TypesFile'"
+    $types | Out-TypeData | Set-Content $TypesFile -Encoding UTF8
+}

PSKoans/Data/Show-MeditationPrompt.Data.psd1

@@ -1,72 +1,5 @@
 @{
-    Prompts = @{
-        Welcome        = @"
-    Welcome, seeker of enlightenment.
-    Please wait a moment while we examine your karma...
-
-"@
-        DetailEntry    = @"
-{0} It {1}
-"@
-        Describe       = @"
-Describing '{0}' has damaged your karma.
-"@
-        TestFailed     = @"
-
-    You have not yet reached enlightenment.
-
-    The answers you seek...
-
-"@
-        Meditate       = @"
-
-    Please meditate on the following code:
-
-"@
-        Subject        = @"
-{0} It {1}
-{2}
-"@
-        Koan           = @"
-
-{0}
-
-"@
-        Path           = @"
-    You examine the path beneath your feet...
-
-"@
-        Topic          = @"
-    You must meditate further on your selected topic{0}:
-        - {1}
-
-"@
-        OpenFolder     = @"
-
-Run 'Show-Karma -Meditate' to begin your meditations.
-
-"@
-        Completed      = @"
-    Congratulations! You have taken the first steps towards enlightenment.
-
-    You cast your gaze back upon the path that you have walked:
-
-"@
-        CompletedTopic = @"
-    Congratulations! You have taken the first steps towards enlightenment.
-
-    You have completed: {0}
-
-    You cast your gaze back upon the path that you have walked...
-
-"@
-        BookSuggestion = @"
-
-    If you would like to further your studies in this manner, consider investing in
-    'PowerShell by Mistake' by Don Jones - https://leanpub.com/powershell-by-mistake
-"@
-    }
-    Koans   = @(
+    Koans = @(
         @'
 The whole moon and the entire sky
 Are reflected in one dewdrop on the grass.
@@ -238,7 +171,7 @@ you're not looking long enough.
 In order to write good code,
 you must become the code.
 '@
-        @'  
+        @'
 Mind is not the Buddha,
 reason is not the Way.
 '@
@@ -249,7 +182,7 @@ that weighs you down.
 '@
         @'
 There are two rules in life:
-1. Never give out all of 
+1. Never give out all of
 the information.
 '@
         @'

PSKoans/Init/ModuleConfiguration.ps1

@@ -3,7 +3,6 @@ Write-Verbose 'Importing data strings'
 
 $ShowMeditationPromptData = Import-PowerShellDataFile -Path "$script:ModuleRoot/Data/Show-MeditationPrompt.Data.psd1"
 $script:MeditationStrings = $ShowMeditationPromptData['Koans']
-$script:MeditationPrompts = $ShowMeditationPromptData['Prompts']
 Remove-Variable -Name 'ShowMeditationPromptData'
 
 $Settings = Get-PSKoanSetting

PSKoans/PSKoans.format.ps1xml

@@ -127,6 +127,18 @@
     # Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
     PrivateData           = @{
 
+        Colors = @{
+
+            Meditation = @{
+                Text     = "#7AAFCA"
+                Emphasis = "#DACF60"
+                Passed   = "#30DF60"
+                Error    = '#E02020'
+                Progress = '#CACEFA'
+            }
+
+        }
+
         PSData = @{
 
             # Tags applied to this module. These help with module discovery in online galleries.