From b302cd0b0c9dc2ad49f24c432059049e187c57f0 Mon Sep 17 00:00:00 2001 From: OCram85 Date: Mon, 13 Jun 2022 09:55:31 +0200 Subject: [PATCH] update pwsh style in store files --- src/Store/Get-CredentialStore.ps1 | 35 +++++++---------- src/Store/New-CredentialStore.ps1 | 61 ++++++++++++------------------ src/Store/Test-CredentialStore.ps1 | 35 +++++++---------- 3 files changed, 52 insertions(+), 79 deletions(-) diff --git a/src/Store/Get-CredentialStore.ps1 b/src/Store/Get-CredentialStore.ps1 index a30de5f..e451656 100644 --- a/src/Store/Get-CredentialStore.ps1 +++ b/src/Store/Get-CredentialStore.ps1 @@ -23,35 +23,28 @@ function Get-CredentialStore { .EXAMPLE $CSContent = Get-CredentialStore -Path "C:\TMP\mystore.json" - - .NOTES - - File Name : Get-CredentialStore.ps1 - - Author : Marco Blessing - marco.blessing@googlemail.com - - Requires : - .LINK - https://github.com/OCram85/PSCredentialStore #> - [CmdletBinding(DefaultParameterSetName = "Private")] + [CmdletBinding(DefaultParameterSetName = 'Private')] [OutputType("PSCredentialStore.Store")] - param( - [Parameter(Mandatory = $false, ParameterSetName = "Shared")] + param ( + [Parameter(Mandatory = $false, ParameterSetName = 'Shared')] [string]$Path, - [Parameter(Mandatory = $true, ParameterSetName = "Shared")] + [Parameter(Mandatory = $true, ParameterSetName = 'Shared')] [switch]$Shared ) - begin { } + begin {} process { # 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 } @@ -61,26 +54,26 @@ function Get-CredentialStore { try { $FileContent = Get-Content -Path $Path -Raw $CS = ConvertFrom-Json $FileContent - $CS.PSObject.TypeNames.Insert(0, "PSCredentialStore.Store") - return $CS + $CS.PSObject.TypeNames.Insert(0, 'PSCredentialStore.Store') + Write-Output $CS } catch [System.Exception] { $MessageParams = @{ - Message = "Unknown CredentialStore format. Invalid JSON file." - ErrorAction = "Stop" + Message = 'Unknown CredentialStore format. Invalid JSON file.' + ErrorAction = 'Stop' } Write-Error @MessageParams } } else { $MessageParams = @{ - Message = "Could not find the CredentialStore." - ErrorAction = "Stop" + Message = 'Could not find the CredentialStore.' + ErrorAction = 'Stop' } Write-Error @MessageParams } } - end { } + end {} } diff --git a/src/Store/New-CredentialStore.ps1 b/src/Store/New-CredentialStore.ps1 index cfa1ce2..effdeed 100644 --- a/src/Store/New-CredentialStore.ps1 +++ b/src/Store/New-CredentialStore.ps1 @@ -49,49 +49,38 @@ function New-CredentialStore { .EXAMPLE New-CredentialStore -Shared -Path "C:\TMP\CredentialStore.json" # Creates a new shared CredentialStore in the given location. - - .NOTES - - File Name : New-CredentialStore.ps1 - - Author : Marco Blessing - marco.blessing@googlemail.com - - Requires : - - .LINK - https://github.com/OCram85/PSCredentialStore #> - [CmdletBinding(SupportsShouldProcess = $true, DefaultParameterSetName = "Private")] - [OutputType("PSCredentialStore.Store")] - param( - [Parameter(Mandatory = $true, ParameterSetName = "Shared")] + [CmdletBinding(SupportsShouldProcess = $true, DefaultParameterSetName = 'Private')] + [OutputType('PSCredentialStore.Store')] + param ( + [Parameter(Mandatory = $true, ParameterSetName = 'Shared')] [switch]$Shared, - [Parameter(Mandatory = $false, ParameterSetName = "Shared")] + [Parameter(Mandatory = $false, ParameterSetName = 'Shared')] [ValidateNotNullOrEmpty()] [System.IO.FileInfo]$Path, - [Parameter(Mandatory = $false, ParameterSetName = "Private")] - [Parameter(Mandatory = $false, ParameterSetName = "Shared")] - [Switch]$Force, + [Parameter(Mandatory = $false, ParameterSetName = 'Private')] + [Parameter(Mandatory = $false, ParameterSetName = 'Shared')] + [switch]$Force, - [Parameter(Mandatory = $false, ParameterSetName = "Private")] - [Parameter(Mandatory = $false, ParameterSetName = "Shared")] - [Switch]$PassThru, + [Parameter(Mandatory = $false, ParameterSetName = 'Private')] + [Parameter(Mandatory = $false, ParameterSetName = 'Shared')] + [switch]$PassThru, - [Parameter(Mandatory = $false, ParameterSetName = "Private")] - [Parameter(Mandatory = $false, ParameterSetName = "Shared")] - [Switch]$SkipPFXCertCreation, + [Parameter(Mandatory = $false, ParameterSetName = 'Private')] + [Parameter(Mandatory = $false, ParameterSetName = 'Shared')] + [switch]$SkipPFXCertCreation, - [Parameter(Mandatory = $false, ParameterSetName = "Private")] - [Parameter(Mandatory = $false, ParameterSetName = "Shared")] - [Switch]$UseCertStore + [Parameter(Mandatory = $false, ParameterSetName = 'Private')] + [Parameter(Mandatory = $false, ParameterSetName = 'Shared')] + [switch]$UseCertStore ) begin { # Lets get the current Date in a human readable format. - $CurrentDate = Get-Date -UFormat "%Y-%m-%d %H:%M:%S" - - # Set latest Credential Store version - # Set-Variable -Name "CSVersion" -Value "2.0.0" -Option Constant -Scope + $CurrentDate = Get-Date -Format 'u' # test if the path input is a valid file path if ($PSCmdlet.MyInvocation.BoundParameters.ContainsKey('Path')) { @@ -108,7 +97,7 @@ function New-CredentialStore { $ErrorParams = @{ ErrorAction = 'Stop' Exception = [System.IO.InvalidDataException]::new( - 'Your provided path does not contain the required file extension .json !' + 'Your provided path does not contain the required file extension .json!' ) } Write-Error @ErrorParams @@ -119,17 +108,17 @@ function New-CredentialStore { process { # 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 } } # Test if in the CredentialStore already exists. - Write-Verbose "Test if there is already a credential store." + Write-Verbose 'Test if there is already a credential store.' if ((Test-Path -Path $Path) -and ($Force -ne $true)) { $ErrorParams = @{ ErrorAction = 'Stop' @@ -211,11 +200,11 @@ function New-CredentialStore { Type = $null } - if ($PSCmdlet.ParameterSetName -eq "Shared") { - $ObjProperties.Type = "Shared" + if ($PSCmdlet.ParameterSetName -eq 'Shared') { + $ObjProperties.Type = 'Shared' } else { - $ObjProperties.Type = "Private" + $ObjProperties.Type = 'Private' } if (! $SkipPFXCertCreation.IsPresent) { diff --git a/src/Store/Test-CredentialStore.ps1 b/src/Store/Test-CredentialStore.ps1 index afbc429..fc307d5 100644 --- a/src/Store/Test-CredentialStore.ps1 +++ b/src/Store/Test-CredentialStore.ps1 @@ -17,35 +17,26 @@ function Test-CredentialStore { .EXAMPLE Test-CredentialStore -eq $true - .NOTES - - File Name : Test-CredentialStore.ps1 - - Author : Marco Blessing - marco.blessing@googlemail.com - - Requires : - - .LINK - https://github.com/OCram85/PSCredentialStore #> - [CmdletBinding(DefaultParameterSetName = "Private")] - param( - [Parameter(Mandatory = $false, ParameterSetName = "Shared")] + [CmdletBinding(DefaultParameterSetName = 'Private')] + [OutputBinding([string])] + param ( + [Parameter(Mandatory = $false, ParameterSetName = 'Shared')] [string]$Path, - [Parameter(Mandatory = $true, ParameterSetName = "Shared")] + [Parameter(Mandatory = $true, ParameterSetName = 'Shared')] [switch]$Shared ) - begin { - # Set latest Credential Store version - #Set-Variable -Name "CSVersion" -Value "2.0.0" -Option Constant - } + begin {} process { # 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 } @@ -53,15 +44,15 @@ function Test-CredentialStore { Write-Verbose -Message ("Path is: {0}" -f $Path) if (Test-Path $Path) { - Write-Verbose "CredentialStore in given path found." - return $true + Write-Verbose 'CredentialStore in given path found.' + Write-Output $true } else { - Write-Verbose "The given CredentialStore does not exist!" - return $false + Write-Verbose 'The given CredentialStore does not exist!' + Write-Output $false } } - end { } + end {} }