PoshCode · Jaykul · Jan 19, 2021 · Jul 2, 2019 · Jul 4, 2019 · Jul 4, 2019
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -0,0 +1,12 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "gitversion.tool": {
+      "version": "5.6.0",
+      "commands": [
+        "dotnet-gitversion"
+      ]
+    }
+  }
+}
diff --git a/.github/workflows/Merge-Module.ps1 b/.github/workflows/Merge-Module.ps1
@@ -0,0 +1,33 @@
+#requires -Module Configuration
+[CmdletBinding()]
+param(
+    $OutputModulePath,
+    $NestedModulePath
+)
+$OutputModule = Get-Module $OutputModulePath -ListAvailable
+$NestedModule = Get-Module $NestedModulePath -ListAvailable
+
+# Copy and then remove the extra output
+Copy-Item -Path (Join-Path $NestedModule.ModuleBase Metadata.psm1) -Destination $OutputModule.ModuleBase
+Remove-Item $NestedModule.ModuleBase -Recurse
+
+# Because this is a double-module, combine the exports of both modules
+# Put the ExportedFunctions of both in the manifest
+Update-Metadata -Path $OutputModule.Path -PropertyName FunctionsToExport `
+                -Value @(
+                    @(
+                        $NestedModule.ExportedFunctions.Keys
+                        $OutputModule.ExportedFunctions.Keys
+                    ) | Select-Object -Unique
+                    # @('*')
+                )
+
+# Put the ExportedAliases of both in the manifest
+Update-Metadata -Path $OutputModule.Path -PropertyName AliasesToExport `
+                -Value @(
+                    @(
+                        $NestedModule.ExportedAliases.Keys
+                        $OutputModule.ExportedAliases.Keys
+                    ) | Select-Object -Unique
+                    # @('*')
+                )
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,65 @@
+name: Build on push
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: windows-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: GitVersion
+        id: gitversion
+        uses: PoshCode/Actions/gitversion@v1
+      - name: Install-RequiredModules
+        uses: PoshCode/Actions/install-requiredmodules@v1
+      - name: Build Module
+        id: build
+        uses: PoshCode/actions/build-module@v1
+        with:
+          version: ${{ steps.gitversion.outputs.LegacySemVerPadded }}
+          destination: ${{github.workspace}}/output
+      - name: Combine Configuration
+        run: |
+          $OutputModule, $NestedModule = (ConvertFrom-Json -Input '${{ steps.build.outputs.moduleinfo }}').Where({$_.Name -eq "Configuration"}, "Split")
+          & "${{github.workspace}}/.github/workflows/Merge-Module.ps1" -OutputModulePath $OutputModule.Path -NestedModulePath $NestedModule.Path
+      - name: Upload Build Output
+        uses: actions/upload-artifact@v2
+        with:
+          name: Modules
+          path: ${{github.workspace}}/output
+      - name: Upload Tests
+        uses: actions/upload-artifact@v2
+        with:
+          name: PesterTests
+          path: ${{github.workspace}}/Specs
+      - name: Upload RequiredModules.psd1
+        uses: actions/upload-artifact@v2
+        with:
+          name: RequiredModules
+          path: ${{github.workspace}}/RequiredModules.psd1
+      - name: Upload PSScriptAnalyzerSettings.psd1
+        uses: actions/upload-artifact@v2
+        with:
+          name: ScriptAnalyzer
+          path: ${{github.workspace}}/PSScriptAnalyzerSettings.psd1
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [windows-latest, windows-2016] #, ubuntu-16.04, ubuntu-18.04, macos-latest]
+    needs: build
+    steps:
+      - name: Download Build Output
+        uses: actions/download-artifact@v2
+      - uses: PoshCode/Actions/install-requiredmodules@v1
+      - uses: PoshCode/Actions/pester@v1
+        with:
+          codeCoveragePath: Modules/Configuration
+          moduleUnderTest: Configuration
+          additionalModulePaths: ${{github.workspace}}/Modules
+      - name: Upload Results
+        uses: actions/upload-artifact@v2
+        with:
+          name: Pester Results
+          path: ${{github.workspace}}/*.xml
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,8 @@
 /[0-9]*/
 
 /.vs/
-/RequiredModules/
+RequiredModules/
+node_modules/
+
+results.xml
+coverage.xml
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,8 @@
+{
+    "files.defaultLanguage": "powershell",
+    "powershell.codeFormatting.preset": "OTBS",
+    "powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationForFirstPipeline",
+    "powershell.codeFormatting.useCorrectCasing": true,
+    "powershell.scriptAnalysis.enable": true,
+    "powershell.scriptAnalysis.settingsPath": "PSScriptAnalyzerSettings.psd1"
+}
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -12,7 +12,7 @@
             "type": "shell",
             "command": "${workspaceFolder}\\build.ps1",
             "args": [
-                "-OutputDirectory", "${workspaceFolder}\\Output\\Configuration"
+                "-OutputDirectory", "${workspaceFolder}"
             ],
             "presentation": {
                 "echo": true,
@@ -29,7 +29,7 @@
             "type": "shell",
             "command": "Invoke-ScriptAnalyzer",
             "args": [
-                "-Path", "${workspaceFolder}\\Output\\"
+                "-Path", "(Get-Module Configuration -List | Sort Version -Desc | Select -First 1 -Expand ModuleBase)"
             ],
             "presentation": {
                 "echo": true,
@@ -49,15 +49,13 @@
             "type": "shell",
             "options": {
                 "cwd": "${workspaceFolder}",
-                "env": {
-                    "PSModulePath": "${workspaceFolder}\\Output;${env:PSModulePath}"
-                }
+
             },
             "command": "Invoke-Gherkin",
             "args": [
                 "-Path", "${workspaceFolder}\\Specs",
                 "-PesterOption", "@{ IncludeVSCodeMarker = $True }",
-                "-CodeCoverage", "${workspaceFolder}\\Output\\*.psm1"
+                "-CodeCoverage", "(Convert-Path (Join-Path (Split-Path (Get-Module Configuration -List | Sort Version -Desc | Select -First 1 -Expand ModuleBase)) *.psm1))"
             ],
             "presentation": {
                 "echo": true,

diff --git a/Build.ps1 b/Build.ps1
@@ -1,21 +1,21 @@
-#requires -Module ModuleBuilder, Configuration
+#requires -Module @{ModuleName = "ModuleBuilder"; ModuleVersion = "2.0.0"}, Configuration
 [CmdletBinding()]
 param(
     # A specific folder to build into
-    $OutputDirectory = $PSScriptRoot,
+    $OutputDirectory,
 
     # The version of the output module
     [Alias("ModuleVersion")]
-    [string]$SemVer,
-
-    # Optionally, a local folder that modules and CLI tools can be installed in
-    $LocalTools = "./RequiredModules"
+    [string]$SemVer
 )
-Push-Location $PSScriptRoot -StackName BuildWindowsConsoleFont
+Push-Location $PSScriptRoot -StackName BuildTestStack
 
 if (!$SemVer -and (Get-Command gitversion -ErrorAction Ignore)) {
     $PSBoundParameters['SemVer'] = gitversion -showvariable nugetversion
 }
+if (!$PSBoundParameters.ContainsKey("OutputDirectory")) {
+    $PSBoundParameters["OutputDirectory"] = $PSScriptRoot
+}
 
 try {
     ## Build the actual module
@@ -27,18 +27,33 @@ try {
                         -Target Build -Passthru `
                         @PSBoundParameters
 
+    # Copy and then remove the extra output
+    Copy-Item -Path (Join-Path $MetadataInfo.ModuleBase Metadata.psm1) -Destination $ConfigurationInfo.ModuleBase
+    Remove-Item $MetadataInfo.ModuleBase -Recurse
+
     # Because this is a double-module, combine the exports of both modules
+    # Put the ExportedFunctions of both in the manifest
     Update-Metadata -Path $ConfigurationInfo.Path -PropertyName FunctionsToExport `
                     -Value @(
-                        $MetadataInfo.ExportedFunctions.Keys
-                        $ConfigurationInfo.ExportedFunctions.Keys
+                        @(
+                            $MetadataInfo.ExportedFunctions.Keys
+                            $ConfigurationInfo.ExportedFunctions.Keys
+                        ) | Select-Object -Unique
+                        # @('*')
+                    )
+
+    # Put the ExportedAliases of both in the manifest
+    Update-Metadata -Path $ConfigurationInfo.Path -PropertyName AliasesToExport `
+                    -Value @(
+                        @(
+                            $MetadataInfo.ExportedAliases.Keys
+                            $ConfigurationInfo.ExportedAliases.Keys
+                        ) | Select-Object -Unique
                         # @('*')
                     )
 
     $ConfigurationInfo
 
-    # Remove the extra metadata file
-    Remove-Item $MetadataInfo.Path
 } finally {
-    Pop-Location -StackName BuildWindowsConsoleFont
+    Pop-Location -StackName BuildTestStack
 }
diff --git a/GitVersion.yml b/GitVersion.yml
@@ -1,5 +1,4 @@
 mode: Mainline
-next-version: 1.0.0
 commit-message-incrementing: MergeMessageOnly
 
 assembly-versioning-format: '{Major}.{Minor}.{Patch}.{env:BUILDCOUNT ?? 0}'

diff --git a/PSScriptAnalyzerSettings.psd1 b/PSScriptAnalyzerSettings.psd1
@@ -0,0 +1,4 @@
+@{
+    Severity     = @('Error', 'Warning')
+    ExcludeRules = @('PSAvoidUsingDeprecatedManifestFields', 'PSPossibleIncorrectUsageOfAssignmentOperator')
+}
diff --git a/README.md b/README.md
@@ -1,12 +1,32 @@
-# Configuration
+[![Build Status](https://dev.azure.com/poshcode/Configuration/_apis/build/status/Configuration?branchName=master)](https://dev.azure.com/poshcode/Configuration/_build/latest?definitionId=2&branchName=master)
 
-A module for saving and loading settings and configuration objects for PowerShell modules (and scripts).
+# The Configuration Module
 
-The Configuration module supports layered configurations with default values, and serializes objects and hashtables to the simple PowerShell metadata format with the ability to extend how your custom types are serialized, so your configuration files are just .psd1 files!
+## Metadata commands for working with .psd1:
 
-The key feature is that you don't have to worry about where to store files, and modules using the Configuration commands will be able to easily store data even when installed in write-protected folders like Program Files.
+- Manipulating metadata files
+- Extensible serialization of types
+- Built in support for DateTime, Version, Guid, SecureString, ScriptBlocks and more
+- Lets you store almost anything in readable metadata (.psd1) files
+- Serializing (`Export`) to metadata (.psd1) files
+- Deserializing (`Import`) from metadata (.psd1) files
 
-Supports WindowsPowerShell, as well as PowerShell Core on Windows, Linux and OS X.
+## Configuration commands for loading settings:
+
+- Ship default configuration files with your module
+- Automatically determines where to save your settings
+    - Supports Windows roaming profiles
+    - Supports XDG settings for Linux (and MacOS)
+- Allow users to configure settings using our commands, or your wrappers
+- Supports _layered_ configurations:
+  - Machine-level config
+  - User override files
+- Supports automatic configuration of parameters values for a command
+  - Reads `Noun` configuration files in your working directory
+  - Filters only values which apply to the current command
+
+
+It supports WindowsPowerShell, as well as PowerShell Core on Windows, Linux and OS X.
 
 ## Installation
 

diff --git a/RequiredModules.psd1 b/RequiredModules.psd1
@@ -1,5 +1,6 @@
 @{
-    Configuration = "[1.3.1,2.0)"
-    Pester        = "[4.7.2,5.0)"
-    ModuleBuilder = "[1.0.0,2.0)"
+    Configuration    = "[1.3.1,2.0)"
+    Pester           = "[4.10.1,5.0)"
+    ModuleBuilder    = "[2.0.0,3.0)"
+    PSScriptAnalyzer = "1.19.1"
 }
diff --git a/Source/Configuration/Public/Export-Configuration.ps1 b/Source/Configuration/Public/Export-Configuration.ps1
@@ -16,7 +16,11 @@ function Export-Configuration {
 
             This example shows how to use Export-Configuration to export data for use in a specific module.
     #>
-    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "")] # Because PSSCriptAnalyzer team refuses to listen to reason. See bugs:  #194 #283 #521 #608
+    # PSSCriptAnalyzer team refuses to listen to reason. See bugs:  #194 #283 #521 #608
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "")]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'Callstack', Justification = 'This is referenced in ParameterBinder')]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'Module', Justification = 'This is referenced in ParameterBinder')]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'DefaultPath', Justification = 'This is referenced in ParameterBinder')]
     [CmdletBinding(DefaultParameterSetName = '__ModuleInfo', SupportsShouldProcess)]
     param(
         # Specifies the objects to export as metadata structures.

diff --git a/Source/Configuration/Public/Get-ConfigurationPath.ps1 b/Source/Configuration/Public/Get-ConfigurationPath.ps1
@@ -25,6 +25,8 @@ function Get-ConfigurationPath {
     #
     #   This example shows how to use Get-ConfigurationPath with Export-CliXML to cache data as clixml from inside a module.
     [Alias("Get-StoragePath")]
+    # [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'Callstack', Justification = 'This is referenced in ParameterBinder')]
+    # [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'Module', Justification = 'This is referenced in ParameterBinder')]
     [CmdletBinding(DefaultParameterSetName = '__ModuleInfo')]
     param(
         # The scope to save at, defaults to Enterprise (which returns a path in "RoamingData")

diff --git a/Source/Configuration/Public/Import-Configuration.ps1 b/Source/Configuration/Public/Import-Configuration.ps1
@@ -14,6 +14,9 @@ function Import-Configuration {
     #
     #   This example shows how to use Import-Configuration in your module to load data cached for another module
     #
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'Callstack', Justification = 'This is referenced in ParameterBinder')]
+    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'Module', Justification = 'This is referenced in ParameterBinder')]
+    # [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', 'DefaultPath', Justification = 'This is referenced in ParameterBinder')]
     [CmdletBinding(DefaultParameterSetName = '__CallStack')]
     param(
         # A callstack. You should not ever pass this.