This release drops .NET Standard in favor of .NET 6.

There are a lot of significant under the hood changes with the release. See the change log for details.

.github/workflows/dotnet.yml

@@ -10,8 +10,7 @@ jobs:
         runs-on: ubuntu-latest
         strategy:
             matrix:
-                dotnet: ["3.1.404", "5.0.101"]
+                dotnet: ["6.0.x"]
-
         steps:
             - uses: actions/checkout@v2
             - name: Setup .NET

.github/workflows/pkgrelease.yml

@@ -9,11 +9,10 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - uses: actions/checkout@v2
-
             - name: Setup dotnet
               uses: actions/setup-dotnet@v1
               with:
-                  dotnet-version: 3.1.404
+                  dotnet-version: "6.0.x"
             - name: Install dependencies
               run: dotnet restore
             - name: Package

README.md

@@ -14,15 +14,13 @@ See [usage.md](./usage.md).
 
 ## Known issues
 
-- Skipping comments is a little buggy.
+- Skipping comments is a little unpredictable.
 
 ## Requirements
-### Prerequisites
 
-- [.NET](https://dotnet.microsoft.com/download) 5+ or Core 3.1
+- [.NET](https://dotnet.microsoft.com/download) 6+.
-- [.NET Interactive](https://github.com/dotnet/interactive/blob/main/README.md) for notebooks
+- [.NET Interactive](https://github.com/dotnet/interactive/blob/main/README.md) for notebooks (optional).
-    - [VSCode Extension](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.dotnet-interactive-vscode) (does not require Jupyter)
+    - [VSCode Extension](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.dotnet-interactive-vscode) or [nteract](https://nteract.io/)
-    - [nteract](https://nteract.io/) (requires Jupyter)
 
 ## License
 

Sixam.CST.Tests/GlobalUsings.cs

@@ -0,0 +1,3 @@
+// This project is licensed under the MIT license.
+// See the LICENSE file in the project root for more information.
+global using Xunit;

Sixam.CST.Tests/MultilineTests.cs

@@ -1,12 +1,10 @@
 // This project is licensed under the MIT license.
 // See the LICENSE file in the project root for more information.
-using System;
-using Xunit;
 
-namespace Sixam.CST.Tests
+namespace Sixam.CST.Tests;
+
+public class MultilineTests
 {
-    public class MultilineTests
-    {
     [Fact]
     public void MiltilineV1()
     {
@@ -24,5 +22,4 @@ namespace Sixam.CST.Tests
         var actual = lorem.GetText(102, "Multiline");
         Assert.Equal(expected, actual);
     }
-    }
 }

Sixam.CST.Tests/SingleLineTests.cs

@@ -1,11 +1,10 @@
 // This project is licensed under the MIT license.
 // See the LICENSE file in the project root for more information.
-using Xunit;
 
-namespace Sixam.CST.Tests
+namespace Sixam.CST.Tests;
+
+public class SingleLineTests
 {
-    public class SingleLineTests
-    {
     [Theory]
     [InlineData(1, @"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin ac dictum orci, at tincidunt nulla. Donec aliquet, eros non interdum posuere, ipsum sapien molestie nunc, nec facilisis libero ipsum et risus. In sed lorem vel ipsum placerat viverra.")]
     [InlineData(3, @"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam venenatis ac odio ut pretium. Interdum et malesuada fames ac ante ipsum primis in faucibus. Donec semper turpis tempor, bibendum sapien at, blandit neque. Vivamus hendrerit imperdiet elit, vel sollicitudin nulla luctus vel. Vivamus nisl quam, feugiat a diam aliquam, iaculis vestibulum nunc. Maecenas euismod leo enim, faucibus ultrices ipsum semper eu. Praesent ullamcorper justo at maximus ultricies.")]
@@ -24,5 +23,4 @@ namespace Sixam.CST.Tests
         var actual = lorem.GetText(102, key);
         Assert.Equal(expected, actual);
     }
-    }
 }

Sixam.CST.Tests/Sixam.CST.Tests.csproj

@@ -1,7 +1,9 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
-        <TargetFramework>netcoreapp3.1</TargetFramework>
+        <TargetFramework>net6.0</TargetFramework>
+        <Nullable>enable</Nullable>
+        <ImplicitUsings>enable</ImplicitUsings>
         <IsPackable>false</IsPackable>
     </PropertyGroup>
 

Sixam.CST/CaretSeparatedText.cs

@@ -1,13 +1,10 @@
 // This project is licensed under the MIT license.
 // See the LICENSE file in the project root for more information.
-using System;
-using System.Collections.Generic;
-using System.Linq;
 
-namespace Sixam.CST
+namespace Sixam.CST;
+
+public class CaretSeparatedText
 {
-    public class CaretSeparatedText
-    {
     const char CARET = '^';
     const string LF = "\u000A";
     const string CR = "\u000D";
@@ -80,11 +77,4 @@ namespace Sixam.CST
 
         return "***MISSING***";
     }
-    }
-}
-
-namespace CSTNet
-{
-    [Obsolete("Use the Sixam.CST namespace instead.")]
-    public class CaretSeparatedText : Sixam.CST.CaretSeparatedText { }
 }

Sixam.CST/Sixam.CST.csproj

@@ -1,8 +1,10 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
-        <TargetFramework>netstandard2.0</TargetFramework>
+        <TargetFramework>net6.0</TargetFramework>
-        <Version>1.1.100</Version>
+        <Version>1.2.100</Version>
+        <Nullable>enable</Nullable>
+        <ImplicitUsings>enable</ImplicitUsings>
         <Authors>Tony Bark, Sixam Software</Authors>
         <PackageDescription>
             Caret-Separated Text (or CST) is a key-value pair format represented by digits or words as keys and the value as text enclosed between carets. ([key] ^[value]^)

Sixam.CST/UIText.cs

@@ -1,12 +1,10 @@
 // This project is licensed under the MIT license.
 // See the LICENSE file in the project root for more information.
-using System;
-using System.IO;
 
-namespace Sixam.CST
+namespace Sixam.CST;
+
+public class UIText
 {
-    public class UIText
-    {
     string Language { get; set; } = "english";
     public string[] BasePath { get; set; } = { AppContext.BaseDirectory, "uitext" };
 
@@ -53,5 +51,4 @@ namespace Sixam.CST
 
         return "***MISSING***";
     }
-    }
 }

changelog.md

@@ -1,5 +1,19 @@
 # Change Log
 
+## 1.2.100
+
+This version removes support for .NET Standard 2.0 in favor of .NET 6 and brings with it (much needed) quality of life changes to the project. Apart from the removal of the ``CSTNet`` namespace, nothing has changed to the API itself and you can continue to use to 1.1.100 on all platforms where .NET Standard 2.0 is [supported](https://dotnet.microsoft.com/platform/dotnet-standard).
+
+From 1.2 onward, Sixam.CST will only target LTS releases. This is why .NET 5 was skipped, despite the initial platform unification.
+
+### Project Changes
+
+With the move to .NET 6.0, this version brings with it a lot of quality of life changes to the project. This includes file-scoped namespaces, implicit and global usings. For a full list of language changes see [Welcome to C# 10](https://devblogs.microsoft.com/dotnet/welcome-to-csharp-10/).
+
+### Nullable Reference Types
+
+The only significant architectural change that was finally enabled with this release is [nullable reference types](https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/tutorials/nullable-reference-types). This feature was introduced in .NET Core 3.0 and .NET Standard 2.1, respectfully, but not the .NET Framework. Nullable values are already taken care of by the library. The reason why I never switched to 2.1 before was because the Sims community has historically targeted the .NET Framework, and that doesn't support 2.1.
+
 ## 1.1.100
 
 - Switched to Sixam.CST namespace and marked CSTNet namespace as obsolete.

usage.md

@@ -7,9 +7,7 @@
 ```
 
 ```csharp
-#r "nuget:Sixam.CST,1.1"
+#r "nuget:Sixam.CST,1.1.100" // If using notebooks
-using System;
-using System.IO;
 using Sixam.CST;
 
 var file = File.ReadAllText("example.cst");
@@ -18,31 +16,29 @@ var example = CaretSeparatedText.Parse(file, 1);
 Console.WriteLine(example);
 ```
 
-See working example on [.NET Fiddle](https://dotnetfiddle.net/ecKb2h).
-
 ## Complex Scenarios
 
-In production, CST files were used in The Sims Online (TSO) to provide translations. It was required that they were prefixed with numbers enclosed in underscores, known as the ID. The IDs were used to locate the right file without knowing it's name. Meanwhile, each translation was split into their respective ``uitext/<languae>.dir`` directories:
+In production, CST files were used in The Sims Online to provide translations It was required that they were prefixed with numbers enclosed in underscores, known as the ID. The IDs were used to locate the right file without knowing it's name. Meanwhile, each translation was split into their respective ``uitext/<languae>.dir`` directories:
 
 - ``uitext/english.dir/_154_miscstrings.cst``
-- ``uitext/swedish.dir/_154_miscstrings.cst``[^1]
+- ``uitext/swedish.dir/_154_miscstrings.cst``
 
 Starting with 1.1, the UIText class provides methods that directorly map to these directories relative to the application's.
 
 ```csharp
-#r "nuget:Sixam.CST,1.1"
+#r "nuget:Sixam.CST,1.1.100"
 using Sixam.CST;
 
 var english = new UIText(); // UIText assumes English
 var swedish = new UIText("swedish");
-var engExample = english.GetText(101, 1); // english.dir/_101_example.cst
+var engExample = english.GetText(152, 1); // english.dir/_154_miscstrings.cst
-var sweExample = swedish.GetText(101, 1); // swedish.dir/_101_example.cst
+var sweExample = swedish.GetText(152, 1); // swedish.dir/_154_miscstrings.cst
 
 Console.WriteLine(engExample);
 Console.WriteLine(sweExample);
 ```
 
-Note that GetText() remains unchanged because the translation is expected to be same id and key, despite being in a different directory.
+Note that the IDs and keys in both ``GetText()`` examples remains the same. This is because it was historically assumed that the English and translations files were identical. However, the original never saw any new languages added.
 
 ### Changing base directories
 
@@ -57,5 +53,3 @@ var example = new UIText()
     BasePath = new[] { "gamedata", "uitext" },
 };
 ```
-
-[^1]: TSO only supported English.