Lua cJSON Pretty Formatter
Lua
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib/resty Release 1.5 Apr 23, 2016
Changes.md Fixed a typo. Sep 29, 2016
LICENSE Release 1.4. Apr 23, 2016
README.md Updated installation instructions. Sep 30, 2016
dist.ini Release 1.6. Sep 29, 2016
lua-resty-prettycjson-dev-1.rockspec Release 1.0 Sep 28, 2015

README.md

lua-resty-prettycjson

lua-resty-prettycjson is a JSON Pretty Formatter for Lua cJSON.

Installation

Just place prettycjson.lua somewhere in your package.path, under resty directory. If you are using OpenResty, the default location would be /usr/local/openresty/lualib/resty.

Using OpenResty Package Manager (opm)

$ opm get bungle/lua-resty-prettycjson

Using LuaRocks

$ luarocks install lua-resty-prettycjson

LuaRocks repository for lua-resty-prettycjson is located at https://luarocks.org/modules/bungle/lua-resty-prettycjson.

Lua API

string function(dt, [lf = "\n", [id = "\t", [ac = " ", [ec = function]]]])

Pretty formats the JSON output. You may pass lf (line feed) if you want to use different linefeed than the default \n. If you want to indent (id argument) with something else than \t (a tab) you can pass that as arguments as well. And if you want to have something else than (single space) after colons : (ac argument) in json, you can change that as well, try for example \n. If you'd like to use an encoder other than cJSON, pass the encoding function as the 5th argument (ec). It should accept anything as input parameter, and if there is a problem with encoding this function should return nil and an error message, such as:

nil, "Cannot serialise function: type not supported"

For input argument dt it accepts anything that cjson.encode accepts (or whatever the custom encoding function accepts).

Example
local pretty = require "resty.prettycjson"

print(pretty({
    key1 = "data",
    key2 = 27,
    key3 = {
        key3_1 = "something",
        key3_2 = "something else"
    },
    key4 = {
        "item1",
        "item2"
    },
    key5 = {},
    key5 = {{''}, {'',''}, {{},{}}},
    key6 = { '' },
    key7 = {{{{ test = "value", {{{{{{}}},{{},{},{}},{},{}}}}}}}}
}))

That will output:

{
	"key6": [
		""
	],
	"key3": {
		"key3_1": "something",
		"key3_2": "something else"
	},
	"key7": [
		[
			[
				{
					"1": [
						[
							[
								[
									[
										{}
									]
								],
								[
									{},
									{},
									{}
								],
								{},
								{}
							]
						]
					],
					"test": "value"
				}
			]
		]
	],
	"key1": "data",
	"key5": [
		[
			""
		],
		[
			"",
			""
		],
		[
			{},
			{}
		]
	],
	"key2": 27,
	"key4": [
		"item1",
		"item2"
	]
}

Changes

The changes of every release of this module is recorded in Changes.md file.

License

lua-resty-prettycjson uses three clause BSD license.

Copyright (c) 2015 — 2016, Aapo Talvensaari
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

* Neither the name of lua-resty-prettycjson nor the names of its
  contributors may be used to endorse or promote products derived from
  this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.