ENRU

Как отформатировать JSON: код, редакторы и онлайн

Обновлено

Отформатировать JSON — значит расставить переводы строк и отступы. И больше ничего. Но многие инструменты по дороге разбирают JSON и печатают его заново, и 1.10 превращается в 1.1. Ниже — команда для каждого языка и редактора и что она меняет, кроме пробелов.

Как отформатировать JSON: команды коротко

ГдеКомандаЧто меняется, кроме пробелов
Python, терминалpython3 -m json.tool data.json1.10 станет 1.1, кириллица — экранами \u041f…
Python, кодjson.dumps(data, indent=2)То же: значения печатаются заново из типов Python
jq 1.7+jq . data.jsonЦифры на месте; экраны в строках и запись экспоненты могут поменяться
JavaScriptJSON.stringify(value, null, 2)Большие целые округляются, 1.10 станет 1.1, ключи-числа уходят вперёд
Gojson.Indent(&out, raw, "", " ")Ничего: только пробелы
PowerShellConvertTo-Json -Depth 100Значения печатаются заново; без -Depth глубокие уровни становятся строками
VS Code, IntelliJFormat Document, Reformat CodeНичего: только пробелы
Notepad++, SublimeПлагин: JSON Viewer, JSTool, Pretty JSONЗависит от плагина
ОнлайнФорматирование JSONНичего: только пробелы; ключи сортируются, только если попросить

Как отформатировать JSON в Python

import json

with open("data.json", encoding="utf-8") as f:
    data = json.load(f)

# ensure_ascii=False: чтобы кириллица осталась кириллицей
print(json.dumps(data, indent=2, ensure_ascii=False))

with open("pretty.json", "w", encoding="utf-8") as f:
    json.dump(data, f, indent=2, ensure_ascii=False)
    f.write("\n")

indent — число пробелов или строка, например "\t". Без ensure_ascii=False каждый символ за пределами латиницы пишется экраном: Привет превращается в \u041f\u0440\u0438\u0432\u0435\u0442. encoding="utf-8" тоже не лишний: без него open на Windows читает файл в кодировке системы, обычно cp1251. sort_keys=True сортирует ключи. Большие целые Python хранит точно, а дробные проходят через float: 1.10 печатается как 1.1, 1E3 — как 1000.0.

Из терминала тот же модуль работает без скрипта:

python3 -m json.tool data.json
python3 -m json.tool --indent 2 data.json pretty.json
python3 -m json.tool --tab --sort-keys --no-ensure-ascii data.json
curl -s https://example.com/api/items | python3 -m json.tool

По умолчанию отступ — 4 пробела; --indent, --tab и --no-ensure-ascii есть с Python 3.9. На Windows команда часто начинается с py: py -m json.tool. Не указывай один и тот же файл входом и выходом: в Python 3.9 выходной файл открывается первым, к моменту чтения он уже пуст, и данные пропадают.

Форматирование JSON через jq

jq . data.json
jq --indent 4 . data.json
jq --tab . data.json
jq -S . data.json > sorted.json
curl -s https://example.com/api/items | jq .

Фильтр . печатает вход как есть, с отступом в 2 пробела; --indent принимает не больше 7, -S сортирует ключи. С версии 1.7 jq сохраняет запись чисел: 1.10 и 12345678901234567890 доживают до вывода. Старые версии переводят каждое число в double. Но и 1.7 округляет, стоит что-то посчитать (.n + 0), а ещё превращает \u00eb в ë, \/ в / и 1E3 в 1E+3.

JavaScript: JSON.stringify с отступом

const pretty = JSON.stringify(JSON.parse(text), null, 2);
const withTabs = JSON.stringify(JSON.parse(text), null, '\t');

// Node.js, из stdin:
// node -e 'console.log(JSON.stringify(JSON.parse(require("fs").readFileSync(0, "utf8")), null, 2))' < data.json

Для данных, которые создал твой же код, этого хватает. С чужим файлом помни, что делает круг через JSON.parse:

  • Целые больше 2^53 − 1 округляются: 12345678901234567890 возвращается как 12345678901234567000. Подробно — в статье о больших числах в JSON.
  • Запись числа теряется: 1.10 становится 1.1, 1e3 — 1000.
  • Ключи, похожие на целые числа, уходят вперёд по возрастанию: {"b":1,"10":2,"2":3} печатается в порядке "2", "10", "b". Почему — в статье о порядке ключей.
  • Отступ ограничен десятью: число больше даст 10 пробелов, строка длиннее обрежется до 10 символов.
  • То, чего нет в JSON: BigInt бросает TypeError: Do not know how to serialize a BigInt, undefined и функции исчезают, NaN и Infinity становятся null, даты — строками вида "1970-01-01T00:00:00.000Z".

Go: json.Indent и json.MarshalIndent

raw, err := os.ReadFile("data.json")
if err != nil {
	log.Fatal(err)
}
var out bytes.Buffer
if err := json.Indent(&out, raw, "", "  "); err != nil {
	log.Fatal("невалидный JSON: ", err)
}
fmt.Println(out.String())

json.Indent копирует вход лексема за лексемой и только добавляет пробелы: числа, экраны и порядок ключей остаются как были. На сломанном входе он возвращает ошибку вроде invalid character '}' looking for beginning of object key string. json.MarshalIndent — другое: он печатает значение Go, поэтому map[string]any выходит с отсортированными ключами, большие целые округляются через float64, а <, > и & превращаются в \u003c, \u003e, \u0026. Он — для своих структур, json.Indent — для файлов.

PowerShell: ConvertTo-Json -Depth

Get-Content data.json -Raw | ConvertFrom-Json | ConvertTo-Json -Depth 100
Get-Content data.json -Raw | ConvertFrom-Json | ConvertTo-Json -Depth 100 | Set-Content pretty.json -Encoding utf8

-Raw читает файл одной строкой. Главное — -Depth: по умолчанию ConvertTo-Json спускается на 2 уровня, а всё глубже превращает в строку вида @{id=1}. PowerShell 7.1 и новее об этом предупреждает, Windows PowerShell 5.1 делает молча. Максимум — 100. Значения PowerShell печатает заново сам, так что запись чисел может поменяться. Windows PowerShell 5.1 ставит неровные отступы, а -Encoding utf8 в нём добавляет BOM; PowerShell 7 (pwsh) отступает на 2 пробела и пишет UTF-8 без BOM.

Как отформатировать JSON в VS Code

  1. Открыть файл .json. Если текст скопирован: новый файл (Ctrl/Cmd+N), вставить, затем выбрать язык — Ctrl/Cmd+K, потом M, набрать JSON.
  2. Запустить Format Document («Форматировать документ»): Shift+Alt+F на Windows, Shift+Option+F на macOS, Ctrl+Shift+I на Linux или через палитру команд (Ctrl/Cmd+Shift+P).
  3. Чтобы отформатировать только часть, выделить её и нажать Ctrl/Cmd+K, затем Ctrl/Cmd+F (Format Selection).
  4. Отступ берётся из настроек редактора: щелчок по Spaces: 4 в строке состояния меняет его. Форматировать при каждом сохранении — "editor.formatOnSave": true.

Встроенный форматтер JSON меняет только пробелы и не трогает комментарии в файлах JSON with Comments вроде settings.json (комментарии в JSON). Если Format Document нет в меню или редактор просит поставить форматтер, файл открыт не в режиме JSON: повтори шаг 1.

Как отформатировать JSON в Notepad++ с плагином и без

С плагином JSON Viewer

  1. Плагины > Управление плагинами (Plugins Admin), на вкладке «Доступные» найти JSON Viewer, отметить и нажать «Установить». Notepad++ перезапустится.
  2. Открыть файл или вставить JSON.
  3. Плагины > JSON Viewer > Format JSON или Ctrl+Alt+Shift+M.

JSTool работает так же: Плагины > JSTool > JSFormat (Ctrl+Alt+M). Оба плагина ещё и показывают документ деревом в боковой панели.

Без плагина

Своего форматтера JSON в Notepad++ нет: Синтаксисы > J > JSON только раскрашивает текст и сворачивает блоки. Регулярное выражение, которое ставит перевод строки после каждой запятой и скобки, не годится: запятые и скобки внутри строк тоже разъедутся. Надёжных путей два: вставить текст в онлайн-форматтер и скопировать обратно или поручить работу Python через Запуск > Запустить… (F5):

python -m json.tool --indent 2 "$(FULL_CURRENT_PATH)" "$(CURRENT_DIRECTORY)\$(NAME_PART).pretty.json"

Команда пишет имя.pretty.json рядом с исходным файлом; открыть его — «Файл > Открыть». Если python не находится, замени на py. Выходной файл всегда другой, а не исходный — причина в разделе о Python.

Форматирование JSON в IntelliJ и других средах JetBrains

Code > Reformat Code: Ctrl+Alt+L на Windows и Linux, Cmd+Option+L на macOS. Без выделения форматируется весь файл. Размер отступа и переносы — в Settings > Editor > Code Style > JSON. Для фрагмента без файла подойдёт scratch-файл (Ctrl+Alt+Shift+Insert, на macOS — Cmd+Shift+N): выбрать JSON, вставить, отформатировать. В PyCharm, WebStorm, GoLand и остальных средах JetBrains сочетание то же.

Форматирование JSON в Sublime Text

Из коробки Sublime Text JSON не переформатирует. Нужен пакет Pretty JSON: палитра команд (Ctrl/Cmd+Shift+P) > Package Control: Install Package > Pretty JSON. Дальше в палитре — Pretty JSON: Format JSON. Подсветку и сворачивание даёт View > Syntax > JSON.

Отформатировать JSON онлайн

Вставь текст в форматтер, перетащи файл или нажми Ctrl/Cmd+O (до 1 МиБ), выбери 2 пробела, 4 или таб и нажми Ctrl/Cmd+Enter. Меняются только пробелы: 1.10, 12345678901234567890 и порядок ключей остаются как в исходнике; сортировка ключей — отдельный переключатель. На сломанном JSON вместо догадок будет первая ошибка со строкой и колонкой; просто проверить — в валидаторе. Текст уходит на наш API по HTTPS, обрабатывается в памяти и не хранится (Безопасность и данные). Обратная операция, одна строка без пробелов, — минификация.

Частые вопросы о форматировании JSON

Меняет ли форматирование данные?

Не должно, но многие инструменты разбирают JSON и печатают заново, и значения проходят через типы языка. Только пробелы меняют json.Indent в Go, VS Code, IntelliJ и наш форматтер. Разбирают и печатают заново JSON.stringify, json.dumps, ConvertTo-Json. jq 1.7 — посередине: цифры сохраняет, экраны может переписать.

Сколько ставить отступ: 2 пробела, 4 или таб?

JSON всё равно: пробелы между лексемами ничего не значат (RFC 8259, раздел 2). jq и большинство проектов на JavaScript используют 2 пробела, json.tool в Python по умолчанию — 4. Выбери один вариант на проект и отдай его форматтеру.

Как отформатировать ответ curl?

Через конвейер: curl -s URL | jq . или curl -s URL | python3 -m json.tool. Если ошибка разбора ругается на <, сервер прислал HTML-страницу, а не JSON: см. Unexpected token.

Как отформатировать файл JSON Lines?

jq . file.jsonl печатает каждую запись с отступами, python3 -m json.tool --json-lines file.jsonl — тоже. Результат уже не JSON Lines: подробнее в статье о JSON Lines.