Kernel - NKS0053

Use KernelPlatform.IsRunningFromScreen()

This analyzer provides the following strings:

Context	String
Error List	Caller uses Environment.GetEnvironmentVariable("STY") instead of KernelPlatform.IsRunningFromScreen()
Suggestion Box	Use KernelPlatform.IsRunningFromScreen() instead of Environment.GetEnvironmentVariable("STY")
Description	KernelPlatform.IsRunningFromScreen() is more readable and less verbose than Environment.GetEnvironmentVariable("STY").

Extended Description

This code analyzer detects the usage of GetEnvironmentVariable("STY") from the Environment class found in the System namespace.

GetEnvironmentVariable is a method to determine the terminal emulator and the terminal type. It's also a method to determine whether it's running on GNU Screen or on Tmux. However, we needed to increase the readability.

As a result, KernelPlatform implements a handful of terminal detection functions to simplify the complicated terminal 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()
{
    var value = Environment.GetEnvironmentVariable("STY");
}

After the fix

Somewhere in your mod code...

public static void MyFunction()
{
    var value = KernelPlatform.IsRunningFromScreen();
}

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.