dprint/dprint-plugin-json

JSON code formatting plugin for dprint.

dprint

Monorepo for dprint—a pluggable and configurable code formatting platform.

Links

• Overview
• Getting Started
• Playground

Plugins

• dprint-plugin-typescript - TypeScript/JavaScript code formatter.
• dprint-plugin-json - JSON/JSONC code formatter.
• dprint-plugin-markdown - Markdown code formatter.
• dprint-plugin-toml - TOML code formatter.
• dprint-plugin-jupyter - Jupyter notebook code block formatter.
• dprint-plugin-dockerfile - Dockerfile code formatter.
• dprint-plugin-biome - Biome (JS/TS) wrapper plugin.
• dprint-plugin-prettier - Prettier wrapper plugin.
• dprint-plugin-roslyn - Roslyn (C#/VB) wrapper plugin.
• dprint-plugin-ruff - Ruff (Python) wrapper plugin.
• dprint-plugin-exec - Formats code with any CLI executable.

Notes

This repo is under active early development.

1. The interface between the CLI and plugins might change often. You may need to keep updating to the latest version of both the CLI and plugins (the CLI will let you know what to do).
   • An upgrade path will be outlined in the release notes when this occurs.
2. I do a lot of this development in my spare time. Please consider sponsoring if you are a commercial company using this.

dprint-plugin-json's Issues

🙏🏻[feat/req] add 'preferSingleLine' option

Currently, for JSON elements which are split onto multiple lines, but fit into the line length, the multi-line format is always maintained. For example,

{
  "includes": ["**/*.{ts,tsx,js,jsx,cjs,mjs,json,md,rs}"],
  "excludes": [
    ".history",
    "**/node_modules"
  ]
}

won't shrink the excludes entry unless the first entry (".history") is on the initial line.

Ultimately, I'm trying to create repeatable final formatting for files which might be formatted in a different style (eg, deno or prettier). A 'preferSingleLine' option makes that an easier/possible task.

In fact, while thinking about this post, it occurs to me that a "global" version of 'preferSingleLine' indicating a default to capable plugins might be a useful option to help create the same output no matter the form (basically differing only in whitespace).

Can't formatting over 4 files with `.sh` script

OS

Windows 11 Pro. WSL 2.

11th Gen Intel(R) Core(TM) i7-1165G7 @ 2.80GHz 2.80 GHz

RAM 16gb

Dprint version

0.41.0

JSON plugin

https://plugins.dprint.dev/json-0.17.4.wasm

dprint.json

{
  "plugins": [
    "https://plugins.dprint.dev/json-0.17.4.wasm"
  ]
}

My script

# /bin/sh

echo "dprint:"

START=$(date +%s%N)
  
npx dprint fmt --incremental=false
  
END=$(date +%s%N)

milliseconds=$((($END - $START)/1000000))

seconds=$(($milliseconds/1000))

minutes=$(($seconds/60))

echo "$milliseconds"
echo "$seconds"
echo "$minutes"

Log

WARNING: Formatting is slow for [my_path]/jsonformat/benches/large-file_1.json
WARNING: Formatting is slow for [my_path]/jsonformat/benches/large-file_2.json
WARNING: Formatting is slow for [my_path]/jsonformat/benches/large-file_3.json
WARNING: Formatting is slow for [my_path]/jsonformat/benches/large-file_4.json
WARNING: Formatting is slow for [my_path]/jsonformat/benches/large-file_5.json
WARNING: Formatting is slow for [my_path]/jsonformat/benches/large-file_6.json
....

I created 100 identical files from https://github.com/Nilstrieb/jsonformat/blob/master/benches/large-file.json.

When I format 4 files everything is fine! But when I try to format more, then I see a WARNING and not one file is formatted.

Panic on invalid JSON

Describe the bug

dprint-plugin-json version: 0.17.1

Input Code

{},

Note the two newlines after the comma.

Expected Output

some diagnostic about this being invalid code

Actual Output

Panic!

============================================================
Deno has panicked. This is a bug in Deno. Please report this
at https://github.com/denoland/deno/issues/new.
If you can reliably reproduce this panic, include the
reproduction steps and re-run with the RUST_BACKTRACE=1 env
var set and include the backtrace in your report.

Platform: macos aarch64
Version: 1.32.1
Args: ["deno", "fmt", "test.json"]

thread 'tokio-runtime-worker' panicked at 'capacity overflow', library/alloc/src/raw_vec.rs:518:5
stack backtrace:
   0: _rust_begin_unwind
   1: core::panicking::panic_fmt
   2: alloc::raw_vec::capacity_overflow
   3: alloc::str::<impl str>::repeat
   4: dprint_core::formatting::utils::string_utils::format_diagnostic
   5: dprint_plugin_json::format_text::format_text
   6: deno::tools::fmt::format_json
   7: deno::tools::fmt::format_file
   8: tokio::runtime::task::raw::poll

no meaningful error message given for `\u200b` in text

Describe the bug

dprint-plugin-json version: 0.13.2

Input Code

{
  "compilerOptions": {
    "esModuleInterop": true​
  }
}

Expected Output

something meaningful.

Actual Output

Error formatting C:/Users/Trim21/proj/cactbot/tsconfig-for-webpack.json. Message: RuntimeError: unreachable
    at __rust_start_panic (<module>[543]:0x3a39e)
    at rust_panic (<module>[540]:0x3a364)
    at std::panicking::rust_panic_with_hook::ha223473efd20893e (<module>[535]:0x3a0ac)
    at std::panicking::begin_panic_handler::{{closure}}::h0eb6605d81329fe7 (<module>[527]:0x39a44)
    at std::sys_common::backtrace::__rust_end_short_backtrace::h8c7d312a147e1df9 (<module>[526]:0x39993)
    at rust_begin_unwind (<module>[534]:0x39f85)
    at core::panicking::panic_fmt::hca0bee0b11468063 (<module>[619]:0x40554)
    at core::str::slice_error_fail::h2e3fd31345cd0cd6 (<module>[639]:0x41a85)
    at dprint_core::formatting::utils::string_utils::format_diagnostic::ha38e663e29e48684 (<module>[452]:0x351da)
    at dprint_plugin_json::format_text::format_text::h90fe515ff2009a58 (<module>[240]:0x1aacb)
    at format (<module>[208]:0x177de)
Had 1 error(s) formatting.

https://dprint.dev/playground/#code/N4WAUABBBEDGD2BbADgSwDYFMBOB5ZALqvAHYDO0AXBKJFDJmQLLwAmArlgJIkE7zIqEAtnaZA0ATgoAX3CywQA/language/json

Add trailing comma configuration

Probably "always", "jsonc", and "never" options, with "never" being the default.

Formatting JSONC can lose comments yet still indicate success

Describe the bug

deno fmt can lose comments without any indication.
Minimal reproducible examples (via deno fmt): here
Additional details: denoland/deno_std#3502 (comment)

Another way to reproduce:

dprint fmt --config <(echo '{"plugins": ["https://plugins.dprint.dev/json-0.17.4.wasm"]}')

dprint version: 0.41.0
dprint-plugin-json version: 0.17.4

Input Code

// before-value (context: top-level)
{
  // before-key (context: object spot 0)
  "k0"
  // after-key (context: object spot 0)
  :
  // before-value (context: object spot 0)
  "v0"
  // after-value (context: object spot 0)
  ,
  // before-key (context: object spot 1)
}
// after-value (context: top-level)

Expected Output

One of two options:

• A canonical rearrangement of the comments' contents.
• Failure if comments would otherwise be lost! (To signal to the user that the comments should be rearranged in order to avoid comment loss.)

Actual Output

// before-value (context: top-level)
{
  // before-key (context: object spot 0)
  "k0": // before-value (context: object spot 0)
  "v0"
  // before-key (context: object spot 1)
}
// after-value (context: top-level)

Allow disabling the new line requirement

Most packcage managers will remove the trailing new line when adding or removing packcages, but otherwise the file matches dprints format.

Allow ignore mising newlines at the end of the file

JSON formatting is super slow on a 700KB single line JSON file

I provided dprint with a 700KB single line JSON file and there seems to be no end in sight to it finishing formatting. I can't provide the file here because it's proprietary information. I formatted it with VS code rather quickly and it ended up being 40K lines.

Worth noting that after the file was formatted with VSCode it is back to being quick enough again.

Rewrite formatter to format a stream of bytes

There's really no need to parse JSON. Instead this could work directly off a stream of bytes.

Ref: #19 #5 dprint/dprint#792

format invalid code ?

I'm not sure if this is in this plugin goals, but https://www.npmjs.com/package/js-beautify for example seems to always format code, even with sytnax errors

interface    { //missing type name
}

Unable to parse correctly number with exponent and no sign

Describe the bug

The scanner is not able to parse numbers where no prefix (+ or -) is given for the exponent. According to the spec, specifying a prefix is optional, making values like this a valid number: 1e1.

This issue additionally hurt by the fact, that Go's standard JSON marshaler will not add the optional +, so a huge amount of JSON files generated by Go API backends can currently not be correctly formatted by dprint.

• Playground example: https://dprint.dev/playground/#code/IwU2Q/language/json
• Spec: https://datatracker.ietf.org/doc/html/rfc8259#section-6
• Respective code in Go standard library: https://cs.opensource.google/go/go/+/refs/heads/master:src/strconv/ftoa.go;drc=e8c8b79f000515e086012df632f01fc0ec21076b;l=381

dprint-plugin-json version: 0.17.1

Input Code

1e1

Expected Output

1e1

Actual Output

Line 1, column 3: Expected plus or minus symbol in number literal

VSCode says dprint can format json but not json with comments

I cannot format jsonc with vscode only json

Allow formatting keys with no quotes

denoland/deno#20623

Allow having trailing commas for config files like tsconfig.json

I like having trailing commas in files like:

• tsconfig.json
• jsconfig.json
• .vscode/settings.json
• .vscode/extensions.json

Even though these files have .json in their name, it is common enough and acceptable to sometimes have trailing commas in these files. But dprint always removes them.

fails to format json with invalid unicode

{
    "": "\ud83d\udcf1",
}

deno fmt fails to format files contains such things, maybe its better to ignore these kind of errors and still format the file

npm:[email protected] for example does format such files (with no warnings/errors)

Have ignore comments apply to trailing commas

A bit of an edge case, but it would be better for ignore comments to apply to trailing commas, so this would format as-is:

{
  "tasks": {
    // dprint-fmt-ignore
    "foo": "echo bar",
  }
}

See denoland/deno#15422

Invalid UTF-8 chars prevent formatting

Describe the bug

deno fmt fails to format a JSON file because it contains invalid UTF8 chars.

dprint-plugin-json version: 0.10.2

Input Code

See https://gist.github.com/lucacasonato/a060df497ca3156327bcef46a554a8fb

Expected Output

A nicely formatted file, like prettier is able to generate.

Actual Output

Error formatting: /home/lucacasonato/Downloads/report.json
   Line 1, column 785340: Invalid unicode escape sequence. 'd834' is not a valid UTF8 character

  to ArrayBuffer with \ud834A\udf06A¥
                      ~~~~~~

Too slow formatting this single line JSON file

Describe the bug

dprint-plugin-json version: 0.10.1

Uploaded as txt to bypass supported github files, but it's a json file:

swc_ecma_parser.txt