.luacheckrc

-------------------------------------------------------------------------------
--[LICENSE]--
-------------------------------------------------------------------------------
-- .luacheckrc
-- This file is free and unencumbered software released into the public domain.
--
-- Anyone is free to copy, modify, publish, use, compile, sell, or
-- distribute this file, either in source code form or as a compiled
-- binary, for any purpose, commercial or non-commercial, and by any
-- means.
--
-- In jurisdictions that recognize copyright laws, the author or authors
-- of this file dedicate any and all copyright interest in the
-- software to the public domain. We make this dedication for the benefit
-- of the public at large and to the detriment of our heirs and
-- successors. We intend this dedication to be an overt act of
-- relinquishment in perpetuity of all present and future rights to this
-- software under copyright law.
--
-- THE FILE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-- IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
-- OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
-- ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-- OTHER DEALINGS IN THE SOFTWARE.
--
-- For more information, please refer to <http://unlicense.org/>
-- ]]

-------------------------------------------------------------------------------
--[.luacheckrc]
-------------------------------------------------------------------------------
-- Set up the the standards for this file.
files['.luacheckrc'] = {
    std = 'lua52c',
    globals = {'files', 'exclude_files', 'not_globals', 'stds', 'std', 'max_line_length', 'ignore', 'quiet', "max_cyclomatic_complexity", "codes"},
    max_line_length = false --turn of line length warnings for this file
}

-------------------------------------------------------------------------------
--[Set Defaults]--
-------------------------------------------------------------------------------
local LINE_LENGTH = false
local IGNORE = {'21./%w+_$', '21./^_%w+$', '213/[ijk]', '213/index', '213/key'}
local NOT_GLOBALS = {'coroutine', 'socket', 'dofile', 'loadfile'}

local STD_ELONA = 'lua52c+elona+stdlib'

-------------------------------------------------------------------------------
--[Standards]--
-------------------------------------------------------------------------------
std = STD_ELONA
max_line_length = LINE_LENGTH

not_globals = NOT_GLOBALS
ignore = IGNORE
quiet = 1 -- pass -q option
max_cyclomatic_complexity = 75
codes = true

--List of files and directories to exclude
exclude_files = {
    --Ignore special folders
    '**/.*/*' --Ignore if path starts with .
}

-------------------------------------------------------------------------------
--[Base]--
-------------------------------------------------------------------------------

files['**/runtime/profile/_/mod'] = {std = STD_ELONA}
files['**/runtime/profile/_/mod/core'] = {std = "+core"}
files['**/runtime/profile/_/user/script/console.lua'] = {std = "+core+console"}
files['src/tests/lua/*.lua'] = {std = "+tests"}
files['src/tests/lua/classes/*.lua'] = {std = "+tests"}
files['src/tests/lua/support'] = {std = "+minctest"}

-------------------------------------------------------------------------------
--[STDS ELONA]--
-------------------------------------------------------------------------------
stds.elona = {
    --Set the read only variables
    read_globals = {
        -- @data@: Data definition table.
        data = {
            fields = {
                raw = {
                    other_fields = true,
                    read_only = true
                },
                by_legacy = {
                    other_fields = true,
                    read_only = true
                },
                types = {
                    other_fields = true,
                    read_only = true
                },
                "add", "add_multi", "define_type"
            },
        },
        -- @Elona@: The core Elona API.
        Elona = {
           fields = {
              "require",
              Rand = {
                 fields = {
                    "rnd", "one_in", "coinflip"
                 },
              },
              Event = {
                 fields = {
                    "register", "unregister", "clear", "trigger",
                    EventKind = {
                      other_fields = true,
                    }
                 },
              },
              Chara = {
                 fields = {
                    "is_alive", "is_player", "is_ally", "player", "create"
                 },
              },
              Map = {
                 fields = {
                    "width", "height", "valid", "can_access", "bound_within", "random_pos", "set_tile", "set_tile_memory",
                 },
              },
              Pos = {
                 fields = {
                    "dist"
                 },
              },
              World = {
                 fields = {
                    "time"
                 },
              },
              Magic = {
                 fields = {
                    "cast"
                 },
              },
              Env = {
                 fields = {
                    "LUA_VERSION", "ELONA_VERSION", "ELONA_FOOBAR_VERSION", "MOD_API_VERSION"
                 },
              },
              FOV = {
                 fields = {
                    "los", "you_see"
                 },
              },
              Item = {
                 fields = {
                    "create"
                 },
              },
              Skill = {
                 fields = {
                    "level"
                 },
              },
              Trait = {
                 fields = {
                    "level", "min", "max", "set", "modify"
                 },
              },
              Input = {
                 fields = {
                    "yes_no", "prompt", "prompt_number", "prompt_text"
                 },
              },
              GUI = {
                 fields = {
                    "txt", "txt_color"
                 },
              },
              I18N = {
                 fields = {
                    "get", "get_optional", "get_enum", "get_enum_property", "get_enum_property_optional"
                 }
              },
              Debug = {
                 fields = {
                    "log", "dump_characters", "dump_items", "inspect"
                 }
              },
              ReadOnly = {
                 fields = {
                    "make_read_only"
                 }
              },
              Iter = {
                 fields = {
                    "rectangle_iter", "rectangle_iter_step"
                 }
              },
              Animation = {
                 fields = {
                    "play_failure_to_cast", "play_bright_aura", "play_breath", "play_ball_atomic_bomb", "play_ball_magic", "play_bolt", "play_throwing_object", "play_swarm", "play_ranged_attack", "play_melee_attack", "play_gene_engineering", "play_miracle", "play_meteor", "play_ragnarok", "play_breaking"
                 }
              },
              Registry = {
                 fields = {
                    "on_event",
                    "register_chara_init",
                    "register_map_init",
                    Data = {
                       read_only = false,
                       other_fields = true
                    }
                 }
              },
              Defines = {
                 fields = {
                    Enums = {},
                    Events = {
                       other_fields = true
                    },
                 }
              },
           }
        },
        -- @Store@: Mod-local data storage.
        Store = {
           fields = {
              map_local = {
                 read_only = false,
                 other_fields = true
              },
              global = {
                 read_only = false,
                 other_fields = true
              }
           }
        },
        -- @LuaCharacter@
        LuaCharacter = { other_fields = true },
        LuaItem = { other_fields = true },
        LuaPosition = { other_fields = true }
    },
}

--(( core ))--
stds.core = {
    globals = {
       "_IS_TEST", "_LOADED", "pairs", "table",
        Elona = {
           fields = {
              core = {
                 other_fields = true,
                 fields = stds.elona.read_globals.Elona.fields
              }
           }
        }
    }
}

--(( console ))--
stds.console = {
    read_globals = {
       "_LAST_RESULT"
    }
}

for k, v in pairs(stds.elona.read_globals.Elona.fields) do
   if type(v) == "table" then
      stds.console.read_globals[k] = v
   end
end

--(( stdlib extensions ))--
stds.stdlib = {
    read_globals = {
        table = {
            fields = {
               "find", "size"
            },
        },
    },
}

--(( tests ))--
stds.tests = {
    read_globals = {
        "lrun", "lequal", "lfequal", "lok", "lresults",
        Testing = {
            fields = {
               "start_in_debug_map", "reset_state", "load_translations"
            },
        }
    },
}

--(( minctest ))--
stds.minctest = {
    globals = stds.tests.read_globals
}

--[[
    "ignore", "std", "globals", "unused_args", "self", "compat", "global", "unused", "redefined",
    "unused_secondaries", "allow_defined", "allow_defined_top", "module",
    "read_globals", "new_globals", "new_read_globals", "enable", "only", "not_globals",
    "max_line_length", "max_code_line_length", "max_string_line_length", "max_comment_line_length",
    "max_cyclomatic_complexity"
--]]

-- Warnings list
-- 011 A syntax error.
-- 021 An invalid inline option.
-- 022 An unpaired inline push directive.
-- 023 An unpaired inline pop directive.
-- 111 Setting an undefined global variable.
-- 112 Mutating an undefined global variable.
-- 113 Accessing an undefined global variable.
-- 121 Setting a read-only global variable.
-- 122 Setting a read-only field of a global variable.
-- 131 Unused implicitly defined global variable.
-- 142 Setting an undefined field of a global variable.
-- 143 Accessing an undefined field of a global variable.
-- 211 Unused local variable.
-- 212 Unused argument.
-- 213 Unused loop variable.
-- 221 Local variable is accessed but never set.
-- 231 Local variable is set but never accessed.
-- 232 An argument is set but never accessed.
-- 233 Loop variable is set but never accessed.
-- 241 Local variable is mutated but never accessed.
-- 311 Value assigned to a local variable is unused.
-- 312 Value of an argument is unused.
-- 313 Value of a loop variable is unused.
-- 314 Value of a field in a table literal is unused.
-- 321 Accessing uninitialized local variable.
-- 331 Value assigned to a local variable is mutated but never accessed.
-- 341 Mutating uninitialized local variable.
-- 411 Redefining a local variable.
-- 412 Redefining an argument.
-- 413 Redefining a loop variable.
-- 421 Shadowing a local variable.
-- 422 Shadowing an argument.
-- 423 Shadowing a loop variable.
-- 431 Shadowing an upvalue.
-- 432 Shadowing an upvalue argument.
-- 433 Shadowing an upvalue loop variable.
-- 511 Unreachable code.
-- 512 Loop can be executed at most once.
-- 521 Unused label.
-- 531 Left-hand side of an assignment is too short.
-- 532 Left-hand side of an assignment is too long.
-- 541 An empty do end block.
-- 542 An empty if branch.
-- 551 An empty statement.
-- 611 A line consists of nothing but whitespace.
-- 612 A line contains trailing whitespace.
-- 613 Trailing whitespace in a string.
-- 614 Trailing whitespace in a comment.
-- 621 Inconsistent indentation (SPACE followed by TAB).
-- 631 Line is too long.

-- Local Variables:
-- mode: lua
-- End: