properly define classes for modules

This ensures that an error is raised when calling a non-existant method.

modules/addons.lua

@@ -4,7 +4,6 @@ local utils = require 'mp.utils'
 
 local o = require 'modules.options'
 local g = require 'modules.globals'
-local fb = require 'modules.apis.fb'
 local fb_utils = require 'modules.utils'
 local parser_API = require 'modules.apis.parser'
 
@@ -188,6 +187,7 @@ local function load_external_addons()
     load_addons(addon_dir)
 end
 
+---@class addons
 return {
     check_api_version = check_api_version,
     load_internal_parsers = load_internal_parsers,

modules/apis/fb.lua

@@ -13,7 +13,7 @@ local scanning = require 'modules.navigation.scanning'
 local cache = require 'modules.cache'
 local controls = require 'modules.controls'
 
----@class FbAPI: FBUtils
+---@class FbAPI: fb_utils
 local fb = setmetatable({}, { __index = setmetatable({}, { __index = fb_utils }) })
 package.loaded["file-browser"] = setmetatable({}, { __index = fb })
 

modules/ass.lua

@@ -3,8 +3,6 @@
 --------------------------------------------------------------------------------------------------------
 --------------------------------------------------------------------------------------------------------
 
-local utils = require 'mp.utils'
-
 local g = require 'modules.globals'
 local o = require 'modules.options'
 local fb_utils = require 'modules.utils'
@@ -175,6 +173,7 @@ local function update_ass()
     draw()
 end
 
+---@class ass
 return {
     update_ass = update_ass,
     highlight_entry = highlight_entry,

modules/controls.lua

@@ -10,6 +10,7 @@ local movement = require 'modules.navigation.directory-movement'
 local ass = require 'modules.ass'
 local cursor = require 'modules.navigation.cursor'
 
+---@class controls
 local controls = {}
 
 --opens the browser

modules/globals.lua

@@ -4,9 +4,10 @@
 --------------------------------------------------------------------------------------------------------
 
 local mp = require 'mp'
+local o = require 'modules.options'
 
+---@class globals
 local globals = {}
-local o = require 'modules.options'
 
 --sets the version for the file-browser API
 globals.API_VERSION = "1.7.1"

modules/keybinds.lua

@@ -341,6 +341,7 @@ local function setup_keybinds()
     end
 end
 
+---@class keybinds
 return {
     setup_keybinds = setup_keybinds,
 }

modules/navigation/cursor.lua

@@ -7,6 +7,7 @@ local g = require 'modules.globals'
 local fb_utils = require 'modules.utils'
 local ass = require 'modules.ass'
 
+---@class cursor
 local cursor = {}
 
 --disables multiselect

modules/navigation/directory-movement.lua

@@ -10,6 +10,7 @@ local cache = require 'modules.cache'
 local scanning = require 'modules.navigation.scanning'
 local fb_utils = require 'modules.utils'
 
+---@class directory_movement
 local directory_movement = {}
 
 function directory_movement.set_current_file(filepath)

modules/navigation/scanning.lua

@@ -198,6 +198,7 @@ local function rescan(moving_adjacent)
     return g.state.co
 end
 
+---@class scanning
 return {
     rescan = rescan,
     scan_directory = parse_directory,

modules/observers.lua

@@ -3,6 +3,7 @@ local directory_movement = require 'modules.navigation.directory-movement'
 local fb = require 'modules.apis.fb'
 local fb_utils = require 'modules.utils'
 
+---@class observers
 local observers ={}
 
 ---saves the directory and name of the currently playing file

modules/options.lua

@@ -1,7 +1,7 @@
 local utils = require 'mp.utils'
 local opt = require 'mp.options'
 
----@class Options
+---@class options
 local o = {
     --root directories
     root = "~/",

modules/playlist.lua

@@ -346,6 +346,7 @@ local function open_file(flag, autoload)
     fb_utils.coroutine.resume_err(opts.co, opts)
 end
 
+---@class playlist
 return {
     add_files = open_file,
 }

modules/script-messages.lua

@@ -7,6 +7,7 @@ local g = require 'modules.globals'
 local fb_utils = require 'modules.utils'
 local scanning = require 'modules.navigation.scanning'
 
+---@class script_messages
 local script_messages = {}
 
 ---Allows other scripts to request directory contents from file-browser.

modules/setup.lua

@@ -46,6 +46,7 @@ local function setup_root()
     end
 end
 
+---@class setup
 return {
     extensions_list = setup_extensions_list,
     root = setup_root,

modules/utils.lua

@@ -15,7 +15,7 @@ local user_input_loaded, user_input = pcall(require, 'user-input-module')
 
 --creates a table for the API functions
 --adds one metatable redirect to prevent addon authors from accidentally breaking file-browser
----@class FBUtils
+---@class fb_utils
 local fb_utils = { API_VERSION = g.API_VERSION }
 
 fb_utils.list = {}