How exactly do multi-file plugins work? #3570
-
What system are you running Yazi on?Linux Wayland What terminal are you running Yazi in?Ghostty 1.2.3-arch2
|
Beta Was this translation helpful? Give feedback.
Replies: 3 comments 6 replies
-
|
Is it possible to provide a minimal reproducer? That error is usually caused by calling an async function from a sync context. Not sure if this is helpful, but I recently split the |
Beta Was this translation helpful? Give feedback.
-
|
Sure here's one:
local M = {}
local utils = require(".utils")
function M:entry() utils.show_warning("Wow") end
return M
local M = {}
-- The default notification options for this plugin
local DEFAULT_NOTIFICATION_OPTIONS = {
title = "Test Plugin",
timeout = 5,
}
-- Function to merge tables.
--
-- The key-value pairs of the tables given later
-- in the argument list WILL OVERRIDE
-- the tables given earlier in the argument list.
--
-- The list items in the table will be added in order,
-- with the items in the first table being added first,
-- and the items in the second table being added second,
-- and so on.
--
-- Pass true as the first parameter to get the function
-- to merge the tables recursively.
---@param deep_or_target table<any, any>|boolean|nil Recursively merge or not
---@param target table<any, any>? The target table to merge
---@param ... table<any, any>[]? The tables to merge
---@return table<any, any> merged_table The merged table
M.merge_tables = function(deep_or_target, target, ...)
--
-- Initialise the target table
local target_table = nil
-- Initialise the arguments
local args = nil
-- Initialise the recursive variable
local recursive = false
-- If the deep or target variable is a boolean
if type(deep_or_target) == "boolean" then
--
-- Set the recursive variable to the boolean value of the
-- deep or target variable
recursive = deep_or_target
-- Set the target table to the target variable
target_table = target
-- Set the arguments to the rest of the arguments
args = { ... }
-- Otherwise, the deep or target variable is not a boolean,
-- and is most likely a table.
else
--
-- Set the target table to the deep or target variable
-- if it is a table, otherwise, set it to an empty table
target_table = type(deep_or_target) == "table" and deep_or_target or {}
-- Set the arguments to the target variable
-- and the rest of the arguments
args = { target, ... }
end
-- The target table will not be nil after the checks above
---@cast target_table table<any, any>
-- Initialise the index variable
local index = #target_table + 1
-- Iterates over the tables given
for _, table in ipairs(args) do
--
-- Iterate over all of the keys and values
for key, value in pairs(table) do
--
-- If the key is a number, then add using the index
-- instead of the key.
-- This is to allow lists to be merged.
if type(key) == "number" then
--
-- Set the value mapped to the index
target_table[index] = value
-- Increment the index
index = index + 1
-- Continue the loop
goto continue
end
-- If recursive merging is wanted
-- and the key for the target table
-- and the value are both tables
if
recursive
and type(target_table[key]) == "table"
and type(value) == "table"
then
--
-- Call the merge table function
-- recursively on the target table's
-- key to merge the table recursively
M.merge_tables(target_table[key], value)
-- Continue the loop
goto continue
end
-- Otherwise, set the key in the target table to the value given
target_table[key] = value
-- The label to continue the loop
::continue::
end
end
-- Return the target table
return target_table
end
-- Function to show a warning
---@param warning_message any The warning message
---@param options YaziNotificationOptions? Options for the notification
---@return nil
M.show_warning = function(warning_message, options)
return ya.notify(
M.merge_tables({}, DEFAULT_NOTIFICATION_OPTIONS, options or {}, {
content = tostring(warning_message),
level = "warn",
})
)
end
return MError: Ignore the complicated Somehow, changing local M = {}
function M:entry() require(".utils").show_warning("Wow") end
return MBut the above syntax is not ideal since I'm making use of pretty large libraries and will need to keep referring to the |
Beta Was this translation helpful? Give feedback.
-
|
Okay, after messing around with this test plugin, it seems to be that all That makes it seem like the Does the |
Beta Was this translation helpful? Give feedback.
-
|
I see the problem now, thanks for the update! Yeah, you're right: Yes, |
Beta Was this translation helpful? Give feedback.
-
|
All I see, that's interesting. Hopefully you'd be able to get module-level async working! For now, it seems like I will have to use the That's great! |
Beta Was this translation helpful? Give feedback.
-
|
You can reference the function: function M:show_warning() require(".utils"):show_warning() endand call it with self.show_warning("Wow") |
Beta Was this translation helpful? Give feedback.
-
|
This defeats the purpose of splitting up the plugin into multiple files. I would rather just implement everything in one file. |
Beta Was this translation helpful? Give feedback.
-
|
Supported in #3594 |
Beta Was this translation helpful? Give feedback.
-
|
Awesome, thank you! |
Beta Was this translation helpful? Give feedback.
Supported in #3594