Merge pull request #698 from MikaylaFischler/697-add-and-move-full-type-hinting-for-mekanism-peripherals

697 add and move full type hinting for mekanism peripherals

Author: MikaylaFischler

coordinator/backplane.lua

@@ -79,6 +79,7 @@ function backplane.init_displays(config)
 
     local disp, iface = ppm.get_periph(config.MainDisplay), config.MainDisplay
 
+    ---@cast disp Monitor
     displays.main = disp
     displays.main_iface = iface
 
@@ -102,6 +103,7 @@ function backplane.init_displays(config)
     if not config.DisableFlowView then
         disp, iface = ppm.get_periph(config.FlowDisplay), config.FlowDisplay
 
+        ---@cast disp Monitor
         displays.flow = disp
         displays.flow_iface = iface
 
@@ -126,6 +128,7 @@ function backplane.init_displays(config)
     for i = 1, config.UnitCount do
         disp, iface = ppm.get_periph(config.UnitDisplays[i]), config.UnitDisplays[i]
 
+        ---@cast disp Monitor
         displays.unit_displays[i] = disp
         displays.unit_ifaces[i] = iface
 
@@ -212,7 +215,10 @@ function backplane.init(config, __shared_memory)
 
     -- Speaker Init
 
-    _bp.speaker = ppm.get_device("speaker")
+    local speaker = ppm.get_device("speaker")
+
+    ---@cast speaker Speaker|nil
+    _bp.speaker = speaker
 
     if not _bp.speaker then
         log_boot("annunciator alarm speaker not found")
@@ -258,7 +264,7 @@ end
 
 -- handle a backplane peripheral attach
 ---@param type string
----@param device table
+---@param device ppm_generic
 ---@param iface string
 function backplane.attach(type, device, iface)
     local MQ__RENDER_DATA = _bp.smem.q_types.MQ__RENDER_DATA
@@ -377,7 +383,7 @@ end
 
 -- handle a backplane peripheral detach
 ---@param type string
----@param device table
+---@param device ppm_generic
 ---@param iface string
 function backplane.detach(type, device, iface)
     local MQ__RENDER_CMD  = _bp.smem.q_types.MQ__RENDER_CMD

coordinator/process.lua

@@ -498,7 +498,7 @@ function process.save(mode, alt_mode, burn_target, range_start, range_stop, char
 end
 
 -- handle a start command acknowledgement
----@param response table ack and configuration reply
+---@param response auto_start_ack ack and configuration reply
 function process.start_ack_handle(response)
     local ack = response[1]
 

coordinator/startup.lua

@@ -20,7 +20,7 @@ local renderer    = require("coordinator.renderer")
 local sounder     = require("coordinator.sounder")
 local threads     = require("coordinator.threads")
 
-local COORDINATOR_VERSION = "v1.8.1"
+local COORDINATOR_VERSION = "v1.8.2"
 
 local CHUNK_LOAD_DELAY_S = 30.0
 

graphics/core.lua

@@ -7,7 +7,7 @@ local flasher = require("graphics.flasher")
 
 local core = {}
 
-core.version = "2.4.10"
+core.version = "2.4.11"
 
 core.flasher = flasher
 core.events = events

graphics/element.lua

@@ -552,7 +552,7 @@ function element.new(args, constraint, child_offset_x, child_offset_y)
 
     -- get all children
     ---@nodiscard
-    ---@return table children table of graphics_element objects
+    ---@return graphics_element[] children this element's children
     function public.get_children()
         local list = {}
         for k, v in pairs(protected.children) do list[k] = v.get() end

graphics/elements/PipeNetwork.lua

@@ -163,11 +163,11 @@ return function (args)
     end
 
     -- draw a particular map cell
-    ---@param map table 2D cell map
+    ---@param map _pipe_map_entry[][] 2D cell map
     ---@param x integer x coord
     ---@param y integer y coord
     local function draw_map_cell(map, x, y)
-        local entry = map[x][y] ---@type _pipe_map_entry already confirmed not false
+        local entry = map[x][y]
         local char
         local invert = false
 

pocket/startup.lua

@@ -22,7 +22,7 @@ local pocket    = require("pocket.pocket")
 local renderer  = require("pocket.renderer")
 local threads   = require("pocket.threads")
 
-local POCKET_VERSION = "v1.1.0"
+local POCKET_VERSION = "v1.1.1"
 
 local println = util.println
 local println_ts = util.println_ts

pocket/ui/docs.lua

@@ -70,8 +70,8 @@ local function tip(body)
 end
 
 ---@param type DOC_LIST_TYPE
----@param items table
----@param colors table|nil colors for indicators or nil for normal lists
+---@param items string[]
+---@param colors color[]|nil colors for indicators or nil for normal lists
 local function list(type, items, colors)
     ---@class pocket_doc_list
     local list_def = { type = DOC_ITEM_TYPE.LIST, list_type = type, items = items, colors = colors }

pocket/ui/pages/guide_section.lua

@@ -25,10 +25,10 @@ local DOC_TYPE  = docs.DOC_ITEM_TYPE
 local LIST_TYPE = docs.DOC_LIST_TYPE
 
 -- new guide documentation section
----@param data { [1]: pocket_app, [2]: Div, [3]: Div[], [4]: { [string]: function }, [5]: [ string, string, string, function ][], [6]: cpair, [7]: cpair }
+---@param data pkt__sect_construct_data
 ---@param base_page nav_tree_page
 ---@param title string
----@param items table
+---@param items pkt__doc_item[]
 ---@param scroll_height integer
 ---@return nav_tree_page
 return function (data, base_page, title, items, scroll_height)
@@ -53,7 +53,7 @@ return function (data, base_page, title, items, scroll_height)
     local page_end
 
     for i = 1, #items do
-        local item = items[i] ---@type pocket_doc_sect|pocket_doc_subsect|pocket_doc_text|pocket_doc_note|pocket_doc_tip|pocket_doc_list
+        local item = items[i]
 
         if item.type == DOC_TYPE.SECTION then
             ---@cast item pocket_doc_sect

reactor-plc/backplane.lua

@@ -114,6 +114,7 @@ function backplane.init(config, __shared_memory)
 
         -- mount a virtual peripheral to init the RPS with
         local _, dev = ppm.mount_virtual()
+---@diagnostic disable-next-line: assign-type-mismatch
         plc_dev.reactor = dev
 
         log.info("BKPLN: mounted virtual device as reactor")
@@ -156,7 +157,7 @@ end
 -- handle a backplane peripheral attach
 ---@param iface string
 ---@param type string
----@param device table
+---@param device ppm_generic
 ---@param print_no_fp function
 function backplane.attach(iface, type, device, print_no_fp)
     local MQ__RPS_CMD = _bp.smem.q_types.MQ__RPS_CMD
@@ -170,6 +171,8 @@ function backplane.attach(iface, type, device, print_no_fp)
 
     if type ~= nil and device ~= nil then
         if type == "fissionReactorLogicAdapter" then
+            ---@cast device FissionReactor
+
             if not state.no_reactor then
                 log.warning("BKPLN: !! DANGER !! an additional reactor (" .. iface .. ") was connected and will not be used!")
                 log.warning(multi_reactor_warn)
@@ -269,7 +272,7 @@ end
 -- handle a backplane peripheral detach
 ---@param iface string
 ---@param type string
----@param device table
+---@param device ppm_generic
 ---@param print_no_fp function
 function backplane.detach(iface, type, device, print_no_fp)
     local MQ__RPS_CMD = _bp.smem.q_types.MQ__RPS_CMD
@@ -281,6 +284,8 @@ function backplane.detach(iface, type, device, print_no_fp)
     local sys   = _bp.smem.plc_sys
 
     if type == "fissionReactorLogicAdapter" then
+        ---@cast device FissionReactor
+
         log.info("BKPLN: REACTOR LINK_DOWN " .. iface)
 
         -- detect and warn about multiple reactors