RJCP.Core.Environment 0.3.0

RJCP.Environment

This library contains miscellaneous routines that are useful for getting information about the environment.

This document covers two assemblies, RJCP.Core.Environment and RJCP.Core.Environment.Version

• 1. Environment Features
  • 1.1. Platform Version
  • 1.2. XDG Specification on Linux
• 2. Environment.Version Features
  • 2.1. Windows Version
  • 2.2. .NET Framework Version
• 3. Tools
  • 3.1. WinVersion
  • 3.2. NetVersion
• 4. Release History
  • 4.1. Environment
    • 4.1.1. Version 0.3.0
  • 4.2. Environment.Version
    • 4.2.1. Version 0.3.0
  • 4.3. Version 0.2.0

1. Environment Features

1.1. Platform Version

Provides a standard way across .NET Framework and .NET Core. .NET 6.0 and later have introduced their own mechanism, so if your projects don't target older versions, use the immplementations from .NET Core.

• IsWinNT()
• IsUnix() for Linux (support for MacOS is removed as this is not tested).

These APIs support the newer SupportedOSPlatform attributes in .NET Core 6.0 and later (the attribute is from .NET 5.0, but .NET 6.0 supports the guards).

In addition, further runtimes can be detected:

• IsMonoClr()
• IsMSys() by checking environment variables - useful with RJCP.Core.CommandLine.
• IsCygwin() by checking environment variables - useful with RJCP.Core.CommandLine.

1.2. XDG Specification on Linux

The Platform.GetFolderPath method supports getting standard paths according to the XDG standard.

The following properties are supported:

• Environment.SpecialFolder.LocalApplicationData
• Environment.SpecialFolder.CommonApplicationData
• Otherwise the base .NET implementation is used. This might change in the future if the XDG supports further features.

Additionally, the APIs Xdg.GetFolderPath is provided with:

• Xdg.SpecialFolder.LocalApplicationData
• Xdg.SpecialFolder.CommonApplicationData
• Xdg.SpecialFolder.CacheData

that rely on XDG_ environment variables.

2. Environment.Version Features

Since version 0.3.0, functionality has moved from Environment to here.

2.1. Windows Version

With WinVersion.LocalMachine get the version of the current operating system using NTDLL. You can compare against other versions in detail, get Windows version information, useful for informational reports. Use the existing functionality in the .NET framework to test against features, and do not use the Windows version.

2.2. .NET Framework Version

Use NetVersions to enumerate a list of installed versions of .NET Framework, and the current runtime in use.

To date, there is no documented standard on querying the versions of the .NET Core runtimes, so this isn't offered.

It checks against MONO on Linux as well as Windows.

3. Tools

3.1. WinVersion

The repository offers a tool (not provided as a binary) that can be used to show windows version information.

3.2. NetVersion

The repository offers a tool (not provided as a binary) that can be used to show the .NET Framework version information.

4. Release History

4.1. Environment

4.1.1. Version 0.3.0

Features:

• Add function to test if binary is running from a Cygwin Shell (DOTNET-931)

Quality:

• Add README.md to NuGet package (DOTNET-805)
• Move out Version information, so that there are less dependencies and remove cyclic dependencies, as most code uses this library for platform information. (DOTNET-851)
• Upgrade to .NET Core 6.0 (DOTNET-936)
• Add references for OS Compatibility (DOTNET-938, DOTNET-942, DOTNET-959)

4.2. Environment.Version

4.2.1. Version 0.3.0

Features:

• NetVersion: Search for Mono 4.2.1 and later (DOTNET-848)
• NetVersion: Search for Mono 1.x to 4.0.3 (DOTNET-849)
• NetVersion: Use the current MonoRuntime to also determine the installed location (DOTNET-851)
• NetVersion: Search the path on Windows for other installations of Mono (DOTNET-858)
• NetVersion: Use the current MonoRuntime on Linux to also determine the installed location (DOTNET-863)
• WinVersion: Add Windows RT 8.1 ARM to a test case (DOTNET-859)

BugFixes:

• NetVersion: Fix and test .NET 1.0 to .NET 4.8.1, fixing especially the detection of .NET 3.0 (DOTNET-843, DOTNET-844, DOTNET-846)
• NetVersion: Only return one current runtime (DOTNET-850)

Quality:

• Add README.md to NuGet package (DOTNET-805)
• NetVersion: Provide the Target Version as a Version object (DOTNET-842, DOTNET-845)
• Code cleanup (DOTNET-848)
• Add references for OS Compatibility (DOTNET-938)
• Upgrade to .NET Core 6.0 (DOTNET-936, DOTNET-940, DOTNET-942, DOTNET-959, DOTNET-963)
• Add .NET 4.8 target, and enable usage of APIs without reflection (DOTNET-976)

4.3. Version 0.2.0

• Initial Release