Merge pull request #232 from PowershellFrameworkCollective/development

0.10.28.144

Author: FriedrichWeinmann

PSFramework/PSFramework.psd1

@@ -5,7 +5,7 @@
 	RootModule = 'PSFramework.psm1'
 
 	# Version number of this module.
-	ModuleVersion = '0.10.27.135'
+	ModuleVersion = '0.10.28.144'
 
 	# ID used to uniquely identify this module
 	GUID = '8028b914-132b-431f-baa9-94a6952f21ff'

PSFramework/PSFramework.psm1

@@ -1,5 +1,5 @@
-$script:ModuleRoot = $PSScriptRoot
-$script:ModuleVersion = "0.10.27.135"
+$script:ModuleRoot = $PSScriptRoot
+$script:ModuleVersion = (Import-PowerShellDataFile -Path "$($script:ModuleRoot)\PSFramework.psd1").ModuleVersion
 
 # Detect whether at some level dotsourcing was enforced
 $script:doDotSource = $false
@@ -25,8 +25,8 @@ if (($PSVersionTable.PSVersion.Major -lt 6) -or ($PSVersionTable.OS -like "*Wind
 	if ((Get-ItemProperty -Path "HKCU:\SOFTWARE\Microsoft\WindowsPowerShell\PSFramework\System" -Name "ImportIndividualFiles" -ErrorAction Ignore).ImportIndividualFiles) { $script:doDotSource = $true }
 }
 if (Test-Path (Join-Path (Resolve-Path -Path "$($script:ModuleRoot)\..") '.git')) { $importIndividualFiles = $true }
-if (-not (Test-Path (Join-Path $script:ModuleRoot "commands.ps1"))) { $importIndividualFiles = $true }
-	
+if ("<was not compiled>" -eq '<was not compiled>') { $importIndividualFiles = $true }
+
 function Import-ModuleFile
 {
 	<#
@@ -54,9 +54,10 @@ function Import-ModuleFile
 	)
 
 	if ($doDotSource) { . (Resolve-Path $Path) }
-	else { $ExecutionContext.InvokeCommand.InvokeScript($false, ([scriptblock]::Create([io.file]::ReadAllText((Resolve-Path $Path)))), $null, $null) }
+	else { $ExecutionContext.InvokeCommand.InvokeScript($false, ([scriptblock]::Create([io.file]::ReadAllText((Resolve-Path $Path).ProviderPath))), $null, $null) }
 }
 
+#region Load individual files
 if ($importIndividualFiles)
 {
 	# Execute Preimport actions
@@ -76,18 +77,12 @@ if ($importIndividualFiles)
 
 	# Execute Postimport actions
 	. Import-ModuleFile -Path "$($script:ModuleRoot)\internal\scripts\postimport.ps1"
-}
-else
-{
-	if (Test-Path (Join-Path $script:ModuleRoot "resourcesBefore.ps1"))
-	{
-		. Import-ModuleFile -Path "$($script:ModuleRoot)\resourcesBefore.ps1"
-	}
 
-	. Import-ModuleFile -Path "$($script:ModuleRoot)\commands.ps1"
-	
-	if (Test-Path (Join-Path $script:ModuleRoot "resourcesAfter.ps1"))
-	{
-		. Import-ModuleFile -Path "$($script:ModuleRoot)\resourcesAfter.ps1"
-	}
-}
+	# End it here, do not load compiled code below
+	return
+}
+#endregion Load individual files
+
+#region Load compiled code
+"<compile code into here>"
+#endregion Load compiled code

PSFramework/The PSFramework Reliability Promise.md

@@ -0,0 +1,70 @@
+# The PSFramework Reliability Promise
+## About
+
+The PSFramework is designed as a platform for others to build their code upon.
+As such, there is a special need for reliability and stability of code.
+This is my promise on how I ensure it is safe to use and safe to rely upon.
+
+## Supported Platforms
+
+This module is supported on:
+
+ - Windows PowerShell 3+ (And Windows 6.1 and later)
+ - PowerShell Core 6.0+ (Any OS; Stable Release only)
+ - PowerShell Core 6.0+ (Any OS; Preview support; Limited support only*)
+
+*Generally, Platform compatibility issues take top priority, having me drop any other issues to fix them.
+For preview editions of PowerShell Core this priority may not apply.
+
+## No breaking change (?)
+
+The greatest risk to relying on foreign code is that that code might introduce a breaking change, thereby breaking your code without you doing anything but deploying a latest version of it.
+
+Therefore, my one greatest promise is this:
+
+> No Breaking Changes*
+
+That is, if a feature has reached deployment stage, I will not introduce breaking changes whatsoever, except for under some very limited and constrained circumstances.
+And even then I'll try not to if I somehow can.
+
+## Coverage
+
+Now what is covered by this promise:
+
+ - All functions and cmdlets signatures. Any current parameterization will keep being valid and produce the same result.
+ - All logging providers. Configuration and default behavior cannot be changed.
+ - All parameter classes will keep understanding current input (they may _also_ learn new things however)
+ - All validation attributes will keep accepting the current definition (new definitions may be introduced however)
+ - Any otherwise advertised feature on the [documentation site](https://psframework.org/documentation/documents/psframework.html)
+
+Not covered by this promise:
+
+ - Preview features. All new commands that are being released are considered to be in preview for one month. This is designed to allow for initial user feedback to be implemented. Note: This only applies to the initial command release, _not_ to any later updates that were made after the preview stage was over.
+ - Any other internal library mechanics. Some of them need to be public for script funtions to access them. That does _not_ imply they are for public consumption (You may use them for that, but at your own risk).
+ - UI User Interaction. Messages written to the host intended for a human consumption may be changed in how they are being displayed. The previous state however must be available using configuration (thus changes to the _default_ behavior can be made, as long as the old state can be reintroduced).
+ - Experimental features. Any feature listed as experimental below is considered to be exempt from this policy.
+ - System mandated change: If a feature needs to be adapted in order for it to be operable on all supported platforms (for example an active conflict with PowerShell Core), then that is an overriding technical need to change it.
+ - A feature undergong the Process of Change.
+
+## Process of Change
+
+One of the great limitations of a "No Breaking Change" policy is that in some few cases, keeping to support the old ways incurs a penalty, a cost.
+Whether that is hurt performance or undesired environment impact.
+In order to not fully prevent improvement in those scenarios, there shall be implemented a public change process:
+
+For each desired breaking change, an RFC most be posted as an issue, describing the reason for this change and the benefits it brings.
+This RFC will be open for discussion for three months.
+If these three months pass and no convincing argument against it have been brought forward, the suggested change will be marked as a pending change:
+
+ - The way of operation that will be broken by that change will be declared deprecated.
+ - The affected feature will be updated to include a warning if a deprecated way of using it is detected, to warn about the impeding change.
+ - On Windows Systems, use of a deprecated functionality will generate a warning eventlog event in the PowerShell Eventlog (ID: 666; Category: 1; EntryType: Warning; Source: PowerShell)
+ - Nine months after the RFC is approved, the breaking change may be implemented.
+
+## Pending Change
+
+There are currently no breaking changes pending
+
+## Experimental features
+
+There currently are no experimental features in the PSFramework

PSFramework/bin/PSFramework.dll

@@ -1,4 +1,15 @@
 # CHANGELOG
+## 0.10.28.144 : 2018-10-28
+ - Upd: Module Architecture update
+ - Upd: Linked online help for commands (by Andrew Pla)
+ - Upd: Configuration - redirected SystemDefault to FileSystem scope on non-Windows systems (#229)
+ - Upd: Message/Logging - Error records are now directly associated with their respective message and available as the ErrorRecord property (#230)
+ - Fix: Reset-PSFConfig fails with error (#223)
+ - Fix: Configuration: Registering empty string will register the wrong value (#224)
+ - Fix: Module on UNC Path Fails to Load (#227)
+ - Fix: Get-PSFUserChoice handling single options more gracefully (#228)
+ - Other: Add formal policy on supported platforms and breaking change policy
+
 ## 0.10.27.135 : 2018-10-12
  - Fix: New dynamic content collections' Reset() method doesn't do a thing.
 

PSFramework/bin/PSFramework.pdb

@@ -51,7 +51,7 @@
 		Runs the $scriptblock against all computers in AD with a name that starts with "srv-db".
 #>
 	[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSPossibleIncorrectUsageOfAssignmentOperator", "")]
-	[CmdletBinding()]
+	[CmdletBinding(HelpUri = 'https://psframework.org/documentation/commands/PSFramework/Invoke-PSFCommand')]
 	param (
 		[PSFComputer[]]
 		[Alias('Session')]

PSFramework/bin/PSFramework.xml

@@ -54,7 +54,7 @@
 		
 		Exports all settings of the module 'MyModule' that are no longer the original default values to json.
 #>
-	[CmdletBinding(DefaultParameterSetName = 'FullName')]
+	[CmdletBinding(DefaultParameterSetName = 'FullName', HelpUri = 'https://psframework.org/documentation/commands/PSFramework/Export-PSFConfig')]
 	Param (
 		[Parameter(ParameterSetName = "FullName", Position = 0, Mandatory = $true)]
 		[string]

PSFramework/changelog.md

@@ -35,7 +35,7 @@
 			Retrieve all configuration elements from all modules, even hidden ones.
     #>
 	[OutputType([PSFramework.Configuration.Config])]
-	[CmdletBinding(DefaultParameterSetName = "FullName")]
+	[CmdletBinding(DefaultParameterSetName = "FullName", HelpUri = 'https://psframework.org/documentation/commands/PSFramework/Get-PSFConfig')]
 	Param (
 		[Parameter(ParameterSetName = "FullName", Position = 0)]
 		[string]