Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bungle/lua-resty-prettycjson
Lua cJSON Pretty Formatter
https://github.com/bungle/lua-resty-prettycjson
Last synced: 19 days ago
JSON representation
Lua cJSON Pretty Formatter
- Host: GitHub
- URL: https://github.com/bungle/lua-resty-prettycjson
- Owner: bungle
- License: bsd-3-clause
- Created: 2015-09-28T16:22:48.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-09-01T17:06:21.000Z (about 4 years ago)
- Last Synced: 2024-02-14T03:31:30.686Z (9 months ago)
- Language: Lua
- Size: 21.5 KB
- Stars: 32
- Watchers: 8
- Forks: 19
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: Changes.md
- License: LICENSE
Awesome Lists containing this project
- awesome-resty - lua-resty-prettycjson
README
# lua-resty-prettycjson
`lua-resty-prettycjson` is a JSON Pretty Formatter for [Lua cJSON](http://www.kyne.com.au/~mark/software/lua-cjson.php).
## Installation
Just place [`prettycjson.lua`](https://github.com/bungle/lua-resty-prettycjson/blob/master/lib/resty/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)
```Shell
$ opm get bungle/lua-resty-prettycjson
```
### Using LuaRocks
```Shell
$ 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:
```lua
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
```lua
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:
```json
{
"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](https://github.com/bungle/lua-resty-prettycjson/blob/master/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.
```