Use a JSON.stringify replacer function instead of changing the value beforehand

Author: Andy Hanson

src/harness/fourslash.ts

@@ -1961,45 +1961,23 @@ namespace FourSlash {
 
         public verifyNavigationBar(json: any) {
             let items = this.languageService.getNavigationBarItems(this.activeFile.fileName);
-            items = this.simplifyNavigationBar(items);
-            if (JSON.stringify(items) !== JSON.stringify(json)) {
-                this.raiseError(`verifyNavigationBar failed - expected: ${JSON.stringify(json, undefined, 2)}, got: ${JSON.stringify(items, undefined, 2)}`);
-            }
-        }
-
-        // Remove any properties that tend to all have the same value so that test data is easier to read.
-        private simplifyNavigationBar(items: ts.NavigationBarItem[]): any {
-            return items.map(item => {
-                item = ts.clone(item);
-                if (item.kindModifiers === "") {
-                    delete item.kindModifiers;
-                }
-                // We won't check this.
-                delete item.spans;
-                item.childItems = item.childItems.map(child => {
-                    child = ts.clone(child);
-                    delete child.spans;
-                    ts.Debug.assert(child.childItems.length === 0);
-                    delete child.childItems;
-                    ts.Debug.assert(child.indent === 0);
-                    delete child.indent;
-                    ts.Debug.assert(child.bolded === false);
-                    delete child.bolded;
-                    ts.Debug.assert(child.grayed === false);
-                    delete child.grayed;
-                    if (child.kindModifiers === "") {
-                        delete child.kindModifiers;
-                    }
-                    return child;
-                });
-                if (item.bolded === false) {
-                    delete item.bolded;
-                }
-                if (item.grayed === false) {
-                    delete item.grayed;
+            if (JSON.stringify(items, replacer) !== JSON.stringify(json)) {
+                this.raiseError(`verifyNavigationBar failed - expected: ${JSON.stringify(json, undefined, 2)}, got: ${JSON.stringify(items, replacer, 2)}`);
+            }
+
+            // Make the data easier to read.
+            function replacer(key: string, value: any) {
+                switch (key) {
+                    case 'spans':
+                        // We won't ever check this.
+                        return undefined;
+                    case 'childItems':
+                        return value.length === 0 ? undefined : value;
+                    default:
+                        // Omit falsy values, those are presumed to be the default.
+                        return value || undefined;
                 }
-                return item;
-            });
+            }
         }
 
         public printNavigationItems(searchValue: string) {

tests/cases/fourslash/deleteClassWithEnumPresent.ts

@@ -14,8 +14,7 @@ verify.navigationBar([
                 "text": "Foo",
                 "kind": "enum"
             }
-        ],
-        "indent": 0
+        ]
     },
     {
         "text": "Foo",

tests/cases/fourslash/getNavigationBarItems.ts

@@ -14,8 +14,7 @@ verify.navigationBar([
                 "text": "C",
                 "kind": "class"
             }
-        ],
-        "indent": 0
+        ]
     },
     {
         "text": "C",

tests/cases/fourslash/navbar_const.ts

@@ -11,7 +11,6 @@ verify.navigationBar([
                 "text": "c",
                 "kind": "const"
             }
-        ],
-        "indent": 0
+        ]
     }
 ]);

tests/cases/fourslash/navbar_contains-no-duplicates.ts

@@ -45,8 +45,7 @@ verify.navigationBar([
                 "kind": "module",
                 "kindModifiers": "declare"
             }
-        ],
-        "indent": 0
+        ]
     },
     {
         "text": "ABC",

tests/cases/fourslash/navbar_exportDefault.ts

@@ -16,15 +16,12 @@ goTo.file("a.ts");
 verify.navigationBar([
     {
         "text": "\"a\"",
-        "kind": "module",
-        "childItems": [],
-        "indent": 0
+        "kind": "module"
     },
     {
         "text": "default",
         "kind": "class",
         "kindModifiers": "export",
-        "childItems": [],
         "indent": 1
     }
 ]);
@@ -40,14 +37,12 @@ verify.navigationBar([
                 "kind": "class",
                 "kindModifiers": "export"
             }
-        ],
-        "indent": 0
+        ]
     },
     {
         "text": "C",
         "kind": "class",
         "kindModifiers": "export",
-        "childItems": [],
         "indent": 1
     }
 ]);
@@ -57,14 +52,11 @@ verify.navigationBar([
     {
         "text": "\"c\"",
         "kind": "module",
-        "childItems": [],
-        "indent": 0
     },
     {
         "text": "default",
         "kind": "function",
         "kindModifiers": "export",
-        "childItems": [],
         "indent": 1
     }
 ]);
@@ -80,14 +72,12 @@ verify.navigationBar([
                 "kind": "function",
                 "kindModifiers": "export"
             }
-        ],
-        "indent": 0
+        ]
     },
     {
         "text": "Func",
         "kind": "function",
         "kindModifiers": "export",
-        "childItems": [],
         "indent": 1
     }
 ]);

tests/cases/fourslash/navbar_let.ts

@@ -11,7 +11,6 @@ verify.navigationBar([
                 "text": "c",
                 "kind": "let"
             }
-        ],
-        "indent": 0
+        ]
     }
 ]);

tests/cases/fourslash/navigationBarItemsBindingPatterns.ts

@@ -55,7 +55,6 @@ verify.navigationBar([
                 "text": "g",
                 "kind": "var"
             }
-        ],
-        "indent": 0
+        ]
     }
 ]);

tests/cases/fourslash/navigationBarItemsBindingPatternsInConstructor.ts

@@ -24,8 +24,7 @@ verify.navigationBar([
                 "text": "B",
                 "kind": "class"
             }
-        ],
-        "indent": 0
+        ]
     },
     {
         "text": "A",

tests/cases/fourslash/navigationBarItemsEmptyConstructors.ts

@@ -14,8 +14,7 @@ verify.navigationBar([
                 "text": "Test",
                 "kind": "class"
             }
-        ],
-        "indent": 0
+        ]
     },
     {
         "text": "Test",