Skip to content

Commit b49a6c5

Browse files
alericksonalerickson
authored
Change "IncludeXML" to "IncludeXml" (#739)
1 parent 767cb52 commit b49a6c5

File tree

7 files changed

+18
-18
lines changed

7 files changed

+18
-18
lines changed

‎help/Save-PSResource.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ Saves resources (modules and scripts) from a registered repository onto the mach
1515
### NameParameterSet
1616
```
1717
Save-PSResource [-Name] <String[]> [-Version <String>] [-Prerelease] [-Repository <String[]>]
18-
[-Credential <PSCredential>] [-AsNupkg] [-IncludeXML] [-Path <String>] [-TrustRepository] [-SkipDependencyCheck] [-AuthenticodeCheck] [-PassThru] [-Quiet] [-WhatIf] [-Confirm] [<CommonParameters>]
18+
[-Credential <PSCredential>] [-AsNupkg] [-IncludeXml] [-Path <String>] [-TrustRepository] [-SkipDependencyCheck] [-AuthenticodeCheck] [-PassThru] [-Quiet] [-WhatIf] [-Confirm] [<CommonParameters>]
1919
```
2020

2121
### InputObjectParameterSet
2222
```
2323
Save-PSResource [-InputObject] <PSResourceInfo> [-Credential <PSCredential>] [-AsNupkg]
24-
[-IncludeXML] [-Path <String>] [-TrustRepository] [-SkipDependencyCheck] [-PassThru] [-Quiet] [-WhatIf] [-Confirm] [<CommonParameters>]
24+
[-IncludeXml] [-Path <String>] [-TrustRepository] [-SkipDependencyCheck] [-PassThru] [-Quiet] [-WhatIf] [-Confirm] [<CommonParameters>]
2525
```
2626

2727
## DESCRIPTION
@@ -50,7 +50,7 @@ Saves the Az module as a .nupkg file
5050

5151
### Example 4
5252
```powershell
53-
PS C:\> Save-PSResource Az -IncludeXML
53+
PS C:\> Save-PSResource Az -IncludeXml
5454
```
5555
Saves the Az module and includes the PowerShellGet XML metadata
5656

@@ -155,7 +155,7 @@ Accept pipeline input: False
155155
Accept wildcard characters: False
156156
```
157157

158-
### -IncludeXML
158+
### -IncludeXml
159159
Includes the PowerShellGet metadata XML (used to verify that PowerShellGet has installed a module).
160160

161161
```yaml

‎help/en-US/PowerShellGet.dll-Help.xml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2406,7 +2406,7 @@ PS C:\&gt; Get-PSResourceRepository
24062406
<dev:defaultValue>False</dev:defaultValue>
24072407
</command:parameter>
24082408
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
2409-
<maml:name>IncludeXML</maml:name>
2409+
<maml:name>IncludeXml</maml:name>
24102410
<maml:description>
24112411
<maml:para>Includes the PowerShellGet metadata XML (used to verify that PowerShellGet has installed a module).</maml:para>
24122412
</maml:description>
@@ -2594,7 +2594,7 @@ PS C:\&gt; Get-PSResourceRepository
25942594
<dev:defaultValue>False</dev:defaultValue>
25952595
</command:parameter>
25962596
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
2597-
<maml:name>IncludeXML</maml:name>
2597+
<maml:name>IncludeXml</maml:name>
25982598
<maml:description>
25992599
<maml:para>Includes the PowerShellGet metadata XML (used to verify that PowerShellGet has installed a module).</maml:para>
26002600
</maml:description>
@@ -2745,7 +2745,7 @@ PS C:\&gt; Get-PSResourceRepository
27452745
</command:example>
27462746
<command:example>
27472747
<maml:title>-------------------------- Example 4 --------------------------</maml:title>
2748-
<dev:code>PS C:\&gt; Save-PSResource Az -IncludeXML</dev:code>
2748+
<dev:code>PS C:\&gt; Save-PSResource Az -IncludeXml</dev:code>
27492749
<dev:remarks>
27502750
<maml:para>Saves the Az module and includes the PowerShellGet XML metadata</maml:para>
27512751
</dev:remarks>

‎src/code/InstallHelper.cs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ internal class InstallHelper : PSCmdlet
4747
private bool _trustRepository;
4848
private PSCredential _credential;
4949
private bool _asNupkg;
50-
private bool _includeXML;
50+
private bool _includeXml;
5151
private bool _noClobber;
5252
private bool _authenticodeCheck;
5353
private bool _savePkg;
@@ -78,14 +78,14 @@ public List<PSResourceInfo> InstallPackages(
7878
bool noClobber,
7979
PSCredential credential,
8080
bool asNupkg,
81-
bool includeXML,
81+
bool includeXml,
8282
bool skipDependencyCheck,
8383
bool authenticodeCheck,
8484
bool savePkg,
8585
List<string> pathsToInstallPkg)
8686
{
8787
_cmdletPassedIn.WriteVerbose(string.Format("Parameters passed in >>> Name: '{0}'; Version: '{1}'; Prerelease: '{2}'; Repository: '{3}'; " +
88-
"AcceptLicense: '{4}'; Quiet: '{5}'; Reinstall: '{6}'; TrustRepository: '{7}'; NoClobber: '{8}'; AsNupkg: '{9}'; IncludeXML '{10}'; SavePackage '{11}'",
88+
"AcceptLicense: '{4}'; Quiet: '{5}'; Reinstall: '{6}'; TrustRepository: '{7}'; NoClobber: '{8}'; AsNupkg: '{9}'; IncludeXml '{10}'; SavePackage '{11}'",
8989
string.Join(",", names),
9090
versionRange != null ? (versionRange.OriginalString != null ? versionRange.OriginalString : string.Empty) : string.Empty,
9191
prerelease.ToString(),
@@ -96,7 +96,7 @@ public List<PSResourceInfo> InstallPackages(
9696
trustRepository.ToString(),
9797
noClobber.ToString(),
9898
asNupkg.ToString(),
99-
includeXML.ToString(),
99+
includeXml.ToString(),
100100
savePkg.ToString()));
101101

102102
_versionRange = versionRange;
@@ -110,7 +110,7 @@ public List<PSResourceInfo> InstallPackages(
110110
_noClobber = noClobber;
111111
_credential = credential;
112112
_asNupkg = asNupkg;
113-
_includeXML = includeXML;
113+
_includeXml = includeXml;
114114
_savePkg = savePkg;
115115
_pathsToInstallPkg = pathsToInstallPkg;
116116

@@ -557,7 +557,7 @@ private List<PSResourceInfo> InstallPackage(
557557
// Delete the extra nupkg related files that are not needed and not part of the module/script
558558
DeleteExtraneousFiles(pkgIdentity, tempDirNameVersion);
559559

560-
if (_includeXML)
560+
if (_includeXml)
561561
{
562562
CreateMetadataXMLFile(tempDirNameVersion, installPath, pkg, isModule);
563563
}

‎src/code/InstallPSResource.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -524,7 +524,7 @@ private void ProcessInstallHelper(string[] pkgNames, VersionRange pkgVersion, bo
524524
noClobber: NoClobber,
525525
credential: pkgCredential,
526526
asNupkg: false,
527-
includeXML: true,
527+
includeXml: true,
528528
skipDependencyCheck: SkipDependencyCheck,
529529
authenticodeCheck: AuthenticodeCheck,
530530
savePkg: false,

‎src/code/SavePSResource.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ public sealed class SavePSResource : PSCmdlet
7676
/// Saves the metadata XML file with the resource
7777
/// </summary>
7878
[Parameter]
79-
public SwitchParameter IncludeXML { get; set; }
79+
public SwitchParameter IncludeXml { get; set; }
8080

8181
/// <summary>
8282
/// The destination where the resource is to be installed. Works for all resource types.
@@ -264,7 +264,7 @@ private void ProcessSaveHelper(string[] pkgNames, bool pkgPrerelease, string[] p
264264
credential: Credential,
265265
noClobber: false,
266266
asNupkg: AsNupkg,
267-
includeXML: IncludeXML,
267+
includeXml: IncludeXml,
268268
skipDependencyCheck: SkipDependencyCheck,
269269
authenticodeCheck: AuthenticodeCheck,
270270
savePkg: true,

‎src/code/UpdatePSResource.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ protected override void ProcessRecord()
183183
credential: Credential,
184184
noClobber: false,
185185
asNupkg: false,
186-
includeXML: true,
186+
includeXml: true,
187187
skipDependencyCheck: SkipDependencyCheck,
188188
authenticodeCheck: AuthenticodeCheck,
189189
savePkg: false,

‎test/SavePSResource.Tests.ps1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ Describe 'Test Save-PSResource for PSResources' {
217217
}
218218

219219
It "Save module and include XML metadata file" {
220-
Save-PSResource -Name $testModuleName -Version "1.0.0" -Repository $PSGalleryName -Path $SaveDir -IncludeXML -TrustRepository
220+
Save-PSResource -Name $testModuleName -Version "1.0.0" -Repository $PSGalleryName -Path $SaveDir -IncludeXml -TrustRepository
221221
$pkgDir = Get-ChildItem -Path $SaveDir | Where-Object Name -eq $testModuleName
222222
$pkgDir | Should -Not -BeNullOrEmpty
223223
$pkgDirVersion = Get-ChildItem -Path $pkgDir.FullName

0 commit comments

Comments
 (0)