refactor(core): types and utilities (#2)

Author: glucaci

.github/workflows/ci.yml

@@ -32,6 +32,10 @@ jobs:
         shell: bash
         run: dotnet build ./all.csproj -f net${{ matrix.dotnet-version }}.0
 
+      - name: Check for breaking API changes
+        shell: bash
+        run: dotnet build src/Yamlify/Yamlify.csproj --no-restore -warnaserror:RS0016,RS0017
+
       - name: Run tests
         shell: bash
         run: dotnet test ./all.csproj /p:BuildTestsOnly=true --no-build -f net${{ matrix.dotnet-version }}.0 -- RunConfiguration.MaxCpuCount=1

Directory.Build.props

@@ -0,0 +1,49 @@
+<Project>
+
+  <PropertyGroup>
+    <!-- Common build settings -->
+    <LangVersion>preview</LangVersion>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <WarningsAsErrors>$(WarningsAsErrors);nullable</WarningsAsErrors>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+    <DebugType>full</DebugType>
+    <DebugSymbols>true</DebugSymbols>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
+    <DebugType>pdbonly</DebugType>
+    <DebugSymbols>true</DebugSymbols>
+  </PropertyGroup>
+
+  <PropertyGroup>
+    <!-- Package metadata -->
+    <Version Condition="$(Version) == ''">0.0.0</Version>
+    <Product>Yamlify</Product>
+    <Authors>SwissLife-OSS</Authors>
+    <Company>Swiss Life</Company>
+    <Copyright>Copyright © $(Company) $([System.DateTime]::Now.Year)</Copyright>
+    <PackageLicenseExpression>MIT</PackageLicenseExpression>
+    <PackageProjectUrl>https://github.com/SwissLife-OSS/Yamlify</PackageProjectUrl>
+    <PackageReleaseNotes>Release notes: https://github.com/SwissLife-OSS/Yamlify/releases/$(Version)</PackageReleaseNotes>
+  </PropertyGroup>
+
+  <PropertyGroup>
+    <!-- Source Link and symbols -->
+    <PublishRepositoryUrl>true</PublishRepositoryUrl>
+    <EmbedUntrackedSources>true</EmbedUntrackedSources>
+    <RepositoryUrl>https://github.com/SwissLife-OSS/Yamlify.git</RepositoryUrl>
+    <RepositoryType>git</RepositoryType>
+    <IncludeSymbols>true</IncludeSymbols>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All" />
+  </ItemGroup>
+
+</Project>

nuget.config

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+    <packageSources>
+        <clear />
+        <add key="nuget" value="https://api.nuget.org/v3/index.json" />
+    </packageSources>
+</configuration>

src/Yamlify.SourceGenerator/YamlSourceGenerator.cs

@@ -84,7 +84,7 @@ private static bool IsCandidateClass(SyntaxNode node)
         var indentSequenceItems = true;
         var ignoreNullValues = false;
         var ignoreEmptyObjects = false;
-        var discriminatorPosition = DiscriminatorPositionMode.Ordered;
+        var discriminatorPosition = DiscriminatorPositionMode.PropertyOrder;
 
         foreach (var attributeData in classSymbol.GetAttributes())
         {
@@ -248,7 +248,7 @@ private static string GenerateContextSource(ContextToGenerate ctx, Compilation c
         sb.AppendLine();
         sb.AppendLine("using System;");
         sb.AppendLine("using System.Collections.Generic;");
-        sb.AppendLine("using Yamlify.Core;");
+        sb.AppendLine("using Yamlify;");
         sb.AppendLine("using Yamlify.Serialization;");
         sb.AppendLine();
 
@@ -369,7 +369,7 @@ private static void GenerateTypeInfoMethod(StringBuilder sb, TypeToGenerate type
 
             sb.AppendLine($"        properties.Add(new YamlPropertyInfo<{fullTypeName}, {propTypeName}>(");
             sb.AppendLine($"            name: \"{propName}\",");
-            sb.AppendLine($"            yamlPropertyName: \"{yamlName}\",");
+            sb.AppendLine($"            serializedName: \"{yamlName}\",");
 
             if (prop.GetMethod is not null)
             {
@@ -1481,11 +1481,11 @@ private static void GenerateWriteMethod(StringBuilder sb, TypeToGenerate type, I
 
         // Write discriminator at the beginning if:
         // 1. DiscriminatorPosition.First is configured, OR
-        // 2. DiscriminatorPosition.Ordered is configured but there's no matching property to attach the order to
+        // 2. DiscriminatorPosition.PropertyOrder is configured but there's no matching property to attach the order to
         if (discriminatorPropertyName is not null && discriminatorValue is not null)
         {
             var shouldWriteDiscriminatorFirst = discriminatorPosition == DiscriminatorPositionMode.First 
-                || (discriminatorPosition == DiscriminatorPositionMode.Ordered && !discriminatorHasMatchingProperty);
+                || (discriminatorPosition == DiscriminatorPositionMode.PropertyOrder && !discriminatorHasMatchingProperty);
 
             if (shouldWriteDiscriminatorFirst)
             {
@@ -1552,7 +1552,7 @@ private static void GenerateWriteMethod(StringBuilder sb, TypeToGenerate type, I
             if (isDiscriminatorProperty)
             {
                 // When DiscriminatorPosition.First (or no matching property), discriminator was already written - skip
-                // When DiscriminatorPosition.Ordered AND there IS a matching property, write the discriminator at this position
+                // When DiscriminatorPosition.PropertyOrder AND there IS a matching property, write the discriminator at this position
                 if (discriminatorPosition == DiscriminatorPositionMode.First || !discriminatorHasMatchingProperty)
                 {
                     continue;
@@ -2000,7 +2000,7 @@ private static void GeneratePropertyWrite(StringBuilder sb, string propName, ITy
                 sb.AppendLine($"{indent}{{");
                 sb.AppendLine($"{indent2}writer.WriteNull();");
                 sb.AppendLine($"{indent}}}");
-                sb.AppendLine($"{indent}else if (YamlSerializerOptions.IsAlreadySerialized(value.{propName}))");
+                sb.AppendLine($"{indent}else if (YamlSerializerOptions.CurrentResolver?.IsCycleReference(value.{propName}) == true)");
                 sb.AppendLine($"{indent}{{");
                 sb.AppendLine($"{indent2}// Circular reference detected - write null to break the cycle");
                 sb.AppendLine($"{indent2}writer.WriteNull();");
@@ -3088,7 +3088,7 @@ private static void GenerateCollectionWrite(StringBuilder sb, string propName, I
         // Use flow style for empty collections to output [] instead of nothing
         sb.AppendLine($"                if (value.{propName} is System.Collections.ICollection {{ Count: 0 }})");
         sb.AppendLine("                {");
-        sb.AppendLine("                    writer.WriteSequenceStart(Yamlify.Core.CollectionStyle.Flow);");
+        sb.AppendLine("                    writer.WriteSequenceStart(Yamlify.CollectionStyle.Flow);");
         sb.AppendLine("                    writer.WriteSequenceEnd();");
         sb.AppendLine("                }");
         sb.AppendLine("                else");
@@ -3203,7 +3203,7 @@ private static void GenerateElementWrite(StringBuilder sb, string varName, IType
                 sb.AppendLine($"{indent}{{");
                 sb.AppendLine($"{indent}    writer.WriteNull();");
                 sb.AppendLine($"{indent}}}");
-                sb.AppendLine($"{indent}else if (YamlSerializerOptions.IsAlreadySerialized({varName}))");
+                sb.AppendLine($"{indent}else if (YamlSerializerOptions.CurrentResolver?.IsCycleReference({varName}) == true)");
                 sb.AppendLine($"{indent}{{");
                 sb.AppendLine($"{indent}    // Circular reference detected - write null to break the cycle");
                 sb.AppendLine($"{indent}    writer.WriteNull();");
@@ -3432,7 +3432,7 @@ public ContextToGenerate(
         bool indentSequenceItems = true,
         bool ignoreNullValues = false,
         bool ignoreEmptyObjects = false,
-        DiscriminatorPositionMode discriminatorPosition = DiscriminatorPositionMode.Ordered)
+        DiscriminatorPositionMode discriminatorPosition = DiscriminatorPositionMode.PropertyOrder)
     {
         ClassName = className;
         Namespace = ns;
@@ -3487,7 +3487,7 @@ internal enum DiscriminatorPositionMode
     /// <summary>
     /// The discriminator property is written according to its YamlPropertyOrder or declaration order.
     /// </summary>
-    Ordered = 0,
+    PropertyOrder = 0,
 
     /// <summary>
     /// The discriminator property is always written first.

src/Yamlify.SourceGenerator/Yamlify.SourceGenerator.csproj

@@ -3,13 +3,11 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
     <LangVersion>12.0</LangVersion>
-    <Nullable>enable</Nullable>
-    <WarningsAsErrors>$(WarningsAsErrors);nullable</WarningsAsErrors>
     <ImplicitUsings>disable</ImplicitUsings>
     <EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
     <IsRoslynComponent>true</IsRoslynComponent>
 
-    <!-- Package metadata - not published separately, bundled with Yamlify -->
+    <!-- Not published separately, bundled with Yamlify -->
     <IsPackable>false</IsPackable>
 
     <!-- Suppress analyzer release tracking warning (bundled with main package) -->

src/Yamlify/Common/CollectionStyle.cs

@@ -0,0 +1,22 @@
+namespace Yamlify;
+
+/// <summary>
+/// Specifies the collection style used in YAML presentation.
+/// </summary>
+public enum CollectionStyle : byte
+{
+    /// <summary>
+    /// Any style (for reader) or auto-detect best style (for writer).
+    /// </summary>
+    Any = 0,
+
+    /// <summary>
+    /// Block style using indentation.
+    /// </summary>
+    Block,
+
+    /// <summary>
+    /// Flow style using explicit indicators ([], {}).
+    /// </summary>
+    Flow
+}

src/Yamlify/Core/Mark.cs src/Yamlify/Common/Mark.cssrc/Yamlify/Core/Mark.cs renamed to src/Yamlify/Common/Mark.cs

@@ -1,4 +1,4 @@
-namespace Yamlify.Core;
+namespace Yamlify;
 
 /// <summary>
 /// Represents a position within a YAML stream, including line and column information.

src/Yamlify/Common/ScalarStyle.cs

@@ -0,0 +1,37 @@
+namespace Yamlify;
+
+/// <summary>
+/// Specifies the scalar style used in YAML presentation.
+/// </summary>
+public enum ScalarStyle : byte
+{
+    /// <summary>
+    /// Any style (for reader) or auto-detect best style (for writer).
+    /// </summary>
+    Any = 0,
+
+    /// <summary>
+    /// Plain (unquoted) scalar style.
+    /// </summary>
+    Plain,
+
+    /// <summary>
+    /// Single-quoted scalar style ('value').
+    /// </summary>
+    SingleQuoted,
+
+    /// <summary>
+    /// Double-quoted scalar style ("value").
+    /// </summary>
+    DoubleQuoted,
+
+    /// <summary>
+    /// Literal block scalar style (|).
+    /// </summary>
+    Literal,
+
+    /// <summary>
+    /// Folded block scalar style (>).
+    /// </summary>
+    Folded
+}

src/Yamlify/Core/YamlTokenType.cs src/Yamlify/Common/YamlTokenType.cssrc/Yamlify/Core/YamlTokenType.cs renamed to src/Yamlify/Common/YamlTokenType.cs

@@ -1,4 +1,4 @@
-namespace Yamlify.Core;
+namespace Yamlify;
 
 /// <summary>
 /// Specifies the type of YAML token encountered by the <see cref="Utf8YamlReader"/>.