Merge pull request #124 from PowershellFrameworkCollective/scripting

2.2.8.103

Author: FriedrichWeinmann

PSModuleDevelopment/PSModuleDevelopment.psd1

@@ -4,7 +4,7 @@
 	RootModule = 'PSModuleDevelopment.psm1'
 
 	# Version number of this module.
-	ModuleVersion = '2.2.7.98'
+	ModuleVersion = '2.2.8.103'
 
 	# ID used to uniquely identify this module
 	GUID = '37dd5fce-e7b5-4d57-ac37-832055ce49d6'
@@ -24,25 +24,10 @@
 	# Minimum version of the Windows PowerShell engine required by this module
 	PowerShellVersion = '3.0'
 
-	# Name of the Windows PowerShell host required by this module
-	PowerShellHostName = ''
-
-	# Minimum version of the Windows PowerShell host required by this module
-	PowerShellHostVersion = ''
-
-	# Minimum version of the .NET Framework required by this module
-	DotNetFrameworkVersion = '2.0'
-
-	# Minimum version of the common language runtime (CLR) required by this module
-	CLRVersion = '2.0.50727'
-
-	# Processor architecture (None, X86, Amd64, IA64) required by this module
-	ProcessorArchitecture = 'None'
-
 	# Modules that must be imported into the global environment prior to importing
 	# this module
 	RequiredModules	       = @(
-		@{ ModuleName = 'PSFramework'; ModuleVersion = '1.0.35' }
+		@{ ModuleName = 'PSFramework'; ModuleVersion = '1.1.59' }
 	)
 
 	# Assemblies that must be loaded prior to importing this module
@@ -72,6 +57,7 @@
 		'Get-PSMDArgumentCompleter',
 		'Get-PSMDAssembly',
 		'Get-PSMDConstructor',
+		'Get-PSMDFileCommand',
 		'Get-PSMDHelp',
 		'Get-PSMDMember',
 		'Get-PSMDModuleDebug',
@@ -86,6 +72,8 @@
 		'New-PSMDModuleNugetPackage',
 		'New-PSMDTemplate',
 		'New-PssModuleProject',
+		'Publish-PSMDScriptFile',
+		'Publish-PSMDStagedModule',
 		'Read-PSMDScript',
 		'Remove-PSMDModuleDebug',
 		'Remove-PSMDTemplate',
@@ -97,15 +85,16 @@
 		'Set-PSMDCmdletBinding',
 		'Set-PSMDModulePath',
 		'Set-PSMDParameterHelp',
+		'Set-PSMDStagingRepository',
 		'Show-PSMDSyntax',
 		'Split-PSMDScriptFile'
     )
 
 	# Cmdlets to export from this module
-	CmdletsToExport = ''
+	# CmdletsToExport = ''
 
 	# Variables to export from this module
-	VariablesToExport = ''
+	# VariablesToExport = ''
 
 	# Aliases to export from this module
     AliasesToExport = @(
@@ -145,7 +134,7 @@
 			# IconUri = ''
 
 			# ReleaseNotes of this module
-			# ReleaseNotes = ''
+			ReleaseNotes = 'https://github.com/PowershellFrameworkCollective/PSModuleDevelopment/blob/master/PSModuleDevelopment/changelog.md'
 
 		} # End of PSData hashtable
 

PSModuleDevelopment/changelog.md

@@ -1,4 +1,13 @@
 # Changelog
+
+## 2.2.8.103 (July 24th, 2020)
+
+- New: Publish-PSMDScriptFile - Packages a script with all dependencies and "publishes" it as a zip package.
+- New: Get-PSMDFileCommand - Parses a scriptfile and returns the contained/used commands.
+- New: Set-PSMDStagingRepository - Define the repository to use for deploying modules along with scripts.
+- New: Publish-PSMDStagedModule - Publish a module to your staging repository.
+- Fix: Export-PSMDString - Random failure to execute (thanks @AndiBellstedt !)
+
 ## 2.2.7.98 (May 30th, 2020)
 
 - Upd: Template PSFTest - Pester v5 compatibility

PSModuleDevelopment/en-us/strings.psd1

@@ -1,4 +1,19 @@
 @{
-	'MeasurePSMDLinesOfCode.Processing' = 'Processing Path: {0}'
-	'Remove-PSMDTemplate.Removing.Template' = 'Removing template {0} (v{1}) from store {2}'
+	'Get-PSMDFileCommand.SyntaxError'				   = 'Syntax error in file: {0}' # $pathItem
+	
+	'MeasurePSMDLinesOfCode.Processing'			       = 'Processing Path: {0}' # $fileItem
+	
+	'Publish-PSMDScriptFile.Module.Saving'			   = 'Saving module {0} from repository {1}' # $moduleName, (Get-PSFConfigValue -FullName 'PSModuleDevelopment.Script.StagingRepository')
+	'Publish-PSMDScriptFile.Script.Command'		       = 'Processing command {0} (used {1} times) from module {2}' # $command.Name, $command.Count, $command.Module
+	'Publish-PSMDScriptFile.Script.Command.NotKnown'   = 'The command {0} (used {1} times) cannot be resolved. Manually figure out where it came from if needed.' # $command.Name, $command.Count
+	'Publish-PSMDScriptFile.Script.ParseError'		   = 'Syntax error in file: {0}' # $Path
+	
+	'Publish-PSMDStagedModule.Module.AlreadyPublished' = 'The module {0} at version {1} has already been published to this repository' # $moduleToPublish.Name, $moduleToPublish.Version
+	'Publish-PSMDStagedModule.Module.NotFound'		   = 'The module {0} could not be found' # $Name
+	'Publish-PSMDStagedModule.Module.PublishError'	   = 'Error publishing {0} from {1}' # $Name, $folder.Name
+	
+	'Remove-PSMDTemplate.Removing.Template'		       = 'Removing template {0} (v{1}) from store {2}' # $item.Name, $item.Version, $item.Store
+	
+	'Validate.File'								       = 'Path does not exist or is not a file: {0}' # <user input>, <validation item>
+	'Validate.Path'								       = 'Path does not exist: {0}' # <user input>, <validation item>
 }

PSModuleDevelopment/functions/refactor/Get-PSMDFileCommand.ps1

@@ -0,0 +1,84 @@
+function Get-PSMDFileCommand
+{
+<#
+	.SYNOPSIS
+		Parses a scriptfile and returns the contained/used commands.
+	
+	.DESCRIPTION
+		Parses a scriptfile and returns the contained/used commands.
+		Use this to determine, what command resources are being used.
+	
+	.PARAMETER Path
+		The path to the scriptfile to parse.
+	
+	.PARAMETER EnableException
+        Replaces user friendly yellow warnings with bloody red exceptions of doom!
+        Use this if you want the function to throw terminating errors you want to catch.
+	
+	.EXAMPLE
+		PS C:\> Get-PSMDFileCommand -Path './task_usersync.ps1'
+	
+		Parses the scriptfile task_usersync.ps1 for commands used.
+#>
+	[CmdletBinding()]
+	param (
+		[Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)]
+		[PsfValidateScript('PSModuleDevelopment.Validate.Path', ErrorString = 'PSModuleDevelopment.Validate.Path')]
+		[string[]]
+		$Path,
+		
+		[switch]
+		$EnableException
+	)
+	
+	process
+	{
+		foreach ($pathItem in $Path)
+		{
+			# Skip Folders
+			if (-not (Test-Path -Path $pathItem -PathType Leaf)) { continue }
+			
+			$parsedCode = Read-PSMDScript -Path $pathItem
+			if ($parsedCode.Errors)
+			{
+				Stop-PSFFunction -String 'Get-PSMDFileCommand.SyntaxError' -StringValues $pathItem -EnableException $EnableException -Continue
+			}
+			
+			$results = @{ }
+			$commands = $parsedCode.Ast.FindAll({ $args[0] -is [System.Management.Automation.Language.CommandAst] }, $true)
+			$internalCommands = $parsedCode.Ast.FindAll({ $args[0] -is [System.Management.Automation.Language.FunctionDefinitionAst] }, $true).Name
+			
+			foreach ($command in $commands)
+			{
+				if (-not $results[$command.CommandElements[0].Value])
+				{
+					$commandInfo = Get-Command $command.CommandElements[0].Value -ErrorAction Ignore
+					$module = $commandInfo.Module
+					if (-not $module) { $module = $commandInfo.PSSnapin }
+					$results[$command.CommandElements[0].Value] = [pscustomobject]@{
+						PSTypeName = 'PSModuleDevelopment.File.Command'
+						File	   = Get-Item $pathItem
+						Name	   = $command.CommandElements[0].Value
+						Parameters = @{ }
+						Count	   = 0
+						AstObjects = @()
+						CommandInfo = $commandInfo
+						Module	   = $module
+						Internal   = $command.CommandElements[0].Value -in $internalCommands
+						Path	   = $pathItem
+					}
+				}
+				$object = $results[$command.CommandElements[0].Value]
+				$object.Count = $object.Count + 1
+				$object.AstObjects += $command
+				foreach ($parameter in $command.CommandElements.Where{ $_ -is [System.Management.Automation.Language.CommandParameterAst] })
+				{
+					if (-not $object.Parameters[$parameter.ParameterName]) { $object.Parameters[$parameter.ParameterName] = 1 }
+					else { $object.Parameters[$parameter.ParameterName] = $object.Parameters[$parameter.ParameterName] + 1 }
+				}
+			}
+			
+			$results.Values
+		}
+	}
+}