Форматирование данных JavaScript / красивый принтер

Я пытаюсь найти способ сделать pretty printструктуру данных JavaScript в удобочитаемой форме для отладки.

У меня довольно большая и сложная структура данных, хранящаяся в JS, и мне нужно написать код для управления ею. Чтобы понять, что я делаю и где ошибаюсь, мне действительно нужно иметь возможность видеть структуру данных во всей ее полноте и обновлять ее всякий раз, когда я вношу изменения через пользовательский интерфейс.

Со всем этим я могу справиться сам, за исключением того, что нашел хороший способ вывести структуру данных JavaScript в удобочитаемую строку. JSON подойдет, но он действительно должен быть хорошо отформатирован и с отступом. Я обычно использую для этого превосходный дамп DOM от Firebug, но мне действительно нужно иметь возможность видеть всю структуру сразу, что, похоже, невозможно в Firebug.

Любые предложения приветствуются.

Заранее спасибо.

Я написал функцию для вывода JS-объекта в читаемой форме, хотя вывод не имеет отступа, но это не должно быть слишком сложно добавить: я сделал эту функцию из той, которую я сделал для Lua (которая намного сложнее ), которая решила эту проблему с отступом.

Вот «простая» версия:

function DumpObject(obj)
{
  var od = new Object;
  var result = "";
  var len = 0;

  for (var property in obj)
  {
    var value = obj[property];
    if (typeof value == 'string')
      value = "'" + value + "'";
    else if (typeof value == 'object')
    {
      if (value instanceof Array)
      {
        value = "[ " + value + " ]";
      }
      else
      {
        var ood = DumpObject(value);
        value = "{ " + ood.dump + " }";
      }
    }
    result += "'" + property + "' : " + value + ", ";
    len++;
  }
  od.dump = result.replace(/, $/, "");
  od.len = len;

  return od;
}

Я посмотрю, как его немного улучшить.
Примечание 1. Чтобы использовать это, сделайте od = DumpObject(something)и используйте od.dump. Сложно, потому что мне нужно было значение len (количество элементов) для другой цели. Заставить функцию возвращать только строку - тривиально.
Примечание 2: он не обрабатывает циклы в ссылках.

РЕДАКТИРОВАТЬ

Я сделал версию с отступом.

function DumpObjectIndented(obj, indent)
{
  var result = "";
  if (indent == null) indent = "";

  for (var property in obj)
  {
    var value = obj[property];
    if (typeof value == 'string')
      value = "'" + value + "'";
    else if (typeof value == 'object')
    {
      if (value instanceof Array)
      {
        // Just let JS convert the Array to a string!
        value = "[ " + value + " ]";
      }
      else
      {
        // Recursive dump
        // (replace "  " by "\t" or something else if you prefer)
        var od = DumpObjectIndented(value, indent + "  ");
        // If you like { on the same line as the key
        //value = "{\n" + od + "\n" + indent + "}";
        // If you prefer { and } to be aligned
        value = "\n" + indent + "{\n" + od + "\n" + indent + "}";
      }
    }
    result += indent + "'" + property + "' : " + value + ",\n";
  }
  return result.replace(/,\n$/, "");
}

Выберите отступ в строке с рекурсивным вызовом и закрепите стиль, переключив прокомментированную строку после этой.

... Я вижу, вы придумали свою версию, и это хорошо. У посетителей будет выбор.

Используйте JSON.stringify Крокфорда следующим образом:

var myArray = ['e', {pluribus: 'unum'}];
var text = JSON.stringify(myArray, null, '\t'); //you can specify a number instead of '\t' and that many spaces will be used for indentation...

Переменная textбудет выглядеть так:

[
  "e",
   {
      "pluribus": "unum"
   }
]

Кстати, для этого не требуется ничего, кроме этого JS-файла - он будет работать с любой библиотекой и т. Д.

Вы можете использовать следующие

<pre id="dump"></pre>
<script>
   var dump = JSON.stringify(sampleJsonObject, null, 4); 
   $('#dump').html(dump)
</script>

В Firebugслучае, если вы просто console.debug ("%o", my_object)можете щелкнуть по нему в консоли и войти в интерактивный проводник объектов. Он показывает весь объект и позволяет раскрывать вложенные объекты.

Для Node.js используйте:

util.inspect(object, [options]);

Документация по API

Для тех, кто ищет отличный способ увидеть свой объект, проверьте prettyPrint.js

Создает таблицу с настраиваемыми параметрами просмотра для печати где-нибудь в вашем документе. Лучше посмотреть, чем в console.

var tbl = prettyPrint( myObject, { /* options such as maxDepth, etc. */ });
document.body.appendChild(tbl);

Я программирую, Rhinoи меня не удовлетворил ни один из ответов, опубликованных здесь. Итак, я написал свой собственный симпатичный принтер:

function pp(object, depth, embedded) { 
  typeof(depth) == "number" || (depth = 0)
  typeof(embedded) == "boolean" || (embedded = false)
  var newline = false
  var spacer = function(depth) { var spaces = ""; for (var i=0;i<depth;i++) { spaces += "  "}; return spaces }
  var pretty = ""
  if (      typeof(object) == "undefined" ) { pretty += "undefined" }
  else if ( typeof(object) == "boolean" || 
            typeof(object) == "number" ) {    pretty += object.toString() } 
  else if ( typeof(object) == "string" ) {    pretty += "\"" + object + "\"" } 
  else if (        object  == null) {         pretty += "null" } 
  else if ( object instanceof(Array) ) {
    if ( object.length > 0 ) {
      if (embedded) { newline = true }
      var content = ""
      for each (var item in object) { content += pp(item, depth+1) + ",\n" + spacer(depth+1) }
      content = content.replace(/,\n\s*$/, "").replace(/^\s*/,"")
      pretty += "[ " + content + "\n" + spacer(depth) + "]"
    } else { pretty += "[]" }
  } 
  else if (typeof(object) == "object") {
    if ( Object.keys(object).length > 0 ){
      if (embedded) { newline = true }
      var content = ""
      for (var key in object) { 
        content += spacer(depth + 1) + key.toString() + ": " + pp(object[key], depth+2, true) + ",\n" 
      }
      content = content.replace(/,\n\s*$/, "").replace(/^\s*/,"")
      pretty += "{ " + content + "\n" + spacer(depth) + "}"
    } else { pretty += "{}"}
  }
  else { pretty += object.toString() }
  return ((newline ? "\n" + spacer(depth) : "") + pretty)
}

Результат выглядит так:

js> pp({foo:"bar", baz: 1})
{ foo: "bar",
  baz: 1
}
js> var taco
js> pp({foo:"bar", baz: [1,"taco",{"blarg": "moo", "mine": "craft"}, null, taco, {}], bleep: {a:null, b:taco, c: []}})
{ foo: "bar",
  baz: 
    [ 1,
      "taco",
      { blarg: "moo",
        mine: "craft"
      },
      null,
      undefined,
      {}
    ],
  bleep: 
    { a: null,
      b: undefined,
      c: []
    }
}

Я также разместил его здесь как Gist для любых будущих изменений, которые могут потребоваться.

jsDump

jsDump.parse([
    window,
    document,
    { a : 5, '1' : 'foo' },
    /^[ab]+$/g,
    new RegExp('x(.*?)z','ig'),
    alert, 
    function fn( x, y, z ){
        return x + y; 
    },
    true,
    undefined,
    null,
    new Date(),
    document.body,
    document.getElementById('links')
])

становится

[
   [Window],
   [Document],
   {
      "1": "foo",
      "a": 5
   },
   /^[ab]+$/g,
   /x(.*?)z/gi,
   function alert( a ){
      [code]
   },
   function fn( a, b, c ){
      [code]
   },
   true,
   undefined,
   null,
   "Fri Feb 19 2010 00:49:45 GMT+0300 (MSK)",
   <body id="body" class="node"></body>,
   <div id="links">
]

QUnit ( фреймворк модульного тестирования, используемый jQuery) с использованием слегка исправленной версии jsDump.

JSON.stringify () - не лучший выбор в некоторых случаях.

JSON.stringify({f:function(){}}) // "{}"
JSON.stringify(document.body)    // TypeError: Converting circular structure to JSON

Взяв на себя инициативу PhiLho (большое спасибо :)), я написал свой собственный, поскольку не мог заставить его делать то, что я хотел. Он довольно грубый и готовый, но он делает то, что мне нужно. Спасибо всем за отличные предложения.

Я знаю, что это не блестящий код, но, как бы то ни было, вот он. Кому-то это может пригодиться:

// Usage: dump(object)
function dump(object, pad){
    var indent = '\t'
    if (!pad) pad = ''
    var out = ''
    if (object.constructor == Array){
        out += '[\n'
        for (var i=0; i<object.length; i++){
            out += pad + indent + dump(object[i], pad + indent) + '\n'
        }
        out += pad + ']'
    }else if (object.constructor == Object){
        out += '{\n'
        for (var i in object){
            out += pad + indent + i + ': ' + dump(object[i], pad + indent) + '\n'
        }
        out += pad + '}'
    }else{
        out += object
    }
    return out
}

На самом деле это просто комментарий к статье Джейсона Бантинга «Использовать JSON.stringify Крокфорда», но я не смог добавить комментарий к этому ответу.

Как отмечено в комментариях, JSON.stringify не очень хорошо работает с библиотекой Prototype (www.prototypejs.org). Тем не менее, довольно легко заставить их хорошо работать вместе, временно удалив метод Array.prototype.toJSON, добавленный прототипом, запустите Crockford stringify (), а затем верните его следующим образом:

  var temp = Array.prototype.toJSON;
  delete Array.prototype.toJSON;
  $('result').value += JSON.stringify(profile_base, null, 2);
  Array.prototype.toJSON = temp;

Я подумал, что ответ Дж. Бантингса на использование JSON.stringify тоже был хорош. Кроме того, вы можете использовать JSON.stringify через объект YUI JSON, если вы используете YUI. В моем случае мне нужно было сделать дамп в HTML, чтобы было проще просто настроить / вырезать / вставить ответ PhiLho.

function dumpObject(obj, indent) 
{
  var CR = "<br />", SPC = "&nbsp;&nbsp;&nbsp;&nbsp;", result = "";
  if (indent == null) indent = "";

  for (var property in obj)
  {
    var value = obj[property];

    if (typeof value == 'string')
    {
      value = "'" + value + "'";
    }
    else if (typeof value == 'object')
    {
      if (value instanceof Array)
      {
        // Just let JS convert the Array to a string!
        value = "[ " + value + " ]";
      }
      else
      {
        var od = dumpObject(value, indent + SPC);
        value = CR + indent + "{" + CR + od + CR + indent + "}";
      }
    }
    result += indent + "'" + property + "' : " + value + "," + CR;
  }
  return result;
}

Многие люди пишут код в этой ветке, оставляя много комментариев по поводу различных ошибок. Мне понравилось это решение, потому что оно казалось законченным и представляло собой единый файл без зависимостей.

браузер

nodejs

Он работал «из коробки» и имел версии для узла и браузера (предположительно, просто разные оболочки, но я не стал копаться, чтобы подтвердить).

Библиотека также поддерживает удобную печать XML, SQL и CSS, но я не пробовал эти функции.

Простой для печати элементов в виде строк:

var s = "";
var len = array.length;
var lenMinus1 = len - 1
for (var i = 0; i < len; i++) {
   s += array[i];
   if(i < lenMinus1)  {
      s += ", ";
   }
}
alert(s);

Моя библиотека NeatJSON имеет версии Ruby и JavaScript . Он находится в свободном доступе по (разрешительной) лицензии MIT. Вы можете просмотреть онлайн-демонстрацию / конвертер по адресу:
http://phrogz.net/JS/neatjson/neatjson.html

Некоторые функции (все необязательно):

• Оберните до определенной ширины; если объект или массив может уместиться в строке, он хранится в одной строке.
• Совместите двоеточия для всех ключей в объекте.
• Отсортируйте ключи к объекту по алфавиту.
• Отформатируйте числа с плавающей запятой до определенного количества десятичных знаков.
• При переносе используйте «короткую» версию, в которой открывающие / закрывающие скобки для массивов и объектов помещаются в одну строку с первым / последним значением.
• Детально контролируйте пробелы для массивов и объектов (внутри скобок, до / после двоеточий и запятых).
• Работает в веб-браузере и как модуль Node.js.

flexjson включает функцию prettyPrint (), которая может дать вам то, что вы хотите.