nixos-config/modules/home/yazi/plugins/file-extra-metadata.yazi
2025-03-21 16:50:54 -04:00
..
LICENSE refactoring 2025-03-21 16:50:54 -04:00
main.lua refactoring 2025-03-21 16:50:54 -04:00
README.md refactoring 2025-03-21 16:50:54 -04:00

file-extra-metadata

This is a Yazi plugin that replaces the default file previewer and spotter with extra information.

Preview

Before:

  • Previewer

    Before preview

  • Spotter (yazi >= v0.4 after 21/11/2024)

    Before spot

After:

  • Previewer

After previewer

  • Spotter (yazi >= v0.4 after 21/11/2024)

After spotter

Requirements

  • yazi >=0.4
  • Tested on Linux. For MacOS, Windows: some fields will shows empty values.

Installation

Install the plugin:

ya pack -a boydaihungst/file-extra-metadata

Add spotter keybind, makes sure not conflict with other <Tab> keybind in manager section:

[manager]
keymap = [
  # ...
  # Spotting
  { on = "<Tab>", run = "spot", desc = "Spot hovered file" },
]

Create ~/.config/yazi/yazi.toml and add:

[plugin]
  append_previewers = [
    { name = "*", run = "file-extra-metadata" },
  ]
  # yazi v0.4 after 21/11/2024
  # Setup keybind for spotter: https://github.com/sxyazi/yazi/pull/1802
  append_spotters = [
    { name = "*", run = "file-extra-metadata" },
  ]

or

[plugin]
  previewers = [
    # ... the rest
    # disable default file plugin { name = "*", run = "file" },
    { name = "*", run = "file-extra-metadata" },
  ]
  # yazi v0.4 after 21/11/2024
  # Setup keybind for spotter: https://github.com/sxyazi/yazi/pull/1802
  spotters = [
    # ... the rest
    # Fallback
    # { name = "*", run = "file" },
    { name = "*", run = "file-extra-metadata" },
  ]

For developer

If you want to compile this with other spotter/previewer:

require("file-extra-metadata"):render_table(job, { show_plugins_section = true })