This PR adds the ability to pass parameters to the previewer/preloader/spotter/fetcher. For example, you can pass parameters to your previewer in yazi.toml like this:

# yazi.toml
[plugin]
prepend_previewers = [
  { mime = "video/*", run = 'my-plugin test --foo --bar=baz' }
]

Then, the first parameter job in the peek() method of the my-plugin plugin will receive it:

-- ~/.config/yazi/plugins/my-plugin.yazi/init.lua
local M = {}

function M:peek(job)
  ya.err(job)
end

return M

Which logs:

{
  area = Rect: 0x600002a80d58,
  args = {  -- <- here
    [1] = "test",
    foo = true,
    bar = "baz",
  },
  file = File: 0x600002a80da8,
  mime = "video/mp4",
  skip = 0,
}

Similarly, preloader/spotter/fetcher also support parameter passing:

prepend_preloaders = [
  { mime = "image/*", run = 'my-plugin test --foo --bar=baz' }
]
prepend_spotters = [
  { mime = "image/*", run = 'my-plugin test --foo --bar=baz' }
]
prepend_fetchers = [
  { id = "test", mime = "image/*", run = 'my-plugin test --foo --bar=baz' }
]

Then, their respective preload(), spot(), and fetch() methods will receive the job.args:

-- ~/.config/yazi/plugins/my-plugin.yazi/init.lua
local M = {}

function M:preload(job)
  ya.err("preload args:", job.args)
end

function M:spot(job)
  ya.err("spot args:", job.args)
end

function M:fetch(job)
  ya.err("fetch args:", job.args)
end

return M

⚠️ Breaking changes

1. Task information for peek()/seek()/preload() has been moved from self to the job parameter.

Before:

function M:peek()
  ya.err("area:", self.area)
  ya.err("file:", self.file)
  ya.err("skip:", self.skip)
end

Now:

function M:peek(job)
  ya.err("area:", job.area)
  ya.err("file:", job.file)
  ya.err("skip:", job.skip)
end

These properties can still be accessed via self, but a deprecation warning will be shown. This compatibility layer will be fully removed in Yazi 0.4.2.

The change aims to resolve potential conflicts between Yazi’s internal properties and user plugin properties.

2. The first parameter of entry() has been replaced with the new job parameter.

Before:

function M:entry(args)
  ya.err("first arg:", args[1])
end

Now:

function M:entry(job)
  ya.err("first arg:", job.args[1])
end

The new job can still be used just like the original args (like job[1] or ipairs(job)), but a deprecation warning will be shown. This compatibility layer will be fully removed in Yazi 0.4.2.

3. The first parameter of seek() has been changed from a number units to a table job.

Before:

function M:seek(units)
  ya.err("units:", units)
end

Now:

function M:seek(job)
  ya.err("units:", job.units)
end

This change is made to provide extensibility for adding more fields in the future.