hotfix/TRPRO-288-option-to-disable-pipe-splitting-on-format-build

src/Ashampoo.Translation.Systems.Formats.Abstractions/src/FormatWriteOptions.cs

@@ -0,0 +1,3 @@
+namespace Ashampoo.Translation.Systems.Formats.Abstractions;
+
+public record FormatWriteOptions;

src/Ashampoo.Translation.Systems.Formats.Abstractions/src/IFormat.cs

@@ -39,17 +39,17 @@
     /// </summary>
     /// <param name="stream"></param>
     /// <exception cref="UnsupportedFormatException"></exception>
-    void Write(Stream stream)
+    void Write(Stream stream, FormatWriteOptions? options = null)
     {
-        WriteAsync(stream).Wait();
+        WriteAsync(stream, options).Wait();
     }
 
     /// <summary>
     /// Writes the format to the given stream asynchronously.
     /// </summary>
     /// <param name="stream"></param>
     /// <exception cref="UnsupportedFormatException"></exception>
-    Task WriteAsync(Stream stream);
+    Task WriteAsync(Stream stream, FormatWriteOptions? options = null);
 
     /// <summary>
     /// The <see cref="IFormatHeader"/> containing the header information for this format.

src/Ashampoo.Translation.Systems.Formats/src/AshLang/AshLangFormat.cs

@@ -47,14 +47,14 @@ public AshLangFormat()
     }
 
     /// <inheritdoc />
-    public void Write(Stream stream)
+    public void Write(Stream stream, FormatWriteOptions? options = null)
     {
         var chunkWriter = new ChunkWriter(stream, Chunks);
         chunkWriter.Write();
     }
 
     /// <inheritdoc />
-    public Task WriteAsync(Stream stream)
+    public Task WriteAsync(Stream stream, FormatWriteOptions? options = null)
     {
         Write(stream);
         return Task.CompletedTask;

src/Ashampoo.Translation.Systems.Formats/src/CSV/CsvFormat.cs

@@ -31,7 +31,7 @@
 
     private const char CommentDelimiter = '|';
 
     public CsvFormat()
     {
         var csvFormatHeader = new CsvFormatHeader();
         Header = csvFormatHeader;
@@ -153,7 +153,7 @@
     }
 
     /// <inheritdoc />
-    public async Task WriteAsync(Stream stream)
+    public async Task WriteAsync(Stream stream, FormatWriteOptions? options = null)
     {
         Guard.IsNotNullOrWhiteSpace(Delimiter.ToString());
         await using StreamWriter writer = new(stream, leaveOpen: true, encoding: Encoding.UTF8);

src/Ashampoo.Translation.Systems.Formats/src/Gengo/GengoFormat.cs

@@ -166,7 +166,7 @@ private string RemoveMarker(string str)
     }
 
     /// <inheritdoc />
-    public void Write(Stream stream)
+    public void Write(Stream stream, FormatWriteOptions? options = null)
     {
         XSSFWorkbook workbook = new(); // Create a new workbook
         var sheet = workbook.CreateSheet("Sheet 1"); // Create a new sheet
@@ -206,9 +206,9 @@ public void Write(Stream stream)
     }
 
     /// <inheritdoc />
-    public Task WriteAsync(Stream stream)
+    public Task WriteAsync(Stream stream, FormatWriteOptions? options = null)
     {
-        Write(stream);
+        Write(stream, options);
         return Task.CompletedTask;
     }
 

src/Ashampoo.Translation.Systems.Formats/src/JavaProperties/JavaPropertiesFormat.cs

@@ -101,7 +101,7 @@
     }
 
     /// <inheritdoc/>
-    public void Write(Stream stream)
+    public void Write(Stream stream, FormatWriteOptions? options = null)
     {
         using StreamWriter writer = new(stream, leaveOpen: true);
 
@@ -120,7 +120,7 @@
     /// 
     /// </summary>
     /// <param name="stream"></param>
-    public async Task WriteAsync(Stream stream)
+    public async Task WriteAsync(Stream stream, FormatWriteOptions? options = null)
     {
         await using StreamWriter writer = new(stream, leaveOpen: true);
 

src/Ashampoo.Translation.Systems.Formats/src/Json/JsonFormat.cs

@@ -165,9 +165,9 @@
     }
 
     /// <inheritdoc />
-    public void Write(Stream stream)
+    public void Write(Stream stream, FormatWriteOptions? options = null)
     {
-        WriteAsync(stream).Wait();
+        WriteAsync(stream, options).Wait();
     }
 
     /// <summary>
@@ -176,7 +176,7 @@
     /// <param name="stream">
     /// The stream to write to.
     /// </param>
-    public async Task WriteAsync(Stream stream)
+    public async Task WriteAsync(Stream stream, FormatWriteOptions? options = null)
     {
         var root = new JsonObject();
         CreateJsonObjects(root); // Create JSON objects from TranslationUnits

src/Ashampoo.Translation.Systems.Formats/src/NLang/NLangFormat.cs

@@ -118,9 +118,9 @@
     }
 
     /// <inheritdoc />
-    public void Write(Stream stream)
+    public void Write(Stream stream, FormatWriteOptions? options = null)
     {
-        WriteAsync(stream).Wait();
+        WriteAsync(stream, options).Wait();
     }
 
     /// <summary>
@@ -132,7 +132,7 @@
     /// <exception cref="Exception">
     /// Thrown if the format is invalid.
     /// </exception>
-    public async Task WriteAsync(Stream stream)
+    public async Task WriteAsync(Stream stream, FormatWriteOptions? options = null)
     {
         // NLang is UTF16 LE
         await using var writer = new StreamWriter(stream, Encoding.Unicode, leaveOpen: true);

src/Ashampoo.Translation.Systems.Formats/src/PO/POFormat.cs

@@ -199,7 +199,7 @@
     }
 
     /// <inheritdoc />
-    public void Write(Stream stream)
+    public void Write(Stream stream, FormatWriteOptions? options = null)
     {
         using var writer = new StreamWriter(stream, Encoding.UTF8, leaveOpen: true);
 
@@ -228,7 +228,7 @@
     /// <exception cref="Exception">
     /// Thrown if an error occurs.
     /// </exception>
-    public async Task WriteAsync(Stream stream)
+    public async Task WriteAsync(Stream stream, FormatWriteOptions? options = null)
     {
         await using var writer = new StreamWriter(stream, Encoding.UTF8, leaveOpen: true);
 

src/Ashampoo.Translation.Systems.Formats/src/PO/PoBuilderOptions.cs

@@ -8,7 +8,10 @@ namespace Ashampoo.Translation.Systems.Formats.PO;
 public sealed record PoBuilderOptions : IFormatBuilderOptions
 {
     /// <summary>
-    /// Disables splitting of the id into msgctxt and msgid if a pipe separator is detected.
+    /// Enables splitting of the id into msgctxt and msgid if a pipe separator is detected.
+    /// <remarks>
+    /// Defaults to True.
+    /// </remarks>
     /// </summary>
     public bool SplitContextAndId { get; init; } = true;
 };

src/Ashampoo.Translation.Systems.Formats/src/QT/QTFormat.cs

@@ -83,7 +83,7 @@ private List<string> GetComments(XElement element)
     }
 
     /// <inheritdoc />
-    public async Task WriteAsync(Stream stream)
+    public async Task WriteAsync(Stream stream, FormatWriteOptions? options = null)
     {
         var test = XmlWriter.Create(stream, new XmlWriterSettings
         {

src/Ashampoo.Translation.Systems.Formats/src/ResX/ResXFormat.cs

@@ -122,7 +122,7 @@ private void ReadTranslations()
     }
 
     /// <inheritdoc />
-    public void Write(Stream stream)
+    public void Write(Stream stream, FormatWriteOptions? options = null)
     {
         //Add an empty namespace and empty value
         var ns = new XmlSerializerNamespaces();
@@ -146,7 +146,7 @@ public void Write(Stream stream)
     /// Asynchronously writes the current instance to the given <paramref name="stream"/>.
     /// </summary>
     /// <param name="stream"></param>
-    public async Task WriteAsync(Stream stream)
+    public async Task WriteAsync(Stream stream, FormatWriteOptions? options = null)
     {
         var ns = new XmlSerializerNamespaces();
         ns.Add("", "");

src/Ashampoo.Translation.Systems.Formats/src/TsProj/TsProjFormat.cs

@@ -172,7 +172,7 @@ private async Task<bool> ConfigureHeader(FormatReadOptions? options)
     }
 
     /// <inheritdoc />
-    public void Write(Stream stream)
+    public void Write(Stream stream, FormatWriteOptions? options = null)
     {
         //Add an empty namespace and empty value
         var ns = new XmlSerializerNamespaces();
@@ -200,7 +200,7 @@ public void Write(Stream stream)
     /// <param name="stream">
     /// The stream to write to.
     /// </param>
-    public async Task WriteAsync(Stream stream)
+    public async Task WriteAsync(Stream stream, FormatWriteOptions? options = null)
     {
 
         //Add an empty namespace and empty value

src/tests/Ashampoo.Translation.Systems.TestBase/MockFormatWithTranslationUnits.cs

@@ -28,7 +28,7 @@ private MockFormatWithTranslationUnits(Language language, string id, string valu
         TranslationUnits.Add(translationUnit);
     }
 
-    public Task WriteAsync(Stream stream)
+    public Task WriteAsync(Stream stream, FormatWriteOptions? options = null)
     {
         throw new NotImplementedException();
     }