Additional file formatting

Author: stevevillardi

Build.ps1

@@ -6,35 +6,35 @@ $manifestPath = "./Logic.Monitor.psd1"
 $publicFuncFolderPath = './Public'
 
 $ps1xmlFiles = Get-ChildItem -Path ./ -Filter *.ps1xml
-foreach ($ps1xml in $ps1xmlFiles) {
+Foreach ($ps1xml in $ps1xmlFiles) {
     [xml]$xml = Get-Content -Path $ps1xml.FullName
     $null = $xml.Schemas.Add($null, 'https://raw.githubusercontent.com/PowerShell/PowerShell/master/src/Schemas/Format.xsd')
     $null = $xml.Schemas.Add($null, 'https://raw.githubusercontent.com/PowerShell/PowerShell/master/src/Schemas/Types.xsd')
-    $xml.Validate( { throw "File '$($ps1xml.Name)' schema error: $($_.Message)" })
+    $xml.Validate( { Throw "File '$($ps1xml.Name)' schema error: $($_.Message)" })
 }
 
-if (!(Get-PackageProvider | Where-Object { $_.Name -eq 'NuGet' })) {
+If (!(Get-PackageProvider | Where-Object { $_.Name -eq 'NuGet' })) {
     Install-PackageProvider -Name NuGet -Force | Out-Null
 }
 Import-PackageProvider -Name NuGet -Force | Out-Null
 
-if ((Get-PSRepository -Name PSGallery).InstallationPolicy -ne 'Trusted') {
+If ((Get-PSRepository -Name PSGallery).InstallationPolicy -ne 'Trusted') {
     Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
 }
 
-if (!(Get-Module Microsoft.PowerShell.SecretManagement -ListAvailable)) {
+If (!(Get-Module Microsoft.PowerShell.SecretManagement -ListAvailable)) {
     Install-Module Microsoft.PowerShell.SecretManagement -Force -Confirm:$false
 }
-if (!(Get-Module Microsoft.PowerShell.SecretStore -ListAvailable)) {
+If (!(Get-Module Microsoft.PowerShell.SecretStore -ListAvailable)) {
     Install-Module Microsoft.PowerShell.SecretStore -Force -Confirm:$false
 }
 
 $manifestContent = (Get-Content -Path $manifestPath -Raw) -replace '<ModuleVersion>', $buildVersion
 
-if ((Test-Path -Path $publicFuncFolderPath) -and ($publicFunctionNames = Get-ChildItem -Path $publicFuncFolderPath -Filter '*.ps1' | Select-Object -ExpandProperty BaseName)) {
+If ((Test-Path -Path $publicFuncFolderPath) -and ($publicFunctionNames = Get-ChildItem -Path $publicFuncFolderPath -Filter '*.ps1' | Select-Object -ExpandProperty BaseName)) {
     $funcStrings = "'$($publicFunctionNames -join "','")'"
 }
-else {
+Else {
     $funcStrings = $null
 }
 

EXAMPLES.md

@@ -192,7 +192,7 @@ Set-LMDevice -Name "192.168.1.1" -DisplayName $deviceProperty
 #Method Three
 #Using Get-LMDeviceGroupDevices to retrieve a list of devices and loop through each and set the sysname value to the displayname
 $devices = Get-LMDeviceGroupDevices -Name "Cambium Wireless"
-foreach ($dev in $devices) {
+Foreach ($dev in $devices) {
     $deviceProperty = ($dev.systemProperties[$dev.systemProperties.name.IndexOf("system.sysname")].value)
     if($deviceProperty -and $dev.systemProperties.name.IndexOf("system.sysname") -ne -1){
         Set-LMDevice -Id $dev.id -DisplayName $deviceProperty
@@ -209,7 +209,7 @@ $processedDeviceList = @()
 $devices = Get-LMDeviceGroupDevices -Id "23"
 
 #Loop through each device and check for presence of property
-foreach ($dev in $devices) {
+Foreach ($dev in $devices) {
     $propName = "test.prop"
     $propValue = "1234"
     $currentPropValue = ($dev.customProperties[$dev.customProperties.name.IndexOf($propName)].value)

Private/Add-ObjectTypeInfo.ps1

@@ -96,7 +96,7 @@ function Add-ObjectTypeInfo {
         http://blogs.microsoft.co.il/scriptfanatic/2012/04/13/custom-objects-default-display-in-powershell-30/
     #>
     [CmdletBinding()] 
-    param(
+    Param (
         [Parameter( Mandatory = $true,
             Position = 0,
             ValueFromPipeline = $true )]
@@ -121,17 +121,17 @@ function Add-ObjectTypeInfo {
     )
 
     Begin {
-        if ($PSBoundParameters.ContainsKey('DefaultProperties')) {
+        If ($PSBoundParameters.ContainsKey('DefaultProperties')) {
             # define a subset of properties
             $ddps = New-Object System.Management.Automation.PSPropertySet DefaultDisplayPropertySet, $DefaultProperties
             $PSStandardMembers = [System.Management.Automation.PSMemberInfo[]]$ddps
         }
     }
     Process {
-        foreach ($Object in $InputObject) {
+        Foreach ($Object in $InputObject) {
             switch ($PSBoundParameters.Keys) {
                 'PropertyToAdd' {
-                    foreach ($Key in $PropertyToAdd.Keys) {
+                    Foreach ($Key in $PropertyToAdd.Keys) {
                         #Add some noteproperties. Slightly faster than Add-Member.
                         $Object.PSObject.Properties.Add( ( New-Object PSNoteProperty($Key, $PropertyToAdd[$Key]) ) )  
                     }
@@ -145,7 +145,7 @@ function Add-ObjectTypeInfo {
                     Add-Member -InputObject $Object -MemberType MemberSet -Name PSStandardMembers -Value $PSStandardMembers
                 }
             }
-            if ($Passthru) {
+            If ($Passthru) {
                 $Object
             }
         }

Private/Format-LMFilter-v1.ps1

@@ -24,7 +24,7 @@
     System.String. The function returns a string that represents the formatted filter.
 
 .NOTES
-    The function does not throw any errors. If a property in the Filter parameter is not in the PropList parameter, it is simply removed from the filter.
+    If a property in the Filter parameter is not in the PropList parameter, it is simply removed from the filter.
 #>
 Function Format-LMFilter-v1 {
     [CmdletBinding()]
@@ -48,7 +48,7 @@ Function Format-LMFilter-v1 {
     }
 
     #Create filter string from hash table and url encode
-    foreach ($Key in $($Filter.keys)) {
+    Foreach ($Key in $($Filter.keys)) {
         $FilterString += $Key + ":" + "`"$($Filter[$Key])`"" + ","
     }
     $FilterString = $FilterString.trimend(',')

Private/Format-LMFilter.ps1

@@ -52,7 +52,7 @@ Function Format-LMFilter {
             If ($Filter -match '\s+-and\s+') {
                 $FormatedFilter += ","
             }
-            ElseIf ($Filter -match '\s+-or\s+') {
+            Elseif ($Filter -match '\s+-or\s+') {
                 $FormatedFilter += "||"
             }
             Else {

Private/New-LMHeader.ps1

@@ -66,15 +66,15 @@ Function New-LMHeader {
         $Token = [System.Net.NetworkCredential]::new("", $Auth.BearerToken).Password
         $Header.Add("Authorization", "Bearer $Token")
     }
-    ElseIf ($Auth.Type -eq "SessionSync") {
+    Elseif ($Auth.Type -eq "SessionSync") {
         $SessionInfo = Get-LMSession -AccountName $Auth.Portal
         If ($SessionInfo) {
             $Header.Add("Cookie", "JSESSIONID=$($SessionInfo.jSessionID)")
             $Session.Cookies.Add((New-Object System.Net.Cookie("JSESSIONID", $SessionInfo.jSessionID, "/", $SessionInfo.domain)))
             $Header.Add("X-CSRF-Token", "$($SessionInfo.token)")
         }
         Else {
-            throw "Unable to generate header details, ensure you are connected to a portal and try again."
+            Throw "Unable to generate header details, ensure you are connected to a portal and try again."
         }
     }
     Else {

Private/Resolve-LMDebugInfo.ps1

@@ -34,5 +34,5 @@ Function Resolve-LMDebugInfo {
     Write-Debug "Bound Parameters: $($Command.BoundParameters.GetEnumerator() | ForEach-Object {"[" + $($_.Key) + ":" + $($_.Value) + "]"})"
     Write-Debug "Invoked URL: $Url"
     If ($Payload) { Write-Debug "Request Payload: `n$Payload" }
-    Write-Debug "Request Headers: $($Headers.GetEnumerator() | ForEach-Object {"[" + $($_.Key) + ":" + $(if ($_.Value.length -gt 25) { $_.Value.substring(0, 25) + "...]" } else { $($_.Value) + "]" })})"
+    Write-Debug "Request Headers: $($Headers.GetEnumerator() | ForEach-Object {"[" + $($_.Key) + ":" + $(If ($_.Value.length -gt 25) { $_.Value.substring(0, 25) + "...]" } Else { $($_.Value) + "]" })})"
 }

Private/Resolve-LMException.ps1

@@ -48,7 +48,6 @@ Function Resolve-LMException {
                     [Console]::ForegroundColor = 'red'
                     [Console]::Error.WriteLine("Failed to execute web request($($HttpStatusCode)): $HttpException")
                     [Console]::ResetColor()
-                    #throw "Failed to execute web request($($HttpStatusCode)): $HttpException"
                 }
             }
             default {
@@ -62,7 +61,6 @@ Function Resolve-LMException {
                     [Console]::ForegroundColor = 'red'
                     [Console]::Error.WriteLine("Failed to execute web request: $LMError")
                     [Console]::ResetColor()
-                    #throw "Failed to execute web request: $LMError"
                 }
             }
         }

Private/Test-LookupResult.ps1

@@ -29,7 +29,7 @@ Function Test-LookupResult {
         return $true
     }
     #If empty stop processing since we have no Id to use
-    ElseIf (!$Result) {
+    Elseif (!$Result) {
         [Console]::ForegroundColor = 'red'
         [Console]::Error.WriteLine("Unable to find resource for the specified name value: $LookupString. Please check spelling and try again.")
         [Console]::ResetColor()

Private/Update-LogicMonitorModule.ps1

@@ -46,7 +46,7 @@ Function Update-LogicMonitorModule {
         If ($Installed -is [Array]) {
             $InstalledVersion = $Installed[0].Version
         }
-        ElseIf ($Installed.Version) {
+        Elseif ($Installed.Version) {
             $InstalledVersion = $Installed.Version
         }
         Else {
@@ -65,7 +65,7 @@ Function Update-LogicMonitorModule {
             If ($CheckOnly) {
                 Write-LMHost "[INFO]: You are currently using an outdated version ($InstalledVersion) of $Module, please consider upgrading to the latest version ($OnlineVersion) as soon as possible. Use the -AutoUpdateModule switch next time you connect to auto upgrade to the latest version." -ForegroundColor Yellow
             }
-            ElseIf ($UninstallFirst -eq $true) {
+            Elseif ($UninstallFirst -eq $true) {
                 Write-LMHost "[INFO]: You are currently using an outdated version ($InstalledVersion) of $Module, uninstalling prior Module $Module version $InstalledVersion" -ForegroundColor Yellow
                 Uninstall-Module -Name $Module -Force -Verbose:$False