Adding components

[ranjithshegde]

Firstly,
Thanks for your wonderful work. This is such a comprehensive plugin! Finally something that can allow me to extend and customize thing I used to do with vim-dispatch

I have finally gotten around to defining and bundling templates (using generator where applicable).
Now starting to add/customize component for tasks.

What I am not able to figure out, if there is a way to pass any component while defining a template? for example something like

local pseudo_template = {
  name = "foo",
  desc = "something",
  components = {"here i pass it as list"} or function(_) end
}

If not, then what is the prefered way of attaching a component to a specific template or task?

[stevearc]

Templates have a builder function that returns a overseer.TaskDefinition. This is passed in directly to overseer.new_task. This could probably be documented better, but the type can be found here:

overseer.nvim/lua/overseer/task.lua

Lines 41 to 49 in 57b1d3d

	---@class overseer.TaskDefinition
	---@field cmd string|string[]
	---@field args? string[]
	---@field name? string
	---@field cwd? string
	---@field env? table<string, string>
	---@field strategy? string|table
	---@field metadata? table
	---@field components? table TODO more specific type

So your template could look like this:

local my_template = {
  name = "My template",
  params = {},
  builder = function(params)
    return {
      cmd = "ls -l",
      components = {'default', 'my_custom_component'},
    }
  end
}

If you need to set the components on the task based on configuration passed to your template, then you can add params to the template and use those in the builder to create the list of components.

[ranjithshegde]

I have one last question on this topic, if you dont mind.

Where (and when) do you pass the params defined in the components? Is it possible to set them in the template definition when setting components = {"default", "myNamespace.some_component"}?

EDIT: I have tried
components = {"default", {"namespace.some_comp", param1 = "foo"}},
components = {"default", {"namespace.some_comp", {param1 = "foo"}}},
components = {"default", {"namespace.some_comp", params = {param1 = "foo"}}},

And they all throw errors

[stevearc]

That's very strange, because components = {"default", {"namespace.some_comp", param1 = "foo"}} is the correct syntax and should work. What errors are you seeing?

[ranjithshegde]

Apologies! I made a spelling mistake between template and component params!

It works as it should!
Thanks

[stevearc]

Ideally if a parameter name typo causes errors, the error message should clearly state what is going wrong. If it was cryptic or confusing, please file an issue and I'll make it more human-friendly

[ranjithshegde]

The error is readable. It states componentName requires param myParams

I had interpreted it to mean that param is not being passed because bad syntax, not that I typed it wrong.