More luacheck-related fixes.

Author: BenLubar

caravan.lua

@@ -31,21 +31,21 @@ INTERESTING_FLAGS = {
     seized = 'Goods seized',
     offended = 'Offended'
 }
-caravans = df.global.ui.caravans
+local caravans = df.global.ui.caravans
 
-function caravans_from_ids(ids)
+local function caravans_from_ids(ids)
     if not ids or #ids == 0 then
-        return pairs(caravans)
+        return caravans
     end
-    local i = 0
-    return function()
-        i = i + 1
-        local id = tonumber(ids[i])
+
+    local c = {} --as:df.caravan_state[]
+    for _,id in ipairs(ids) do
+        local id = tonumber(id)
         if id then
-            return id, caravans[id]
+            c[id] = caravans[id]
         end
-        return nil
     end
+    return c
 end
 
 function bring_back(car)
@@ -54,9 +54,7 @@ function bring_back(car)
     end
 end
 
-commands = {}
-
-function commands.list()
+local function list()
     for id, car in pairs(caravans) do
         print(dfhack.df2console(('%d: %s caravan from %s'):format(
             id,
@@ -73,32 +71,42 @@ function commands.list()
     end
 end
 
-function commands.extend(days, ...)
+local function extend(days, ...)
     days = tonumber(days or 7) or qerror('invalid number of days: ' .. days)
-    for id, car in caravans_from_ids{...} do
+    for id, car in pairs(caravans_from_ids{...}) do
         car.time_remaining = car.time_remaining + (days * 120)
         bring_back(car)
     end
 end
 
-function commands.happy(...)
-    for id, car in caravans_from_ids{...} do
+local function happy(...)
+    for id, car in pairs(caravans_from_ids{...}) do
         -- all flags default to false
         car.flags.whole = 0
         bring_back(car)
     end
 end
 
-function commands.leave(...)
-    for id, car in caravans_from_ids{...} do
+local function leave(...)
+    for id, car in pairs(caravans_from_ids{...}) do
         car.trade_state = df.caravan_state.T_trade_state.Leaving
     end
 end
 
 function main(...)
-    args = {...}
-    command = table.remove(args, 1)
-    commands[command](table.unpack(args))
+    local args = {...}
+    local command = table.remove(args, 1)
+    if command == "list" then
+        list(table.unpack(args))
+    elseif command == "extend" then
+        extend(table.unpack(args))
+    elseif command == "happy" then
+        happy(table.unpack(args))
+    elseif command == "leave" then
+        leave(table.unpack(args))
+    else
+        qerror("No such command: "..command)
+    end
 end
 
 if not dfhack_flags.module then

colonies.lua

@@ -21,7 +21,7 @@ and ``colonies convert TERMITE`` ends your beekeeping industry.
 ]====]
 
 function findVermin(target_verm)
-    for k,v in pairs(df.global.world.raws.creatures.all) do
+    for k,v in ipairs(df.global.world.raws.creatures.all) do
         if v.creature_id == target_verm then
             return k
         end
@@ -31,7 +31,7 @@ end
 
 function list_colonies()
     for idx, col in pairs(df.global.world.vermin.colonies) do
-        race = df.global.world.raws.creatures.all[col.race].creature_id
+        local race = df.global.world.raws.creatures.all[col.race].creature_id
         print(race..'    at  '..col.pos.x..', '..col.pos.y..', '..col.pos.z)
     end
 end

devel/annc-monitor.lua

@@ -15,11 +15,9 @@ Displays announcements and reports in the console.
 
 VERSION = '0.2'
 
-eventful = require 'plugins.eventful'
+local eventful = require 'plugins.eventful'
 
-if enabled == nil then
-    enabled = false
-end
+enabled = enabled or false
 
 function usage()
     print [[
@@ -35,15 +33,7 @@ function log(s, color)
     dfhack.color(COLOR_RESET)
 end
 
-function annc_handler(id)
-    if enabled and dfhack.isWorldLoaded() then
-        local annc = df.report.find(id)
-        local color = annc.color + (annc.bright and 8 or 0)
-        log(annc.text, color)
-    end
-end
-
-args = {...}
+local args = {...}
 if dfhack_flags and dfhack_flags.enable then
     table.insert(args, dfhack_flags.enable_state and 'enable' or 'disable')
 end
@@ -60,4 +50,11 @@ else
 end
 
 eventful.enableEvent(eventful.eventType.REPORT, 1)
-eventful.onReport.annc_monitor = annc_handler
+function eventful.onReport.annc_monitor(id)
+    if enabled and dfhack.isWorldLoaded() then
+        local annc = df.report.find(id)
+        local color = annc.color + (annc.bright and 8 or 0)
+        log(annc.text, color)
+    end
+end
+

devel/check-release.lua

@@ -5,7 +5,7 @@ devel/check-release
 Basic checks for release readiness
 ]====]
 
-ok = true
+local ok = true
 function err(s)
     dfhack.printerr(s)
     ok = false
@@ -16,9 +16,9 @@ function warn(s)
     dfhack.color(nil)
 end
 
-dfhack_ver = dfhack.getDFHackVersion()
-git_desc = dfhack.getGitDescription()
-git_commit = dfhack.getGitCommit()
+local dfhack_ver = dfhack.getDFHackVersion()
+local git_desc = dfhack.getGitDescription()
+local git_commit = dfhack.getGitCommit()
 if not dfhack.isRelease() then
     err('This build is not tagged as a release')
     print[[
@@ -27,7 +27,7 @@ Try running `git fetch origin --tags` in the DFHack source tree.
 ]]
 end
 
-expected_git_desc = ('%s-0-g%s'):format(dfhack_ver, git_commit:sub(1, 8))
+local expected_git_desc = ('%s-0-g%s'):format(dfhack_ver, git_commit:sub(1, 8))
 if git_desc:sub(1, #expected_git_desc) ~= expected_git_desc then
     err(([[Bad git description:
 Expected %s, got %s]]):format(expected_git_desc, git_desc))

devel/clear-script-env.lua

@@ -6,13 +6,13 @@ devel/clear-script-env
 Clears the environment of the specified lua script(s).
 
 ]====]
-args = {...}
+local args = {...}
 if #args < 1 then qerror("script name(s) required") end
 for _, name in pairs(args) do
     local file = dfhack.findScript(name)
     if file then
         local script = dfhack.internal.scripts[file]
-        if script then
+        if script then --luacheck: skip
             local env = script.env
             while next(env) do
                 env[next(env)] = nil

devel/click-monitor.lua

@@ -13,7 +13,7 @@ Usage: ``devel/click-monitor start|stop``
 
 VERSION = '0.2'
 
-if active == nil then active = false end
+active = active or false
 
 function usage()
     print [[
@@ -27,6 +27,8 @@ function set_timeout()
     dfhack.timeout(1, 'frames', check_click)
 end
 
+last_msg = last_msg or ''
+
 function log(s, color)
     -- prevent duplicate output
     if s ~= last_msg then
@@ -36,12 +38,14 @@ function log(s, color)
     end
 end
 
+--luacheck: in=none
 function check_click()
     local s = ''
     local color = COLOR_RESET
     for _, attr in pairs({'mouse_lbut', 'mouse_rbut', 'mouse_lbut_down',
         'mouse_rbut_down', 'mouse_lbut_lift', 'mouse_rbut_lift'}) do
-        if df.global.enabler[attr] ~= 0 then
+        local enabler = df.global.enabler --as:number[]
+        if enabler[attr] ~= 0 then
             s = s .. '[' .. attr:sub(7) .. ']  '
         end
     end
@@ -58,7 +62,7 @@ function check_click()
     if active then set_timeout() end
 end
 
-args = {...}
+local args = {...}
 if dfhack_flags and dfhack_flags.enable then
     table.insert(args, dfhack_flags.enable_state and 'enable' or 'disable')
 end

devel/cmptiles.lua

@@ -13,8 +13,8 @@ local nmat1,nmat2=...
 local mat1 = df.tiletype_material[nmat1]
 local mat2 = df.tiletype_material[nmat2]
 
-local tmat1 = {}
-local tmat2 = {}
+local tmat1 = {} --as:bool[]
+local tmat2 = {} --as:bool[]
 
 local attrs = df.tiletype.attrs
 

devel/dump-offsets.lua

@@ -191,7 +191,7 @@ else
     search = {0x12345678, 0x87654321}
 end
 
-addrs = {}
+local addrs = {}
 function save_addr(name, addr)
     print(("<global-address name='%s' value='0x%x'/>"):format(name, addr))
     if iargs[name] or iargs.all then

devel/export-dt-ini.lua

@@ -45,7 +45,7 @@ local function address(name,base,field,...)
             _,addr = df.sizeof(ms.field_ref(base,field,...))
         end
         addr = addr - rdelta
-    elseif base._kind == 'class-type' then
+    elseif base._kind == 'class-type' then --luacheck: skip
         -- field_offset crashes with classes due to vtable problems,
         -- so we have to create a real temporary object here.
         local obj = df.new(base)
@@ -467,6 +467,7 @@ end
 
 -- Flags
 local function write_flags(name,flag_array)
+    local flag_array = flag_array --as:{1:string,2:'number[]'}[]
     out:write('\n')
     out:write('['..name..']\n')
     out:write('size='..#flag_array..'\n')

devel/find-offsets.lua

@@ -39,7 +39,7 @@ local is_known = dfhack.internal.getAddress
 
 local os_type = dfhack.getOSType()
 
-local force_scan = {}
+local force_scan = {} --as:bool[]
 for _,v in ipairs({...}) do
     force_scan[v] = true
 end
@@ -167,10 +167,12 @@ end
 
 local finder_searches = {}
 local function exec_finder(finder, names, validators)
-    if type(names) ~= 'table' then
+    local names = names --as:string[]
+    local validators = validators --as:{_type:function,_node:bool}[]
+    if type(names) ~= 'table' then --luacheck: skip
         names = { names }
     end
-    if type(validators) ~= 'table' then
+    if type(validators) ~= 'table' then --luacheck: skip
         validators = { validators }
     end
     local search = force_scan['all']
@@ -179,7 +181,7 @@ local function exec_finder(finder, names, validators)
             table.insert(finder_searches, v)
             search = true
         elseif validators[k] then
-            if not validators[k](df.global[v]) then
+            if not validators[k](df.global[v]) then --luacheck: skip
                 dfhack.printerr('Validation failed for '..v..', will try to find again')
                 table.insert(finder_searches, v)
                 search = true
@@ -259,7 +261,7 @@ local function dwarfmode_to_top()
         return false
     end
 
-    local screen = screen_dwarfmode()
+    local screen = screen_dwarfmode() --as:df.viewscreen_dwarfmodest
     if not df.isvalid(screen) then
         return false
     end
@@ -1794,8 +1796,9 @@ local function find_standing_orders(gname, seq, depends)
 end
 
 local function exec_finder_so(gname, seq, _depends)
-    local depends = {}
+    local depends = {} --as:number[]
     for k, v in pairs(_depends or {}) do
+        local v = v --as:number
         if k:find('standing_orders_') ~= 1 then
             k = 'standing_orders_' .. k
         end