Some plug-in interface requests

[DreamMaoMao]

hey, I want to implement a label jump plugin, and now I need these interfaces, are there any ready-made lua interfaces now?

• 1.Input parameter (void), get how many items are displayed in the current area, and be able to get the attributes of all the items(are displaying) like: (mime-type, path)
• 2.Input parameter (n), can get the type icon character of the nth item, like this: 
• 3.Input parameter (n, str), can modify the type icon character of the n th item to str (allow to modify to multiple characters, like this: AB)
• 4.Input parameter (n), can select the nth item with the cursor
• 5.Input parameter (fun), keyboard input event callback fun(event data), data contains the input character, and do not let other keyboard events be captured by other places.

@sxyazi

[sxyazi]

Thank you for summarizing this.

---

1.Input parameter (void), get how many items are displayed in the current area, and be able to get the attributes of all the items(are displaying) like: (mime-type, path)

2.Input parameter (n), can get the type icon character of the nth item, like this: 

You can obtain the list of files in the current area using Folder:by_kind(Folder.CURRENT).window.

It returns an array where each element is a file object. You can retrieve the file's icon using file:icon() and its mime-type using file:mime(), and so on. This is a list of all supported methods:

yazi/yazi-plugin/src/bindings/file.rs

Lines 15 to 24 in cf769bf

	reg.add_field_method_get("url", |lua, me| Url::cast(lua, me.url.clone()));
	reg.add_field_method_get("cha", |lua, me| Cha::cast(lua, me.cha));
	reg.add_field_method_get("link_to", |lua, me| {
	me.link_to.as_ref().cloned().map(|u| Url::cast(lua, u)).transpose()
	});
	// Extension
	reg.add_field_method_get("name", |lua, me| {
	me.url.file_name().map(|n| lua.create_string(n.as_encoded_bytes())).transpose()
	});

And:

yazi/yazi-fm/src/lives/folder.rs

Lines 47 to 156 in cf769bf

	reg.add_function("size", |_, me: AnyUserData| {
	let file = me.borrow::<yazi_shared::fs::File>()?;
	if !file.is_dir() {
	return Ok(Some(file.len));
	}
	let folder = me.named_user_value::<FolderRef>("folder")?;
	Ok(folder.files.sizes.get(&file.url).copied())
	});
	reg.add_function("mime", |lua, me: AnyUserData| {
	let cx = lua.named_registry_value::<CtxRef>("cx")?;
	let file = me.borrow::<yazi_shared::fs::File>()?;
	Ok(cx.manager.mimetype.get(&file.url).cloned())
	});
	reg.add_function("prefix", |lua, me: AnyUserData| {
	let folder = me.named_user_value::<FolderRef>("folder")?;
	if !folder.cwd.is_search() {
	return Ok(None);
	}
	let file = me.borrow::<yazi_shared::fs::File>()?;
	let mut p = file.url.strip_prefix(&folder.cwd).unwrap_or(&file.url).components();
	p.next_back();
	Some(lua.create_string(p.as_path().as_os_str().as_encoded_bytes())).transpose()
	});
	reg.add_method("icon", |_, me, ()| {
	Ok(
	THEME
	.icons
	.iter()
	.find(|&x| x.name.match_path(&me.url, me.is_dir()))
	.map(|x| x.display.to_string()),
	)
	});
	reg.add_function("style", |lua, me: AnyUserData| {
	let cx = lua.named_registry_value::<CtxRef>("cx")?;
	let file = me.borrow::<yazi_shared::fs::File>()?;
	let mime = if file.is_dir() {
	Some(MIME_DIR)
	} else {
	cx.manager.mimetype.get(&file.url).map(|x| &**x)
	};
	Ok(
	THEME
	.filetypes
	.iter()
	.find(|&x| x.matches(&file.url, mime))
	.map(|x| Style::from(x.style)),
	)
	});
	reg.add_function("is_hovered", |_, me: AnyUserData| {
	let folder = me.named_user_value::<FolderRef>("folder")?;
	let file = me.borrow::<yazi_shared::fs::File>()?;
	Ok(matches!(folder.hovered(), Some(f) if f.url == file.url))
	});
	reg.add_function("is_yanked", |lua, me: AnyUserData| {
	let cx = lua.named_registry_value::<CtxRef>("cx")?;
	let file = me.borrow::<yazi_shared::fs::File>()?;
	Ok(if !cx.manager.yanked.1.contains(&file.url) {
	0u8
	} else if cx.manager.yanked.0 {
	2u8
	} else {
	1u8
	})
	});
	reg.add_function("is_selected", |lua, me: AnyUserData| {
	let cx = lua.named_registry_value::<CtxRef>("cx")?;
	let folder = me.named_user_value::<FolderRef>("folder")?;
	let file = me.borrow::<yazi_shared::fs::File>()?;
	let selected = folder.files.is_selected(&file.url);
	Ok(if !cx.manager.active().mode.is_visual() {
	selected
	} else {
	let idx: usize = me.named_user_value("idx")?;
	cx.manager.active().mode.pending(folder.offset + idx, selected)
	})
	});
	reg.add_function("found", |lua, me: AnyUserData| {
	let cx = lua.named_registry_value::<CtxRef>("cx")?;
	let Some(finder) = &cx.manager.active().finder else {
	return Ok(None);
	};
	let file = me.borrow::<yazi_shared::fs::File>()?;
	if let Some(idx) = finder.matched_idx(&file.url) {
	return Some(
	lua.create_sequence_from([idx.into_lua(lua)?, finder.matched().len().into_lua(lua)?]),
	)
	.transpose();
	}
	Ok(None)
	});
	reg.add_function("highlights", |lua, me: AnyUserData| {
	let cx = lua.named_registry_value::<CtxRef>("cx")?;
	let Some(finder) = &cx.manager.active().finder else {
	return Ok(None);
	};
	let file = me.borrow::<yazi_shared::fs::File>()?;
	let Some(h) = file.name().and_then(|n| finder.filter.highlighted(n)) else {
	return Ok(None);
	};
	Ok(Some(h.into_iter().map(Range::from).collect::<Vec<_>>()))
	});
	})?;

3.Input parameter (n, str), can modify the type icon character of the n th item to str (allow to modify to multiple characters, like this: AB)

yazi/yazi-plugin/preset/components/folder.lua

Line 17 in cf769bf

function Folder:icon(file) return ui.Span(" " .. file:icon() .. " ") end

You can directly override the Folder:icon(file) method in your init.lua to do anything you wish, such as:

local old_icon_method = Folder.icon
function Folder:icon(file) 
    if my_plugin.some_key_pressed then
        return ui.Span("this is my custom icon")
    else
        return old_icon_method(self)
    end
end

4.Input parameter (n), can select the nth item with the cursor

We can add a dedicated command for it. Currently, you can only combine two commands, arrow and select, something like:

ya.manager_emit("arrow", { "5" })
ya.manager_emit("select", { state="true" })

It will select the fifth file.

5.Input parameter (fun), keyboard input event callback fun(event data), data contains the input character, and do not let other keyboard events be captured by other places.

We can also add it.

[DreamMaoMao]

First of all, thank you very much for your patient answer, I believe we can make yazi better together.

[DreamMaoMao]

I'll test the existing api first, and if you have the time, thank you very much for adding the last api.

[DreamMaoMao]

2024-01-04.21-00-25.mp4

hey,I think I have completed the testing of the previous interfaces. What should I do to bind my feature switch function in keymap.toml? just like triggering linemo.

[DreamMaoMao]

I can only manually change init.lua to statically start and shut down, I need a dynamic way to enable and shut down by key commands like other feature.