Bugfixes and added templates

Friedrich Weinmann · Friedrich Weinmann · commit 77db3da2354d · 2018-03-07T13:56:26.000+01:00
diff --git a/PSModuleDevelopment/PSModuleDevelopment.psm1 b/PSModuleDevelopment/PSModuleDevelopment.psm1
@@ -2,7 +2,7 @@
 $script:PSModuleVersion = "2.2.0.11"
 
 $script:doDotSource = $false
-if (Get-PSFConfigValue -Name PSModuleDevelopment.Import.DoDotSource) { $script:doDotSource = $true }
+if (Get-PSFConfigValue -FullName PSModuleDevelopment.Import.DoDotSource) { $script:doDotSource = $true }
 
 #region Helper function
 function Import-PSMDFile
diff --git a/PSModuleDevelopment/functions/templating/New-PSMDTemplate.ps1 b/PSModuleDevelopment/functions/templating/New-PSMDTemplate.ps1
@@ -229,6 +229,18 @@
 		}
 		#endregion Insert basic meta-data
 		
+		#region Validation
+		#region Validate FilePath
+		if ($FilePath)
+		{
+			if (-not (Test-Path $FilePath -PathType Leaf))
+			{
+				Stop-PSFFunction -Message "Filepath $FilePath is invalid. Ensure it exists and is a file" -EnableException $EnableException -Category InvalidArgument -Tag 'fail', 'argument', 'path'
+				return
+			}
+		}
+		#endregion Validate FilePath
+		
 		#region Validate & ensure output folder
 		$fileName = "$($template.Name)-$($template.Version).xml"
 		$infoFileName = "$($template.Name)-$($template.Version)-Info.xml"
@@ -265,6 +277,7 @@
 			return
 		}
 		#endregion Validate & ensure output folder
+		#endregion Validation
 		
 		#region Utility functions
 		function Convert-Item
@@ -428,7 +441,7 @@
 						#region Fixed string replacement
 						if ($find.Groups[1].Success)
 						{
-							if ($object.FileSystemParameterFlat -notcontains $find.Groups[1].Value)
+							if ($object.ContentParameterFlat -notcontains $find.Groups[1].Value)
 							{
 								$null = $object.ContentParameterFlat.Add($find.Groups[1].Value)
 							}
@@ -522,6 +535,7 @@
 			foreach ($item in (Get-ChildItem -Path $processedReferencePath -Filter $Filter))
 			{
 				if ($item.FullName -in $Exclusions) { continue }
+				if ($item.Name -eq "PSMDTemplate.ps1") { continue }
 				Convert-Item -Item $item -Filter $Filter -Exclusions $Exclusions -Template $template -ReferencePath $processedReferencePath -Identifier $identifier -BinaryExtensions $binaryExtensions
 			}
 		}
diff --git a/PSModuleDevelopment/internal/templates/PSMDTemplateReference-1.0.0.0-Info.xml b/PSModuleDevelopment/internal/templates/PSMDTemplateReference-1.0.0.0-Info.xml
diff --git a/PSModuleDevelopment/internal/templates/PSMDTemplateReference-1.0.0.0.xml b/PSModuleDevelopment/internal/templates/PSMDTemplateReference-1.0.0.0.xml
diff --git a/PSModuleDevelopment/internal/templates/function-1.0.0.0-Info.xml b/PSModuleDevelopment/internal/templates/function-1.0.0.0-Info.xml
diff --git a/PSModuleDevelopment/internal/templates/function-1.0.0.0.xml b/PSModuleDevelopment/internal/templates/function-1.0.0.0.xml
diff --git a/PSModuleDevelopment/internal/templates/module-1.0.0.0-Info.xml b/PSModuleDevelopment/internal/templates/module-1.0.0.0-Info.xml
diff --git a/PSModuleDevelopment/internal/templates/module-1.0.0.0.xml b/PSModuleDevelopment/internal/templates/module-1.0.0.0.xml
diff --git a/templates/PSMDTemplateReference/PSMDInvoke.ps1 b/templates/PSMDTemplateReference/PSMDInvoke.ps1
@@ -0,0 +1 @@
+New-PSMDTemplate -FilePath "$PSScriptRoot\PSMDTemplate.ps1" -TemplateName PSMDTemplateReference -OutStore psmoduledevelopment -Description "PSModule Development Template Reference file" -Author "Friedrich Weinmann" -Tags 'template','file','configuration'
diff --git a/templates/PSMDTemplateReference/PSMDTemplate.ps1 b/templates/PSMDTemplateReference/PSMDTemplate.ps1
@@ -0,0 +1,14 @@
+@{
+	TemplateName = 'þnameþ' # Insert name of template
+	Version = "1.0.0.0" # Version to build to
+	AutoIncrementVersion = $true # If a newer version than specified is present, instead of the specified version, make it one greater than the existing template
+	Tags = @() # Insert Tags as desired
+	Author = 'þauthorþ' # The author of the template, not the file / project created from it
+	Description = 'þdescriptionþ' # Try describing the template
+	Exclusions = @() # Contains list of files - relative path to root - to ignore when building the template
+	Scripts = @{
+		guid = {
+			[System.Guid]::NewGuid().ToString()
+		}
+	} # Insert additional scriptblocks as needed. Each scriptblock will be executed once only on create, no matter how often it is referenced.
+}
diff --git a/templates/function/PSMDInvoke.ps1 b/templates/function/PSMDInvoke.ps1
@@ -0,0 +1 @@
+New-PSMDTemplate -FilePath "$PSScriptRoot\þnameþ.ps1" -TemplateName function -OutStore psmoduledevelopment -Description "Basic function template" -Author "Friedrich Weinmann" -Tags 'function','file'
diff --git a/templates/function/þnameþ.ps1 b/templates/function/þnameþ.ps1
@@ -0,0 +1,20 @@
+﻿function þnameþ
+{
+	[CmdletBinding()]
+	Param (
+	
+	)
+	
+	begin
+	{
+		
+	}
+	process
+	{
+	
+	}
+	end
+	{
+	
+	}
+}
diff --git a/templates/module/PSMDInvoke.ps1 b/templates/module/PSMDInvoke.ps1
@@ -0,0 +1 @@
+New-PSMDTemplate -ReferencePath "$PSScriptRoot" -OutStore psmoduledevelopment
diff --git a/templates/module/PSMDTemplate.ps1 b/templates/module/PSMDTemplate.ps1
@@ -0,0 +1,14 @@
+@{
+	TemplateName = 'module'
+	Version = "1.0.0.0"
+	AutoIncrementVersion = $true
+	Tags = 'module'
+	Author = 'Friedrich Weinmann'
+	Description = 'Basic module scaffold'
+	Exclusions = @("PSMDInvoke.ps1") # Contains list of files - relative path to root - to ignore when building the template
+	Scripts = @{
+		guid = {
+			[System.Guid]::NewGuid().ToString()
+		}
+	}
+}
diff --git a/templates/module/en-us/about_þnameþ.help.txt b/templates/module/en-us/about_þnameþ.help.txt
@@ -0,0 +1,12 @@
+﻿TOPIC
+	about_þnameþ
+	
+SHORT DESCRIPTION
+	A short synopsis of þnameþ
+
+LONG DESCRIPTION
+	A more detailed description of þnameþ,
+	Should tell the user how to get started with this module.
+	
+KEYWORDS
+	module development debugging
diff --git a/templates/module/internal/scripts/postimport.ps1 b/templates/module/internal/scripts/postimport.ps1
@@ -0,0 +1 @@
+# Place all code that should be run after functions are imported here
diff --git a/templates/module/internal/scripts/preimport.ps1 b/templates/module/internal/scripts/preimport.ps1
@@ -0,0 +1 @@
+# Place all code that should be run before functions are imported here
diff --git a/templates/module/þnameþ.psd1 b/templates/module/þnameþ.psd1
@@ -0,0 +1,112 @@
+﻿@{
+	
+	# Script module or binary module file associated with this manifest
+	ModuleToProcess = 'þnameþ.psm1'
+	
+	# Version number of this module.
+	ModuleVersion = '1.0.0.0'
+	
+	# ID used to uniquely identify this module
+	GUID = 'þ!guid!þ'
+	
+	# Author of this module
+	Author = 'þauthorþ'
+	
+	# Company or vendor of this module
+	CompanyName = 'þcompanyþ'
+	
+	# Copyright statement for this module
+	Copyright = '(c) þauthorþ. All rights reserved.'
+	
+	# Description of the functionality provided by this module
+	Description = 'þdescriptionþ'
+	
+	# Minimum version of the Windows PowerShell engine required by this module
+	PowerShellVersion = '5.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 = @()
+	
+	# Assemblies that must be loaded prior to importing this module
+	# RequiredAssemblies = @()
+	
+	# Script files (.ps1) that are run in the caller's environment prior to
+	# importing this module
+	# ScriptsToProcess = @()
+	
+	# Type files (.ps1xml) to be loaded when importing this module
+	# TypesToProcess = @()
+	
+	# Format files (.ps1xml) to be loaded when importing this module
+	# FormatsToProcess = @()
+	
+	# Modules to import as nested modules of the module specified in
+	# ModuleToProcess
+	# NestedModules = @()
+	
+	# Functions to export from this module
+	FunctionsToExport = ''
+	
+	# Cmdlets to export from this module
+	CmdletsToExport = ''
+	
+	# Variables to export from this module
+	VariablesToExport = ''
+	
+	# Aliases to export from this module
+	AliasesToExport = ''
+	
+	# List of all modules packaged with this module
+	ModuleList = @()
+	
+	# List of all files packaged with this module
+	FileList = @()
+	
+	# Private data to pass to the module specified in ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
+	PrivateData = @{
+		
+		#Support for PowerShellGet galleries.
+		PSData = @{
+			
+			# Tags applied to this module. These help with module discovery in online galleries.
+			# Tags = @()
+			
+			# A URL to the license for this module.
+			# LicenseUri = ''
+			
+			# A URL to the main website for this project.
+			# ProjectUri = ''
+			
+			# A URL to an icon representing this module.
+			# IconUri = ''
+			
+			# ReleaseNotes of this module
+			# ReleaseNotes = ''
+			
+		} # End of PSData hashtable
+		
+	} # End of PrivateData hashtable
+}
+
+
+
+
+
+
+
diff --git a/templates/module/þnameþ.psm1 b/templates/module/þnameþ.psm1
@@ -0,0 +1,51 @@
+﻿$script:PSModuleRoot = $PSScriptRoot
+
+#region Helper function
+function Import-ModuleFile
+{
+	<#
+		.SYNOPSIS
+			Loads files into the module on module import.
+		
+		.DESCRIPTION
+			This helper function is used during module initialization.
+			It should always be dotsourced itself, in order to proper function.
+			
+			This provides a central location to react to files being imported, if later desired
+		
+		.PARAMETER Path
+			The path to the file to load
+		
+		.EXAMPLE
+			PS C:\> . Import-ModuleFile -File $function.FullName
+	
+			Imports the file stored in $function according to import policy
+	#>
+	[CmdletBinding()]
+	Param (
+		[string]
+		$Path
+	)
+	
+	if ($script:dontDotSource) { $ExecutionContext.InvokeCommand.InvokeScript($false, ([scriptblock]::Create([io.file]::ReadAllText($Path))), $null, $null) }
+	else { . $Path }
+}
+#endregion Helper function
+
+# Perform Actions before loading the rest of the content
+. Import-ModuleFile -Path "$PSModuleRoot\internal\scripts\preimport.ps1"
+
+#region Load functions
+foreach ($function in (Get-ChildItem "$PSModuleRoot\internal\functions" -Recurse -File -Filter "*.ps1"))
+{
+	. Import-ModuleFile -Path $function.FullName
+}
+
+foreach ($function in (Get-ChildItem "$PSModuleRoot\functions" -Recurse -File -Filter "*.ps1"))
+{
+	. Import-ModuleFile -Path $function.FullName
+}
+#endregion Load functions
+
+# Perform Actions after loading the module contents
+. Import-ModuleFile -Path "$PSModuleRoot\internal\scripts\postimport.ps1"

Original file line number	Diff line number	Diff line change
`@@ -229,6 +229,18 @@`
`229`	`229`	`}`
`230`	`230`	`#endregion Insert basic meta-data`
`231`	`231`
	`232`	`+ #region Validation`
	`233`	`+ #region Validate FilePath`
	`234`	`+ if ($FilePath)`
	`235`	`+ {`
	`236`	`+ if (-not (Test-Path $FilePath -PathType Leaf))`
	`237`	`+ {`
	`238`	`+ Stop-PSFFunction -Message "Filepath $FilePath is invalid. Ensure it exists and is a file" -EnableException $EnableException -Category InvalidArgument -Tag 'fail', 'argument', 'path'`
	`239`	`+ return`
	`240`	`+ }`
	`241`	`+ }`
	`242`	`+ #endregion Validate FilePath`
	`243`	`+`
`232`	`244`	`#region Validate & ensure output folder`
`233`	`245`	`$fileName = "$($template.Name)-$($template.Version).xml"`
`234`	`246`	`$infoFileName = "$($template.Name)-$($template.Version)-Info.xml"`
`@@ -265,6 +277,7 @@`
`265`	`277`	`return`
`266`	`278`	`}`
`267`	`279`	`#endregion Validate & ensure output folder`
	`280`	`+ #endregion Validation`
`268`	`281`
`269`	`282`	`#region Utility functions`
`270`	`283`	`function Convert-Item`
`@@ -428,7 +441,7 @@`
`428`	`441`	`#region Fixed string replacement`
`429`	`442`	`if ($find.Groups[1].Success)`
`430`	`443`	`{`
`431`		`- if ($object.FileSystemParameterFlat -notcontains $find.Groups[1].Value)`
	`444`	`+ if ($object.ContentParameterFlat -notcontains $find.Groups[1].Value)`
`432`	`445`	`{`
`433`	`446`	`$null = $object.ContentParameterFlat.Add($find.Groups[1].Value)`
`434`	`447`	`}`
`@@ -522,6 +535,7 @@`
`522`	`535`	`foreach ($item in (Get-ChildItem -Path $processedReferencePath -Filter $Filter))`
`523`	`536`	`{`
`524`	`537`	`if ($item.FullName -in $Exclusions) { continue }`
	`538`	`+ if ($item.Name -eq "PSMDTemplate.ps1") { continue }`
`525`	`539`	`Convert-Item -Item $item -Filter $Filter -Exclusions $Exclusions -Template $template -ReferencePath $processedReferencePath -Identifier $identifier -BinaryExtensions $binaryExtensions`
`526`	`540`	`}`
`527`	`541`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+New-PSMDTemplate -FilePath "$PSScriptRoot\PSMDTemplate.ps1" -TemplateName PSMDTemplateReference -OutStore psmoduledevelopment -Description "PSModule Development Template Reference file" -Author "Friedrich Weinmann" -Tags 'template','file','configuration'`