0.2.0

Author: cryi

README.md

@@ -29,23 +29,23 @@ Library exports json.lua like and JS like api.
     - `obj` - Lua object - `table`, `string`, `number`, `nil`, `boolean`
     - `options` table with following values:
       - `indent` - default `"    "`. Accepts string of whitespace characters or a number representing number of spaces (non indented HJSON is JSON, automatically forwards to `_to_json` version)
-      - `skipkeys` - default `true`  Skips invalid keys. If false throws error on invalid key.
+      - `skip_keys` - default `true`  Skips invalid keys. If false throws error on invalid key.
         - Valid key types: `boolean`, `nil`, `string`
-      - `sortKeys` - whether to sort keys in objects
+      - `sort_keys` - whether to sort keys in objects
       - `item_sort_key` - sort function which is passed to `table.sort` sorting object keys 
-      - `invalidObjectsAsType` if true functions and others objects are replaced with their type name in format `__lua_<type>` e.g. `__lua_function`
+      - `invalid_objects_as_type` if true functions and others objects are replaced with their type name in format `__lua_<type>` e.g. `__lua_function`
 - Lua object to JSON - returns JSON string
   - `encode(obj, options)` 
   - `stringify(obj, options)`
   - Parameters:
     - `obj` - Lua object - `table`, `string`, `number`, `nil`, `boolean`
     - `options` table with following values:
       - `indent` - default `"    "`. Accepts string of whitespace characters or a number representing number of spaces (non indented HJSON is JSON, automatically forwards to `_to_json` version)
-      - `skipkeys` - default `true`  Skips invalid keys. If false throws error on invalid key.
+      - `skip_keys` - default `true`  Skips invalid keys. If false throws error on invalid key.
         - Valid key types: `boolean`, `nil`, `string`
-      - `sortKeys` - whether to sort keys in objects
+      - `sort_keys` - whether to sort keys in objects
       - `item_sort_key` - sort function which is passed to `table.sort` sorting object keys 
-      - `invalidObjectsAsType` if true functions and others objects are replaced with their type name in format `__lua_<type>` e.g. `__lua_function`
+      - `invalid_objects_as_type` if true functions and others objects are replaced with their type name in format `__lua_<type>` e.g. `__lua_function`
 - H/JSON to Lua object - returns Lua object
     - `decode(str, strict, object_hook, object_pairs_hook)`
     - `parse(str, strict, object_hook, object_pairs_hook)`

hjson-lua-0.1.6-1.rockspec hjson-lua-0.2.0-1.rockspechjson-lua-0.1.6-1.rockspec renamed to hjson-lua-0.2.0-1.rockspec

@@ -1,5 +1,5 @@
 package = "hjson-lua"
-version = "0.1.6-1"
+version = "0.2.0-1"
 source = {
   url = "git://github.com/hjson/hjson-lua.git",
 }

hjson.lua

@@ -3,7 +3,7 @@ local decoder = require "hjson.decoder"
 local encoder = require "hjson.encoder"
 local encoderH = require "hjson.encoderH"
 
----@class HjsonKeyValuePair
+---@class HJsonKeyValuePair
 ---@field key any
 ---@field value any
 
@@ -13,28 +13,54 @@ local encoderH = require "hjson.encoderH"
 ---@param str string
 ---@param strict boolean?
 ---@param object_hook (fun(obj: table): table)?
----@param object_pairs_hook (fun(pairs: HjsonKeyValuePair[]): HjsonKeyValuePair[])?
+---@param object_pairs_hook (fun(pairs: HJsonKeyValuePair[]): HJsonKeyValuePair[])?
 ---@return any
 local function decode(str, strict, object_hook, object_pairs_hook)
     local _decoder = decoder:new(strict, object_hook, object_pairs_hook)
     return _decoder:decode(str)
 end
 
----@class HjsonEncodeOptions
+---@class HJsonEncodeOptions
 ---@field indent string|boolean|nil
----@field skipkeys boolean?
----@field sortKeys boolean?
+---@field skip_keys boolean?
+---@field sort_keys boolean?
 ---@field item_sort_key (fun(k1:any, k2:any): boolean)?
----@field invalidObjectsAsType boolean?
+---@field invalid_objects_as_type boolean?
 
+---@param options HJsonEncodeOptions?
+---@return HJsonEncodeOptions
+local function preprocess_encode_options(options)
+    if type(options) ~= "table" then
+        local result = {}  --[[@as HJsonEncodeOptions]]
+        return result
+    end
+
+    if options.skipkeys == true then
+        print("skipkeys is deprecated, use skip_keys instead")
+        options.skip_keys = true
+    end
+
+    if options.sortKeys == true then
+        print("sortKeys is deprecated, use sort_keys instead")
+        options.sort_keys = true
+    end
+
+    if options.invalidObjectsAsType == true then
+        print("invalidObjectsAsType is deprecated, use invalid_objects_as_type instead")
+        options.invalid_objects_as_type = true
+    end
+    return options
+end
 
 ---#DES 'hjson.encode_to_json'
 ---
 ---encodes json
 ---@param obj any
----@param options HjsonEncodeOptions?
+---@param options HJsonEncodeOptions?
 ---@return any
 local function encode_json(obj, options)
+    options = preprocess_encode_options(options)
+
     local _encoder = encoder:new(options)
     return _encoder:encode(obj)
 end
@@ -43,12 +69,10 @@ end
 ---
 ---encodes hjson
 ---@param obj any
----@param options HjsonEncodeOptions?
+---@param options HJsonEncodeOptions?
 ---@return any
 local function encode(obj, options)
-    if type(options) ~= "table" then
-        options = {}
-    end
+    options = preprocess_encode_options(options) --[[@as HJsonEncodeOptions]]
 
     if options.indent == "" or options.indent == false or options.indent == 0 then
         return encode_json(obj, options)
@@ -63,15 +87,15 @@ local hjson = {
     ---
     ---encodes hjson
     ---@param obj any
-    ---@param options HjsonEncodeOptions?
+    ---@param options HJsonEncodeOptions?
     ---@return any
     stringify = encode,
     encode_to_json = encode_json,
     ---#DES 'hjson.stringify_to_json'
     ---
     ---encodes json
     ---@param obj any
-    ---@param options HjsonEncodeOptions?
+    ---@param options HJsonEncodeOptions?
     ---@return any
     stringify_to_json = encode_json,
     decode = decode,
@@ -81,7 +105,7 @@ local hjson = {
     ---@param str string
     ---@param strict boolean?
     ---@param object_hook (fun(obj: table): table)?
-    ---@param object_pairs_hook (fun(pairs: HjsonKeyValuePair[]): HjsonKeyValuePair[])?
+    ---@param object_pairs_hook (fun(pairs: HJsonKeyValuePair[]): HJsonKeyValuePair[])?
     ---@return any
     parse = decode
 }

hjson/encoder.lua

@@ -40,11 +40,11 @@ local JsonEncoder = {}
 
 function JsonEncoder:new(options)
     if type(options) ~= "table" then options = {} end
-    local indent, skipkeys, sortKeys, item_sort_key, invalidObjectsAsType =
-        options.indent, options.skipkeys, options.sortKeys,
-        options.item_sort_key, options.invalidObjectsAsType
+    local indent, skip_keys, sort_keys, item_sort_key, invalid_objects_as_type =
+        options.indent, options.skip_keys, options.sort_keys,
+        options.item_sort_key, options.invalid_objects_as_type
 
-    if skipkeys == nil then skipkeys = true end
+    if skip_keys == nil then skip_keys = true end
     if indent == nil then indent = "    " end
     if type(indent) ~= "number" and type(indent) ~= "string" and type(indent) ~=
         "boolean" then
@@ -71,7 +71,7 @@ function JsonEncoder:new(options)
         elseif _type == "string" then
             return encodeString(key)
         end
-        if skipkeys then return nil end
+        if skip_keys then return nil end
         error(string.format("Invalid key type - %s (%s) ", _type, key))
     end
 
@@ -125,7 +125,7 @@ function JsonEncoder:new(options)
                 keysetMap[key] = k
             end
         end
-        if sortKeys then
+        if sort_keys then
             if type(item_sort_key) == "function" then
                 table.sort(keyset, item_sort_key)
             else
@@ -171,7 +171,7 @@ function JsonEncoder:new(options)
         end
         local func = encodeFunctionMap[_type]
         if type(func) == "function" then return func(o, encode) end
-        if invalidObjectsAsType then
+        if invalid_objects_as_type then
             return encodeFunctionMap["string"]('__lua_' .. type(o))
         end
         error("Unexpected type '" .. _type .. "'")

hjson/encoderH.lua

@@ -96,11 +96,11 @@ local HjsonEncoder = {}
 
 function HjsonEncoder:new(options)
     if type(options) ~= "table" then options = {} end
-    local indent, skipkeys, sortKeys, item_sort_key, invalidObjectsAsType =
-        options.indent, options.skipkeys, options.sortKeys,
-        options.item_sort_key, options.invalidObjectsAsType
+    local indent, skip_keys, sort_keys, item_sort_key, invalid_objects_as_type =
+        options.indent, options.skip_keys, options.sort_keys,
+        options.item_sort_key, options.invalid_objects_as_type
 
-    if skipkeys == nil then skipkeys = true end
+    if skip_keys == nil then skip_keys = true end
     if indent == nil then indent = "    " end
     if (type(indent) ~= "number" or indent < 2) and
         (type(indent) ~= "string" or not indent:find("%s%s*")) then
@@ -165,7 +165,7 @@ function HjsonEncoder:new(options)
                 return key
             end
         end
-        if skipkeys then return nil end
+        if skip_keys then return nil end
         error(string.format("Invalid key type - %s (%s) ", _type, key))
     end
 
@@ -211,7 +211,7 @@ function HjsonEncoder:new(options)
                 keysetMap[key] = k
             end
         end
-        if sortKeys then
+        if sort_keys then
             if type(item_sort_key) == "function" then
                 table.sort(keyset, item_sort_key)
             else
@@ -257,7 +257,7 @@ function HjsonEncoder:new(options)
         end
         local func = encodeFunctionMap[_type]
         if type(func) == "function" then return func(o, _encode) end
-        if invalidObjectsAsType then
+        if invalid_objects_as_type then
             return encodeFunctionMap["string"]('__lua_' .. type(o))
         end
         error("Unexpected type '" .. _type .. "'")