Merge pull request #119 from PowershellFrameworkCollective/development

2.2.7.98

Author: FriedrichWeinmann

.github/FUNDING.yml

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+ FriedrichWeinmann
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

PSModuleDevelopment/PSModuleDevelopment.psd1

@@ -4,7 +4,7 @@
 	RootModule = 'PSModuleDevelopment.psm1'
 
 	# Version number of this module.
-	ModuleVersion = '2.2.7.90'
+	ModuleVersion = '2.2.7.98'
 
 	# ID used to uniquely identify this module
 	GUID = '37dd5fce-e7b5-4d57-ac37-832055ce49d6'

PSModuleDevelopment/changelog.md

@@ -1,4 +1,15 @@
 # Changelog
+## 2.2.7.98 (May 30th, 2020)
+
+- Upd: Template PSFTest - Pester v5 compatibility
+- Upd: Template PSFModule - Pester v5 compatibility
+- Upd: Template PSFProject - Pester v5 compatibility
+- Upd: Template PSFProject - Simplified module import workflow
+- Upd: Template PSFProject - Improved build process cross-agent convenience
+- Upd: Template PSFProject - Prerequisites task automatically detects module dependencies
+- Upd: Template PSFProject - Prerequisites task can be configured to work with any registered repository
+- Upd: Export-PSMDString - Now also detects splatted localization strings (thanks @StevePlp ; #117)
+
 ## 2.2.7.90 (September 1st, 2019)
  - New: Export-PSMDString - Parses strings from modules using the PSFramework localization feature.
  - Upd: Measure-PSMDCommand - Renamed from Measure-PSMDCommandEx, performance upgrades, adding option for comparing multiple test sets.

PSModuleDevelopment/functions/moduledebug/Get-PSMDModuleDebug.ps1

@@ -16,6 +16,7 @@
 	
 			Returns the module debugging configuration for all modules with a name that contains "net"
 	#>
+	[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', '')]
 	[CmdletBinding()]
 	Param (
 		[string]

PSModuleDevelopment/functions/moduledebug/Import-PSMDModuleDebug.ps1

@@ -25,7 +25,7 @@
 	{
 		# Get original module configuration
 		$____module = $null
-		$____module = Import-Clixml -Path (Get-PSFConfigValue -FullName 'PSModuleDevelopment.Debug.ConfigPath') | Where-Object { $_.Name -eq $Name }
+		$____module = Import-Clixml -Path (Get-PSFConfigValue -FullName 'PSModuleDevelopment.Debug.ConfigPath') | Where-Object Name -eq $Name
 		if (-not $____module) { throw "No matching module configuration found" }
 
 		# Process entry

PSModuleDevelopment/functions/refactor/Export-PSMDString.ps1

@@ -72,7 +72,67 @@
 					StringValues = $stringValueParamValue
 				}
 			}
-			
+            
+             # Additional checks for splatted commands
+            # find all splatted commands
+            $splattedVariables = $ast.FindAll( {
+                if ($args[0] -isnot [System.Management.Automation.Language.VariableExpressionAst ]) { return $false }
+                if (-not ($args[0].Splatted -eq $true)) { return $false }
+                $true
+            }, $true)
+
+            foreach ($splattedVariable in $splattedVariables)
+            {
+                #get the variable name
+                $splatParamName = $splattedVariable.VariablePath.UserPath
+                if ($splatParamName)
+                {
+                    # match the $param = @{
+                    $splatParamNameRegex = "^\s?\`$$($splatParamName)\s?=\s?\@\{"
+                    # get all variable assignments where the
+                    # left side matches our param
+                    # operator is =
+                    # matches our assignment regex
+                    $splatAssignmentAsts = $ast.FindAll( {
+                            if ($args[0] -isnot [System.Management.Automation.Language.AssignmentStatementAst ]) { return $false }
+                            if (-not ($args[0].Left -match $splatParamName)) { return $false }
+                            if (-not ($args[0].Operator -eq 'Equals')) { return $false }
+                            if (-not ($args[0].Extent -match $splatParamNameRegex)) { return $false }
+                            $true
+                        }, $true)
+                    foreach ($splatAssignmentAst in $splatAssignmentAsts)
+                    {
+                        # get the hashtable
+                        $splatHashTable = $splatAssignmentAst.Right.Expression
+                        # see if its an empty assignment or null
+                        if ($splatHashTable -and $splatHashTable.KeyValuePairs.Count -gt 0)
+                        {
+                            # find any String or ActionString
+                            $splatParam = $splatAssignmentAst.Right.Expression.KeyValuePairs |  Where-Object Item1 -match '^String$|^ActionString$'
+                            # The kvp.item.extent.text returns nested quotes where as the commandast.extent.text doesn't so strip them off
+                            $splatParamValue = $splatParam.Item2.Extent.Text.Trim('"').Trim("'")
+                            # find any StringValue or ActionStringValue
+                            $splatValueParam = $splatAssignmentAst.Right.Expression.KeyValuePairs |  Where-Object Item1 -match '^StringValues$|^ActionStringValues$'
+                            if ($splatValueParam)
+                            {
+                                # The kvp.item.extent.text returns nested quotes whereas the commandast.extent.text doesn't so strip them off
+                                $splatValueParamValue = $splatValueParam.Item2.Extent.Text.Trim('"').Trim("'")
+                            }
+                            else { $splatValueParamValue = '' }
+
+                            [PSCustomObject]@{
+                                PSTypeName   = 'PSModuleDevelopment.String.ParsedItem'
+                                File         = $file.FullName
+                                Line         = $splatHashTable.Extent.StartLineNumber
+                                CommandName  = $splattedVariable.Parent.CommandElements[0].Value
+                                String       = $splatParamValue
+                                StringValues = $splatValueParamValue
+                            }
+                        }
+                    }
+                }
+            }
+
 			$validateAsts = $ast.FindAll({
 					if ($args[0] -isnot [System.Management.Automation.Language.AttributeAst]) { return $false }
 					if ($args[0].TypeName -notmatch '^PsfValidateScript$|^PsfValidatePattern$') { return $false }

PSModuleDevelopment/functions/refactor/Format-PSMDParameter.ps1

@@ -30,6 +30,7 @@
 	
 			Updates all commands in the module to have a cmdletbinding attribute.
 	#>
+	[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', '')]
 	[CmdletBinding(SupportsShouldProcess = $true)]
 	param (
 		[Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)]
@@ -45,6 +46,7 @@
 		#region Utility functions
 		function Invoke-AstWalk
 		{
+			[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', '')]
 			[CmdletBinding()]
 			param (
 				$Ast,

PSModuleDevelopment/functions/refactor/Set-PSMDCmdletBinding.ps1

@@ -46,6 +46,7 @@
 		#region Utility functions
 		function Invoke-AstWalk
 		{
+			[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', '')]
 			[CmdletBinding()]
 			Param (
 				$Ast,

PSModuleDevelopment/functions/refactor/Split-PSMDScriptFile.ps1

@@ -47,7 +47,7 @@
 
 			foreach ($functionAst in ($ast.EndBlock.Statements | Where-Object { $_.GetType().FullName -eq "System.Management.Automation.Language.FunctionDefinitionAst" }))
 			{
-				$ast.Extent.Text.Substring($functionAst.Extent.StartOffset, ($functionAst.Extent.EndOffset - $functionAst.Extent.StartOffset)) | Set-Content "$Path\$($functionAst.Name).ps1" -Encoding UTF8
+				$ast.Extent.Text.Substring($functionAst.Extent.StartOffset, ($functionAst.Extent.EndOffset - $functionAst.Extent.StartOffset)) | Set-Content "$Path\$($functionAst.Name).ps1" -Encoding $Encoding
 			}
 		}
 	}

PSModuleDevelopment/functions/templating/Invoke-PSMDTemplate.ps1

@@ -78,6 +78,7 @@
 		Creates a project based on the module template with the name "MyModule"
 #>
 	[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSPossibleIncorrectUsageOfAssignmentOperator", "")]
+	[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', '')]
 	[CmdletBinding(SupportsShouldProcess = $true)]
 	param (
 		[Parameter(Mandatory = $true, Position = 0, ParameterSetName = 'NameStore')]