From 739d56648faf9181131aa3bbfe08ec5cfa6bed23 Mon Sep 17 00:00:00 2001 From: OCram85 Date: Mon, 13 Jun 2022 10:06:54 +0200 Subject: [PATCH] update pwsh style in item files --- src/Item/Get-CredentialStoreItem.ps1 | 38 +++++++++------------ src/Item/New-CredentialStoreItem.ps1 | 44 ++++++++++--------------- src/Item/Remove-CredentialStoreItem.ps1 | 34 ++++++++----------- src/Item/Set-CredentialStoreItem.ps1 | 38 +++++++++------------ src/Item/Test-CredentialStoreItem.ps1 | 30 ++++++----------- 5 files changed, 70 insertions(+), 114 deletions(-) diff --git a/src/Item/Get-CredentialStoreItem.ps1 b/src/Item/Get-CredentialStoreItem.ps1 index bf32e1a..db0e63f 100644 --- a/src/Item/Get-CredentialStoreItem.ps1 +++ b/src/Item/Get-CredentialStoreItem.ps1 @@ -29,33 +29,25 @@ function Get-CredentialStoreItem { .EXAMPLE $myCreds = Get-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" - - .NOTES - - File Name : Get-CredentialStoreItem.ps1 - - Author : Messing - marco.blessing@googlemail.com - - Requires : - - .LINK - https://github.com/OCram85/PSCredentialStore #> - [CmdletBinding(DefaultParameterSetName = "Private")] + [CmdletBinding(DefaultParameterSetName = 'Private')] [OutputType([PSCredential])] - param( - [Parameter(Mandatory = $true, ParameterSetName = "Shared")] - [Parameter(Mandatory = $true, ParameterSetName = "Private")] + param ( + [Parameter(Mandatory = $true, ParameterSetName = 'Shared')] + [Parameter(Mandatory = $true, ParameterSetName = 'Private')] [ValidateNotNullOrEmpty()] [string]$RemoteHost, - [Parameter(Mandatory = $false, ParameterSetName = "Shared")] - [Parameter(Mandatory = $false, ParameterSetName = "Private")] + [Parameter(Mandatory = $false, ParameterSetName = 'Shared')] + [Parameter(Mandatory = $false, ParameterSetName = 'Private')] [ValidateNotNullOrEmpty()] [string]$Identifier, - [Parameter(Mandatory = $true, ParameterSetName = "Shared")] + [Parameter(Mandatory = $true, ParameterSetName = 'Shared')] [switch]$Shared, - [Parameter(Mandatory = $false, ParameterSetName = "Shared")] + [Parameter(Mandatory = $false, ParameterSetName = 'Shared')] [ValidateNotNullOrEmpty()] [string]$Path ) @@ -63,10 +55,10 @@ function Get-CredentialStoreItem { begin { # Set the CredentialStore for private, shared or custom mode. Write-Debug ("ParameterSetName: {0}" -f $PSCmdlet.ParameterSetName) - if ($PSCmdlet.ParameterSetName -eq "Private") { + if ($PSCmdlet.ParameterSetName -eq 'Private') { $Path = Get-DefaultCredentialStorePath } - elseif ($PSCmdlet.ParameterSetName -eq "Shared") { + elseif ($PSCmdlet.ParameterSetName -eq 'Shared') { if (!($PSBoundParameters.ContainsKey('Path'))) { $Path = Get-DefaultCredentialStorePath -Shared } @@ -85,7 +77,7 @@ function Get-CredentialStoreItem { $CS = Get-CredentialStore -Shared -Path $Path $CSMembers = Get-Member -InputObject $CS # Let's first check if the given remote host exists as object property - if (($CSMembers.MemberType -eq "NoteProperty") -and ($CSMembers.Name -contains $CredentialName)) { + if (($CSMembers.MemberType -eq 'NoteProperty') -and ($CSMembers.Name -contains $CredentialName)) { if ($null -eq $CS.PfxCertificate) { $Cert = Get-CSCertificate -Type $CS.Type -Thumbprint $CS.Thumbprint } @@ -106,16 +98,16 @@ function Get-CredentialStoreItem { } else { $MsgParams = @{ - ErrorAction = "Stop" - Message = "Could not find credentials for the given remote host: {0}" -f $RemoteHost + ErrorAction = 'Stop' + Message = 'Could not find credentials for the given remote host: {0}' -f $RemoteHost } Write-Error @MsgParams } } else { $MsgParams = @{ - ErrorAction = "Stop" - Message = "The given credential store ({0}) does not exist!" -f $Path + ErrorAction = 'Stop' + Message = 'The given credential store ({0}) does not exist!' -f $Path } Write-Error @MsgParams } diff --git a/src/Item/New-CredentialStoreItem.ps1 b/src/Item/New-CredentialStoreItem.ps1 index a95c2d4..a01d417 100644 --- a/src/Item/New-CredentialStoreItem.ps1 +++ b/src/Item/New-CredentialStoreItem.ps1 @@ -33,25 +33,17 @@ function New-CredentialStoreItem { .EXAMPLE New-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" - - .NOTES - - File Name : New-CredentialStoreItem.ps1 - - Author : Marco Blessing - marco.blessing@googlemail.com - - Requires : - - .LINK - https://github.com/OCram85/PSCredentialStore #> - [CmdletBinding(DefaultParameterSetName = "Private")] - param( - [Parameter(Mandatory = $true, ParameterSetName = "Shared")] - [Parameter(Mandatory = $true, ParameterSetName = "Private")] + [CmdletBinding(DefaultParameterSetName = 'Private')] + param ( + [Parameter(Mandatory = $true, ParameterSetName = 'Shared')] + [Parameter(Mandatory = $true, ParameterSetName = 'Private')] [ValidateNotNullOrEmpty()] [string]$RemoteHost, - [Parameter(Mandatory = $false, ParameterSetName = "Shared")] - [Parameter(Mandatory = $false, ParameterSetName = "Private")] + [Parameter(Mandatory = $false, ParameterSetName = 'Shared')] + [Parameter(Mandatory = $false, ParameterSetName = 'Private')] [ValidateNotNullOrEmpty()] [string]$Identifier, @@ -59,10 +51,10 @@ function New-CredentialStoreItem { [ValidateNotNullOrEmpty()] [PSCredential]$Credential, - [Parameter(Mandatory = $true, ParameterSetName = "Shared")] + [Parameter(Mandatory = $true, ParameterSetName = 'Shared')] [switch]$Shared, - [Parameter(Mandatory = $false, ParameterSetName = "Shared")] + [Parameter(Mandatory = $false, ParameterSetName = 'Shared')] [ValidateNotNullOrEmpty()] [string]$Path @@ -72,10 +64,10 @@ function New-CredentialStoreItem { begin { # Set the CredentialStore for private, shared or custom mode. Write-Debug ("ParameterSetName: {0}" -f $PSCmdlet.ParameterSetName) - if ($PSCmdlet.ParameterSetName -eq "Private") { + if ($PSCmdlet.ParameterSetName -eq 'Private') { $Path = Get-DefaultCredentialStorePath } - elseif ($PSCmdlet.ParameterSetName -eq "Shared") { + elseif ($PSCmdlet.ParameterSetName -eq 'Shared') { if (!($PSBoundParameters.ContainsKey('Path'))) { $Path = Get-DefaultCredentialStorePath -Shared } @@ -96,7 +88,7 @@ function New-CredentialStoreItem { $CSContent = Get-CredentialStore -Shared -Path $Path - $CurrentDate = Get-Date -UFormat "%Y-%m-%d %H:%M:%S" + $CurrentDate = Get-Date -Format 'u' if ($Identifier -ne "") { $CredentialName = $RemoteHost = "{0}/{1}" -f $Identifier, $RemoteHost @@ -119,7 +111,7 @@ function New-CredentialStoreItem { if (Get-Member -InputObject $CSContent -Name $CredentialName -Membertype Properties) { $MessageParams = @{ - Message = "The given host already exists. Nothing to do here." + Message = 'The given host already exists. Nothing to do here.' } Write-Warning @MessageParams } @@ -139,8 +131,8 @@ function New-CredentialStoreItem { } catch { $MessageParams = @{ - Message = "Couldn't add item into credential store!" - ErrorAction = "Stop" + Message = 'Could not add item into credential store!' + ErrorAction = 'Stop' } Write-Error @MessageParams } @@ -148,15 +140,13 @@ function New-CredentialStoreItem { } else { $MessageParams = @{ - Message = "Please Provide at least a valid user!" - ErrorAction = "Stop" + Message = 'Please Provide at least a valid user!' + ErrorAction = 'Stop' } Write-Error @MessageParams } } - end { - - } + end {} } diff --git a/src/Item/Remove-CredentialStoreItem.ps1 b/src/Item/Remove-CredentialStoreItem.ps1 index f3296b7..253d501 100644 --- a/src/Item/Remove-CredentialStoreItem.ps1 +++ b/src/Item/Remove-CredentialStoreItem.ps1 @@ -37,30 +37,22 @@ function Remove-CredentialStoreItem { .EXAMPLE Remove-CredentialStoreItem -RemoteHost "esx01.myside.local" -Identifier svc - - .NOTES - - File Name : Remove-CredentialStoreItem.ps1 - - Author : Marco Blessing - marco.blessing@googlemail.com - - Requires : - - .LINK - https://github.com/OCram85/PSCredentialStore #> - [CmdletBinding(DefaultParameterSetName = "Private")] - param( - [Parameter(Mandatory = $true, ParameterSetName = "Private")] - [Parameter(Mandatory = $true, ParameterSetName = "Shared")] + [CmdletBinding(DefaultParameterSetName = 'Private')] + param ( + [Parameter(Mandatory = $true, ParameterSetName = 'Private')] + [Parameter(Mandatory = $true, ParameterSetName = 'Shared')] [string]$RemoteHost, - [Parameter(Mandatory = $false, ParameterSetName = "Private")] - [Parameter(Mandatory = $false, ParameterSetName = "Shared")] + [Parameter(Mandatory = $false, ParameterSetName = 'Private')] + [Parameter(Mandatory = $false, ParameterSetName = 'Shared')] [string]$Identifier, - [Parameter(Mandatory = $true, ParameterSetName = "Shared")] + [Parameter(Mandatory = $true, ParameterSetName = 'Shared')] [switch]$Shared, - [Parameter(Mandatory = $false, ParameterSetName = "Shared")] + [Parameter(Mandatory = $false, ParameterSetName = 'Shared')] [ValidateNotNullOrEmpty()] [string]$Path ) @@ -68,10 +60,10 @@ function Remove-CredentialStoreItem { begin { # Set the CredentialStore for private, shared or custom mode. Write-Debug ("ParameterSetName: {0}" -f $PSCmdlet.ParameterSetName) - if ($PSCmdlet.ParameterSetName -eq "Private") { + if ($PSCmdlet.ParameterSetName -eq 'Private') { $Path = Get-DefaultCredentialStorePath } - elseif ($PSCmdlet.ParameterSetName -eq "Shared") { + elseif ($PSCmdlet.ParameterSetName -eq 'Shared') { if (!($PSBoundParameters.ContainsKey('Path'))) { $Path = Get-DefaultCredentialStorePath -Shared } @@ -82,8 +74,8 @@ function Remove-CredentialStoreItem { # Lets do a quick test on the given CredentialStore. if (-not(Test-CredentialStore -Shared -Path $Path)) { $MessageParams = @{ - Message = "Could not add anything into the given CredentialStore." - ErrorAction = "Stop" + Message = 'Could not add anything into the given CredentialStore.' + ErrorAction = 'Stop' } Write-Error @MessageParams } @@ -105,7 +97,7 @@ function Remove-CredentialStoreItem { } else { $MessageParams = @{ - Message = "The given CredentialStoreItem does not exist." + Message = 'The given CredentialStoreItem does not exist.' } Write-Warning @MessageParams } diff --git a/src/Item/Set-CredentialStoreItem.ps1 b/src/Item/Set-CredentialStoreItem.ps1 index 3194d58..73c87cf 100644 --- a/src/Item/Set-CredentialStoreItem.ps1 +++ b/src/Item/Set-CredentialStoreItem.ps1 @@ -34,34 +34,26 @@ function Set-CredentialStoreItem { .EXAMPLE Set-CredentialStoreItem -Path "C:\TMP\mystore.json" -RemoteHost "esx01.myside.local" -Identifier svc - - .NOTES - - File Name : Set-CredentialStoreItem.ps1 - - Author : Marco Blessing - marco.blessing@googlemail.com - - Requires : - - .LINK - https://github.com/OCram85/PSCredentialStore #> - [CmdletBinding(DefaultParameterSetName = "Private")] - param( - [Parameter(Mandatory = $true, ParameterSetName = "Private")] - [Parameter(Mandatory = $true, ParameterSetName = "Shared")] + [CmdletBinding(DefaultParameterSetName = 'Private')] + param ( + [Parameter(Mandatory = $true, ParameterSetName = 'Private')] + [Parameter(Mandatory = $true, ParameterSetName = 'Shared')] [string]$RemoteHost, - [Parameter(Mandatory = $false, ParameterSetName = "Private")] - [Parameter(Mandatory = $false, ParameterSetName = "Shared")] + [Parameter(Mandatory = $false, ParameterSetName = 'Private')] + [Parameter(Mandatory = $false, ParameterSetName = 'Shared')] [string]$Identifier, [Parameter(Mandatory = $false, ValueFromPipeline = $true)] [ValidateNotNullOrEmpty()] [PSCredential]$Credential, - [Parameter(Mandatory = $true, ParameterSetName = "Shared")] + [Parameter(Mandatory = $true, ParameterSetName = 'Shared')] [switch]$Shared, - [Parameter(Mandatory = $false, ParameterSetName = "Shared")] + [Parameter(Mandatory = $false, ParameterSetName = 'Shared')] [ValidateNotNullOrEmpty()] [string]$Path ) @@ -69,10 +61,10 @@ function Set-CredentialStoreItem { begin { # Set the CredentialStore for private, shared or custom mode. Write-Debug ("ParameterSetName: {0}" -f $PSCmdlet.ParameterSetName) - if ($PSCmdlet.ParameterSetName -eq "Private") { + if ($PSCmdlet.ParameterSetName -eq 'Private') { $Path = Get-DefaultCredentialStorePath } - elseif ($PSCmdlet.ParameterSetName -eq "Shared") { + elseif ($PSCmdlet.ParameterSetName -eq 'Shared') { if (!($PSBoundParameters.ContainsKey('Path'))) { $Path = Get-DefaultCredentialStorePath -Shared } @@ -83,8 +75,8 @@ function Set-CredentialStoreItem { # Lets do a quick test on the given CredentialStore. if (-not(Test-CredentialStore -Shared -Path $Path)) { $MessageParams = @{ - Message = "Could not add anything into the given CredentailStore." - ErrorAction = "Stop" + Message = 'Could not add anything into the given CredentailStore.' + ErrorAction = 'Stop' } Write-Error @MessageParams } @@ -92,7 +84,7 @@ function Set-CredentialStoreItem { # Read the file content based on the given ParameterSetName $CSContent = Get-CredentialStore -Shared -Path $Path - $CurrentDate = Get-Date -UFormat "%Y-%m-%d %H:%M:%S" + $CurrentDate = Get-Date -Format 'u' if ($Identifier -ne "") { $CredentialName = $RemoteHost = "{0}/{1}" -f $Identifier, $RemoteHost @@ -129,8 +121,8 @@ function Set-CredentialStoreItem { } Else { $MessageParams = @{ - Message = "Please Provide at least a valid user!" - ErrorAction = "Stop" + Message = 'Please Provide at least a valid user!' + ErrorAction = 'Stop' } Write-Error @MessageParams } diff --git a/src/Item/Test-CredentialStoreItem.ps1 b/src/Item/Test-CredentialStoreItem.ps1 index a248f0e..f62b634 100644 --- a/src/Item/Test-CredentialStoreItem.ps1 +++ b/src/Item/Test-CredentialStoreItem.ps1 @@ -35,19 +35,11 @@ function Test-CredentialStoreItem { Else { Write-Warning ("The given Remote Host {0} does not exist in the credential Store!" -f $RemoteHost) } - - .NOTES - - File Name : Test-CredentialStoreItem.ps1 - - Author : Marco Blessing - marco.blessing@googlemail.com - - Requires : - - .LINK - https://github.com/OCram85/PSCredentialStore #> - [CmdletBinding(DefaultParameterSetName = "Private")] - [OutputType([Boolean])] - param( - [Parameter(Mandatory = $false, ParameterSetName = "Shared")] + [CmdletBinding(DefaultParameterSetName = 'Private')] + [OutputType([boolean])] + param ( + [Parameter(Mandatory = $false, ParameterSetName = 'Shared')] [string]$Path = "{0}\PSCredentialStore\CredentialStore.json" -f $env:ProgramData, [Parameter(Mandatory = $true)] @@ -58,17 +50,17 @@ function Test-CredentialStoreItem { [ValidateNotNullOrEmpty()] [string]$Identifier, - [Parameter(Mandatory = $false, ParameterSetName = "Shared")] + [Parameter(Mandatory = $false, ParameterSetName = 'Shared')] [switch]$Shared ) begin { # Set the CredentialStore for private, shared or custom mode. Write-Debug ("ParameterSetName: {0}" -f $PSCmdlet.ParameterSetName) - if ($PSCmdlet.ParameterSetName -eq "Private") { + if ($PSCmdlet.ParameterSetName -eq 'Private') { $Path = Get-DefaultCredentialStorePath } - elseif ($PSCmdlet.ParameterSetName -eq "Shared") { + elseif ($PSCmdlet.ParameterSetName -eq 'Shared') { if (!($PSBoundParameters.ContainsKey('Path'))) { $Path = Get-DefaultCredentialStorePath -Shared } @@ -86,7 +78,7 @@ function Test-CredentialStoreItem { if (Test-CredentialStore -Shared -Path $Path) { $CS = Get-CredentialStore -Shared -Path $Path $CSMembers = Get-Member -InputObject $CS - if (($CSMembers.MemberType -eq "NoteProperty") -and ($CSMembers.Name -contains $CredentialName)) { + if (($CSMembers.MemberType -eq 'NoteProperty') -and ($CSMembers.Name -contains $CredentialName)) { return $true } else { @@ -95,15 +87,13 @@ function Test-CredentialStoreItem { } else { $MsgParams = @{ - ErrorAction = "Stop" + ErrorAction = 'Stop' Message = "The given credential store ({0}) does not exist!" -f $Path } Write-Error @MsgParams } } - end { - - } + end {} }