Transaction Scope Compiler Warning

Epic_Santiago · February 28, 2025, 8:40pm

Hi everyone,
We have introduced some new warnings to verify that code is cross-platform. This is in preparation to moving to Linux for 2025.1. The warning was backported to 2024.2 to help identify such code prior to the upgrade. You can find examples of code that is not cross-platform (like the Windows registry) here:

gist.github.com

https://gist.github.com/Epic-Santiago/41b8604ac935ed3ed20461534d6dfd6b

XPlatform.cs

// Replace arbitrary paths like these:
var path = @"C:\Arbitrary\Example.txt";
System.IO.File.AppendAllText(path, "My text");

// With the Sandbox class:
var filePath = new FilePath(ServerFolder.UserData, "Example.txt");
Sandbox.IO.File.AppendAllText(filePath, "My text");

// File name are case sensitive on Linux:
System.IO.File.ReadAllText("myfilename.txt");   // This.

This file has been truncated. show original

TransactionScope.Close() however is a false positive as this method is indeed portable. This has already been fixed and the warning should go away in the next build.

Not directly relevant to this question but another good resource to reworking absolute paths in custom code (since C:\Folder won’t work on Linux where it would be something like /Folder) is this:

gist.github.com

https://gist.github.com/Epic-Santiago/b842d06370cb56d2b1af43ae1f45f5e8

Paths.cs

// Before
var oldPath = @"C:\MyFolder\Test.txt";

System.IO.Directory.CreateDirectory(oldPath);
System.IO.Directory.Delete(oldPath);
System.IO.Directory.Delete(oldPath, recursive: true);
System.IO.Directory.Exists(oldPath);
System.IO.Directory.GetDirectories(oldPath);
System.IO.Directory.GetDirectories(oldPath, "*abc*");
System.IO.Directory.GetDirectories(oldPath, "*abc*", System.IO.SearchOption.AllDirectories);

This file has been truncated. show original