Skip to content

Commit 1459c9a

Browse files
FriedrichWeinmannFriedrichWeinmann
committed
updates
1 parent 63c1cbe commit 1459c9a

11 files changed

+268
-4
lines changed

‎PSFramework.NuGet/PSFramework.NuGet.psd1

+2
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,15 @@
4141
# Functions to export from this module
4242
FunctionsToExport = @(
4343
'Find-PSFModule'
44+
'Get-PSFModuleScope'
4445
'Get-PSFModuleSignature'
4546
'Get-PSFPowerShellGet'
4647
'Get-PSFRepository'
4748
'Install-PSFModule'
4849
'Install-PSFPowerShellGet'
4950
'Publish-PSFModule'
5051
'Publish-PSFResourceModule'
52+
'Register-PSFModuleScope'
5153
'Save-PSFModule'
5254
'Save-PSFPowerShellGet'
5355
'Save-PSFResourceModule'

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

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
function Get-PSFModuleScope {
2+
<#
3+
.SYNOPSIS
4+
Lists the registered module scopes.
5+
6+
.DESCRIPTION
7+
Lists the registered module scopes.
8+
These are used as presets with Install-PSFModule's '-Scope' parameter.
9+
10+
Use Register-PSFModuleScope to add additional scopes.
11+
12+
.PARAMETER Name
13+
The name of the scope to filter by.
14+
Defaults to '*'
15+
16+
.EXAMPLE
17+
PS C:\> Get-PSFModuleScope
18+
19+
Lists all registered module scopes.
20+
#>
21+
[CmdletBinding()]
22+
param (
23+
[PsfArgumentCompleter('PSFramework.NuGet.ModuleScope')]
24+
[string]
25+
$Name = '*'
26+
)
27+
process {
28+
($script:moduleScopes.Values) | Where-Object Name -Like $Name
29+
}
30+
}

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

+54-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,60 @@
11
function Install-PSFModule
22
{
3-
[CmdletBinding()]
3+
[CmdletBinding(PositionalBinding = $false, DefaultParameterSetName = 'ByName', SupportsShouldProcess = $true)]
44
Param (
5-
5+
[Parameter(Mandatory = $true, Position = 0, ParameterSetName = 'ByName')]
6+
[string[]]
7+
$Name,
8+
9+
[Parameter(ParameterSetName = 'ByName')]
10+
[string]
11+
$Version,
12+
13+
[Parameter(ParameterSetName = 'ByName')]
14+
[switch]
15+
$Prerelease,
16+
17+
[PsfValidateSet(TabCompletion = 'PSFramework.NuGet.ModuleScope')]
18+
[PsfArgumentCompleter('PSFramework.NuGet.ModuleScope')]
19+
[string]
20+
$Scope,
21+
22+
[PSFComputer[]]
23+
$ComputerName,
24+
25+
[switch]
26+
$SkipDependency,
27+
28+
[switch]
29+
$AuthenticodeCheck = (Get-PSFConfigValue -FullName 'PSFramework.NuGet.Install.AuthenticodeSignature.Check'),
30+
31+
[switch]
32+
$Force,
33+
34+
[PSCredential]
35+
$Credential,
36+
37+
[PSCredential]
38+
$RemotingCredential,
39+
40+
[ValidateRange(1, [int]::MaxValue)]
41+
[int]
42+
$ThrottleLimit = (Get-PSFConfigValue -FullName 'PSFramework.NuGet.Remoting.Throttling'),
43+
44+
[PsfArgumentCompleter('PSFramework.NuGet.Repository')]
45+
[string[]]
46+
$Repository = ((Get-PSFrepository).Name | Sort-Object -Unique),
47+
48+
[switch]
49+
$TrustRepository,
50+
51+
[ValidateSet('All', 'V2', 'V3')]
52+
[string]
53+
$Type = 'All',
54+
55+
[Parameter(Mandatory = $true, ValueFromPipeline = $true, ParameterSetName = 'ByObject')]
56+
[object[]]
57+
$InputObject
658
)
759

860
begin

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

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
function Register-PSFModuleScope {
2+
<#
3+
.SYNOPSIS
4+
Provide a scope you can install modules to.
5+
6+
.DESCRIPTION
7+
Provide a scope you can install modules to.
8+
Those are used by Install-PFModule to pick what path to install to.
9+
10+
.PARAMETER Name
11+
Name of the scope.
12+
Must be unique, otherwise it will overwrite an existing scope.
13+
14+
.PARAMETER Path
15+
Path where modules should be stored.
16+
17+
.PARAMETER Mode
18+
Specifying a mode will add the path provided to the PSModulePath variable for this session.
19+
- Append: Adds the path as the last option, making it the last location PowerShell will look for modules.
20+
- Prepend: Adds the path as the first option, making it take precedence over all other module paths.
21+
22+
.PARAMETER ScriptBlock
23+
Logic determining, where modules should be stored.
24+
This scriptblock will not receive any parameters.
25+
Used to dynamically determine the path, may be executed against remote computers,
26+
when installing to remote computers.
27+
Keep in mind that dependencies may not be available.
28+
29+
.PARAMETER Description
30+
A description to add to the module scope registered.
31+
Purely for documentation purposes.
32+
33+
.EXAMPLE
34+
PS C:\> Register-PSFModuleScope -Name WinPSAllUsers -Path 'C:\Program Files\WindowsPowerShell\Modules'
35+
36+
Registers the module-scope "WinPSAllusers" with the default path for Modules in Windows PowerShell.
37+
This would allow installing modules for Windows PowerShell from PowerShell 7.
38+
#>
39+
[CmdletBinding()]
40+
param (
41+
[Parameter(Mandatory = $true)]
42+
[string]
43+
$Name,
44+
45+
[Parameter(Mandatory = $true, ParameterSetName = 'Path')]
46+
[string]
47+
$Path,
48+
49+
[Parameter(ParameterSetName = 'Path')]
50+
[ValidateSet('Append', 'Prepend')]
51+
[string]
52+
$Mode,
53+
54+
[Parameter(Mandatory = $true, ParameterSetName = 'Scriptblock')]
55+
[PsfValidateLanguageMode('FullLanguage')]
56+
[scriptblock]
57+
$ScriptBlock,
58+
59+
[string]
60+
$Description
61+
)
62+
process {
63+
$typeMap = @{
64+
$true = 'Dynamic'
65+
$false = 'Static'
66+
}
67+
$script:moduleScopes[$Name] = [PSCustomObject]@{
68+
PSTypeName = 'PSFramework.NuGet.ModulePath'
69+
Name = $Name
70+
Type = $typeMap[($ScriptBlock -as [bool])]
71+
Path = $Path
72+
ScriptBlock = $ScriptBlock
73+
Description = $Description
74+
}
75+
if (-not $Mode) { return }
76+
77+
$envPaths = $env:PSModulePath -split ';'
78+
if ($Path -in $envPaths) { return }
79+
switch ($Mode) {
80+
'Append' {
81+
$envPaths = @($envPaths) + $Path
82+
}
83+
'Prepend' {
84+
$envPaths = @($Path) + $envPaths
85+
}
86+
}
87+
$env:PSModulePath = $envPaths -join ';'
88+
}
89+
}

‎PSFramework.NuGet/internal/moduleScopes/AllUsers.scope.ps1

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
$code = {
2+
if ($PSVersionTable.PSVersion.Major -le 5) {
3+
return "$([Environment]::GetFolderPath("ProgramFiles"))\WindowsPowerShell\Modules"
4+
}
5+
if ($IsWindows) {
6+
return "$([Environment]::GetFolderPath("ProgramFiles"))\PowerShell\Modules"
7+
}
8+
'/usr/local/share/powershell/Modules'
9+
}
10+
$scopeParam = @{
11+
Name = 'AllUsers'
12+
ScriptBlock = $code
13+
Description = 'Default path for modules visible to all users.'
14+
}
15+
Register-PSFModuleScope @scopeParam

‎PSFramework.NuGet/internal/moduleScopes/AllUsersWinPS.scope.ps1

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
$code = {
2+
if ($PSVersionTable.PSVersion.Major -le 5) {
3+
return "$([Environment]::GetFolderPath("ProgramFiles"))\WindowsPowerShell\Modules"
4+
}
5+
if ($IsWindows) {
6+
return "$([Environment]::GetFolderPath("ProgramFiles"))\WindowsPowerShell\Modules"
7+
}
8+
'/usr/local/share/powershell/Modules'
9+
}
10+
$scopeParam = @{
11+
Name = 'AllUsersWinPS'
12+
ScriptBlock = $code
13+
Description = 'Default PS 5.1 path for modules visible to all users. Modules will be available to all versions of PowerShell. Will still work on non-Windows systems, but be no different to "AllUsers".'
14+
}
15+
Register-PSFModuleScope @scopeParam

‎PSFramework.NuGet/internal/moduleScopes/CurrentUser.scope.ps1

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
$code = {
2+
if ($PSVersionTable.PSVersion.Major -le 5) {
3+
return "$([Environment]::GetFolderPath("MyDocuments"))\WindowsPowerShell\Modules"
4+
}
5+
if ($IsWindows) {
6+
return "$([Environment]::GetFolderPath("MyDocuments"))\PowerShell\Modules"
7+
}
8+
'~/.local/share/powershell/Modules'
9+
}
10+
$scopeParam = @{
11+
Name = 'CurrentUser'
12+
ScriptBlock = $code
13+
Description = 'Default path for modules visible to the current user only.'
14+
}
15+
Register-PSFModuleScope @scopeParam

‎PSFramework.NuGet/internal/scripts/postimport.ps1

+4-1
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,7 @@ $moduleRoot = Split-Path (Split-Path $PSScriptRoot)
2626
"$moduleRoot\internal\scripts\initialize.ps1"
2727

2828
# Load License
29-
"$moduleRoot\internal\scripts\license.ps1"
29+
"$moduleRoot\internal\scripts\license.ps1"
30+
31+
# Load Module Scopes
32+
(Get-ChildItem "$moduleRoot\internal\moduleScopes\*.ps1" -ErrorAction Ignore).FullName

‎PSFramework.NuGet/internal/scripts/variables.ps1

+4-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,7 @@ $script:psget = @{
77
'v3' = $configuration.V3
88
}
99
#>
10-
$script:psget = @{ }
10+
$script:psget = @{ }
11+
12+
# What paths are available for Install-PSFModule's "-Scope" parameter
13+
$script:moduleScopes = @{ }

‎PSFramework.NuGet/internal/tepp/modulescope.tepp.ps1

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Register-PSFTeppScriptblock -Name 'PSFramework.NuGet.ModuleScope' -ScriptBlock {
2+
foreach ($scope in Get-PSFModuleScope) {
3+
@{ Text = $scope.Name; ToolTip = $scope.Description }
4+
}
5+
} -Global

‎PSFramework.NuGet/xml/PSFramework.NuGet.Format.ps1xml

+35
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,41 @@
4848
</TableControl>
4949
</View>
5050

51+
<!-- PSFramework.NuGet.ModulePath -->
52+
<View>
53+
<Name>PSFramework.NuGet.ModulePath</Name>
54+
<ViewSelectedBy>
55+
<TypeName>PSFramework.NuGet.ModulePath</TypeName>
56+
</ViewSelectedBy>
57+
<TableControl>
58+
<AutoSize/>
59+
<TableHeaders>
60+
<TableColumnHeader/>
61+
<TableColumnHeader/>
62+
<TableColumnHeader/>
63+
<TableColumnHeader/>
64+
</TableHeaders>
65+
<TableRowEntries>
66+
<TableRowEntry>
67+
<TableColumnItems>
68+
<TableColumnItem>
69+
<PropertyName>Name</PropertyName>
70+
</TableColumnItem>
71+
<TableColumnItem>
72+
<PropertyName>Type</PropertyName>
73+
</TableColumnItem>
74+
<TableColumnItem>
75+
<PropertyName>Description</PropertyName>
76+
</TableColumnItem>
77+
<TableColumnItem>
78+
<PropertyName>Path</PropertyName>
79+
</TableColumnItem>
80+
</TableColumnItems>
81+
</TableRowEntry>
82+
</TableRowEntries>
83+
</TableControl>
84+
</View>
85+
5186
<!-- PSFramework.NuGet.PublishResult -->
5287
<View>
5388
<Name>PSFramework.NuGet.PublishResult</Name>

0 commit comments

Comments
 (0)