Kernel - NKS0038

Use KernelPlatform.IsOnUnix()

This analyzer provides the following strings:

Context	String
Error List	Caller uses Environment.OSVersion.Platform == PlatformID.Unix instead of KernelPlatform.IsOnUnix()
Suggestion Box	Use KernelPlatform.IsOnUnix() instead of Environment.OSVersion.Platform == PlatformID.Unix
Description	KernelPlatform.IsOnUnix() is more readable and less verbose than Environment.OSVersion.Platform == PlatformID.Unix.

Extended Description

This code analyzer detects the comparison of Environment.OSVersion.Platform against the Unix value.

Environment.OSVersion.Platform is an ancient way of determining the current operating system that Nitrocid is running on. As a result, it doesn't implement the macOS operating system detection, since it was considered as Unix.

As a result, KernelPlatform implements a handful of platform detection functions to allow you to more accurately detect your platform. Also, it simplifies the complicated platform checking statements to its simpler equivalent.

Analysis Comparison

To get a brief insight about how this analyzer works, compare the two code blocks shown to you below:

Before the fix

Somewhere in your mod code...

public static void MyFunction()
{
    bool value = Environment.OSVersion.Platform == PlatformID.Unix;
}

After the fix

Somewhere in your mod code...

public static void MyFunction()
{
    bool value = KernelPlatform.IsOnUnix();
}

Suppression

You can suppress this suggestion by including it in the appropriate place, whichever is convenient.

For more information about how to suppress any warning issued by the Nitrocid analyzer, visit the below page:

Suppress code analysis warnings - .NETMicrosoftLearn

Recommendation

We recommend that every caller which use this function use the recommended abovementioned method.