McSherry.SemanticVersioning 1.3.0

.NET Core 1.0 This package targets .NET Core 1.0. The package is compatible with this framework or higher. .NET Standard 1.0 This package targets .NET Standard 1.0. The package is compatible with this framework or higher. .NET Framework 4.5 This package targets .NET Framework 4.5. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package McSherry.SemanticVersioning --version 1.3.0                

                    
                

            
NuGet\Install-Package McSherry.SemanticVersioning -Version 1.3.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="McSherry.SemanticVersioning" Version="1.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add McSherry.SemanticVersioning --version 1.3.0                

                    
                

            
#r "nuget: McSherry.SemanticVersioning, 1.3.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install McSherry.SemanticVersioning as a Cake Addin
#addin nuget:?package=McSherry.SemanticVersioning&version=1.3.0

// Install McSherry.SemanticVersioning as a Cake Tool
#tool nuget:?package=McSherry.SemanticVersioning&version=1.3.0

Semantic Versioning for .NET

McSherry.SemanticVersioning is a comprehensive library for working with Semantic Versions. It takes care of parsing, comparing, formatting, and filtering and is intended as an easy-to-use, plug-and-play component of self-updating software, package managers, and any other software that needs to work with semantic versions.

Features

  • Full support for Semantic Versioning (2.0.0) and Monotonic Versioning (1.2)
  • Practically full support* for node-semver version ranges (up to v6.0.0)
  • Provides parsing, comparison, and formatting
  • Flexible and configurable parsing to suit nearly any application
  • Targets .NET Framework 4.5 and 4.6, .NET Core 1.0, and .NET Standard 1.0

Getting Started

Installation is simple, as the library is available via NuGet. To install, use the following from the NuGet Package Manager Console:

Install-Package McSherry.SemanticVersioning

Once installed, just import the McSherry.SemanticVersioning namespace and you're all set. Here's a small example to get you started:

Basic comparison
// The version we'll be comparing against.
var comparand = (SemanticVersion)"1.7.0";

while (true)
{    
    Console.Write("Enter a version number: ");
    var versionStr = Console.ReadLine();
    
    SemanticVersion userVersion;
    if (!SemanticVersion.TryParse(versionStr, out userVersion))
        Console.WriteLine("Uh oh! That's not a valid version!");
    else if (userVersion > comparand)
        Console.WriteLine($"Higher precedence than {comparand}!");
    else if (userVersion < comparand)
        Console.WriteLine($"Lower precedence than {comparand}!");
    else
        Console.WriteLine($"Equal precedence to {comparand}!");
        
    Console.WriteLine();
}
Version range comparison
using McSherry.SemanticVersioning.Ranges;

// The range of versions we want to accept.
var range = new VersionRange("1.7.x || 1.8.x");

while (true)
{
    Console.Write("Enter a version number: ");
    var versionStr = Console.ReadLine();
    
    if (!SemanticVersion.TryParse(versionStr, out var result))
    {
        Console.WriteLine("That's not a valid version!");
    }
    else
    {
        Console.WriteLine($"Acceptable? {range.SatisfiedBy(result)}.");
    }
    
    Console.WriteLine();
}

Contributing

Contributions are welcome, especially to documentation (both code comments and the markdown documentation).

Licence Information

The project is licensed under the MIT licence.

Copyright © 2015-19 Liam McSherry.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp1.0 is compatible.  netcoreapp1.1 was computed.  netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard1.0 is compatible.  netstandard1.1 was computed.  netstandard1.2 was computed.  netstandard1.3 was computed.  netstandard1.4 was computed.  netstandard1.5 was computed.  netstandard1.6 was computed.  netstandard2.0 was computed.  netstandard2.1 was computed. 
.NET Framework net45 is compatible.  net451 was computed.  net452 was computed.  net46 is compatible.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen30 was computed.  tizen40 was computed.  tizen60 was computed. 
Universal Windows Platform uap was computed.  uap10.0 was computed. 
Windows Phone wp8 was computed.  wp81 was computed.  wpa81 was computed. 
Windows Store netcore was computed.  netcore45 was computed.  netcore451 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on McSherry.SemanticVersioning:

Package Downloads
Triamec.Tam.Core

Triamec Advanced Motion libraries.

GitHub repositories (2)

Showing the top 2 popular GitHub repositories that depend on McSherry.SemanticVersioning:

Repository Stars
exceptionless/Exceptionless
Exceptionless application
geluk/pass-winmenu
An easy-to-use password manager for Windows, compatible with pass.
Version Downloads Last updated
1.4.1 20,824 1/10/2021
1.4.0 3,116 6/4/2020
1.3.0 5,433 6/14/2019
1.2.1 6,997 4/7/2017
1.2.0 5,002 7/14/2016
1.1.0 1,288 11/28/2015
1.0.0 1,086 10/16/2015

This minor update adds new features and corrections.
       
### Features
       
o Advanced version range syntax is now supported
  Support for 'node-semver' caret, tilde, hyphen, and X-range operators in
  VersionRange is added, allowing more complex comparisons to be done simply.
     
o Semantic versions can now be parsed greedily
  By passing the [ParseMode.Greedy] flag, the [SemanticVersion] parser can now
  be configured to attempt to return a valid version at the first error it
  encounters. This is intended to allow including information after a version
  string that the caller is able to handle.
  
o Semantic version parser now exposes [IEnumerator(char)] to callers
  This enables a caller to pick up where the parser left off. Used in
  combination with greedy parsing, it makes the job of the caller in
  processing anything stored after a version string easier. It would, for
  example, make converting a [System.Version] of '1.0.0.0' to a semantic
  version easier than it is currently.
  
o Version range comparisons are no longer transparently memoized
  The [VersionRange] class now exposes an instance [MemoizationAgent] member,
  which enables caching the results of comparisons and which is disabled by
  default. This enables consumers to provide their own caching mechanism
  without potentially causing unexplained high memory usage.
  

### Bug fixes

o Version range comparisons where one [SemanticVersion] has pre-release
  identifiers and the other doesn't are now performed correctly. Prior to
  this, a comparison would be erroneously performed if the right-hand version
  had identifiers and the left-hand version didn't.