Add TomlSerializable source-gen roots

Fix #113

Warn when JsonSerializable is used on TomlSerializerContext and switch the repo, tests, and docs to the dedicated TomlSerializable root attribute. Also add TypeInfoPropertyName parity and remove the SYSLIB1224 suppressions that are no longer needed.

Author: xoofx

readme.md

@@ -12,7 +12,7 @@ Tomlyn is a high-performance .NET TOML 1.1 parser, round-trippable syntax tree,
 
 - **`System.Text.Json`-style API**: familiar surface with `TomlSerializer`, `TomlSerializerOptions`, `TomlTypeInfo<T>`
 - **TOML 1.1.0 only**: Tomlyn v1 targets TOML 1.1.0 and does **not** support TOML 1.0
-- **Source generation**: NativeAOT / trimming friendly via `TomlSerializerContext` - reuses `[JsonSerializable]` attributes
+- **Source generation**: NativeAOT / trimming friendly via `TomlSerializerContext` and `[TomlSerializable]` roots
 - **`System.Text.Json` attribute interop**: reuse `[JsonPropertyName]`, `[JsonIgnore]`, `[JsonRequired]`, `[JsonConstructor]`, polymorphism attributes
 - **Allocation-free parsing pipeline**: incremental `TomlLexer` → `TomlParser` with precise spans for errors
 - **Low-level access**: full lexer/parser API plus a lossless, trivia-preserving syntax tree (`SyntaxParser` → `DocumentSyntax`)
@@ -97,13 +97,11 @@ public sealed class MyConfig
     public string? Global { get; set; }
 }
 
-#pragma warning disable SYSLIB1224
 [TomlSourceGenerationOptions(PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase)]
-[JsonSerializable(typeof(MyConfig))]
+[TomlSerializable(typeof(MyConfig))]
 internal partial class MyTomlContext : TomlSerializerContext
 {
 }
-#pragma warning restore SYSLIB1224
 
 var config = TomlSerializer.Deserialize(toml, MyTomlContext.Default.MyConfig);
 var tomlOut = TomlSerializer.Serialize(config, MyTomlContext.Default.MyConfig);

site/docs/compatibility.md

@@ -44,11 +44,11 @@ See [Source generation and NativeAOT](source-generation.md) for details.
 
 ## System.Text.Json interop
 
-Tomlyn reuses [`System.Text.Json`](xref:System.Text.Json) types in two areas:
+Tomlyn reuses [`System.Text.Json`](xref:System.Text.Json) types in several areas:
 
 - **Naming policies** - [`TomlSerializerOptions.PropertyNamingPolicy`](xref:Tomlyn.TomlSerializerOptions.PropertyNamingPolicy) accepts any [`JsonNamingPolicy`](xref:System.Text.Json.JsonNamingPolicy).
 - **Attributes** - most common [`System.Text.Json.Serialization`](xref:System.Text.Json.Serialization) attributes work out of the box.
-- **Source generation** - [`[JsonSerializable]`](xref:System.Text.Json.Serialization.JsonSerializableAttribute) roots and [`JsonKnownNamingPolicy`](xref:System.Text.Json.JsonKnownNamingPolicy) are used for context declaration.
+- **Source generation** - [`[TomlSerializable]`](xref:Tomlyn.Serialization.TomlSerializableAttribute) roots declare TOML contexts, while [`JsonKnownNamingPolicy`](xref:System.Text.Json.JsonKnownNamingPolicy) remains available for compile-time naming options.
 
 > [!NOTE]
 > This allows you to share model classes between JSON and TOML serializers. TOML-specific attributes take precedence when both are present.

site/docs/getting-started.md

@@ -164,11 +164,10 @@ See [DOM model](dom.md) for more details.
 For NativeAOT / trimming, declare a [`TomlSerializerContext`](xref:Tomlyn.Serialization.TomlSerializerContext) and use generated metadata:
 
 ```csharp
-using System.Text.Json.Serialization;
 using Tomlyn;
 using Tomlyn.Serialization;
 
-[JsonSerializable(typeof(ServerConfig))]
+[TomlSerializable(typeof(ServerConfig))]
 internal partial class MyTomlContext : TomlSerializerContext { }
 
 var toml = TomlSerializer.Serialize(config, MyTomlContext.Default.ServerConfig);

site/docs/migration.md

@@ -19,7 +19,7 @@ This page summarizes the major breaking changes when migrating from Tomlyn v0.x.
 | `Toml.Parse(...)` | [`SyntaxParser.Parse(...)`](xref:Tomlyn.Parsing.SyntaxParser) / `ParseStrict(...)` |
 | `DocumentSyntax.Tokens()` | [`TomlLexer`](xref:Tomlyn.Parsing.TomlLexer) |
 | `ITomlMetadataProvider` (on your types) | [`TomlSerializerOptions.MetadataStore`](xref:Tomlyn.TomlSerializerOptions.MetadataStore) (external store) |
-| `[TomlModel]` source gen roots | [`TomlSerializerContext`](xref:Tomlyn.Serialization.TomlSerializerContext) + [`JsonSerializable`](xref:System.Text.Json.Serialization.JsonSerializableAttribute) |
+| `[TomlModel]` source gen roots | [`TomlSerializerContext`](xref:Tomlyn.Serialization.TomlSerializerContext) + [`TomlSerializable`](xref:Tomlyn.Serialization.TomlSerializableAttribute) |
 
 ## Main API shape (TomlSerializer)
 
@@ -68,17 +68,16 @@ v0.x source generation required referencing an analyzer and marking a root model
 Tomlyn v1 uses a `System.Text.Json`-style source generation model based on:
 
 - [`TomlSerializerContext`](xref:Tomlyn.Serialization.TomlSerializerContext)
-- [`JsonSerializableAttribute`](xref:System.Text.Json.Serialization.JsonSerializableAttribute) roots
+- [`TomlSerializableAttribute`](xref:Tomlyn.Serialization.TomlSerializableAttribute) roots
 
 > [!NOTE]
 > The Tomlyn v1 source generator ships with the main `Tomlyn` NuGet package (as a compiler analyzer).
 > You typically only need to add a `TomlSerializerContext` to your project.
 
 ```csharp
-using System.Text.Json.Serialization;
 using Tomlyn.Serialization;
 
-[JsonSerializable(typeof(MyType))]
+[TomlSerializable(typeof(MyType))]
 internal partial class MyTomlContext : TomlSerializerContext
 {
 }

site/docs/serialization.md

@@ -56,11 +56,10 @@ See [Source generation and NativeAOT](source-generation.md) for full details.
 ## Using a source-generated context
 
 ```csharp
-using System.Text.Json.Serialization;
 using Tomlyn;
 using Tomlyn.Serialization;
 
-[JsonSerializable(typeof(MyConfig))]
+[TomlSerializable(typeof(MyConfig))]
 internal partial class MyTomlContext : TomlSerializerContext { }
 
 var context = MyTomlContext.Default;
@@ -317,7 +316,7 @@ public sealed class Config
 
 ```csharp
 [TomlSourceGenerationOptions(Converters = [typeof(UpperCaseStringConverter)])]
-[JsonSerializable(typeof(Config))]
+[TomlSerializable(typeof(Config))]
 internal partial class MyTomlContext : TomlSerializerContext { }
 ```
 

site/docs/source-generation.md

@@ -18,10 +18,9 @@ It follows the same patterns as [`System.Text.Json`](xref:System.Text.Json) sour
 
 ## Define a context
 
-Declare a `partial` class that inherits from [`TomlSerializerContext`](xref:Tomlyn.Serialization.TomlSerializerContext) and annotate it with [`[JsonSerializable]`](xref:System.Text.Json.Serialization.JsonSerializableAttribute) for each root type:
+Declare a `partial` class that inherits from [`TomlSerializerContext`](xref:Tomlyn.Serialization.TomlSerializerContext) and annotate it with [`[TomlSerializable]`](xref:Tomlyn.Serialization.TomlSerializableAttribute) for each root type:
 
 ```csharp
-using System.Text.Json.Serialization;
 using Tomlyn.Serialization;
 
 public sealed class ServerConfig
@@ -30,12 +29,13 @@ public sealed class ServerConfig
     public int Port { get; set; } = 8080;
 }
 
-[JsonSerializable(typeof(ServerConfig))]
+[TomlSerializable(typeof(ServerConfig))]
 internal partial class MyTomlContext : TomlSerializerContext { }
 ```
 
 The generator produces a `Default` singleton and a typed [`TomlTypeInfo<T>`](xref:Tomlyn.TomlTypeInfo`1) property for each root.
 Nested types referenced by the root are discovered transitively - you only need to annotate top-level types.
+Set [`TomlSerializableAttribute.TypeInfoPropertyName`](xref:Tomlyn.Serialization.TomlSerializableAttribute.TypeInfoPropertyName) when you want to customize the generated property name exposed by the context.
 
 ## Use generated metadata
 
@@ -72,7 +72,7 @@ using Tomlyn.Serialization;
     WriteIndented = true,
     IndentSize = 2,
     DefaultIgnoreCondition = TomlIgnoreCondition.WhenWritingNull)]
-[JsonSerializable(typeof(ServerConfig))]
+[TomlSerializable(typeof(ServerConfig))]
 internal partial class MyTomlContext : TomlSerializerContext { }
 ```
 
@@ -81,7 +81,7 @@ internal partial class MyTomlContext : TomlSerializerContext { }
 ```csharp
 [TomlSourceGenerationOptions(
     Converters = [typeof(MyCustomConverter)])]
-[JsonSerializable(typeof(ServerConfig))]
+[TomlSerializable(typeof(ServerConfig))]
 internal partial class MyTomlContext : TomlSerializerContext { }
 ```
 
@@ -140,10 +140,10 @@ You can also disable reflection via MSBuild in your project file:
 You can define multiple contexts for different parts of your application:
 
 ```csharp
-[JsonSerializable(typeof(ServerConfig))]
+[TomlSerializable(typeof(ServerConfig))]
 internal partial class ServerContext : TomlSerializerContext { }
 
-[JsonSerializable(typeof(DatabaseConfig))]
+[TomlSerializable(typeof(DatabaseConfig))]
 internal partial class DatabaseContext : TomlSerializerContext { }
 ```
 
@@ -153,6 +153,6 @@ internal partial class DatabaseContext : TomlSerializerContext { }
 | --- | --- |
 | Generated properties are missing | Ensure the project references the `Tomlyn` NuGet package (the generator is shipped under `analyzers/dotnet/cs`). |
 | Compilation errors on context | Ensure the context class is `partial`. |
-| Type not found on context | Ensure root types are declared via `[JsonSerializable(typeof(...))]`. |
+| Type not found on context | Ensure root types are declared via `[TomlSerializable(typeof(...))]`. |
 | Nested types not serialized | Nested types are discovered transitively - verify they're reachable from a root type. |
 | Converter not applied | Use `TomlSourceGenerationOptionsAttribute.Converters` instead of `TomlConverterAttribute` for source-generated contexts. |

src/Tomlyn.AotTests/Program.cs

@@ -318,11 +318,9 @@ internal sealed class PlatformConfig
     }
 }
 
-#pragma warning disable SYSLIB1224
 [TomlSourceGenerationOptions(PropertyNamingPolicy = JsonKnownNamingPolicy.SnakeCaseLower)]
-[JsonSerializable(typeof(Program.RootConfig))]
-[JsonSerializable(typeof(TomlTable))]
+[TomlSerializable(typeof(Program.RootConfig))]
+[TomlSerializable(typeof(TomlTable))]
 internal partial class AotTomlSerializerContext : TomlSerializerContext
 {
 }
-#pragma warning restore SYSLIB1224

src/Tomlyn.AotTests/Tomlyn.AotTests.csproj

@@ -5,7 +5,6 @@
     <TargetFramework>net10.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
-    <NoWarn>$(NoWarn);SYSLIB1224</NoWarn>
     <PublishAot>true</PublishAot>
     <InvariantGlobalization>true</InvariantGlobalization>
     <IsPackable>false</IsPackable>

src/Tomlyn.Benchmarks.SourceGen/Tomlyn.Benchmarks.SourceGen.csproj

@@ -7,7 +7,6 @@
         <Nullable>enable</Nullable>
         <IsPackable>false</IsPackable>
         <LangVersion>latest</LangVersion>
-        <NoWarn>$(NoWarn);SYSLIB1224</NoWarn>
     </PropertyGroup>
 
     <ItemGroup>

src/Tomlyn.Benchmarks.SourceGen/TomlynBenchmarkContext.cs

@@ -1,9 +1,8 @@
-using System.Text.Json.Serialization;
 using Tomlyn.Serialization;
 
 namespace Tomlyn.Benchmarks;
 
-[JsonSerializable(typeof(BenchmarkDocument))]
+[TomlSerializable(typeof(BenchmarkDocument))]
 internal partial class TomlynBenchmarkContext : TomlSerializerContext
 {
 }