docs & minor fixes

Author: cryi

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Void (cryon.io)
+Copyright (c) 2020 V (cryon.io)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

hjson-lua-0.1.2-2.rockspec hjson-lua-0.1.3-1.rockspec

@@ -1,5 +1,5 @@
 package = "hjson-lua"
-version = "0.1.2-2"
+version = "0.1.3-1"
 source = {
   url = "git://github.com/cryi/hjson-lua.git",
 }

hjson.lua

@@ -1,20 +1,50 @@
--- MIT License - Copyright (c) 2019 Void (cryon.io)
+-- MIT License - Copyright (c) 2021 V (cryon.io)
 local decoder = require "hjson.decoder"
 local encoder = require "hjson.encoder"
 local encoderH = require "hjson.encoderH"
 
+---@class HjsonKeyValuePair
+---@field key any
+---@field value any
+
+---#DES 'decode'
+---
+---decodes h/json
+---@param str string
+---@param strict boolean
+---@param object_hook fun(obj: table): table
+---@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
 
--- options = {indent, skipkeys, sort_keys, item_sort_key, invalidObjectsAsType}
+---@class HjsonEncodeOptions
+---@field indent string|boolean
+---@field skipkeys boolean
+---@field sortKeys boolean
+---@field item_sort_key fun(k1:any, k2:any): boolean
+---@field invalidObjectsAsType boolean
+
+
+---#DES 'encode_json'
+---
+---encodes json
+---@param obj any
+---@param options HjsonEncodeOptions
+---@return any
 local function encode_json(obj, options)
     local _encoder = encoder:new(options)
     return _encoder:encode(obj)
 end
 
--- options = {indent, skipkeys, sort_keys, item_sort_key, invalidObjectsAsType}
+---#DES 'encode_json'
+---
+---encodes hjson
+---@param obj any
+---@param options HjsonEncodeOptions
+---@return any
 local function encode(obj, options)
     if type(options) ~= "table" then
         options = {}
@@ -27,6 +57,7 @@ local function encode(obj, options)
     return _encoderH:encode(obj)
 end
 
+
 local hjson = {
     encode = encode,
     stringify = encode,

hjson/decoder.lua

@@ -1,4 +1,4 @@
--- MIT License - Copyright (c) 2019 Void (cryon.io)
+-- MIT License - Copyright (c) 2021 V (cryon.io)
 
 local WHITESPACE = " \t\n\r"
 local PUNCTUATOR = "{}[],:"
@@ -169,7 +169,7 @@ function HjsonDecoder:new(strict, object_hook, object_pairs_hook)
                 goto scan_string_loop_start
             elseif terminator ~= "\\" then
                 if strict then
-                    decodeError(s, begin, "Invalid control character" .. ch)
+                    decodeError(s, begin, "Invalid control character" .. terminator)
                 else
                     chunks = chunks .. terminator
                     goto scan_string_loop_start
@@ -292,7 +292,7 @@ function HjsonDecoder:new(strict, object_hook, object_pairs_hook)
                 local frac = nil
                 local exp = nil
 
-                trimmed_range = trim(s:sub(begin, _end - 1))
+                local trimmed_range = trim(s:sub(begin, _end - 1))
                 if chf == "n" and trimmed_range == "null" then
                     return nil, _end
                 elseif chf == "t" and trimmed_range == "true" then
@@ -305,12 +305,12 @@ function HjsonDecoder:new(strict, object_hook, object_pairs_hook)
                     if integer then
                         frac = s:match("^(%.%d+)", begin + #integer) or ""
                         exp = s:match("^([eE][-+]?%d+)", begin + #integer + #frac) or ""
-                        ending = s:match("^([\t ]*)", begin + #integer + #frac + #exp) or ""
+                        local ending = s:match("^([\t ]*)", begin + #integer + #frac + #exp) or ""
                         m = integer .. frac .. exp .. ending
                     end
                 end
                 if m and begin + #m == _end then
-                    res = tonumber(integer .. frac .. exp)
+                    local res = tonumber(integer .. frac .. exp)
                     return res, _end
                 end
 
@@ -397,7 +397,7 @@ function HjsonDecoder:new(strict, object_hook, object_pairs_hook)
         -- Trivial empty object
         if not objectWithoutBraces and ch == "}" then
             if type(object_pairs_hook) == "function" then
-                result = object_pairs_hook(pairs)
+                local result = object_pairs_hook(pairs)
                 return result, _end + 1
             end
             pairs = {}
@@ -440,15 +440,15 @@ function HjsonDecoder:new(strict, object_hook, object_pairs_hook)
             ch, _end = getNext(s, _end)
         end
         if type(object_pairs_hook) == "function" then
-            result = object_pairs_hook(pairs)
+            local result = object_pairs_hook(pairs)
             return result, _end
         end
 
-        pairs = dict(pairs)
+        local obj = dict(pairs)
         if type(object_hook) == "function" then
-            pairs = object_hook(pairs)
+            obj = object_hook(obj)
         end
-        return pairs, _end
+        return obj, _end
     end
 
     local function parseArray(state, scanOnce)