diff --git a/help/Get-PSResource.md b/help/Get-PSResource.md index c52afbc2b..42239d789 100644 --- a/help/Get-PSResource.md +++ b/help/Get-PSResource.md @@ -135,7 +135,7 @@ PSResourceInfo : { Name PackageManagementProvider PowerShellGetFormatVersion - PrereleaseLabel + Prerelease ProjectUri PublishedDate ReleaseNotes diff --git a/src/PSGet.Format.ps1xml b/src/PSGet.Format.ps1xml index 8baea53f1..24599c165 100644 --- a/src/PSGet.Format.ps1xml +++ b/src/PSGet.Format.ps1xml @@ -19,7 +19,7 @@ Name Version - PrereleaseLabel + Prerelease Repository Description @@ -53,7 +53,7 @@ Name $_.ParentResource.Version - $_.ParentResource.PrereleaseLabel + $_.ParentResource.Prerelease $_.ParentResource.Name $_.ParentResource.Repository diff --git a/src/code/InstallHelper.cs b/src/code/InstallHelper.cs index 5094b1f02..e7d3dea58 100644 --- a/src/code/InstallHelper.cs +++ b/src/code/InstallHelper.cs @@ -347,7 +347,7 @@ private List InstallPackage( string createFullVersion = pkg.Version.ToString(); if (pkg.IsPrerelease) { - createFullVersion = pkg.Version.ToString() + "-" + pkg.PrereleaseLabel; + createFullVersion = pkg.Version.ToString() + "-" + pkg.Prerelease; } if (!NuGetVersion.TryParse(createFullVersion, out NuGetVersion pkgVersion)) @@ -449,11 +449,11 @@ private List InstallPackage( // pkgIdentity.Version.Version gets the version without metadata or release labels. string newVersion = pkgIdentity.Version.ToNormalizedString(); - string normalizedVersionNoPrereleaseLabel = newVersion; + string normalizedVersionNoPrerelease = newVersion; if (pkgIdentity.Version.IsPrerelease) { // eg: 2.0.2 - normalizedVersionNoPrereleaseLabel = pkgIdentity.Version.ToNormalizedString().Substring(0, pkgIdentity.Version.ToNormalizedString().IndexOf('-')); + normalizedVersionNoPrerelease = pkgIdentity.Version.ToNormalizedString().Substring(0, pkgIdentity.Version.ToNormalizedString().IndexOf('-')); } string tempDirNameVersion = isLocalRepo ? tempInstallPath : Path.Combine(tempInstallPath, pkgIdentity.Id.ToLower(), newVersion); diff --git a/src/code/InstallPSResource.cs b/src/code/InstallPSResource.cs index 88fbde63d..ac7688270 100644 --- a/src/code/InstallPSResource.cs +++ b/src/code/InstallPSResource.cs @@ -90,7 +90,7 @@ class InstallPSResource : PSCmdlet /// /// Prevents installing a package that contains cmdlets that already exist on the machine. /// - [Parameter] + [Parameter] public SwitchParameter NoClobber { get; set; } /// @@ -166,7 +166,7 @@ protected override void ProcessRecord() break; case InputObjectParameterSet: - string normalizedVersionString = Utils.GetNormalizedVersionString(InputObject.Version.ToString(), InputObject.PrereleaseLabel); + string normalizedVersionString = Utils.GetNormalizedVersionString(InputObject.Version.ToString(), InputObject.Prerelease); if (!Utils.TryParseVersionOrVersionRange(normalizedVersionString, out _versionRange)) { var exMessage = String.Format("Version '{0}' for resource '{1}' cannot be parsed.", normalizedVersionString, InputObject.Name); diff --git a/src/code/PSResourceInfo.cs b/src/code/PSResourceInfo.cs index 483662a1a..5b434c055 100644 --- a/src/code/PSResourceInfo.cs +++ b/src/code/PSResourceInfo.cs @@ -247,7 +247,7 @@ public sealed class PSResourceInfo public string Name { get; } public string PackageManagementProvider { get; } public string PowerShellGetFormatVersion { get; } - public string PrereleaseLabel { get; } + public string Prerelease { get; } public Uri ProjectUri { get; } public DateTime? PublishedDate { get; } public string ReleaseNotes { get; } @@ -280,7 +280,7 @@ private PSResourceInfo( string name, string packageManagementProvider, string powershellGetFormatVersion, - string prereleaseLabel, + string prerelease, Uri projectUri, DateTime? publishedDate, string releaseNotes, @@ -306,7 +306,7 @@ private PSResourceInfo( Name = name ?? string.Empty; PackageManagementProvider = packageManagementProvider ?? string.Empty; PowerShellGetFormatVersion = powershellGetFormatVersion ?? string.Empty; - PrereleaseLabel = prereleaseLabel ?? string.Empty; + Prerelease = prerelease ?? string.Empty; ProjectUri = projectUri; PublishedDate = publishedDate; ReleaseNotes = releaseNotes ?? string.Empty; @@ -394,7 +394,7 @@ public static bool TryRead( filePath)); var additionalMetadata = GetProperty>(nameof(PSResourceInfo.AdditionalMetadata), psObjectInfo); - Version version = GetVersionInfo(psObjectInfo, additionalMetadata, out string prereleaseLabel); + Version version = GetVersionInfo(psObjectInfo, additionalMetadata, out string prerelease); psGetInfo = new PSResourceInfo( additionalMetadata: additionalMetadata, @@ -412,7 +412,7 @@ public static bool TryRead( name: GetStringProperty(nameof(PSResourceInfo.Name), psObjectInfo), packageManagementProvider: GetStringProperty(nameof(PSResourceInfo.PackageManagementProvider), psObjectInfo), powershellGetFormatVersion: GetStringProperty(nameof(PSResourceInfo.PowerShellGetFormatVersion), psObjectInfo), - prereleaseLabel: prereleaseLabel, + prerelease: prerelease, projectUri: GetProperty(nameof(PSResourceInfo.ProjectUri), psObjectInfo), publishedDate: GetProperty(nameof(PSResourceInfo.PublishedDate), psObjectInfo), releaseNotes: GetStringProperty(nameof(PSResourceInfo.ReleaseNotes), psObjectInfo), @@ -449,10 +449,10 @@ private static string GetStringProperty( private static Version GetVersionInfo( PSObject psObjectInfo, Dictionary additionalMetadata, - out string prereleaseLabel) + out string prerelease) { string versionString = GetProperty(nameof(PSResourceInfo.Version), psObjectInfo); - prereleaseLabel = String.Empty; + prerelease = String.Empty; if (!String.IsNullOrEmpty(versionString) || additionalMetadata.TryGetValue("NormalizedVersion", out versionString)) @@ -472,7 +472,7 @@ private static Version GetVersionInfo( // versionStringParsed.Length > 1 (because string contained '-' so couldn't be 0) // versionString: "1.2.0-alpha1" pkgVersion = versionStringParsed[0]; - prereleaseLabel = versionStringParsed[1]; + prerelease = versionStringParsed[1]; } } @@ -480,7 +480,7 @@ private static Version GetVersionInfo( // parse the pkgVersion parsed out above into a System.Version object if (!Version.TryParse(pkgVersion, out Version parsedVersion)) { - prereleaseLabel = String.Empty; + prerelease = String.Empty; return null; } else @@ -491,7 +491,7 @@ private static Version GetVersionInfo( // version could not be parsed as string, it was written to XML file as a System.Version object // V3 code briefly did so, I believe so we provide support for it - prereleaseLabel = String.Empty; + prerelease = String.Empty; return GetProperty(nameof(PSResourceInfo.Version), psObjectInfo); } @@ -536,7 +536,7 @@ public static bool TryConvert( name: ParseMetadataName(metadataToParse), packageManagementProvider: null, powershellGetFormatVersion: null, - prereleaseLabel: ParsePrerelease(metadataToParse), + prerelease: ParsePrerelease(metadataToParse), projectUri: ParseMetadataProjectUri(metadataToParse), publishedDate: ParseMetadataPublishedDate(metadataToParse), releaseNotes: null, @@ -887,7 +887,7 @@ private PSObject ConvertToCustomObject() { // 1.0.0-alpha1 // 1.0.0.0 - string NormalizedVersion = IsPrerelease ? ConcatenateVersionWithPrerelease(Version.ToString(), PrereleaseLabel) : Version.ToString(); + string NormalizedVersion = IsPrerelease ? ConcatenateVersionWithPrerelease(Version.ToString(), Prerelease) : Version.ToString(); var additionalMetadata = new PSObject(); diff --git a/src/code/SavePSResource.cs b/src/code/SavePSResource.cs index 97dd07ac9..a7e17e3ab 100644 --- a/src/code/SavePSResource.cs +++ b/src/code/SavePSResource.cs @@ -131,11 +131,11 @@ public string Path [Parameter] public SwitchParameter SkipDependencyCheck { get; set; } - /// - /// Suppresses progress information. - /// - [Parameter(ParameterSetName = NameParameterSet)] - [Parameter(ParameterSetName = InputObjectParameterSet)] + /// + /// Suppresses progress information. + /// + [Parameter(ParameterSetName = NameParameterSet)] + [Parameter(ParameterSetName = InputObjectParameterSet)] public SwitchParameter Quiet { get; set; } #endregion @@ -183,7 +183,7 @@ protected override void ProcessRecord() break; case InputObjectParameterSet: - string normalizedVersionString = Utils.GetNormalizedVersionString(InputObject.Version.ToString(), InputObject.PrereleaseLabel); + string normalizedVersionString = Utils.GetNormalizedVersionString(InputObject.Version.ToString(), InputObject.Prerelease); if (!Utils.TryParseVersionOrVersionRange(normalizedVersionString, out _versionRange)) { var exMessage = String.Format("Version '{0}' for resource '{1}' cannot be parsed.", normalizedVersionString, InputObject.Name); diff --git a/src/code/UninstallPSResource.cs b/src/code/UninstallPSResource.cs index 05aa4e886..e52e6c622 100644 --- a/src/code/UninstallPSResource.cs +++ b/src/code/UninstallPSResource.cs @@ -113,8 +113,8 @@ protected override void ProcessRecord() break; case InputObjectParameterSet: - string inputObjectPrereleaseLabel = InputObject.PrereleaseLabel; - string inputObjectVersion = String.IsNullOrEmpty(inputObjectPrereleaseLabel) ? InputObject.Version.ToString() : Utils.GetNormalizedVersionString(versionString: InputObject.Version.ToString(), prerelease: inputObjectPrereleaseLabel); + string inputObjectPrerelease = InputObject.Prerelease; + string inputObjectVersion = String.IsNullOrEmpty(inputObjectPrerelease) ? InputObject.Version.ToString() : Utils.GetNormalizedVersionString(versionString: InputObject.Version.ToString(), prerelease: inputObjectPrerelease); if (!Utils.TryParseVersionOrVersionRange( version: inputObjectVersion, versionRange: out _versionRange)) diff --git a/src/code/Utils.cs b/src/code/Utils.cs index 30e8765c2..95bea6bc9 100644 --- a/src/code/Utils.cs +++ b/src/code/Utils.cs @@ -213,10 +213,10 @@ public static bool GetVersionForInstallPath( } string version = psGetInfo.Version.ToString(); - string prereleaseLabel = psGetInfo.PrereleaseLabel; + string prerelease = psGetInfo.Prerelease; if (!NuGetVersion.TryParse( - value: String.IsNullOrEmpty(prereleaseLabel) ? version : GetNormalizedVersionString(version, prereleaseLabel), + value: String.IsNullOrEmpty(prerelease) ? version : GetNormalizedVersionString(version, prerelease), version: out pkgNuGetVersion)) { cmdletPassedIn.WriteVerbose(String.Format("Leaf directory in path '{0}' cannot be parsed into a version.", installedPkgPath)); diff --git a/test/FindPSResource.Tests.ps1 b/test/FindPSResource.Tests.ps1 index 20290a610..602a6c823 100644 --- a/test/FindPSResource.Tests.ps1 +++ b/test/FindPSResource.Tests.ps1 @@ -215,7 +215,7 @@ Describe 'Test Find-PSResource for Module' { $resPrerelease = Find-PSResource -Name $testModuleName -Prerelease -Repository $TestGalleryName $resPrerelease.Version | Should -Be "5.2.5.0" - $resPrerelease.PrereleaseLabel | Should -Be "alpha001" + $resPrerelease.Prerelease | Should -Be "alpha001" } It "find resources, including Prerelease version resources, when given Prerelease parameter" { diff --git a/test/GetInstalledPSResource.Tests.ps1 b/test/GetInstalledPSResource.Tests.ps1 index 63d44e241..986f25c59 100644 --- a/test/GetInstalledPSResource.Tests.ps1 +++ b/test/GetInstalledPSResource.Tests.ps1 @@ -117,7 +117,7 @@ $testCases = $res = Get-PSResource -Name $testModuleName -Version "5.2.5-alpha001" $res.Name | Should -Be $testModuleName $res.Version | Should -Be "5.2.5" - $res.PrereleaseLabel | Should -Be "alpha001" + $res.Prerelease | Should -Be "alpha001" } It "Get prerelease version script when version with correct prerelease label is specified" { @@ -127,6 +127,6 @@ $testCases = $res = Get-PSResource -Name $testScriptName -Version "3.0.0-alpha001" $res.Name | Should -Be $testScriptName $res.Version | Should -Be "3.0.0" - $res.PrereleaseLabel | Should -Be "alpha001" + $res.Prerelease | Should -Be "alpha001" } } diff --git a/test/PSGetTestUtils.psm1 b/test/PSGetTestUtils.psm1 index b0620b4d9..be7d7253a 100644 --- a/test/PSGetTestUtils.psm1 +++ b/test/PSGetTestUtils.psm1 @@ -574,7 +574,7 @@ function CheckForExpectedPSGetInfo $psGetInfo.Description | Should -BeLike 'This module provides a convenient way for a user to store*' $psGetInfo.IconUri | Should -BeNullOrEmpty $psGetInfo.IsPrerelease | Should -Be $True - $psGetInfo.PrereleaseLabel | Should -Be "preview2" + $psGetInfo.Prerelease | Should -Be "preview2" $psGetInfo.Includes.Cmdlet | Should -HaveCount 10 $psGetInfo.Includes.Cmdlet[0] | Should -BeExactly 'Register-SecretVault' $psGetInfo.InstalledDate.Year | Should -BeExactly 2021 diff --git a/test/UpdatePSResource.Tests.ps1 b/test/UpdatePSResource.Tests.ps1 index cb11a8b59..bd081d970 100644 --- a/test/UpdatePSResource.Tests.ps1 +++ b/test/UpdatePSResource.Tests.ps1 @@ -147,7 +147,7 @@ Describe 'Test Update-PSResource' { { if ([System.Version]$pkg.Version -gt [System.Version]"1.0.2.0") { - $pkg.PrereleaseLabel | Should -Be "alpha1" + $pkg.Prerelease | Should -Be "alpha1" $isPkgUpdated = $true } }