diff --git a/piper.yazi/LICENSE b/piper.yazi/LICENSE new file mode 120000 index 0000000..ea5b606 --- /dev/null +++ b/piper.yazi/LICENSE @@ -0,0 +1 @@ +../LICENSE \ No newline at end of file diff --git a/piper.yazi/README.md b/piper.yazi/README.md new file mode 100644 index 0000000..a3e8c12 --- /dev/null +++ b/piper.yazi/README.md @@ -0,0 +1,64 @@ +# piper.yazi + +Pipe any shell command as a previewer. + +## Installation + +```sh +ya pack -a yazi-rs/plugins:piper +``` + +## Usage + +Piper is a general-purpose previewer - you can pass any shell command to `piper` and it will use the command's output as the preview content. + +It accepts a string parameter, which is the shell command to be executed, for example: + +```toml +# ~/.config/yazi/yaiz.toml +[[plugin.prepend_previewers]] +name = "*" +run = 'piper -- echo "$1"' +``` + +This will set `piper` as the previewer for all file types and use `$1` (file path) as the preview content. + +## Variables + +Available variables: + +- `$w`: the width of the preview area. +- `$h`: the height of the preview area. +- `$1`: the path to the file being previewed. + +## Examples + +Here are some configuration examples: + +### Preview CSV with [`bat`](https://github.com/sharkdp/bat) + +```toml +[[plugin.prepend_previewers]] +name = "*.csv" +run = 'piper -- bat -p --color=always "$1"' +``` + +### Preview Markdown with [`glow`](https://github.com/charmbracelet/glow) + +```toml +[[plugin.prepend_previewers]] +name = "*.md" +run = 'piper -- CLICOLOR_FORCE=1 glow -w=$w -s=dark "$1"' +``` + +### Preview directory tree with [`eza`](https://github.com/eza-community/eza) + +```toml +[[plugin.prepend_previewers]] +name = "*/" +run = 'piper -- eza -TL=3 --color=always --icons=always --group-directories-first --no-quotes "$1"' +``` + +## License + +This plugin is MIT-licensed. For more information check the [LICENSE](LICENSE) file. diff --git a/piper.yazi/main.lua b/piper.yazi/main.lua new file mode 100644 index 0000000..bc5b532 --- /dev/null +++ b/piper.yazi/main.lua @@ -0,0 +1,55 @@ +local M = {} + +local function fail(job, s) + ya.preview_widgets(job, { + ui.Text(string.format("`piper` plugin error: %s", s)):area(job.area):wrap(ui.Text.WRAP), + }) +end + +function M:peek(job) + local child, err = Command("sh") + :args({ + "-c", + job.args[1], + }) + :env("w", job.area.w) + :env("h", job.area.h) + :args({ "", tostring(job.file.url) }) + :stdout(Command.PIPED) + :stderr(Command.PIPED) + :spawn() + + if not child then + return fail(job, err) + end + + local limit = job.area.h + local i, lines = 0, "" + repeat + local next, event = child:read_line() + if event == 1 then + return fail(job, "error occurred in stderr") + elseif event ~= 0 then + break + end + + i = i + 1 + if i > job.skip then + lines = lines .. next + end + until i >= job.skip + limit + + child:start_kill() + if job.skip > 0 and i < job.skip + limit then + ya.mgr_emit("peek", { math.max(0, i - limit), only_if = job.file.url, upper_bound = true }) + else + lines = lines:gsub("\t", string.rep(" ", rt.preview.tab_size)) + ya.preview_widgets(job, { + ui.Text.parse(lines):area(job.area):wrap(rt.preview.wrap == "yes" and ui.Text.WRAP or ui.Text.WRAP_NO), + }) + end +end + +function M:seek(job) require("code"):seek(job) end + +return M