Skip to content

Commit b40e987

Browse files
authored
Rename params: *url to *uri (#551)
Rename params *url to *uri
1 parent 993eacc commit b40e987

22 files changed

+280
-280
lines changed

build.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ param (
4040
[string] $BuildFramework = "netstandard2.0"
4141
)
4242

43-
if ( ! ( Get-Module -ErrorAction SilentlyContinue PSPackageProject) ) {
43+
if ( -not (Get-Module -ErrorAction SilentlyContinue PSPackageProject) -and -not (Import-Module -PassThru -ErrorAction SilentlyContinue PSPackageProject -MinimumVersion 0.1.18) ) {
4444
Install-Module -Name PSPackageProject -MinimumVersion 0.1.18 -Force
4545
}
4646

help/Get-PSResourceRepository.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The Get-PSResourceRepository cmdlet searches for the PowerShell resource reposit
2424
### Example 1
2525
```
2626
PS C:\> Get-PSResourceRepository -Name "PSGallery"
27-
Name Url Trusted Priority
27+
Name Uri Trusted Priority
2828
---- --- ------- --------
2929
PSGallery https://www.powershellgallery.com/api/v2 False 50
3030
```
@@ -34,7 +34,7 @@ This example runs the command with the 'Name' parameter being set to "PSGallery"
3434
### Example 2
3535
```
3636
PS C:\> Get-PSResourceRepository -Name "*Gallery"
37-
Name Url Trusted Priority
37+
Name Uri Trusted Priority
3838
---- --- ------- --------
3939
PoshTestGallery https://www.poshtestgallery.com/api/v2 True 40
4040
PSGallery https://www.powershellgallery.com/api/v2 False 50
@@ -46,7 +46,7 @@ This example runs the command with the 'Name' parameter being set to "*Gallery"
4646
### Example 3
4747
```
4848
PS C:\> Get-PSResourceRepository -Name "PSGallery","PoshTestGallery"
49-
Name Url Trusted Priority
49+
Name Uri Trusted Priority
5050
---- --- ------- --------
5151
PoshTestGallery https://www.poshtestgallery.com/api/v2 True 40
5252
PSGallery https://www.powershellgallery.com/api/v2 False 50
@@ -58,7 +58,7 @@ This example runs the command with the 'Name' parameter being set to an array of
5858
### Example 4
5959
```
6060
PS C:\> Get-PSResourceRepository -Name "*"
61-
Name Url Trusted Priority
61+
Name Uri Trusted Priority
6262
---- --- ------- --------
6363
PoshTestGallery https://www.poshtestgallery.com/api/v2 True 40
6464
PSGallery https://www.powershellgallery.com/api/v2 False 50

help/Register-PSResourceRepository.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Registers a repository for PowerShell resources.
1414

1515
### NameParameterSet (Default)
1616
```
17-
Register-PSResourceRepository [-Name] <String> [-URL] <String> [-Trusted] [-Priority <Int32>] [-PassThru]
17+
Register-PSResourceRepository [-Name] <String> [-Uri] <String> [-Trusted] [-Priority <Int32>] [-PassThru]
1818
[-WhatIf] [-Confirm] [<CommonParameters>]
1919
```
2020

@@ -36,32 +36,32 @@ The Register-PSResourceRepository cmdlet registers a repository for PowerShell r
3636
These examples assume that the repository we attempt to register is not already registered on the user's machine.
3737
### Example 1
3838
```
39-
PS C:\> Register-PSResourceRepository -Name "PoshTestGallery" -URL "https://www.powershellgallery.com/api/v2"
39+
PS C:\> Register-PSResourceRepository -Name "PoshTestGallery" -Uri "https://www.powershellgallery.com/api/v2"
4040
PS C:\> Get-PSResourceRepository -Name "PoshTestGallery"
41-
Name Url Trusted Priority
41+
Name Uri Trusted Priority
4242
---- --- ------- --------
4343
PoshTestGallery https://www.poshtestgallery.com/api/v2 False 50
4444
```
4545

46-
This example registers the repository with the `-Name` of "PoshTestGallery" along with the associated `URL` value for it.
46+
This example registers the repository with the `-Name` of "PoshTestGallery" along with the associated `Uri` value for it.
4747

4848
### Example 2
4949
```
5050
PS C:\> Register-PSResourceRepository -PSGallery
5151
PS C:\> Get-PSResourceRepository -Name "PSGallery"
52-
Name Url Trusted Priority
52+
Name Uri Trusted Priority
5353
---- --- ------- --------
5454
PSGallery https://www.powershellgallery.com/api/v2 False 50
5555
```
5656

57-
This example registers the "PSGallery" repository, with the 'PSGallery' parameter. Unlike the previous example, we cannot use the `-Name` or `-URL` parameters to register the "PSGallery" repository as it is considered Powershell's default repository store and has its own value for URL.
57+
This example registers the "PSGallery" repository, with the 'PSGallery' parameter. Unlike the previous example, we cannot use the `-Name` or `-Uri` parameters to register the "PSGallery" repository as it is considered Powershell's default repository store and has its own value for Uri.
5858

5959
### Example 3
6060
```
61-
PS C:\> $arrayOfHashtables = @{Name = "psgettestlocal"; URL = "c:/code/testdir"},@{PSGallery = $True}
61+
PS C:\> $arrayOfHashtables = @{Name = "psgettestlocal"; Uri = "c:/code/testdir"}, @{PSGallery = $True}
6262
PS C:\> Register-PSResourceRepository -Repositories $arrayOfHashtables
6363
PS C:\> Get-PSResourceRepository
64-
Name Url Trusted Priority
64+
Name Uri Trusted Priority
6565
---- --- ------- --------
6666
PSGallery https://www.powershellgallery.com/api/v2 False 50
6767
psgettestlocal file:///c:/code/testdir False 50
@@ -149,9 +149,9 @@ Accept pipeline input: False
149149
Accept wildcard characters: False
150150
```
151151
152-
### -URL
152+
### -Uri
153153
Specifies the location of the repository to be registered.
154-
URL can be of the following Uri schemas: HTTPS, HTTP, FTP, file share based.
154+
Uri can be of the following Uri schemas: HTTPS, HTTP, FTP, file share based.
155155
156156
```yaml
157157
Type: String
@@ -225,8 +225,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
225225
## NOTES
226226
Repositories are unique by 'Name'. Attempting to register a repository with same 'Name' as an already registered repository will not successfully register.
227227
228-
Registering the PSGallery repository must be done via the PSGalleryParameterSet (i.e by using the 'PSGallery' parameter instead of 'Name' and 'URL' parameters).
228+
Registering the PSGallery repository must be done via the PSGalleryParameterSet (i.e by using the 'PSGallery' parameter instead of 'Name' and 'Uri' parameters).
229229
230-
URL string input must be of one of the following Uri schemes: HTTP, HTTPS, FTP, File
230+
Uri string input must be of one of the following Uri schemes: HTTP, HTTPS, FTP, File
231231
232232
## RELATED LINKS

help/Set-PSResourceRepository.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Sets information for a registered repository.
1414

1515
### NameParameterSet (Default)
1616
```
17-
Set-PSResourceRepository [-Name] <String> [-URL <String>] [-Trusted] [-Priority <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]
17+
Set-PSResourceRepository [-Name] <String> [-Uri <String>] [-Trusted] [-Priority <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]
1818
```
1919

2020
### RepositoriesParameterSet
@@ -30,43 +30,43 @@ These examples are run independently of each other and assume the repositories u
3030
### Example 1
3131
```powershell
3232
PS C:\> Get-PSResourceRepository -Name "PoshTestGallery"
33-
Name Url Trusted Priority
33+
Name Uri Trusted Priority
3434
---- --- ------- --------
3535
PoshTestGallery https://www.poshtestgallery.com/api/v2 False 50
36-
PS C:\> Set-PSResourceRepository -Name "PoshTestGallery" -URL "c:/code/testdir" -PassThru
37-
Name Url Trusted Priority
36+
PS C:\> Set-PSResourceRepository -Name "PoshTestGallery" -Uri "c:/code/testdir" -PassThru
37+
Name Uri Trusted Priority
3838
---- --- ------- --------
3939
PoshTestGallery file:///c:/code/testdir False 50
4040
```
4141

42-
This example first checks if the PoshTestGallery repository has been registered. We wish to set the `-URL` value of this repository by running the Set-PSResourceRepository cmdlet with the `-URL` parameter and a valid Uri scheme url. We run the Get-PSResourceRepository cmdlet again to ensure that the `-URL` of the repository was changed. We also use the `-PassThru` parameter to see the changed repository.
42+
This example first checks if the PoshTestGallery repository has been registered. We wish to set the `-Uri` value of this repository by running the Set-PSResourceRepository cmdlet with the `-Uri` parameter and a valid Uri scheme Uri. We run the Get-PSResourceRepository cmdlet again to ensure that the `-Uri` of the repository was changed. We also use the `-PassThru` parameter to see the changed repository.
4343

4444
### Example 2
4545
```powershell
4646
PS C:\> Get-PSResourceRepository -Name "PSGallery"
47-
Name Url Trusted Priority
47+
Name Uri Trusted Priority
4848
---- --- ------- --------
4949
PSGallery https://www.powershellgallery.com/api/v2 False 50
5050
PS C:\> Set-PSResourceRepository -Name "PSGallery" -Priority 25 -Trusted -PassThru
51-
Name Url Trusted Priority
51+
Name Uri Trusted Priority
5252
---- --- ------- --------
5353
PSGallery https://www.powershellgallery.com/api/v2 True 25
5454
```
5555

56-
This example first checks if the PSGallery repository has been registered. We wish to set the `-Priority` and `-Trusted` values of this repository by running the Set-PSResourceRepository cmdlet with the `-Priority` parameter set to a value between 0 and 50 and by using the `-Trusted` parameter switch. We run the Get-PSResourceRepository cmdlet again to ensure that the `-Priority` and `-Trusted` values of the repository were changed. An important note here is that just for the default PSGallery repository, the `-URL` value can't be changed/set. We also use the `-PassThru` parameter to see the changed repository.
56+
This example first checks if the PSGallery repository has been registered. We wish to set the `-Priority` and `-Trusted` values of this repository by running the Set-PSResourceRepository cmdlet with the `-Priority` parameter set to a value between 0 and 50 and by using the `-Trusted` parameter switch. We run the Get-PSResourceRepository cmdlet again to ensure that the `-Priority` and `-Trusted` values of the repository were changed. An important note here is that just for the default PSGallery repository, the `-Uri` value can't be changed/set. We also use the `-PassThru` parameter to see the changed repository.
5757

5858
### Example 3
5959
```powershell
6060
PS C:\> Get-PSResourceRepository -Name "*"
61-
Name Url Trusted Priority
61+
Name Uri Trusted Priority
6262
---- --- ------- --------
6363
PSGallery https://www.powershellgallery.com/api/v2 False 50
6464
PoshTestGallery https://www.poshtestgallery.com/api/v2 False 50
6565
66-
PS C:\> $arrayOfHashtables = @{Name = "PSGallery"; Trusted = $True},@{Name = "PoshTestGallery"; URL = "c:/code/testdir"}
66+
PS C:\> $arrayOfHashtables = @{Name = "PSGallery"; Trusted = $True}, @{Name = "PoshTestGallery"; Uri = "c:/code/testdir"}
6767
6868
PS C:\> Set-PSResourceRepository -Repositories $arrayOfHashtables -PassThru
69-
Name Url Trusted Priority
69+
Name Uri Trusted Priority
7070
---- --- ------- --------
7171
PSGallery https://www.powershellgallery.com/api/v2 True 50
7272
PoshTestGallery file:///c:/code/testdir False 50
@@ -121,7 +121,7 @@ Accept pipeline input: False
121121
Accept wildcard characters: False
122122
```
123123
124-
### -URL
124+
### -Uri
125125
Specifies the location of the repository to be set.
126126
127127
```yaml

help/Unregister-PSResourceRepository.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ In this example, we assume the repository "PoshTestGallery" has been previously
3636
### Example 2
3737
```
3838
PS C:\> Get-PSResourceRepository
39-
Name Url Trusted Priority
39+
Name Uri Trusted Priority
4040
---- --- ------- --------
4141
PoshTestGallery https://www.poshtestgallery.com/api/v2 True 40
4242
PSGallery https://www.powershellgallery.com/api/v2 False 50
4343
psgettestlocal file:///c:/code/testdir True 50
4444
4545
PS C:\> Unregister-PSResourceRepository -Name "PoshTestGallery","psgettestlocal"
4646
PS C:\> Get-PSResourceRepository
47-
Name Url Trusted Priority
47+
Name Uri Trusted Priority
4848
---- --- ------- --------
4949
PSGallery https://www.powershellgallery.com/api/v2 False 50
5050
@@ -75,7 +75,7 @@ Passes the resource installed to the console.
7575
```yaml
7676
Type: SwitchParameter
7777
Parameter Sets: (All)
78-
Aliases:
78+
Aliases:
7979

8080
Required: False
8181
Position: Named

src/PSGet.Format.ps1xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,15 +69,15 @@
6969
<TableControl>
7070
<TableHeaders>
7171
<TableColumnHeader><Label>Name</Label></TableColumnHeader>
72-
<TableColumnHeader><Label>Url</Label></TableColumnHeader>
72+
<TableColumnHeader><Label>Uri</Label></TableColumnHeader>
7373
<TableColumnHeader><Label>Trusted</Label></TableColumnHeader>
7474
<TableColumnHeader><Label>Priority</Label></TableColumnHeader>
7575
</TableHeaders>
7676
<TableRowEntries>
7777
<TableRowEntry>
7878
<TableColumnItems>
7979
<TableColumnItem><PropertyName>Name</PropertyName></TableColumnItem>
80-
<TableColumnItem><PropertyName>Url</PropertyName></TableColumnItem>
80+
<TableColumnItem><PropertyName>Uri</PropertyName></TableColumnItem>
8181
<TableColumnItem><PropertyName>Trusted</PropertyName></TableColumnItem>
8282
<TableColumnItem><PropertyName>Priority</PropertyName></TableColumnItem>
8383
</TableColumnItems>

src/PowerShellGet.psd1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,5 +46,5 @@ See change log (CHANGELOG.md) at https://github.com/PowerShell/PowerShellGet
4646
}
4747
}
4848

49-
HelpInfoURI = 'http://go.microsoft.com/fwlink/?linkid=855963'
49+
HelpInfoUri = 'http://go.microsoft.com/fwlink/?linkid=855963'
5050
}

0 commit comments

Comments
 (0)