Extension docs: Adjusting `.../samples.html` to have more readable diffs.

chrome/common/extensions/docs/static/samples.html

 <link rel="stylesheet" href="css/samples.css" />
 <script jscontent="search_data"></script>
 <script src="js/sample_search.js"></script>
 
 <script type="text/prerenderjs">
   /**
    * The following code is executed before the jstemplate in this file is
    * rendered, meaning it can modify template data by changing the pageData
    * window variable.  See api_page_generator.js for more information.
    *
@@ skipping 38 matching lines @@
     for (var i = 0; i < source_files.length; i++) {
       sample.source_files.push({
           'file': source_files[i],
           'url': 'http://src.chromium.org/viewvc/chrome/trunk' +
                  '/src/chrome/common/extensions/docs/' + sample.path +
                  source_files[i] + '?content-type=text/plain'
       });
     }
   });
 
+  function stringifyFlatObjectsReadably(obj) {
+    if (typeof(obj) === "object") {
+      var temp = [];
+      for (key in obj) {
+        if (obj.hasOwnProperty(key)) {
+          if (typeof(key) === "string" && typeof(obj[key]) === "string") {
+            temp.push("  " + JSON.stringify(key) + ": " +
+                JSON.stringify(obj[key]));
+          } else {

[Pam (message me for reviews), 2011/08/09 11:52:06]

I'm not a JS expert, but should this be out one level? That is, fall back to
JSON.stringify() if we find any key in obj that doesn't match hasOwnProperty(),
not just if it's not a string.

[Use mkwst_at_chromium.org plz., 2011/08/09 11:57:32]

If it's a property that the object doesn't itself have, then it's a property of
it's prototype (methods like `toString` or the like). It's perfectly reasonable
for an object to have inherited properties that we wouldn't want to print (I
guess...).

In this particular scenario, it makes no difference at all, as we create an
object literal that has no properties to speak of. But it's best practice, so...

+            // We hit something strange; it's not a flat object: abort!
+            return JSON.stringify(obj);
+          }
+        }
+      }
+      return "{\n" + temp.join(",\n") + "}";
+    } else {
+      return JSON.stringify(obj);
+    }
+  }
+
   // The search data should be injected as executable JavaScript, so assign
   // a template value which will store the data as a page global.
   pageData.search_data = "var search_data = " +
-                         JSON.stringify(search_data); + ";";
+                         stringifyFlatObjectsReadably(search_data) + ";\n";
 </script>
 
 <div id="controls">
   <div id="searchbox" class="controlbox">
     <strong>Filter by keyword:</strong>
     <input autofocus type="search" type="text" id="searchinput" placeholder="Type to search" onkeyup="filterSamples();" />
     <a id="clearlink" href="javascript:void(0);" onclick="clearFilter();" style="display: none;">clear</a>
   </div>
 
   <div id="filterbox" class="controlbox">
@@ skipping 35 matching lines @@
   </div>
   <div>
     <a jsvalues="href:'http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/' + path" target="_blank">Browse source</a>
     - <a jsvalues="href:$this.zip_path">Download source</a>
   </div>
 </div>
 
 <div id="noresults" style="display:none">
   Sorry, no results were found.
 </div>