McSherry.SemanticVersioning 1.3.0

A comprehensive library for working with Semantic Versions (2.0.0), version ranges (node-semver v6.0.0), and Monotonic Versions (1.2).

Install-Package McSherry.SemanticVersioning -Version 1.3.0
dotnet add package McSherry.SemanticVersioning --version 1.3.0
<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
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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 &copy; 2015-19 Liam McSherry.

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 &copy; 2015-19 Liam McSherry.

Release Notes

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.

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

Repository Stars
exceptionless/Exceptionless
Exceptionless server and jobs

Version History

Version Downloads Last updated
1.3.0 159 6/14/2019
1.2.1 2,942 4/7/2017
1.2.0 1,476 7/14/2016
1.1.0 381 11/28/2015
1.0.0 353 10/16/2015
1.0.0-rc1 302 10/10/2015