Skip to content

Commit 9e4a9fd

Browse files
FriedrichWeinmannFriedrichWeinmann
committed
0.9.0
1 parent 5a4c010 commit 9e4a9fd

25 files changed

+611
-46
lines changed

‎PSFramework.NuGet/changelog.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Changelog
2-
## 1.0.0 (2023-03-13)
3-
- New: Some Stuff
4-
- Upd: Moar Stuff
5-
- Fix: Much Stuff
2+
3+
## 0.9.0 (2025-01-03)
4+
5+
+ Initial Preview Release

‎PSFramework.NuGet/en-us/strings.psd1

+94-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,98 @@
11
# This is where the strings go, that are written by
22
# Write-PSFMessage, Stop-PSFFunction or the PSFramework validation scriptblocks
33
@{
4-
'key' = 'Value'
4+
'Assert-V2Publishing.CannotPublish' = 'PowerShellGet may not yet be configured for publishing modules. This may prompt you to install required binaries and fail to publish if denied or internet access is not available. If this indeed fails, you can configure it by running "Install-PSFPowerShellGet" from an elevated console (no internet access required).' #
5+
6+
'Copy-Module.Error.ManifestNotFound' = 'No module manifest found in {0}' # $Path
7+
'Copy-Module.Error.ManifestSyntaxError' = 'Invalid manifest, contains syntax errors: {0}' # $manifestPath
8+
'Copy-Module.Error.StagingFolderCopy' = 'Failed to deploy module to staging directory when trying to publish {0}' # $Path
9+
'Copy-Module.Error.StagingFolderFailed' = 'Failed to create staging folder when trying to publish {0}' # $Path
10+
11+
'Install-PSFModule.Error.Installation' = 'Failed to install {0}' # $Name -join ','
12+
'Install-PSFModule.Error.NoComputerValid' = 'Unable to establish ANY remote connections to {0}' # $ComputerName -join ',
13+
'Install-PSFModule.Error.Setup' = 'Failed to prepare to install {0}' # $Name -join ','
14+
15+
'New-ManagedSession.Error.BrokenSession' = 'Received a session to {0} that is already in a broken state. Repair the conection and try again.' # "$_"
16+
'New-ManagedSession.Error.Connect' = 'Failed to connect to {0}' # $fail.TargetObject
17+
18+
'Publish-ModuleToPath.Error.AlreadyPublished' = 'The module {0} ({1}) has already been published to {2}. Do not forget to raise your module version before publishing.' # $Module.Name, $Module.Version, $Path
19+
'Publish-ModuleToPath.Error.FailedToStaging.V2' = 'Failed to publish {0} ({1}) to a staging repository.' # $module.Name, $module.Version
20+
'Publish-ModuleToPath.Error.FailedToStaging.V3' = 'Failed to publish {0} ({1}) to a staging repository.' # $module.Name, $module.Version
21+
'Publish-ModuleToPath.Publishing' = 'Publishing {0} ({1})' # $module.Name, $module.Version
22+
23+
'Publish-ModuleV2.Publish' = 'Publishing module {0} ({1}) to repository {2}' # $Module.Name, $Module.Version, $Repository.Name
24+
25+
'Publish-ModuleV3.Error.AlreadyPublished' = 'Module {0} ({1}) has already been published to repository {2}. Do not forget to raise your module version before publishing.' # $Module.Name, $Module.Version, $Repository.Name
26+
'Publish-ModuleV3.Publish' = 'Publishing module {0} ({1}) to repository {2}' # $Module.Name, $Module.Version, $Repository.Name
27+
28+
'Publish-PSFModule.Error.UnexpectedRepositoryType' = 'Unexpected repository type: {0} of type {1}. This is likely a bug, please report it at "https://github.com/PowershellFrameworkCollective/PSFramework.NuGet/issues"' # $repositoryObject.Name, $repositoryObject.Type
29+
30+
'Publish-PSFResourceModule.Error' = 'Failed to publish the resource module {0} to {1}' # $Name, ($Repository -join ', ')
31+
32+
'Publish-StagingModule.Deploying.DeleteOld' = 'Cleaning up previously existing copy of {0} ({1})' # $module.Name, $version.Name
33+
'Publish-StagingModule.Deploying.Local' = 'Deploying {0} ({1}) to {2}' # $module.Name, $version.Name, $destination.Path
34+
'Publish-StagingModule.Deploying.Remote' = 'Deploying {1} ({2}) on {0} to {3}' # $TargetPath.ComputerName, $module.Name, $version.Name, $targetVersionRoot
35+
'Publish-StagingModule.Deploying.Remote.Failed' = 'Failed to deploy {1} ({2}) on {0} to {3}: {4}' # $TargetPath.ComputerName, $module.Name, $version.Name, $targetVersionRoot, $deployResult.Error
36+
'Publish-StagingModule.Deploying.RenameOld' = 'Renaming previously existing copy of {0} ({1})' # $module.Name, $version.Name
37+
'Publish-StagingModule.Error.General' = 'An error happened when deploying to {0}' # $TargetPath.ComputerName
38+
'Publish-StagingModule.Remote.Deploying.RenameOld' = 'Renaming previously existing copy of {1} ({2}) on {0} at {3}' # $TargetPath.ComputerName, $module.Name, $version.Name, $testPath
39+
'Publish-StagingModule.Remote.Deploying.RenameOld.NoSuccess' = 'Failed to rename previously existing copy of {1} ({2}) on {0} at {3}: {4}' # $TargetPath.ComputerName, $module.Name, $version.Name, $testPath, $renameResult.Error
40+
'Publish-StagingModule.Remote.Deploying.RenameOld.Success' = 'Successfully renamed previously existing copy of {1} ({2}) on {0} at {3}.' # $TargetPath.ComputerName, $module.Name, $version.Name, $testPath
41+
'Publish-StagingModule.Remote.DeployStaging' = 'Deploying {1} ({2}) on {0} to staging directory {3}' # $TargetPath.ComputerName, $module.Name, $version.Name, $targetStagingRoot
42+
'Publish-StagingModule.Remote.DeployStaging.FailedCopy' = 'Failed to deploy {1} ({2}) on {0} to staging directory {3}. Staging directory could not be created: {4}' # $TargetPath.ComputerName, $module.Name, $version.Name, $targetStagingRoot
43+
'Publish-StagingModule.Remote.DeployStaging.FailedDirectory' = 'Failed to deploy {1} ({2}) on {0} to staging directory {3}.' # $TargetPath.ComputerName, $module.Name, $version.Name, $targetStagingRoot, $createResult.Error
44+
'Publish-StagingModule.Remote.Error.TempStagingSetup' = 'Failed to setup the staging folder on {0}: {1}' # $TargetPath.ComputerName, $stagingResult.Error
45+
'Publish-StagingModule.Remote.Skipping.AlreadyExists' = 'Skipping deploying {1} ({2}) - already exists on {0}' # $TargetPath.ComputerName, $module.Name, $version.Name
46+
'Publish-StagingModule.Skipping.AlreadyExists' = 'Skipping module {0} ({1}): Already exists in target {2}' # $module.Name, $version.Name, $destination.Path
47+
48+
'Read-ManifestDependency.Warning.VersionError' = 'Invalid RequiredModules in manifest {0}: The version on {1} is not correct' # $Path, $requirement.Name
49+
50+
'Read-VersionString.Error.BadFormat' = 'Bad version filter format: {0}. The version format requires a %Version%-%Version% format with either version number optional. The notation may be encapsuled by parenthesis or square brackets and nothing else.' # $Version
51+
'Read-VersionString.Error.BadFormat.ZeroUpperBound' = 'Bad version filter format: {0}. The upper bound version limit cannot be "0.0.0"!' # $Version
52+
53+
'Resolve-ModuleScopePath.Error.NotFound' = 'Failed to resolve paths on {0}: {1}' # $result.ComputerName, (@($result.Results).Where{ -not $_.Exists }.Path -join ' | ')
54+
'Resolve-ModuleScopePath.Error.ScopeNotFound' = 'Module installation scope not found: {0}. Known scopes: {1}' # $Scope, ((Get-PSFModuleScope).Name -join ', ')
55+
'Resolve-ModuleScopePath.Error.UnReached' = 'Unable to resolve scope paths - computer not reached: {0} ({1})' # $result.ComputerName, ($result.Path -join ' | ')
56+
'Resolve-ModuleScopePath.Fail.NotAll' = 'Failed to resolve scope paths for all computers. Failed targets: {0}' # (@($testResult).Where{-not $_.Success }.ComputerName -join ' | ')
57+
'Resolve-ModuleScopePath.Fail.NotAny' = 'Failed to resolve scope paths for any computers. {0}' # ($testResult.ComputerName -join ' | ')
58+
59+
'Resolve-RemotePath.Error.NotFound' = 'Reached {0} but was unable to resolve paths {1}' # $result.ComputerName, (@($result.Results).Where{ -not $_.Exists }.Path -join ' | ')
60+
'Resolve-RemotePath.Error.UnReached' = 'Failed to reach {0}, unable to resolve paths {1}' # $result.ComputerName, ($Path -join ' | ')
61+
'Resolve-RemotePath.Fail.NotAll' = 'Failed to successfully resolve paths on {0} > {1}' # (@($testResult).Where{-not $_.Success }.ComputerName -join ' | '), ($Path -join ' | ')
62+
'Resolve-RemotePath.Fail.NotAny' = 'Failed to successfully resolve paths on {0} > {1}' # ($testResult.ComputerName -join ' | '), ($Path -join ' | ')
63+
64+
'Resolve-Repository.Error.NoRepo' = 'Failed to find repository {0} of type {1}' # ($Name -join ', '), $Type
65+
66+
'Save-PowerShellGet.Error.UnableToResolve' = 'Unable to resolve aka.ms link: {0}. Make sure internet access is available!' # $link
67+
68+
'Save-PSFModule.Error.NoComputerValid' = 'Failed to connect to any of the provided computer targets: {0}' # ($ComputerName -join ', ')
69+
70+
'Save-PSFResourceModule.Deploying' = 'Deploying {2} from resource module {0} ({1}) to {3}' # $module.Name, $versionFolder.Name, $item.Name, $pathEntry
71+
'Save-PSFResourceModule.Downloading' = 'Downloading resource modules {0}' # ($Name -join ', ')
72+
'Save-PSFResourceModule.Skipping.AlreadyExists' = 'Skipping transfer of {2} from resource module {0} ({1}) - already exists as {3}' # $module.Name, $versionFolder.Name, $item.Name, $pathEntry
73+
'Save-PSFResourceModule.Skipping.InvalidResource' = 'Invalid resource module: {0} ({1}). It does not contain the expected "Resources" folder. Make sure the resource module has been published using Publish-PSFResourceModule' # $module.Name, $versionFolder.Name
74+
75+
'Save-StagingModule.Error.SaveFailed' = 'Failed to retrieve module {0} ({1}) from any of the following repositories: {2}' # $installItem.Name, $installItem.Version, (@($repository).ForEach{ '{0} ({1})' -f $_.Name, $_.Type } -join ', ')
76+
'Save-StagingModule.Error.UnknownRepoType' = 'Unexpected repository type {0} on repository {1}. This is probably an implementation but, please report it at "https://github.com/PowershellFrameworkCollective/PSFramework.NuGet/issues"' # $repository.Type, $repository.Name
77+
'Save-StagingModule.SavingV2.Done' = 'Finished download of {1} ({2}) from repository {3} of type {4}. Success: {0}' # $result.Success, $Item.Name, $Item.Version, $Repository.Name, $Repository.Type
78+
'Save-StagingModule.SavingV2.Error.DependencyCleanup' = 'Failed to remove undesired temporary dependencies for {1} ({2}) from repository {3} of type {4}' # $Item.Name, $Item.Version, $Repository.Name, $Repository.Type
79+
'Save-StagingModule.SavingV2.Error.Download' = 'Failed to download module {0} ({1}) from repository {2} of type {3}' # $Item.Name, $Item.Version, $Repository.Name, $Repository.Type
80+
'Save-StagingModule.SavingV2.Error.Transfer' = 'Failed to transfer module {0} ({1}) from repository {2} of type {3} to the staging folder.' # $Item.Name, $Item.Version, $Repository.Name, $Repository.Type
81+
'Save-StagingModule.SavingV2.Error.Unsigned' = 'Failed to verify signature of module {0} ({1}) or any of its dependencies from repository {2} of type {3}' # $Item.Name, $Item.Version, $Repository.Name, $Repository.Type
82+
'Save-StagingModule.SavingV2.SignatureCheck' = 'Signature validation. Module {0} ({1}) is signed correctly: {2}' # $signature.Name, $signature.Version, $signature.IsSigned
83+
'Save-StagingModule.SavingV2.Start' = 'Starting the download of {0} ({1}) from repository {2} of type {3}' # $Item.Name, $Item.Version, $Repository.Name, $Repository.Type
84+
'Save-StagingModule.SavingV3.Done' = 'Finished download of {1} ({2}) from repository {3} of type {4}. Success: {0}' # $result.Success, $Item.Name, $Item.Version, $Repository.Name, $Repository.Type
85+
'Save-StagingModule.SavingV3.Error.Download' = 'Failed to download module {0} ({1}) from repository {2} of type {3}' # $Item.Name, $Item.Version, $Repository.Name, $Repository.Type
86+
'Save-StagingModule.SavingV3.Error.Transfer' = 'Failed to transfer module {0} ({1}) from repository {2} of type {3} to the staging folder.' # $Item.Name, $Item.Version, $Repository.Name, $Repository.Type
87+
'Save-StagingModule.SavingV3.Error.Unsigned' = 'Failed to verify signature of module {0} ({1}) or any of its dependencies from repository {2} of type {3}' # $Item.Name, $Item.Version, $Repository.Name, $Repository.Type
88+
'Save-StagingModule.SavingV3.SignatureCheck' = 'Signature validation. Module {0} ({1}) is signed correctly: {2}' # $signature.Name, $signature.Version, $signature.IsSigned
89+
'Save-StagingModule.SavingV3.Start' = 'Starting the download of {0} ({1}) from repository {2} of type {3}' # $Item.Name, $Item.Version, $Repository.Name, $Repository.Type
90+
91+
'Update-PSFModuleManifest.Error.BadManifest' = 'Invalid module manifest {0} ({1}): Manifest must at least contain "ModuleVersion" and "RootModule"' # (Get-Item -Path $Path).BaseName, $Path
92+
'Update-PSFModuleManifest.Error.InvalidModuleReference' = 'Invalid Module Reference - the module specification does not contain a valid module name: {0}. It should either be a string or a hashtable with a "ModuleName" key.' # $item
93+
94+
'Update-PSFRepository.Error.InvalidType' = 'Failed to compare repository types - unexpected Type configured: {0}. Supported types: {1}. Use this to see the configured repository types: "Get-PSFConfig -FullName PSFramework.NuGet.Repositories.*.Type"' # $configuredRepo.Type, ($supportedTypes -join ', ')
95+
'Update-PSFRepository.Register.Failed' = 'Failed to refister the {0} repository {1} ({2})' # V2, $param.Name, $uri
96+
'Update-PSFRepository.Repository.Unregister' = 'Unregistering the {0} repository {1}' # $change.Actual.Type, $Change.Actual.Name
97+
'Update-PSFRepository.Repository.Update' = 'Updating the settings on the {0} repository {1}. Settings changed: {2}' # $change.Actual.Type, $Change.Actual.Name, ($param.Keys -join ',')
598
}

‎PSFramework.NuGet/functions/Get/Install-PSFModule.ps1

+12-3
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@
182182
$null = Resolve-Repository -Name $Repository -Type $Type -Cmdlet $PSCmdlet # Terminates if no repositories found
183183
$managedSessions = New-ManagedSession -ComputerName $ComputerName -Credential $RemotingCredential -Cmdlet $PSCmdlet -Type Temporary
184184
if ($ComputerName -and -not $managedSessions) {
185-
Stop-PSFFunction -String 'Install-PSFModule.Error.NoComputerValid' -EnableException $killIt -Cmdlet $PSCmdlet
185+
Stop-PSFFunction -String 'Install-PSFModule.Error.NoComputerValid' -StringValues ($ComputerName -join ', ') -EnableException $killIt -Cmdlet $PSCmdlet
186186
return
187187
}
188188
$resolvedPaths = Resolve-ModuleScopePath -Scope $Scope -ManagedSession $managedSessions -TargetHandling Any -PathHandling Any -Cmdlet $PSCmdlet # Errors for bad paths, terminates if no path
@@ -195,14 +195,23 @@
195195
process {
196196
if (Test-PSFFunctionInterrupt) { return }
197197

198+
$stopParam = @{ StringValues = $Name -join ', '}
199+
if ($InputObject) {
200+
$names = foreach ($item in $InputObject) {
201+
if ($item -is [string]) { $item }
202+
elseif ($item.ModuleName) { $item.ModuleName }
203+
}
204+
$stopParam = @{ StringValues = $names -join ', '}
205+
}
206+
198207
#region Start Nested Save-PSFModule
199208
if (-not $command) {
200209
$command = { Save-PSFModule @saveParam -PathInternal $resolvedPaths -Cmdlet $PSCmdlet -ErrorAction $ErrorActionPreference }.GetSteppablePipeline()
201210
try { $command.Begin((-not $Name)) }
202211
catch {
203212
if (-not $cleanedUp -and $managedSessions) { $managedSessions | Where-Object Type -EQ 'Temporary' | ForEach-Object Session | Remove-PSSession }
204213
$cleanedUp = $true
205-
Stop-PSFFunction -String 'Install-PSFModule.Error.Setup' -ErrorRecord $_ -EnableException $killIt -Cmdlet $PSCmdlet
214+
Stop-PSFFunction -String 'Install-PSFModule.Error.Setup' @stopParam -ErrorRecord $_ -EnableException $killIt -Cmdlet $PSCmdlet
206215
return
207216
}
208217
}
@@ -216,7 +225,7 @@
216225
catch {
217226
if (-not $cleanedUp -and $managedSessions) { $managedSessions | Where-Object Type -EQ 'Temporary' | ForEach-Object Session | Remove-PSSession }
218227
$cleanedUp = $true
219-
Stop-PSFFunction -String 'Install-PSFModule.Error.Installation' -ErrorRecord $_ -EnableException $killIt -Cmdlet $PSCmdlet
228+
Stop-PSFFunction -String 'Install-PSFModule.Error.Installation' @stopParam -ErrorRecord $_ -EnableException $killIt -Cmdlet $PSCmdlet
220229
return
221230
}
222231
#endregion Execute Process

‎PSFramework.NuGet/functions/Get/Publish-PSFModule.ps1

+8-2
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,12 @@
6161
This flags the module as "Prerelease", hiding it from regular Find-PSFModule / Install-PSFModule use.
6262
Use to provide test versions that only affect those in the know.
6363
64+
.PARAMETER WhatIf
65+
If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.
66+
67+
.PARAMETER Confirm
68+
If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.
69+
6470
.EXAMPLE
6571
PS C:\> Publish-PSFModule -Path C:\code\MyModule -Repository PSGallery -ApiKey $key
6672
@@ -177,10 +183,10 @@
177183
:repo foreach ($repositoryObject in $repositories) {
178184
switch ($repositoryObject.Type) {
179185
V2 {
180-
Publish-ModuleV2 @commonPublish -Module $moduleData -Repository $repositoryObject
186+
Publish-ModuleV2 @commonPublish -Module $moduleData -Repository $repositoryObject
181187
}
182188
V3 {
183-
Publish-ModuleV3 @commonPublish -Module $moduleData -Repository $repositoryObject
189+
Publish-ModuleV3 @commonPublish -Module $moduleData -Repository $repositoryObject
184190
}
185191
default {
186192
Stop-PSFFunction -String 'Publish-PSFModule.Error.UnexpectedRepositoryType' -StringValues $repositoryObject.Name, $repositoryObject.Type -Continue -Cmdlet $PSCmdlet -EnableException $killIt

‎PSFramework.NuGet/functions/Get/Register-PSFModuleScope.ps1

+19-1
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@
2929
.PARAMETER Description
3030
A description to add to the module scope registered.
3131
Purely for documentation purposes.
32+
33+
.PARAMETER Persist
34+
Remember the configured scope.
35+
For the current user, even when starting a new console, this scope will still exist.
36+
This will NOT remember the "Mode" parameter - configure your PSModulePath environment evariable separately, if desired.
37+
Not compatible with a ScriptBlock-based setting.
3238
3339
.EXAMPLE
3440
PS C:\> Register-PSFModuleScope -Name WinPSAllUsers -Path 'C:\Program Files\WindowsPowerShell\Modules'
@@ -57,7 +63,11 @@
5763
$ScriptBlock,
5864

5965
[string]
60-
$Description
66+
$Description,
67+
68+
[Parameter(ParameterSetName = 'Path')]
69+
[switch]
70+
$Persist
6171
)
6272
process {
6373
$typeMap = @{
@@ -72,6 +82,14 @@
7282
ScriptBlock = $ScriptBlock
7383
Description = $Description
7484
}
85+
86+
if ($Persist) {
87+
Set-PSFConfig -Module 'PSFramework.NuGet' -Name "ModuleScopes.$Name.Path" -Value $Path -PassThru | Register-PSFConfig
88+
if ($Description) {
89+
Set-PSFConfig -Module 'PSFramework.NuGet' -Name "ModuleScopes.$Name.Description" -Value $Description -PassThru | Register-PSFConfig
90+
}
91+
}
92+
7593
if (-not $Mode) { return }
7694

7795
$envPaths = $env:PSModulePath -split ';'

‎PSFramework.NuGet/functions/Get/Save-PSFModule.ps1

+1-1
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@
226226
$shouldProcessMessage = "Saving modules to $Path"
227227
$managedSessions = New-ManagedSession -ComputerName $ComputerName -Credential $RemotingCredential -Cmdlet $Cmdlet -Type Temporary
228228
if ($ComputerName -and -not $managedSessions) {
229-
Stop-PSFFunction -String 'Save-PSFModule.Error.NoComputerValid' -EnableException ($ErrorActionPreference -eq 'Stop') -Cmdlet $Cmdlet
229+
Stop-PSFFunction -String 'Save-PSFModule.Error.NoComputerValid' -StringValues ($ComputerName -join ', ') -EnableException ($ErrorActionPreference -eq 'Stop') -Cmdlet $Cmdlet
230230
return
231231
}
232232
$resolvedPaths = Resolve-RemotePath -Path $Path -ComputerName $managedSessions.Session -ManagedSession $managedSessions -TargetHandling Any -Cmdlet $Cmdlet # Errors for bad paths, terminates if no path

0 commit comments

Comments
 (0)