Code Formatting of Repo - Add Preprocessing to Compilation Process - Introduction of Dev/Build Tools to WinUtil (Although very simple at the moment)

Compile.ps1

@@ -1,26 +1,28 @@
 param (
     [switch]$Debug,
-    [switch]$Run
+    [switch]$Run,
+    [switch]$SkipPreprocessing
 )
 $OFS = "`r`n"
 $scriptname = "winutil.ps1"
+$workingdir = $PSScriptRoot
 
 # Variable to sync between runspaces
 $sync = [Hashtable]::Synchronized(@{})
-$sync.PSScriptRoot = $PSScriptRoot
+$sync.PSScriptRoot = $workingdir
 $sync.configs = @{}
 
 function Update-Progress {
     param (
         [Parameter(Mandatory, position=0)]
         [string]$StatusMessage,
 
-	[Parameter(Mandatory, position=1)]
-	[ValidateRange(0,100)]
+        [Parameter(Mandatory, position=1)]
+        [ValidateRange(0,100)]
         [int]$Percent,
 
-	[Parameter(position=2)]
-	[string]$Activity = "Compiling"
+        [Parameter(position=2)]
+        [string]$Activity = "Compiling"
     )
 
     Write-Progress -Activity $Activity -Status $StatusMessage -PercentComplete $Percent
@@ -34,6 +36,13 @@ $header = @"
 ################################################################################################################
 "@
 
+if (-NOT $SkipPreprocessing) {
+    # Dot source the 'Do-PreProcessing' Function from 'tools/Do-PreProcessing.ps1' Function
+    . "$workingdir\tools\Do-PreProcessing.ps1"
+    $msg = "Pre-req: Code Formatting"
+    Update-Progress "Pre-req: Allocating Memory" 0
+    Do-PreProcessing $msg
+}
 
 # Create the script in memory.
 Update-Progress "Pre-req: Allocating Memory" 0
@@ -43,14 +52,14 @@ Update-Progress "Adding: Header" 5
 $script_content.Add($header)
 
 Update-Progress "Adding: Version" 10
-$script_content.Add($(Get-Content .\scripts\start.ps1).replace('#{replaceme}',"$(Get-Date -Format yy.MM.dd)"))
+$script_content.Add($(Get-Content "$workingdir\scripts\start.ps1").replace('#{replaceme}',"$(Get-Date -Format yy.MM.dd)"))
 
 Update-Progress "Adding: Functions" 20
-Get-ChildItem .\functions -Recurse -File | ForEach-Object {
+Get-ChildItem "$workingdir\functions" -Recurse -File | ForEach-Object {
     $script_content.Add($(Get-Content $psitem.FullName))
     }
 Update-Progress "Adding: Config *.json" 40
-Get-ChildItem .\config | Where-Object {$psitem.extension -eq ".json"} | ForEach-Object {
+Get-ChildItem "$workingdir\config" | Where-Object {$psitem.extension -eq ".json"} | ForEach-Object {
 
     $json = (Get-Content $psitem.FullName).replace("'","''")
 
@@ -65,15 +74,15 @@ Get-ChildItem .\config | Where-Object {$psitem.extension -eq ".json"} | ForEach-
         #  Use **HTML decimal/hex codes instead**, as using HTML Entity Codes will result in XML parse Error when running the compiled script.
         for ($i = 0; $i -lt $firstLevelJsonList.Count; $i += 1) {
             $firstLevelName = $firstLevelJsonList[$i]
-	    if ($jsonAsObject.$firstLevelName.content -ne $null) {
+            if ($jsonAsObject.$firstLevelName.content -ne $null) {
                 $jsonAsObject.$firstLevelName.content = $jsonAsObject.$firstLevelName.content.replace('&','&#38;').replace('“','&#8220;').replace('”','&#8221;').replace("'",'&#39;').replace('<','&#60;').replace('>','&#62;').replace('—','&#8212;')
                 $jsonAsObject.$firstLevelName.content = $jsonAsObject.$firstLevelName.content.replace('&#39;&#39;',"&#39;") # resolves the Double Apostrophe caused by the first replace function in the main loop
             }
             if ($jsonAsObject.$firstLevelName.description -ne $null) {
                 $jsonAsObject.$firstLevelName.description = $jsonAsObject.$firstLevelName.description.replace('&','&#38;').replace('“','&#8220;').replace('”','&#8221;').replace("'",'&#39;').replace('<','&#60;').replace('>','&#62;').replace('—','&#8212;')
                 $jsonAsObject.$firstLevelName.description = $jsonAsObject.$firstLevelName.description.replace('&#39;&#39;',"&#39;") # resolves the Double Apostrophe caused by the first replace function in the main loop
-	    }
-	}
+            }
+        }
 
     # Add 'WPFInstall' as a prefix to every entry-name in 'applications.json' file
     if ($psitem.Name -eq "applications.json") {
@@ -95,10 +104,10 @@ Get-ChildItem .\config | Where-Object {$psitem.extension -eq ".json"} | ForEach-
     $script_content.Add($(Write-output "`$sync.configs.$($psitem.BaseName) = '$json' `| convertfrom-json" ))
 }
 
-$xaml = (Get-Content .\xaml\inputXML.xaml).replace("'","''")
+$xaml = (Get-Content "$workingdir\xaml\inputXML.xaml").replace("'","''")
 
 # Dot-source the Get-TabXaml function
-. .\functions\private\Get-TabXaml.ps1
+. "$workingdir\functions\private\Get-TabXaml.ps1"
 
 Update-Progress "Building: Xaml " 75
 $appXamlContent = Get-TabXaml "applications" 5
@@ -114,30 +123,29 @@ $xaml = $xaml -replace "{{InstallPanel_features}}", $featuresXamlContent
 
 $script_content.Add($(Write-output "`$inputXML =  '$xaml'"))
 
-$script_content.Add($(Get-Content .\scripts\main.ps1))
+$script_content.Add($(Get-Content "$workingdir\scripts\main.ps1"))
 
-if ($Debug){
+if ($Debug) {
     Update-Progress "Writing debug files" 95
-    $appXamlContent | Out-File -FilePath ".\xaml\inputApp.xaml" -Encoding ascii
-    $tweaksXamlContent | Out-File -FilePath ".\xaml\inputTweaks.xaml" -Encoding ascii
-    $featuresXamlContent | Out-File -FilePath ".\xaml\inputFeatures.xaml" -Encoding ascii
+    $appXamlContent | Out-File -FilePath "$workingdir\xaml\inputApp.xaml" -Encoding ascii
+    $tweaksXamlContent | Out-File -FilePath "$workingdir\xaml\inputTweaks.xaml" -Encoding ascii
+    $featuresXamlContent | Out-File -FilePath "$workingdir\xaml\inputFeatures.xaml" -Encoding ascii
 }
 else {
     Update-Progress "Removing temporary files" 99
-    Remove-Item ".\xaml\inputApp.xaml" -ErrorAction SilentlyContinue
-    Remove-Item ".\xaml\inputTweaks.xaml" -ErrorAction SilentlyContinue
-    Remove-Item ".\xaml\inputFeatures.xaml" -ErrorAction SilentlyContinue
+    Remove-Item "$workingdir\xaml\inputApp.xaml" -ErrorAction SilentlyContinue
+    Remove-Item "$workingdir\xaml\inputTweaks.xaml" -ErrorAction SilentlyContinue
+    Remove-Item "$workingdir\xaml\inputFeatures.xaml" -ErrorAction SilentlyContinue
 }
 
-Set-Content -Path $scriptname -Value ($script_content -join "`r`n") -Encoding ascii
+Set-Content -Path "$workingdir\$scriptname" -Value ($script_content -join "`r`n") -Encoding ascii
 Write-Progress -Activity "Compiling" -Completed
 
-if ($run){
+if ($run) {
     try {
-        Start-Process -FilePath "pwsh" -ArgumentList ".\$scriptname"
-    }
-    catch {
-        Start-Process -FilePath "powershell" -ArgumentList ".\$scriptname"
+        Start-Process -FilePath "pwsh" -ArgumentList "$workingdir\$scriptname"
+    } catch {
+        Start-Process -FilePath "powershell" -ArgumentList "$workingdir\$scriptname"
     }
 
 }

functions/private/ConvertTo-Icon.ps1

@@ -57,9 +57,9 @@ function ConvertTo-Icon {
 
     #>
     param(
-        [Parameter(Mandatory=$true, position=0)]
+        [Parameter(Mandatory, position=0)]
         [string]$bitmapPath,
-        [Parameter(Mandatory=$true, position=1)]
+        [Parameter(Mandatory, position=1)]
         [string]$iconPath,
         [Parameter(position=2)]
         [bool]$overrideIconFile = $true

functions/private/Get-Oscdimg.ps1

@@ -1,15 +1,17 @@
 function Get-Oscdimg {
     <#
-
         .DESCRIPTION
         This function will download oscdimg file from github Release folders and put it into env:temp folder
 
         .EXAMPLE
         Get-Oscdimg
     #>
-    param( [Parameter(Mandatory=$true)]
+
+    param(
+        [Parameter(Mandatory, position=0)]
         [string]$oscdimgPath
     )
+
     $oscdimgPath = "$env:TEMP\oscdimg.exe"
     $downloadUrl = "https://github.com/ChrisTitusTech/winutil/raw/main/releases/oscdimg.exe"
     Invoke-RestMethod -Uri $downloadUrl -OutFile $oscdimgPath

functions/private/Get-TabXaml.ps1

@@ -1,19 +1,23 @@
 function Get-TabXaml {
     <#
-    .SYNOPSIS
-        Generates XAML for a tab in the WinUtil GUI
-        This function is used to generate the XAML for the applications tab in the WinUtil GUI
-        It takes the tabname and the number of columns to display the applications in as input and returns the XAML for the tab as output
-    .PARAMETER tabname
-        The name of the tab to generate XAML for
-        Note: the 'tabname' parameter must equal one of the json files found in $sync.configs variable
-              Otherwise, it'll throw an exception
-    .PARAMETER columncount
-        The number of columns to display the applications in, default is 0
-    .OUTPUTS
-        The XAML for the tab
-    .EXAMPLE
-        Get-TabXaml "applications" 3
+        .SYNOPSIS
+            Generates XAML for a tab in the WinUtil GUI
+            This function is used to generate the XAML for the applications tab in the WinUtil GUI
+            It takes the tabname and the number of columns to display the applications in as input and returns the XAML for the tab as output
+
+        .PARAMETER tabname
+            The name of the tab to generate XAML for
+            Note: the 'tabname' parameter must equal one of the json files found in $sync.configs variable
+                  Otherwise, it'll throw an exception
+
+        .PARAMETER columncount
+            The number of columns to display the applications in, default is 0
+
+        .OUTPUTS
+            The XAML for the tab
+
+        .EXAMPLE
+            Get-TabXaml "applications" 3
     #>
 
 
@@ -115,7 +119,7 @@ function Get-TabXaml {
             }
 
             # Dot-source the Get-WPFObjectName function
-            . .\functions\private\Get-WPFObjectName
+            . "$($sync.PSScriptRoot)\functions\private\Get-WPFObjectName.ps1"
 
             $categorycontent = $($category -replace '^.__', '')
             $categoryname = Get-WPFObjectName -type "Label" -name $categorycontent

functions/private/Get-WPFObjectName.ps1

@@ -1,27 +1,31 @@
 function Get-WPFObjectName {
-        <#
-    .SYNOPSIS
-        This is a helper function that generates an objectname with the prefix WPF that can be used as a Powershell Variable after compilation.
-        To achieve this, all characters that are not a-z, A-Z or 0-9 are simply removed from the name.
-    .PARAMETER type
-        The type of object for which the name should be generated. (e.g. Label, Button, CheckBox...)
-    .PARAMETER name
-        The name or description to be used for the object. (invalid characters are removed)
-    .OUTPUTS
-        A string that can be used as a object/variable name in powershell.
-        For example: WPFLabelMicrosoftTools
+    <#
+        .SYNOPSIS
+            This is a helper function that generates an objectname with the prefix WPF that can be used as a Powershell Variable after compilation.
+            To achieve this, all characters that are not a-z, A-Z or 0-9 are simply removed from the name.
 
-    .EXAMPLE
-        Get-WPFObjectName -type Label -name "Microsoft Tools"
-    #>
+        .PARAMETER type
+            The type of object for which the name should be generated. (e.g. Label, Button, CheckBox...)
+
+        .PARAMETER name
+            The name or description to be used for the object. (invalid characters are removed)
 
-    param( [Parameter(Mandatory=$true)]
-    $type,
-    $name
-)
+        .OUTPUTS
+            A string that can be used as a object/variable name in powershell.
+            For example: WPFLabelMicrosoftTools
+
+        .EXAMPLE
+            Get-WPFObjectName -type Label -name "Microsoft Tools"
+    #>
 
-$Output = $("WPF"+$type+$name) -replace '[^a-zA-Z0-9]', ''
+    param(
+        [Parameter(Mandatory, position=0)]
+        [string]$type,
 
-return $Output
+        [Parameter(position=1)]
+        [string]$name
+    )
 
-}
+    $Output = $("WPF"+$type+$name) -replace '[^a-zA-Z0-9]', ''
+    return $Output
+}