Can a JSON value contain a multiline string

Question

I am writing a JSON file which would be read by a Java program. The fragment is as follows...

{
  "testCases" :
  {
    "case.1" :
    {
      "scenario" : "this the case 1.",
      "result" : "this is a very long line which is not easily readble.
                  so i would like to write it in multiple lines.
                  but, i do NOT require any new lines in the output.
                  I need to split the string value in this input file only.
                  such that I don't require to slide the horizontal scroll again and again while verifying the correctness of the statements.
                  the prev line, I have shown, without splitting just to give a feel of my problem"
    }
  }
}

I think this is more about readability of the serialized JSON file and not about linebreaks in the loaded data (thus, not a duplicate of Multiline strings in JSON). Think of it more like using JSON as a configuration file where you have a long string and, for readability, it is helpful to hard-wrap the string in case someone is editing it via a text editor. — zashu
– zashu, Commented Aug 22, 2013 at 22:54
@zashu: Most text editors have a soft-wrap function. That's immediately more useful than some hard-coded line width. — Lightness Races in Orbit
– Lightness Races in Orbit, Commented Feb 17, 2014 at 15:50
@LightnessRacesinOrbit running git diffs (or resolving merge conflicts) on files with such long lines is also a pain. — Alicja Kario
– Alicja Kario, Commented Nov 20, 2015 at 14:20
This IS a dupe a of Multiline string in JSON, citing that OP's question: "Is it possible to have multi-line strings in JSON? It's mostly for visual comfort so I suppose I can just turn word wrap on in my editor, but I'm just kinda curious..." — Andre Figueiredo
– Andre Figueiredo, Commented Jan 26, 2018 at 13:15

Rob Bednark · Accepted Answer · 2020-10-26 21:05:59Z

81

Per the specification, the JSON grammar's char production can take the following values:

any-Unicode-character-except-"-or-\-or-control-character
\"
\\
\/
\b
\f
\n
\r
\t
\u four-hex-digits

Newlines are "control characters", so no, you may not have a literal newline within your string. However, you may encode it using whatever combination of \n and \r you require.

The JSONLint tool confirms that your JSON is invalid.

And, if you want to write newlines inside your JSON syntax without actually including newlines in the data, then you're doubly out of luck. While JSON is intended to be human-friendly to a degree, it is still data and you're trying to apply arbitrary formatting to that data. That is absolutely not what JSON is about.

edited Oct 26, 2020 at 21:05

Rob Bednark

28.8k28 gold badges90 silver badges131 bronze badges

answered May 22, 2013 at 11:08

Lightness Races in Orbit

387k77 gold badges671 silver badges1.1k bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

ruffin Over a year ago

"While JSON is intended to be human-friendly to a degree, it is still data..." There it is. Or, as Crockford puts it, "[JSON] is easy for humans to read and write. It is easy for machines to parse and generate." [emph mine] One might argue that template literals would be a good addition, but one might have to argue with Crockford (and, natch, individual JSON implementations).

Elisha Habinsky · Accepted Answer · 2022-04-27 10:42:21Z

43

I'm not sure of your exact requirement but one possible solution to improve 'readability' is to store it as an array.

{
  "testCases" :
  {
    "case.1" :
    {
      "scenario" : "this the case 1.",
      "result" : ["this is a very long line which is not easily readble.",
                  "so i would like to write it in multiple lines.",
                  "but, i do NOT require any new lines in the output."]
    }
  }
}

}

Then join it back as the need arrives with

    result.join(" ")

edited Apr 27, 2022 at 10:42

Elisha Habinsky

13110 bronze badges

answered Jan 24, 2014 at 13:10

Brian McAuliffe

2,1751 gold badge16 silver badges13 bronze badges

4 Comments

Lightness Races in Orbit Over a year ago

That's unsemantic though. It's an abstraction leak. I would consider a data format specified in this way to be, essentially, broken.

Adam Dyga Over a year ago

I can't imagine designing an API or JSON document this way just to increase string readability (only for debugging reasons I guess) :| ....

sf_jeff Over a year ago

" I would consider a data format specified in this way to be, essentially, broken." Consider that this is for a test case, though. If you want to hard-code strings you probably want a properties file. I personally wouldn't store "real" data in JSON in normal circumstances. But if this is a simple way to go from no tests to tests, then go for it.

yota Over a year ago

@AdamDyga in fact it could be usefull in order to store the json files into a CVS, where the unit of delta is the line.

Cody Gray · Accepted Answer · 2021-01-29 01:50:39Z

10

Not pretty good solution, but you can try the hjson tool. It allows you to write text multi-lined in editor and then converts it to the proper valid JSON format.

Note: it adds '\n' characters for the new lines, but you can simply delete them in any text editor with the "Replace all.." function.

edited Jan 29, 2021 at 1:50

Cody Gray♦

246k53 gold badges513 silver badges591 bronze badges

answered Jun 30, 2016 at 8:25

omalyutin

4547 silver badges27 bronze badges

1 Comment

Lightness Races in Orbit Over a year ago

That's a good idea actually. Version control the Hjson and have it transpiled to JSON as needed.

Elric Best · Accepted Answer · 2016-11-21 17:34:25Z

4

I believe it depends on what json interpreter you're using... in plain javascript you could use line terminators

{
  "testCases" :
  {
    "case.1" :
    {
      "scenario" : "this the case 1.",
      "result" : "this is a very long line which is not easily readble. \
                  so i would like to write it in multiple lines. \
                  but, i do NOT require any new lines in the output."
    }
  }
}

answered Nov 21, 2016 at 17:34

Elric Best

514 bronze badges

3 Comments

Andre Figueiredo Over a year ago

This is correct, but indentation spaces will output: a\ c => a c.

Lightness Races in Orbit Over a year ago

JavaScript has no "JSON interpreter" that would accept this. It can only take JSON in a string. True, if you provided JSON inside a string literal then you could take this approach, but that's an unusual thing to do. Are you confusing JSON with actual object declarations in JavaScript?

kfkhalili Over a year ago

This is not valid JSON.

JustAnotherCurious · Accepted Answer · 2013-05-22 11:58:27Z

As I could understand the question is not about how pass a string with control symbols using json but how to store and restore json in file where you can split a string with editor control symbols.

If you want to store multiline string in a file then your file will not store the valid json object. But if you use your json files in your program only, then you can store the data as you wanted and remove all newlines from file manually each time you load it to your program and then pass to json parser.

Or, alternatively, which would be better, you can have your json data source files where you edit a sting as you want and then remove all new lines with some utility to the valid json file which your program will use.

Collectives™ on Stack Overflow

Can a JSON value contain a multiline string

5 Answers 5

1 Comment

4 Comments

1 Comment

3 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

1 Comment

4 Comments

1 Comment

3 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related