Add support for indented json via config/scoped json

Author: mythz

src/ServiceStack.Text/JsConfig.cs

@@ -96,6 +96,11 @@ public static JsConfigScope CreateScope(string config, JsConfigScope scope = nul
                     case "includetypeinfo":
                         scope.IncludeTypeInfo = boolValue;
                         break;
+                    case "i":
+                    case "pp": //pretty-print
+                    case "indent":
+                        scope.Indent = boolValue;
+                        break;
                     case "eccn":
                     case "emitcamelcasenames":
                         scope.TextCase = boolValue ? TextCase.CamelCase : scope.TextCase;
@@ -399,6 +404,12 @@ public static bool IncludeTypeInfo
             set => Config.AssertNotInit().IncludeTypeInfo = value;
         }
 
+        public static bool Indent
+        {
+            get => JsConfigScope.Current != null ? JsConfigScope.Current.Indent : Config.Instance.Indent;
+            set => Config.AssertNotInit().Indent = value;
+        }
+
         public static string TypeAttr
         {
             get => JsConfigScope.Current != null ? JsConfigScope.Current.TypeAttr : Config.Instance.TypeAttr;

src/ServiceStack.Text/JsConfigScope.cs

@@ -120,6 +120,7 @@ private Config(Config config)
         public bool TreatEnumAsInteger { get; set; }
         public bool ExcludeTypeInfo { get; set; }
         public bool IncludeTypeInfo { get; set; }
+        public bool Indent { get; set; }
 
         private string typeAttr;
         public string TypeAttr
@@ -196,6 +197,7 @@ public bool EmitLowercaseUnderscoreNames
             TreatEnumAsInteger = false,
             ExcludeTypeInfo = false,
             IncludeTypeInfo = false,
+            Indent = false,
             TypeAttr = JsWriter.TypeAttr,
             DateTimeFormat = null,
             TypeWriter = AssemblyUtils.WriteType,
@@ -240,6 +242,7 @@ public Config Populate(Config config)
             TreatEnumAsInteger = config.TreatEnumAsInteger;
             ExcludeTypeInfo = config.ExcludeTypeInfo;
             IncludeTypeInfo = config.IncludeTypeInfo;
+            Indent = config.Indent;
             TypeAttr = config.TypeAttr;
             DateTimeFormat = config.DateTimeFormat;
             TypeWriter = config.TypeWriter;

src/ServiceStack.Text/Json/JsonWriter.Generic.cs

@@ -214,12 +214,17 @@ public static void WriteObject(TextWriter writer, object value)
         }
 
         public static void WriteRootObject(TextWriter writer, object value)
+        {
+            GetRootObjectWriteFn(value)(writer, value);
+        }
+
+        public static WriteObjectDelegate GetRootObjectWriteFn(object value)
         {
             TypeConfig<T>.Init();
             JsonSerializer.OnSerialize?.Invoke(value);
 
             JsState.Depth = 0;
-            CacheFn(writer, value);
+            return CacheFn;
         }
     }
 

src/ServiceStack.Text/JsonSerializer.cs

@@ -99,7 +99,7 @@ public static string SerializeToString<T>(T value)
             }
             else
             {
-                JsonWriter<T>.WriteRootObject(writer, value);
+                WriteObjectToWriter(value, JsonWriter<T>.GetRootObjectWriteFn(value), writer);
             }
             return StringWriterThreadStatic.ReturnAndFree(writer);
         }
@@ -116,7 +116,7 @@ public static string SerializeToString(object value, Type type)
             else
             {
                 OnSerialize?.Invoke(value);
-                JsonWriter.GetWriteFn(type)(writer, value);
+                WriteObjectToWriter(value, JsonWriter.GetWriteFn(type), writer);
             }
             return StringWriterThreadStatic.ReturnAndFree(writer);
         }
@@ -141,7 +141,7 @@ public static void SerializeToWriter<T>(T value, TextWriter writer)
             }
             else
             {
-                JsonWriter<T>.WriteRootObject(writer, value);
+                WriteObjectToWriter(value, JsonWriter<T>.GetRootObjectWriteFn(value), writer);
             }
         }
 
@@ -155,7 +155,7 @@ public static void SerializeToWriter(object value, Type type, TextWriter writer)
             }
 
             OnSerialize?.Invoke(value);
-            JsonWriter.GetWriteFn(type)(writer, value);
+            WriteObjectToWriter(value, JsonWriter.GetWriteFn(type), writer);
         }
 
         public static void SerializeToStream<T>(T value, Stream stream)
@@ -175,7 +175,7 @@ public static void SerializeToStream<T>(T value, Stream stream)
             else
             {
                 var writer = new StreamWriter(stream, JsConfig.UTF8Encoding, BufferSize, leaveOpen:true);
-                JsonWriter<T>.WriteRootObject(writer, value);
+                WriteObjectToWriter(value, JsonWriter<T>.GetRootObjectWriteFn(value), writer);
                 writer.Flush();
             }
         }
@@ -184,10 +184,27 @@ public static void SerializeToStream(object value, Type type, Stream stream)
         {
             OnSerialize?.Invoke(value);
             var writer = new StreamWriter(stream, JsConfig.UTF8Encoding, BufferSize, leaveOpen:true);
-            JsonWriter.GetWriteFn(type)(writer, value);
+            WriteObjectToWriter(value, JsonWriter.GetWriteFn(type), writer);
             writer.Flush();
         }
 
+        private static void WriteObjectToWriter(object value, WriteObjectDelegate serializeFn, TextWriter writer)
+        {
+            if (!JsConfig.Indent)
+            {
+                serializeFn(writer, value);
+            }
+            else
+            {
+                var sb = StringBuilderCache.Allocate();
+                using var captureJson = new StringWriter(sb);
+                serializeFn(captureJson, value);
+                captureJson.Flush();
+                var json = StringBuilderCache.ReturnAndFree(sb);
+                var indentJson = json.IndentJson();
+                writer.Write(indentJson);
+            }
+        }
         public static T DeserializeFromStream<T>(Stream stream)
         {
             return (T)MemoryProvider.Instance.Deserialize(stream, typeof(T), DeserializeFromSpan);

tests/ServiceStack.Text.Tests/JsConfigTests.cs

@@ -201,6 +201,19 @@ class TestObject
         }
 
         private const string AssertMessageFormat = "Cannot find correct property value ({0})";
+
+        [Test]
+        public void Can_indent_in_scoped_json()
+        {
+            var obj = new TestObject { Id = 1 };
+            using (JsConfig.With(new Config { Indent = true }))
+            {
+                var scopedJson = obj.ToJson();
+                Assert.That(scopedJson.NormalizeNewLines(), Is.EqualTo("{\n    \"Id\": 1,\n    \"RootId\": 0\n}"));
+            }
+            var json = obj.ToJson();
+            Assert.That(json, Is.EqualTo("{\"Id\":1,\"RootId\":0}"));
+        }
     }
 
     [TestFixture]
@@ -209,11 +222,12 @@ public class JsConfigCreateTests
         [Test]
         public void Does_create_scope_from_string()
         {
-            var scope = JsConfig.CreateScope("emitlowercaseunderscorenames,IncludeNullValues:false,ExcludeDefaultValues:0,IncludeDefaultEnums:1");
+            var scope = JsConfig.CreateScope("emitlowercaseunderscorenames,IncludeNullValues:false,ExcludeDefaultValues:0,IncludeDefaultEnums:1,indent");
             Assert.That(scope.TextCase, Is.EqualTo(TextCase.SnakeCase));
             Assert.That(!scope.IncludeNullValues);
             Assert.That(!scope.ExcludeDefaultValues);
             Assert.That(scope.IncludeDefaultEnums);
+            Assert.That(scope.Indent);
             scope.Dispose();
 
             scope = JsConfig.CreateScope("DateHandler:ISO8601,timespanhandler:durationformat,PropertyConvention:strict,TextCase:CamelCase");
@@ -227,11 +241,12 @@ public void Does_create_scope_from_string()
         [Test]
         public void Does_create_scope_from_string_using_CamelCaseHumps()
         {
-            var scope = JsConfig.CreateScope("eccn,inv:false,edv:0,ide:1");
+            var scope = JsConfig.CreateScope("eccn,inv:false,edv:0,ide:1,pp");
             Assert.That(scope.TextCase, Is.EqualTo(TextCase.CamelCase));
             Assert.That(!scope.IncludeNullValues);
             Assert.That(!scope.ExcludeDefaultValues);
             Assert.That(scope.IncludeDefaultEnums);
+            Assert.That(scope.Indent);
             scope.Dispose();
 
             scope = JsConfig.CreateScope("dh:ISO8601,tsh:df,pc:strict,tc:cc");
@@ -274,7 +289,7 @@ public void Does_not_allow_setting_multiple_inits_in_StrictMode()
 
             Env.StrictMode = true;
 
-            Assert.Throws<NotSupportedException>(() => JsConfig.Init());
+            Assert.Throws<NotSupportedException>(JsConfig.Init);
         }
 
         [Test]