restertet yazi setup
new file: herdr/.config/herdr/sessions/home/session-history.json new file: herdr/.config/herdr/sessions/home/session.json new file: kanata/.config/systemd/user/default.target.wants/duplicati.service new file: pi/.pi/agent/extensions/atuin.ts new file: yazi/.config/yazi/bookmark modified: yazi/.config/yazi/init.lua modified: yazi/.config/yazi/keymap.toml modified: yazi/.config/yazi/package.toml renamed: yazi/.config/yazi/flavors/catppuccin-mocha.yazi/LICENSE -> yazi/.config/yazi/plugins/chmod.yazi/LICENSE new file: yazi/.config/yazi/plugins/chmod.yazi/README.md new file: yazi/.config/yazi/plugins/chmod.yazi/main.lua new file: yazi/.config/yazi/plugins/eza-preview.yazi/LICENSE new file: yazi/.config/yazi/plugins/eza-preview.yazi/README.md new file: yazi/.config/yazi/plugins/eza-preview.yazi/main.lua modified: yazi/.config/yazi/plugins/fchar.yazi/README.md modified: yazi/.config/yazi/plugins/fchar.yazi/main.lua deleted: yazi/.config/yazi/plugins/file-extra-metadata.yazi/main.lua modified: yazi/.config/yazi/plugins/mediainfo.yazi/LICENSE modified: yazi/.config/yazi/plugins/mediainfo.yazi/README.md new file: yazi/.config/yazi/plugins/mediainfo.yazi/adobe-old.lua new file: yazi/.config/yazi/plugins/mediainfo.yazi/adobe-stable.lua new file: yazi/.config/yazi/plugins/mediainfo.yazi/audio-old.lua new file: yazi/.config/yazi/plugins/mediainfo.yazi/audio-stable.lua new file: yazi/.config/yazi/plugins/mediainfo.yazi/const.lua new file: yazi/.config/yazi/plugins/mediainfo.yazi/image-old.lua new file: yazi/.config/yazi/plugins/mediainfo.yazi/image-stable.lua modified: yazi/.config/yazi/plugins/mediainfo.yazi/main.lua new file: yazi/.config/yazi/plugins/mediainfo.yazi/none-media-preview-old.lua new file: yazi/.config/yazi/plugins/mediainfo.yazi/none-media-preview-stable.lua new file: yazi/.config/yazi/plugins/mediainfo.yazi/utils.lua new file: yazi/.config/yazi/plugins/mediainfo.yazi/video-old.lua new file: yazi/.config/yazi/plugins/mediainfo.yazi/video-stable.lua modified: yazi/.config/yazi/plugins/mime-ext.yazi/README.md new file: yazi/.config/yazi/plugins/mime-ext.yazi/local.lua modified: yazi/.config/yazi/plugins/mime-ext.yazi/main.lua new file: yazi/.config/yazi/plugins/mime-ext.yazi/remote.lua modified: yazi/.config/yazi/plugins/rich-preview.yazi/main.lua modified: yazi/.config/yazi/plugins/smart-enter.yazi/README.md deleted: yazi/.config/yazi/plugins/whoosh.yazi/.luarc.json modified: yazi/.config/yazi/plugins/whoosh.yazi/LICENSE deleted: yazi/.config/yazi/plugins/whoosh.yazi/README-RU.md modified: yazi/.config/yazi/plugins/whoosh.yazi/README.md modified: yazi/.config/yazi/plugins/whoosh.yazi/bookmarks deleted: yazi/.config/yazi/plugins/whoosh.yazi/image/history.png deleted: yazi/.config/yazi/plugins/whoosh.yazi/image/plugin.png modified: yazi/.config/yazi/plugins/whoosh.yazi/main.lua modified: yazi/.config/yazi/yazi.toml renamed: yazi/.config/yazi/plugins/full-border.yazi/LICENSE -> yazi_1/.config/yazi/flavors/catppuccin-mocha.yazi/LICENSE renamed: yazi/.config/yazi/flavors/catppuccin-mocha.yazi/LICENSE-tmtheme -> yazi_1/.config/yazi/flavors/catppuccin-mocha.yazi/LICENSE-tmtheme renamed: yazi/.config/yazi/flavors/catppuccin-mocha.yazi/README.md -> yazi_1/.config/yazi/flavors/catppuccin-mocha.yazi/README.md renamed: yazi/.config/yazi/flavors/catppuccin-mocha.yazi/flavor.toml -> yazi_1/.config/yazi/flavors/catppuccin-mocha.yazi/flavor.toml renamed: yazi/.config/yazi/flavors/catppuccin-mocha.yazi/preview.png -> yazi_1/.config/yazi/flavors/catppuccin-mocha.yazi/preview.png renamed: yazi/.config/yazi/flavors/catppuccin-mocha.yazi/tmtheme.xml -> yazi_1/.config/yazi/flavors/catppuccin-mocha.yazi/tmtheme.xml renamed: yazi/.config/yazi/flavors/dracula.yazi -> yazi_1/.config/yazi/flavors/dracula.yazi renamed: yazi/.config/yazi/flavors/everforest-medium.yazi/LICENSE -> yazi_1/.config/yazi/flavors/everforest-medium.yazi/LICENSE renamed: yazi/.config/yazi/flavors/everforest-medium.yazi/LICENSE-tmtheme -> yazi_1/.config/yazi/flavors/everforest-medium.yazi/LICENSE-tmtheme renamed: yazi/.config/yazi/flavors/everforest-medium.yazi/README.md -> yazi_1/.config/yazi/flavors/everforest-medium.yazi/README.md renamed: yazi/.config/yazi/flavors/everforest-medium.yazi/flavor.toml -> yazi_1/.config/yazi/flavors/everforest-medium.yazi/flavor.toml renamed: yazi/.config/yazi/flavors/everforest-medium.yazi/preview.png -> yazi_1/.config/yazi/flavors/everforest-medium.yazi/preview.png renamed: yazi/.config/yazi/flavors/everforest-medium.yazi/tmtheme.xml -> yazi_1/.config/yazi/flavors/everforest-medium.yazi/tmtheme.xml new file: yazi_1/.config/yazi/flavors/gruvbox-dark.yazi/LICENSE new file: yazi_1/.config/yazi/flavors/gruvbox-dark.yazi/LICENSE-tmtheme new file: yazi_1/.config/yazi/flavors/gruvbox-dark.yazi/README.md new file: yazi_1/.config/yazi/flavors/gruvbox-dark.yazi/flavor.toml new file: yazi_1/.config/yazi/flavors/gruvbox-dark.yazi/preview.png new file: yazi_1/.config/yazi/flavors/gruvbox-dark.yazi/tmtheme.xml renamed: yazi/.config/yazi/flavors/gruvbox-material.yazi/LICENSE -> yazi_1/.config/yazi/flavors/gruvbox-material.yazi/LICENSE renamed: yazi/.config/yazi/flavors/gruvbox-material.yazi/LICENSE-tmtheme -> yazi_1/.config/yazi/flavors/gruvbox-material.yazi/LICENSE-tmtheme renamed: yazi/.config/yazi/flavors/gruvbox-material.yazi/README.md -> yazi_1/.config/yazi/flavors/gruvbox-material.yazi/README.md renamed: yazi/.config/yazi/flavors/gruvbox-material.yazi/flavor.toml -> yazi_1/.config/yazi/flavors/gruvbox-material.yazi/flavor.toml renamed: yazi/.config/yazi/flavors/gruvbox-material.yazi/preview.png -> yazi_1/.config/yazi/flavors/gruvbox-material.yazi/preview.png renamed: yazi/.config/yazi/flavors/gruvbox-material.yazi/tmtheme.xml -> yazi_1/.config/yazi/flavors/gruvbox-material.yazi/tmtheme.xml renamed: yazi/.config/yazi/flavors/kanagawa.yazi/LICENSE -> yazi_1/.config/yazi/flavors/kanagawa.yazi/LICENSE renamed: yazi/.config/yazi/flavors/kanagawa.yazi/LICENSE-tmtheme -> yazi_1/.config/yazi/flavors/kanagawa.yazi/LICENSE-tmtheme renamed: yazi/.config/yazi/flavors/kanagawa.yazi/README.md -> yazi_1/.config/yazi/flavors/kanagawa.yazi/README.md renamed: yazi/.config/yazi/flavors/kanagawa.yazi/flavor.toml -> yazi_1/.config/yazi/flavors/kanagawa.yazi/flavor.toml renamed: yazi/.config/yazi/flavors/kanagawa.yazi/preview.png -> yazi_1/.config/yazi/flavors/kanagawa.yazi/preview.png renamed: yazi/.config/yazi/flavors/kanagawa.yazi/tmtheme.xml -> yazi_1/.config/yazi/flavors/kanagawa.yazi/tmtheme.xml renamed: yazi/.config/yazi/flavors/monokai.yazi/LICENSE -> yazi_1/.config/yazi/flavors/monokai.yazi/LICENSE renamed: yazi/.config/yazi/flavors/monokai.yazi/LICENSE-tmtheme -> yazi_1/.config/yazi/flavors/monokai.yazi/LICENSE-tmtheme renamed: yazi/.config/yazi/flavors/monokai.yazi/README.md -> yazi_1/.config/yazi/flavors/monokai.yazi/README.md renamed: yazi/.config/yazi/flavors/monokai.yazi/flavor.toml -> yazi_1/.config/yazi/flavors/monokai.yazi/flavor.toml renamed: yazi/.config/yazi/flavors/monokai.yazi/preview.png -> yazi_1/.config/yazi/flavors/monokai.yazi/preview.png renamed: yazi/.config/yazi/flavors/monokai.yazi/tmtheme.xml -> yazi_1/.config/yazi/flavors/monokai.yazi/tmtheme.xml renamed: yazi/.config/yazi/flavors/rose-pine-moon.yazi/LICENSE -> yazi_1/.config/yazi/flavors/rose-pine-moon.yazi/LICENSE renamed: yazi/.config/yazi/flavors/rose-pine-moon.yazi/LICENSE-tmtheme -> yazi_1/.config/yazi/flavors/rose-pine-moon.yazi/LICENSE-tmtheme renamed: yazi/.config/yazi/flavors/rose-pine-moon.yazi/README.md -> yazi_1/.config/yazi/flavors/rose-pine-moon.yazi/README.md renamed: yazi/.config/yazi/flavors/rose-pine-moon.yazi/flavor.toml -> yazi_1/.config/yazi/flavors/rose-pine-moon.yazi/flavor.toml renamed: yazi/.config/yazi/flavors/rose-pine-moon.yazi/preview.png -> yazi_1/.config/yazi/flavors/rose-pine-moon.yazi/preview.png renamed: yazi/.config/yazi/flavors/rose-pine-moon.yazi/tmtheme.xml -> yazi_1/.config/yazi/flavors/rose-pine-moon.yazi/tmtheme.xml renamed: yazi/.config/yazi/flavors/tokyo-night.yazi/LICENSE -> yazi_1/.config/yazi/flavors/tokyo-night.yazi/LICENSE renamed: yazi/.config/yazi/flavors/tokyo-night.yazi/LICENSE-tmtheme -> yazi_1/.config/yazi/flavors/tokyo-night.yazi/LICENSE-tmtheme renamed: yazi/.config/yazi/flavors/tokyo-night.yazi/README.md -> yazi_1/.config/yazi/flavors/tokyo-night.yazi/README.md renamed: yazi/.config/yazi/flavors/tokyo-night.yazi/flavor.toml -> yazi_1/.config/yazi/flavors/tokyo-night.yazi/flavor.toml renamed: yazi/.config/yazi/flavors/tokyo-night.yazi/preview.png -> yazi_1/.config/yazi/flavors/tokyo-night.yazi/preview.png renamed: yazi/.config/yazi/flavors/tokyo-night.yazi/tmtheme.xml -> yazi_1/.config/yazi/flavors/tokyo-night.yazi/tmtheme.xml new file: yazi_1/.config/yazi/init.lua new file: yazi_1/.config/yazi/keymap.toml renamed: yazi/.config/yazi/omp/omp.json -> yazi_1/.config/yazi/omp/omp.json renamed: yazi/.config/yazi/omp/omp.toml -> yazi_1/.config/yazi/omp/omp.toml renamed: yazi/.config/yazi/omp/omp2.toml -> yazi_1/.config/yazi/omp/omp2.toml renamed: yazi/.config/yazi/omp/omp_rose-pine.toml -> yazi_1/.config/yazi/omp/omp_rose-pine.toml new file: yazi_1/.config/yazi/package.toml renamed: yazi/.config/yazi/plugins/bunny.yazi/LICENSE -> yazi_1/.config/yazi/plugins/bunny.yazi/LICENSE renamed: yazi/.config/yazi/plugins/bunny.yazi/README.md -> yazi_1/.config/yazi/plugins/bunny.yazi/README.md renamed: yazi/.config/yazi/plugins/bunny.yazi/main.lua -> yazi_1/.config/yazi/plugins/bunny.yazi/main.lua renamed: yazi/.config/yazi/plugins/bypass.yazi/LICENSE -> yazi_1/.config/yazi/plugins/bypass.yazi/LICENSE renamed: yazi/.config/yazi/plugins/bypass.yazi/README.md -> yazi_1/.config/yazi/plugins/bypass.yazi/README.md renamed: yazi/.config/yazi/plugins/bypass.yazi/main.lua -> yazi_1/.config/yazi/plugins/bypass.yazi/main.lua renamed: yazi/.config/yazi/plugins/dupes.yazi/LICENSE -> yazi_1/.config/yazi/plugins/dupes.yazi/LICENSE renamed: yazi/.config/yazi/plugins/dupes.yazi/README.md -> yazi_1/.config/yazi/plugins/dupes.yazi/README.md renamed: yazi/.config/yazi/plugins/dupes.yazi/main.lua -> yazi_1/.config/yazi/plugins/dupes.yazi/main.lua renamed: yazi/.config/yazi/plugins/fazif.yazi/LICENSE -> yazi_1/.config/yazi/plugins/fazif.yazi/LICENSE renamed: yazi/.config/yazi/plugins/fazif.yazi/README.md -> yazi_1/.config/yazi/plugins/fazif.yazi/README.md renamed: yazi/.config/yazi/plugins/fazif.yazi/faziffd -> yazi_1/.config/yazi/plugins/fazif.yazi/faziffd renamed: yazi/.config/yazi/plugins/fazif.yazi/faziffdr -> yazi_1/.config/yazi/plugins/fazif.yazi/faziffdr renamed: yazi/.config/yazi/plugins/fazif.yazi/fazifrg -> yazi_1/.config/yazi/plugins/fazif.yazi/fazifrg renamed: yazi/.config/yazi/plugins/fazif.yazi/fazifrga -> yazi_1/.config/yazi/plugins/fazif.yazi/fazifrga renamed: yazi/.config/yazi/plugins/fazif.yazi/main.lua -> yazi_1/.config/yazi/plugins/fazif.yazi/main.lua new file: yazi_1/.config/yazi/plugins/fchar.yazi/LICENSE new file: yazi_1/.config/yazi/plugins/fchar.yazi/README.md new file: yazi_1/.config/yazi/plugins/fchar.yazi/main.lua renamed: yazi/.config/yazi/plugins/file-extra-metadata.yazi/LICENSE -> yazi_1/.config/yazi/plugins/file-extra-metadata.yazi/LICENSE renamed: yazi/.config/yazi/plugins/file-extra-metadata.yazi/README.md -> yazi_1/.config/yazi/plugins/file-extra-metadata.yazi/README.md new file: yazi_1/.config/yazi/plugins/file-extra-metadata.yazi/main.lua renamed: yazi/.config/yazi/plugins/git.yazi/LICENSE -> yazi_1/.config/yazi/plugins/full-border.yazi/LICENSE renamed: yazi/.config/yazi/plugins/full-border.yazi/README.md -> yazi_1/.config/yazi/plugins/full-border.yazi/README.md renamed: yazi/.config/yazi/plugins/full-border.yazi/main.lua -> yazi_1/.config/yazi/plugins/full-border.yazi/main.lua renamed: yazi/.config/yazi/plugins/mount.yazi/LICENSE -> yazi_1/.config/yazi/plugins/git.yazi/LICENSE renamed: yazi/.config/yazi/plugins/git.yazi/README.md -> yazi_1/.config/yazi/plugins/git.yazi/README.md renamed: yazi/.config/yazi/plugins/git.yazi/main.lua -> yazi_1/.config/yazi/plugins/git.yazi/main.lua renamed: yazi/.config/yazi/plugins/git.yazi/types.lua -> yazi_1/.config/yazi/plugins/git.yazi/types.lua renamed: yazi/.config/yazi/plugins/lazygit.yazi/LICENSE -> yazi_1/.config/yazi/plugins/lazygit.yazi/LICENSE renamed: yazi/.config/yazi/plugins/lazygit.yazi/README.md -> yazi_1/.config/yazi/plugins/lazygit.yazi/README.md renamed: yazi/.config/yazi/plugins/lazygit.yazi/main.lua -> yazi_1/.config/yazi/plugins/lazygit.yazi/main.lua renamed: yazi/.config/yazi/plugins/open-with-cmd.yazi/LICENSE -> yazi_1/.config/yazi/plugins/mediainfo.yazi/LICENSE new file: yazi_1/.config/yazi/plugins/mediainfo.yazi/README.md new file: yazi_1/.config/yazi/plugins/mediainfo.yazi/adobe-old.lua new file: yazi_1/.config/yazi/plugins/mediainfo.yazi/adobe-stable.lua new file: yazi_1/.config/yazi/plugins/mediainfo.yazi/assets/2025-02-15-09-14-23.png new file: yazi_1/.config/yazi/plugins/mediainfo.yazi/assets/2025-02-15-09-15-39.png new file: yazi_1/.config/yazi/plugins/mediainfo.yazi/assets/2025-02-15-16-51-11.png new file: yazi_1/.config/yazi/plugins/mediainfo.yazi/assets/2025-02-15-16-52-39.png new file: yazi_1/.config/yazi/plugins/mediainfo.yazi/audio-old.lua new file: yazi_1/.config/yazi/plugins/mediainfo.yazi/audio-stable.lua new file: yazi_1/.config/yazi/plugins/mediainfo.yazi/const.lua new file: yazi_1/.config/yazi/plugins/mediainfo.yazi/image-old.lua new file: yazi_1/.config/yazi/plugins/mediainfo.yazi/image-stable.lua new file: yazi_1/.config/yazi/plugins/mediainfo.yazi/main.lua new file: yazi_1/.config/yazi/plugins/mediainfo.yazi/none-media-preview-old.lua new file: yazi_1/.config/yazi/plugins/mediainfo.yazi/none-media-preview-stable.lua new file: yazi_1/.config/yazi/plugins/mediainfo.yazi/utils.lua new file: yazi_1/.config/yazi/plugins/mediainfo.yazi/video-old.lua new file: yazi_1/.config/yazi/plugins/mediainfo.yazi/video-stable.lua renamed: yazi/.config/yazi/plugins/piper.yazi/LICENSE -> yazi_1/.config/yazi/plugins/mime-ext.yazi/LICENSE new file: yazi_1/.config/yazi/plugins/mime-ext.yazi/README.md new file: yazi_1/.config/yazi/plugins/mime-ext.yazi/local.lua new file: yazi_1/.config/yazi/plugins/mime-ext.yazi/main.lua new file: yazi_1/.config/yazi/plugins/mime-ext.yazi/remote.lua renamed: yazi/.config/yazi/plugins/rsync.yazi/LICENSE -> yazi_1/.config/yazi/plugins/mount.yazi/LICENSE renamed: yazi/.config/yazi/plugins/mount.yazi/README.md -> yazi_1/.config/yazi/plugins/mount.yazi/README.md new file: yazi_1/.config/yazi/plugins/mount.yazi/cross.lua renamed: yazi/.config/yazi/plugins/mount.yazi/main.lua -> yazi_1/.config/yazi/plugins/mount.yazi/main.lua new file: yazi_1/.config/yazi/plugins/mount.yazi/sudo.lua renamed: yazi/.config/yazi/plugins/omp.yazi -> yazi_1/.config/yazi/plugins/omp.yazi renamed: yazi/.config/yazi/plugins/open-git-remote.yazi/LICENSE -> yazi_1/.config/yazi/plugins/open-git-remote.yazi/LICENSE renamed: yazi/.config/yazi/plugins/open-git-remote.yazi/README.md -> yazi_1/.config/yazi/plugins/open-git-remote.yazi/README.md renamed: yazi/.config/yazi/plugins/open-git-remote.yazi/main.lua -> yazi_1/.config/yazi/plugins/open-git-remote.yazi/main.lua new file: yazi_1/.config/yazi/plugins/open-with-cmd.yazi/LICENSE renamed: yazi/.config/yazi/plugins/open-with-cmd.yazi/README.md -> yazi_1/.config/yazi/plugins/open-with-cmd.yazi/README.md renamed: yazi/.config/yazi/plugins/open-with-cmd.yazi/main.lua -> yazi_1/.config/yazi/plugins/open-with-cmd.yazi/main.lua renamed: yazi/.config/yazi/plugins/ouch.yazi/LICENSE -> yazi_1/.config/yazi/plugins/ouch.yazi/LICENSE renamed: yazi/.config/yazi/plugins/ouch.yazi/README.md -> yazi_1/.config/yazi/plugins/ouch.yazi/README.md renamed: yazi/.config/yazi/plugins/ouch.yazi/main.lua -> yazi_1/.config/yazi/plugins/ouch.yazi/main.lua renamed: yazi/.config/yazi/plugins/toggle-pane.yazi/LICENSE -> yazi_1/.config/yazi/plugins/piper.yazi/LICENSE renamed: yazi/.config/yazi/plugins/piper.yazi/README.md -> yazi_1/.config/yazi/plugins/piper.yazi/README.md renamed: yazi/.config/yazi/plugins/piper.yazi/main.lua -> yazi_1/.config/yazi/plugins/piper.yazi/main.lua renamed: yazi/.config/yazi/plugins/projects.yazi/LICENSE -> yazi_1/.config/yazi/plugins/projects.yazi/LICENSE renamed: yazi/.config/yazi/plugins/projects.yazi/README.md -> yazi_1/.config/yazi/plugins/projects.yazi/README.md renamed: yazi/.config/yazi/plugins/projects.yazi/json.lua -> yazi_1/.config/yazi/plugins/projects.yazi/json.lua renamed: yazi/.config/yazi/plugins/projects.yazi/main.lua -> yazi_1/.config/yazi/plugins/projects.yazi/main.lua renamed: yazi/.config/yazi/plugins/recycle-bin.yazi/LICENSE -> yazi_1/.config/yazi/plugins/recycle-bin.yazi/LICENSE renamed: yazi/.config/yazi/plugins/recycle-bin.yazi/README.md -> yazi_1/.config/yazi/plugins/recycle-bin.yazi/README.md renamed: yazi/.config/yazi/plugins/recycle-bin.yazi/main.lua -> yazi_1/.config/yazi/plugins/recycle-bin.yazi/main.lua new file: yazi_1/.config/yazi/plugins/rich-preview.yazi/LICENSE new file: yazi_1/.config/yazi/plugins/rich-preview.yazi/README.md new file: yazi_1/.config/yazi/plugins/rich-preview.yazi/main.lua renamed: yazi/.config/yazi/plugins/vcs-files.yazi/LICENSE -> yazi_1/.config/yazi/plugins/rsync.yazi/LICENSE renamed: yazi/.config/yazi/plugins/rsync.yazi/README.md -> yazi_1/.config/yazi/plugins/rsync.yazi/README.md renamed: yazi/.config/yazi/plugins/rsync.yazi/assets/demo.gif -> yazi_1/.config/yazi/plugins/rsync.yazi/assets/demo.gif renamed: yazi/.config/yazi/plugins/rsync.yazi/assets/demo.webm -> yazi_1/.config/yazi/plugins/rsync.yazi/assets/demo.webm renamed: yazi/.config/yazi/plugins/rsync.yazi/main.lua -> yazi_1/.config/yazi/plugins/rsync.yazi/main.lua renamed: yazi/.config/yazi/plugins/simple-tag.yazi/LICENSE -> yazi_1/.config/yazi/plugins/simple-tag.yazi/LICENSE renamed: yazi/.config/yazi/plugins/simple-tag.yazi/README.md -> yazi_1/.config/yazi/plugins/simple-tag.yazi/README.md renamed: yazi/.config/yazi/plugins/simple-tag.yazi/main.lua -> yazi_1/.config/yazi/plugins/simple-tag.yazi/main.lua new file: yazi_1/.config/yazi/plugins/smart-enter.yazi/LICENSE new file: yazi_1/.config/yazi/plugins/smart-enter.yazi/README.md new file: yazi_1/.config/yazi/plugins/smart-enter.yazi/main.lua renamed: yazi/.config/yazi/plugins/smart-paste.yazi/LICENSE -> yazi_1/.config/yazi/plugins/smart-paste.yazi/LICENSE renamed: yazi/.config/yazi/plugins/smart-paste.yazi/README.md -> yazi_1/.config/yazi/plugins/smart-paste.yazi/README.md renamed: yazi/.config/yazi/plugins/smart-paste.yazi/main.lua -> yazi_1/.config/yazi/plugins/smart-paste.yazi/main.lua new file: yazi_1/.config/yazi/plugins/toggle-pane.yazi/LICENSE renamed: yazi/.config/yazi/plugins/toggle-pane.yazi/README.md -> yazi_1/.config/yazi/plugins/toggle-pane.yazi/README.md renamed: yazi/.config/yazi/plugins/toggle-pane.yazi/main.lua -> yazi_1/.config/yazi/plugins/toggle-pane.yazi/main.lua new file: yazi_1/.config/yazi/plugins/vcs-files.yazi/LICENSE renamed: yazi/.config/yazi/plugins/vcs-files.yazi/README.md -> yazi_1/.config/yazi/plugins/vcs-files.yazi/README.md renamed: yazi/.config/yazi/plugins/vcs-files.yazi/main.lua -> yazi_1/.config/yazi/plugins/vcs-files.yazi/main.lua renamed: yazi/.config/yazi/plugins/what-size.yazi/LICENSE -> yazi_1/.config/yazi/plugins/what-size.yazi/LICENSE renamed: yazi/.config/yazi/plugins/what-size.yazi/README.md -> yazi_1/.config/yazi/plugins/what-size.yazi/README.md renamed: yazi/.config/yazi/plugins/what-size.yazi/main.lua -> yazi_1/.config/yazi/plugins/what-size.yazi/main.lua new file: yazi_1/.config/yazi/plugins/whoosh.yazi new file: yazi_1/.config/yazi/plugins/wise-enter.yazi/LICENSE new file: yazi_1/.config/yazi/plugins/wise-enter.yazi/README.md new file: yazi_1/.config/yazi/plugins/wise-enter.yazi/main.lua renamed: yazi/.config/yazi/plugins/yafg.yazi/LICENSE -> yazi_1/.config/yazi/plugins/yafg.yazi/LICENSE renamed: yazi/.config/yazi/plugins/yafg.yazi/README.md -> yazi_1/.config/yazi/plugins/yafg.yazi/README.md renamed: yazi/.config/yazi/plugins/yafg.yazi/main.lua -> yazi_1/.config/yazi/plugins/yafg.yazi/main.lua renamed: yazi/.config/yazi/plugins/yaziline.yazi/LICENSE -> yazi_1/.config/yazi/plugins/yaziline.yazi/LICENSE renamed: yazi/.config/yazi/plugins/yaziline.yazi/README.md -> yazi_1/.config/yazi/plugins/yaziline.yazi/README.md renamed: yazi/.config/yazi/plugins/yaziline.yazi/main.lua -> yazi_1/.config/yazi/plugins/yaziline.yazi/main.lua renamed: yazi/.config/yazi/tags/home/liph/.local/share/Trash/files/tags.json -> yazi_1/.config/yazi/tags/home/liph/.local/share/Trash/files/tags.json renamed: yazi/.config/yazi/tags/home/liph/Downloads/tags.json -> yazi_1/.config/yazi/tags/home/liph/Downloads/tags.json renamed: yazi/.config/yazi/tags/home/liph/programming/webdev/html/static/tags.json -> yazi_1/.config/yazi/tags/home/liph/programming/webdev/html/static/tags.json new file: yazi_1/.config/yazi/tags/home/liph/scripts/tags.json renamed: yazi/.config/yazi/tags/home/liph/tags.json -> yazi_1/.config/yazi/tags/home/liph/tags.json new file: yazi_1/.config/yazi/yazi.toml
This commit is contained in:
liph committed
1 parent
d6fd64c8af
commit
a8a1b5a718
226 files changed
+17541
-3631
No files matched your search
@@ -0,0 +1,9 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright © 2024 Stel Clementine
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
@@ -0,0 +1,102 @@
|
||||
# bunny.yazi 🐰
|
||||
|
||||
*🩷 Hop around your filesystem 🩷*
|
||||
|
||||
This is a bookmark plugin for [yazi](https://github.com/sxyazi/yazi) which augments the builtin bookmarking abilities into a single menu of `cd` powers designed with user experience (and cuteness) in mind. Bookmarks are referred to as *hops* because users should always feel adorable while using their terminal.
|
||||
|
||||
## Features
|
||||
|
||||
- Create persistent hops in your `init.lua` config file
|
||||
- Create ephemeral hops while using yazi
|
||||
- Hop to any directory open in another tab
|
||||
- Hop back to previous directory (history is associated with tab number)
|
||||
- Hop by fuzzy searching available hops with [fzf](https://github.com/junegunn/fzf) or similar program
|
||||
- Single menu for all functionality, therefore only one keymap is required in your `keymap.toml` file
|
||||
- Hands off: no reads or writes to your filesystem, all state is kept in memory
|
||||
|
||||
<img src="https://i.imgur.com/9OKQJUT.png" alt="bunny.yazi menu open in a terminal"/>
|
||||
|
||||
## Installation
|
||||
|
||||
### With `git`
|
||||
|
||||
```sh
|
||||
git clone https://github.com/stelcodes/bunny.yazi ~/.config/yazi/plugins/bunny.yazi
|
||||
```
|
||||
|
||||
### With `yapack`
|
||||
|
||||
```sh
|
||||
ya pack -a stelcodes/bunny
|
||||
```
|
||||
|
||||
### With Nix (Home Manager + flakes)
|
||||
|
||||
`flake.nix`:
|
||||
```nix
|
||||
inputs = {
|
||||
bunny-yazi = {
|
||||
url = "github:stelcodes/bunny.yazi";
|
||||
flake = false;
|
||||
};
|
||||
};
|
||||
```
|
||||
|
||||
Home Manager config:
|
||||
```nix
|
||||
programs.yazi = {
|
||||
plugins.bunny = "${inputs.bunny-yazi}";
|
||||
initLua = ''
|
||||
require("bunny"):setup({ ... })
|
||||
'';
|
||||
keymap.mgr.prepend_keymap = [
|
||||
{ on = ";"; run = "plugin bunny"; desc = "Start bunny.yazi"; }
|
||||
];
|
||||
};
|
||||
```
|
||||
|
||||
## Configuration
|
||||
`~/.config/yazi/init.lua`:
|
||||
```lua
|
||||
require("bunny"):setup({
|
||||
hops = {
|
||||
{ key = "/", path = "/", },
|
||||
{ key = "t", path = "/tmp", },
|
||||
{ key = "n", path = "/nix/store", desc = "Nix store" },
|
||||
{ key = "~", path = "~", desc = "Home" },
|
||||
{ key = "m", path = "~/Music", desc = "Music" },
|
||||
{ key = "d", path = "~/Desktop", desc = "Desktop" },
|
||||
{ key = "D", path = "~/Documents", desc = "Documents" },
|
||||
{ key = "c", path = "~/.config", desc = "Config files" },
|
||||
{ key = { "l", "s" }, path = "~/.local/share", desc = "Local share" },
|
||||
{ key = { "l", "b" }, path = "~/.local/bin", desc = "Local bin" },
|
||||
{ key = { "l", "t" }, path = "~/.local/state", desc = "Local state" },
|
||||
-- key and path attributes are required, desc is optional
|
||||
},
|
||||
desc_strategy = "path", -- If desc isn't present, use "path" or "filename", default is "path"
|
||||
ephemeral = true, -- Enable ephemeral hops, default is true
|
||||
tabs = true, -- Enable tab hops, default is true
|
||||
notify = false, -- Notify after hopping, default is false
|
||||
fuzzy_cmd = "fzf", -- Fuzzy searching command, default is "fzf"
|
||||
})
|
||||
```
|
||||
|
||||
`~/.config/yazi/keymap.toml`:
|
||||
```toml
|
||||
[[mgr.prepend_keymap]]
|
||||
desc = "Start bunny.yazi"
|
||||
on = ";"
|
||||
run = "plugin bunny"
|
||||
|
||||
# Optionally, add another keymap to immediately fuzzy search bookmarks
|
||||
[[mgr.prepend_keymap]]
|
||||
desc = "Start bunny.yazi fuzzy search"
|
||||
on = "'"
|
||||
run = "plugin bunny fuzzy"
|
||||
```
|
||||
|
||||
## Inspiration
|
||||
|
||||
[yamb.yazi](https://github.com/h-hg/yamb.yazi)
|
||||
|
||||
[nnn bookmarks](https://github.com/jarun/nnn/wiki/Basic-use-cases#add-bookmarks)
|
||||
@@ -0,0 +1,385 @@
|
||||
--- @since 25.5.28
|
||||
local function debug(...)
|
||||
local function toReadableString(val)
|
||||
if type(val) == "table" then
|
||||
local str = "{ "
|
||||
for k, v in pairs(val) do
|
||||
str = str .. "[" .. tostring(k) .. "] = " .. toReadableString(v) .. ", "
|
||||
end
|
||||
return str .. "}"
|
||||
elseif type(val) == "Url" then
|
||||
return "Url:" .. tostring(val)
|
||||
else
|
||||
return tostring(val)
|
||||
end
|
||||
end
|
||||
local args = { ... }
|
||||
local processed_args = {}
|
||||
for _, arg in pairs(args) do
|
||||
table.insert(processed_args, toReadableString(arg))
|
||||
end
|
||||
ya.dbg("BUNNY.YAZI", table.unpack(processed_args))
|
||||
end
|
||||
local function fail(s, ...) ya.notify { title = "bunny.yazi", content = string.format(s, ...), timeout = 4, level = "error" } end
|
||||
local function info(s, ...) ya.notify { title = "bunny.yazi", content = string.format(s, ...), timeout = 2, level = "info" } end
|
||||
|
||||
local get_state = ya.sync(function(state, attr)
|
||||
return state[attr]
|
||||
end)
|
||||
|
||||
local set_state = ya.sync(function(state, attr, value)
|
||||
state[attr] = value
|
||||
end)
|
||||
|
||||
local get_cwd = ya.sync(function(state)
|
||||
return tostring(cx.active.current.cwd) -- Url objects are evil >.<"
|
||||
end)
|
||||
|
||||
local get_current_tab_idx = ya.sync(function(state)
|
||||
return cx.tabs.idx
|
||||
end)
|
||||
|
||||
local get_tabs_as_paths = ya.sync(function(state)
|
||||
local tabs = cx.tabs
|
||||
local active_tab_idx = tabs.idx
|
||||
local result = {}
|
||||
for idx = 1, #tabs, 1 do
|
||||
if idx ~= active_tab_idx and tabs[idx] then
|
||||
result[idx] = tostring(tabs[idx].current.cwd)
|
||||
end
|
||||
end
|
||||
return result
|
||||
end)
|
||||
|
||||
local some = function(...)
|
||||
for _, v in ipairs({ ... }) do
|
||||
if v ~= nil then
|
||||
return v
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
local function filename(pathstr)
|
||||
if pathstr == "/" then return pathstr end
|
||||
local url_name = Url(pathstr):name()
|
||||
if url_name then
|
||||
return tostring(url_name)
|
||||
else
|
||||
return pathstr
|
||||
end
|
||||
end
|
||||
|
||||
local function path_to_desc(path, strategy)
|
||||
if strategy == "filename" then
|
||||
return filename(path)
|
||||
end
|
||||
local home = os.getenv("HOME")
|
||||
if home and home ~= "" then
|
||||
local startPos, endPos = string.find(path, home)
|
||||
-- Only substitute if the match is from the start of path, very important
|
||||
if startPos == 1 then
|
||||
return "~" .. path:sub(endPos + 1)
|
||||
end
|
||||
end
|
||||
return tostring(path)
|
||||
end
|
||||
|
||||
local function sort_hops(hops)
|
||||
local function convert_key(key)
|
||||
local t = type(key)
|
||||
if t == "table" then
|
||||
-- If table, sort by first key string
|
||||
return key[1]
|
||||
elseif t == "string" and string.lower(key) ~= key then
|
||||
-- If uppercase letter (signifying an ephemeral hop), prepend "z"
|
||||
-- so it gets sorted after lowercase persistent hops
|
||||
return "z" .. key
|
||||
end
|
||||
return key
|
||||
end
|
||||
table.sort(hops, function(x, y)
|
||||
return convert_key(x.key) < convert_key(y.key)
|
||||
end)
|
||||
return hops
|
||||
end
|
||||
|
||||
local create_special_hops = function(config)
|
||||
local hops = {}
|
||||
local desc_strategy, tabs, ephemeral = config.desc_strategy, config.tabs, config.ephemeral
|
||||
if ephemeral then
|
||||
table.insert(hops, { key = "<Enter>", desc = "Create hop", path = "__MARK__" })
|
||||
end
|
||||
table.insert(hops, { key = "<Space>", desc = "Fuzzy search", path = "__FUZZY__" })
|
||||
local tabhist = get_state("tabhist")
|
||||
local tab = get_current_tab_idx()
|
||||
if tabhist[tab] and tabhist[tab][2] then
|
||||
local previous_dir = tabhist[tab][2]
|
||||
table.insert(hops, {
|
||||
key = "<Backspace>",
|
||||
path = previous_dir,
|
||||
desc = path_to_desc(previous_dir, desc_strategy)
|
||||
})
|
||||
end
|
||||
if tabs then
|
||||
for idx, tab_path in pairs(get_tabs_as_paths()) do
|
||||
table.insert(hops, {
|
||||
key = tostring(idx),
|
||||
path = tab_path,
|
||||
desc = path_to_desc(tab_path, desc_strategy)
|
||||
})
|
||||
end
|
||||
end
|
||||
return hops
|
||||
end
|
||||
|
||||
local function validate_options(options)
|
||||
local function validate_key(key)
|
||||
local kt = type(key)
|
||||
if not key then
|
||||
return false, "key is missing"
|
||||
elseif kt == "string" then
|
||||
if utf8.len(key) ~= 1 then
|
||||
return false, "key must be single character"
|
||||
end
|
||||
elseif kt == "table" then
|
||||
if #key == 0 then
|
||||
return false, "key cannot be empty table"
|
||||
end
|
||||
for _, char in pairs(key) do
|
||||
if utf8.len(char) ~= 1 then
|
||||
return false, "key list must contain single characters"
|
||||
end
|
||||
end
|
||||
else
|
||||
return false, "key must be string or table"
|
||||
end
|
||||
return true, ""
|
||||
end
|
||||
if type(options) ~= "table" then
|
||||
return "Invalid config"
|
||||
end
|
||||
local hops, desc_strategy, tabs, ephemeral, fuzzy_cmd, notify =
|
||||
options.hops, options.desc_strategy, options.tabs,
|
||||
options.ephemeral, options.fuzzy_cmd, options.notify
|
||||
-- Validate hops
|
||||
if type(hops) == "table" then
|
||||
local used_keys = {}
|
||||
for idx, hop in pairs(hops) do
|
||||
hop.desc = hop.desc or hop.tag or nil -- used to be tag, allow for backwards compat
|
||||
local key_is_validated, key_err = validate_key(hop.key)
|
||||
local err = 'Invalid "hops" config value: #' .. idx .. " "
|
||||
if not key_is_validated then
|
||||
return err .. key_err
|
||||
elseif not hop.path then
|
||||
return err .. 'path is missing'
|
||||
elseif type(hop.path) ~= "string" or string.len(hop.path) == 0 then
|
||||
return err .. 'path must be non-empty string'
|
||||
elseif hop.desc and (type(hop.desc) ~= "string" or string.len(hop.path) == 0) then
|
||||
return err .. 'desc must be non-empty string'
|
||||
end
|
||||
-- Check for duplicate keys
|
||||
if used_keys[hop.key] then
|
||||
return err .. 'needs unique key'
|
||||
end
|
||||
-- Insert hop keys as table keys to easily check for set membership
|
||||
used_keys[hop.key] = true
|
||||
end
|
||||
else
|
||||
return 'Invalid "hops" config value'
|
||||
end
|
||||
-- Validate other options
|
||||
if desc_strategy ~= nil and desc_strategy ~= "path" and desc_strategy ~= "filename" then
|
||||
return 'Invalid "desc_strategy" config value'
|
||||
elseif tabs ~= nil and type(notify) ~= "boolean" then
|
||||
return 'Invalid "tabs" config value'
|
||||
elseif ephemeral ~= nil and type(notify) ~= "boolean" then
|
||||
return 'Invalid "ephemeral" config value'
|
||||
elseif fuzzy_cmd ~= nil and type(fuzzy_cmd) ~= "string" then
|
||||
return 'Invalid "fuzzy_cmd" config value'
|
||||
elseif notify ~= nil and type(notify) ~= "boolean" then
|
||||
return 'Invalid "notify" config value'
|
||||
end
|
||||
end
|
||||
|
||||
-- https://github.com/sxyazi/yazi/blob/main/yazi-plugin/preset/plugins/fzf.lua
|
||||
-- https://github.com/sxyazi/yazi/blob/main/yazi-plugin/src/process/child.rs
|
||||
-- Returns nil if fzf command failed or user exited with escape key
|
||||
local select_fuzzy = function(hops, config)
|
||||
local permit = ui.hide()
|
||||
local child, spawn_err =
|
||||
Command(config.fuzzy_cmd):stdin(Command.PIPED):stdout(Command.PIPED):stderr(Command.INHERIT):spawn()
|
||||
if not child then
|
||||
fail("Command `%s` failed with code %s. Do you have it installed?", config.fuzzy_cmd, spawn_err.code)
|
||||
return
|
||||
end
|
||||
local fuzzy_entries = {}
|
||||
for _, hop in pairs(hops) do
|
||||
local existing_desc = fuzzy_entries[hop.path]
|
||||
if not existing_desc or existing_desc == "" then
|
||||
local fuzzy_desc = hop.desc
|
||||
-- Avoid repeating path in description
|
||||
if fuzzy_desc == hop.path then
|
||||
fuzzy_desc = ""
|
||||
end
|
||||
fuzzy_entries[hop.path] = fuzzy_desc
|
||||
end
|
||||
end
|
||||
-- Build fzf input string
|
||||
local input_lines = {}
|
||||
for entry_path, entry_desc in pairs(fuzzy_entries) do
|
||||
local line = entry_desc .. string.rep(" ", 23 - #entry_desc) .. "\t" .. entry_path
|
||||
table.insert(input_lines, line)
|
||||
end
|
||||
child:write_all(table.concat(input_lines, "\n"))
|
||||
child:flush()
|
||||
local output, output_err = child:wait_with_output()
|
||||
permit:drop()
|
||||
if not output.status.success then
|
||||
if output.status.code ~= 130 then -- user pressed escape to quit
|
||||
fail("Command `%s` failed with code %s", config.fuzzy_cmd, output_err.code)
|
||||
end
|
||||
return
|
||||
end
|
||||
-- Parse fzf output, remove right padded spaces from desc
|
||||
local desc, path = string.match(output.stdout, "^(.-) *\t(.-)\n$")
|
||||
if not desc or not path or path == "" then
|
||||
fail("Failed to parse fuzzy searcher result")
|
||||
return
|
||||
end
|
||||
if desc == "" then
|
||||
desc = path_to_desc(path, config.desc_strategy)
|
||||
end
|
||||
return { desc = desc, path = path }
|
||||
end
|
||||
|
||||
local cd = function(selected_hop, config)
|
||||
local _, dir_list_err = fs.read_dir(Url(selected_hop.path), { limit = 1, resolve = true })
|
||||
if dir_list_err then
|
||||
fail("Invalid directory " .. path_to_desc(selected_hop.path))
|
||||
return
|
||||
end
|
||||
-- Assuming that if I can fs.read_dir, then this will also succeed
|
||||
ya.emit("cd", { selected_hop.path })
|
||||
if config.notify then
|
||||
info('Hopped to ' .. selected_hop.desc)
|
||||
end
|
||||
end
|
||||
|
||||
local attempt_hop = function(hops, config)
|
||||
local cands = {}
|
||||
for _, hop in pairs(create_special_hops(config)) do
|
||||
table.insert(cands, { desc = hop.desc, on = hop.key, path = hop.path })
|
||||
end
|
||||
for _, hop in pairs(hops) do
|
||||
table.insert(cands, { desc = hop.desc, on = hop.key, path = hop.path })
|
||||
end
|
||||
local hops_idx = ya.which { cands = cands }
|
||||
if not hops_idx then return end
|
||||
local selected_hop = cands[hops_idx]
|
||||
-- Handle special hops
|
||||
if selected_hop.path == "__MARK__" then
|
||||
local mark_cands = {};
|
||||
-- Ideally any unicode character would be supported, but yazi.which
|
||||
-- requies a concrete list of candidates
|
||||
local candidate_chars = {
|
||||
'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p',
|
||||
'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', 'A', 'B', 'C', 'D', 'E', 'F',
|
||||
'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V',
|
||||
'W', 'X', 'Y', 'Z', '`', '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')',
|
||||
'-', '_', '=', '+', '[', '{', ']', '}', '\\', '|', ';', ':', "'", '"', ',', '<',
|
||||
'.', '>', '/', '?', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9'
|
||||
}
|
||||
for _, char in pairs(candidate_chars) do
|
||||
table.insert(mark_cands, { on = char })
|
||||
end
|
||||
info("Press a key to create new hop")
|
||||
local char_idx = ya.which { cands = mark_cands, silent = true }
|
||||
if char_idx ~= nil then
|
||||
local selected_char = mark_cands[char_idx].on
|
||||
local cwd = get_cwd()
|
||||
table.insert(hops, { key = selected_char, path = cwd, desc = path_to_desc(cwd, config.desc_strategy) })
|
||||
set_state("hops", sort_hops(hops))
|
||||
end
|
||||
return
|
||||
elseif selected_hop.path == "__FUZZY__" then
|
||||
local fuzzy_hop = select_fuzzy(hops, config)
|
||||
if not fuzzy_hop then return end
|
||||
selected_hop = fuzzy_hop
|
||||
end
|
||||
cd(selected_hop, config)
|
||||
end
|
||||
|
||||
local function init()
|
||||
local options = get_state("options")
|
||||
local err = validate_options(options)
|
||||
if err then
|
||||
set_state("init_error", err)
|
||||
fail(err)
|
||||
return
|
||||
end
|
||||
-- Set default config values
|
||||
local desc_strategy = options.desc_strategy or "path"
|
||||
set_state("config", {
|
||||
desc_strategy = desc_strategy,
|
||||
fuzzy_cmd = some(options.fuzzy_cmd, "fzf"),
|
||||
notify = some(options.notify, false),
|
||||
ephemeral = some(options.ephemeral, true),
|
||||
tabs = some(options.tabs, true),
|
||||
})
|
||||
-- Set hops after ensuring they all have a description
|
||||
local hops = {}
|
||||
for _, hop in pairs(options.hops) do
|
||||
hop.desc = hop.desc or path_to_desc(hop.path, desc_strategy)
|
||||
-- Manually replace ~ from users so we can make a valid Url later to check if dir exists
|
||||
if string.sub(hop.path, 1, 1) == "~" then
|
||||
hop.path = os.getenv("HOME") .. hop.path:sub(2)
|
||||
end
|
||||
table.insert(hops, hop)
|
||||
end
|
||||
set_state("hops", sort_hops(hops))
|
||||
set_state("init", true)
|
||||
end
|
||||
|
||||
return {
|
||||
setup = function(state, options)
|
||||
state.options = options
|
||||
ps.sub("cd", function(body)
|
||||
-- Note: This callback is sync and triggered at startup!
|
||||
local tab = body.tab -- type number
|
||||
-- Very important to turn this into a string because Url has ownership issues
|
||||
-- when passed to standard utility functions >.<'
|
||||
-- https://github.com/sxyazi/yazi/issues/2159
|
||||
local cwd = tostring(cx.active.current.cwd)
|
||||
-- Upon startup this will be nil so initialize if necessary
|
||||
local tabhist = state.tabhist or {}
|
||||
-- tabhist structure:{ <tab_index> = { <current_dir>, <previous_dir?> }, ... }
|
||||
if not tabhist[tab] then
|
||||
-- If fresh tab, initialize tab history table
|
||||
tabhist[tab] = { cwd }
|
||||
else
|
||||
-- Otherwise, shift history table to the right and add cwd to the front
|
||||
tabhist[tab] = { cwd, tabhist[tab][1] }
|
||||
end
|
||||
state.tabhist = tabhist
|
||||
end)
|
||||
end,
|
||||
entry = function(self, job)
|
||||
if not get_state("init") then
|
||||
init()
|
||||
end
|
||||
local init_error = get_state("init_error")
|
||||
if init_error then
|
||||
fail(init_error)
|
||||
return
|
||||
end
|
||||
local hops, config = get_state("hops"), get_state("config")
|
||||
if job.args[1] == "fuzzy" then
|
||||
local fuzzy_hop = select_fuzzy(hops, config)
|
||||
if fuzzy_hop then
|
||||
cd(fuzzy_hop, config)
|
||||
end
|
||||
else
|
||||
attempt_hop(hops, config)
|
||||
end
|
||||
end,
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2024 Rolv Apneseth
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,50 @@
|
||||
# bypass.yazi
|
||||
|
||||
[Yazi](https://github.com/sxyazi/yazi) plugin for bidirectional skipping of directories which only have a single subdirectory
|
||||
|
||||
<https://github.com/Rolv-Apneseth/bypass.yazi/assets/69486699/5487537b-fe01-40e9-bc34-4d1116b491b5>
|
||||
|
||||
## Requirements
|
||||
|
||||
- [Yazi](https://github.com/sxyazi/yazi) v25.3.2+
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
ya pkg add Rolv-Apneseth/bypass
|
||||
```
|
||||
|
||||
### Manual
|
||||
|
||||
```sh
|
||||
# Linux / MacOS
|
||||
git clone https://github.com/Rolv-Apneseth/bypass.yazi.git ~/.config/yazi/plugins/bypass.yazi
|
||||
# Windows
|
||||
git clone https://github.com/Rolv-Apneseth/bypass.yazi.git %AppData%\yazi\config\plugins\bypass.yazi
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Add this to your `keymap.toml`:
|
||||
|
||||
```toml
|
||||
[[mgr.prepend_keymap]]
|
||||
on = [ "L" ]
|
||||
run = "plugin bypass"
|
||||
desc = "Recursively enter child directory, skipping children with only a single subdirectory"
|
||||
[[mgr.prepend_keymap]]
|
||||
on = [ "H" ]
|
||||
run = "plugin bypass reverse"
|
||||
desc = "Recursively enter parent directory, skipping parents with only a single subdirectory"
|
||||
```
|
||||
|
||||
And that's it. You can bind any key you like, including overriding the default `enter` and `leave` bindings by setting them to `l` and `h` respectively.
|
||||
|
||||
Note that if you're using the [smart enter tip](https://yazi-rs.github.io/docs/tips#smart-enter) from the documentation, this plugin can replace that entirely by using this keybind instead:
|
||||
|
||||
```toml
|
||||
[[mgr.prepend_keymap]]
|
||||
on = [ "l" ]
|
||||
run = "plugin bypass smart-enter"
|
||||
desc = "Open a file, or recursively enter child directory, skipping children with only a single subdirectory"
|
||||
```
|
||||
@@ -0,0 +1,106 @@
|
||||
---@since 25.3.2
|
||||
|
||||
-- For development
|
||||
--[[ local function notify(message) ]]
|
||||
--[[ ya.notify({ title = "Bypass", content = message, timeout = 5 }) ]]
|
||||
--[[ end ]]
|
||||
|
||||
-- `ya.emit` as of 25.5.28
|
||||
local emit = ya.emit or ya.manager_emit
|
||||
|
||||
---Returns the loading state of the current directory
|
||||
---@type fun(): boolean
|
||||
local is_directory_loading = ya.sync(function(_)
|
||||
-- Try to use the v25.4.8 interface
|
||||
local ok, res = pcall(cx.active.current.stage)
|
||||
if ok then
|
||||
return not res
|
||||
-- Fallback to the v25.3.2 interface
|
||||
else
|
||||
return cx.active.current.stage.is_loading
|
||||
end
|
||||
end)
|
||||
|
||||
---Enter hovered item if it is a directory
|
||||
---@type fun(use_smart_enter: boolean): boolean
|
||||
local initial = ya.sync(function(_, use_smart_enter)
|
||||
local hovered = cx.active.current.hovered
|
||||
if hovered == nil then
|
||||
return false
|
||||
end
|
||||
|
||||
if not hovered.cha.is_dir then
|
||||
-- Open file if using "smart enter"
|
||||
if use_smart_enter then
|
||||
emit("escape", { visual = true, select = true })
|
||||
emit("open", { hovered = true })
|
||||
end
|
||||
return false
|
||||
end
|
||||
|
||||
emit("escape", { visual = true, select = true })
|
||||
emit("enter", { hovered = true })
|
||||
|
||||
return true
|
||||
end)
|
||||
|
||||
---Enter hovered item if it is a directory and is the only item in the parent
|
||||
---@type fun(): boolean
|
||||
local bypass = ya.sync(function(_)
|
||||
local hovered = cx.active.current.hovered
|
||||
|
||||
if hovered == nil or not hovered.cha.is_dir or #cx.active.current.files > 1 then
|
||||
return false
|
||||
end
|
||||
|
||||
emit("enter", { hovered = true })
|
||||
|
||||
return true
|
||||
end)
|
||||
|
||||
---Leave the CWD, if the CWD has a parent
|
||||
---@type fun(): boolean
|
||||
local initial_rev = ya.sync(function(_)
|
||||
if cx.active.parent == nil then
|
||||
return false
|
||||
end
|
||||
|
||||
emit("escape", { visual = true, select = true })
|
||||
emit("leave", {})
|
||||
|
||||
return true
|
||||
end)
|
||||
|
||||
---Leave the CWD, if the CWD has a parent and contains only one item
|
||||
---@type fun(): boolean
|
||||
local bypass_rev = ya.sync(function(_)
|
||||
if cx.active.parent == nil or #cx.active.current.files > 1 then
|
||||
return false
|
||||
end
|
||||
|
||||
emit("leave", {})
|
||||
|
||||
return true
|
||||
end)
|
||||
|
||||
return {
|
||||
entry = function(_, job)
|
||||
-- old version of Yazi will pass args directly, new version passes job. Below code ensures we derive args in both 0.3 and 0.4 Yazi API versions.
|
||||
local args = job.args or job
|
||||
local use_smart_enter = args and args[1] == "smart-enter"
|
||||
local is_reverse = args and args[1] == "reverse"
|
||||
|
||||
-- Initial run, should behave like a regular enter/smart-enter/leave
|
||||
local run = is_reverse and initial_rev() or initial(use_smart_enter)
|
||||
|
||||
while run do
|
||||
-- Wait for directory to have loaded
|
||||
while is_directory_loading() do
|
||||
ya.sleep(0.002)
|
||||
end
|
||||
|
||||
-- Conditional enter/smart-enter/leave
|
||||
run = is_reverse and bypass_rev() or bypass()
|
||||
end
|
||||
end,
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2025 Mshnwq
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,221 @@
|
||||
# Dupes Plugin for Yazi
|
||||
|
||||
Duplicate files plugin for [Yazi](https://github.com/sxyazi/yazi) file manager, leveraging [jdupes](https://codeberg.org/jbruchon/jdupes) for fast and efficient duplicate detection.
|
||||
|
||||
> [!NOTE]
|
||||
> The latest release of Yazi is required at the moment.
|
||||
|
||||
https://github.com/user-attachments/assets/1d87bb52-d326-4720-834c-baac74008d7d
|
||||
|
||||
## Features
|
||||
|
||||
- 🔍 **Fast Duplicate Detection** - Uses jdupes for high-performance scanning
|
||||
- 👁️ **Visual Preview** - See duplicates directly in Yazi with deletion markers
|
||||
- 🧪 **Dry Run Mode** - Preview what will be deleted before applying changes
|
||||
- ⚙️ **Profile System** - Define custom scanning or override profiles for different use cases
|
||||
- 💾 **Export Results** - Save scan results to JSON or text files
|
||||
- 🔒 **Safe by Default** - Confirmation required for destructive operations
|
||||
|
||||
## Requirements
|
||||
|
||||
- [Yazi](https://github.com/sxyazi/yazi) file manager (v25.5.31+)
|
||||
- [jdupes](https://codeberg.org/jbruchon/jdupes) command-line tool
|
||||
|
||||
## Installation
|
||||
|
||||
**Using yazi package manager:**
|
||||
```sh
|
||||
ya pkg add mshnwq/dupes
|
||||
```
|
||||
|
||||
**Using nix home-manager (nixpkgs): (recommended)**
|
||||
```nix
|
||||
{ pkgs, ... }: {
|
||||
programs.yazi = {
|
||||
enable = true;
|
||||
plugins = {
|
||||
# jdupes is self contained within
|
||||
dupes = pkgs.yaziPlugins.dupes
|
||||
};
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
**Using nix home-manager (github):**
|
||||
```nix
|
||||
{ pkgs, ... }: {
|
||||
home.packages = with pkgs; [ jdupes ];
|
||||
programs.yazi = {
|
||||
enable = true;
|
||||
plugins = {
|
||||
dupes = pkgs.fetchFromGitHub {
|
||||
owner = "mshnwq";
|
||||
repo = "dupes.yazi";
|
||||
rev = "4666b6f299c2257c011f622319ae97fab8adbabe";
|
||||
hash = "sha256-v9xuSY/i/trIHHbOPbijd0AmcUb2vufNL9BSjBE6+Vo=";
|
||||
};
|
||||
};
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
**Manual installation:**
|
||||
```sh
|
||||
git clone https://github.com/mshnwq/dupes.yazi.git ~/.config/yazi/plugins/dupes.yazi
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Configuration in `~/.config/yazi/init.lua`:
|
||||
```lua
|
||||
require("dupes"):setup {
|
||||
-- Global settings
|
||||
save_op = false, -- Save results to file by default
|
||||
-- auto_confirm = true, -- Skip confirmation for apply (use with caution!)
|
||||
|
||||
profiles = {
|
||||
-- Interactive mode: recursively scan and display duplicates
|
||||
interactive = {
|
||||
args = { "-r" },
|
||||
},
|
||||
-- Apply mode: recursively scan and DELETE duplicates
|
||||
apply = {
|
||||
args = { "-r", "-N", "-d" },
|
||||
save_op = true, -- Save results before deletion
|
||||
},
|
||||
-- Custom profile example (uncomment to use)
|
||||
-- custom = {
|
||||
-- args = { "-r", "-s", }, -- Your custom jdupes flags
|
||||
-- },
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
Keybindings in `~/.config/yazi/keymap.toml`:
|
||||
```toml
|
||||
[[manager.prepend_keymap]]
|
||||
on = ["<A-J>", "i"]
|
||||
run = "plugin dupes interactive"
|
||||
desc = "Run dupes interactive"
|
||||
|
||||
[[manager.prepend_keymap]]
|
||||
on = ["<A-J>", "o"]
|
||||
run = "plugin dupes override"
|
||||
desc = "Run dupes override"
|
||||
|
||||
[[manager.prepend_keymap]]
|
||||
on = ["<A-J>", "d"]
|
||||
run = "plugin dupes dry"
|
||||
desc = "Run dupes dry"
|
||||
|
||||
[[manager.prepend_keymap]]
|
||||
on = ["<A-J>", "a"]
|
||||
run = "plugin dupes apply"
|
||||
desc = "Run dupes apply"
|
||||
|
||||
# [[mgr.prepend_keymap]]
|
||||
# on = ["<A-J>", "c"]
|
||||
# run = "plugin dupes custom"
|
||||
# desc = "Run dupes custom"
|
||||
```
|
||||
|
||||
### Profiles
|
||||
|
||||
#### 🔍 Interactive Mode
|
||||
Scans for duplicates and displays them in Yazi. Safe to use - no files are deleted.
|
||||
|
||||
```lua
|
||||
interactive = {
|
||||
args = { "-r" }, -- Recursive scan
|
||||
}
|
||||
```
|
||||
#### 🧪 Dry Run Mode (inherits apply mode)
|
||||
Shows what **would** be deleted using the same settings as apply mode. Files marked 'X' will be deleted. The first file in each duplicate set is kept.
|
||||
|
||||
- Normal files: displayed normally (will be kept)
|
||||
- Files marked 'X': will be deleted
|
||||
|
||||
#### ⚠️ Apply Mode
|
||||
**DESTRUCTIVE OPERATION** - Permanently deletes duplicate files.
|
||||
|
||||
```lua
|
||||
apply = {
|
||||
args = { "-r", "-N", "-d" },
|
||||
save_op = true, -- Saves results to dupes.json
|
||||
}
|
||||
```
|
||||
|
||||
#### 🛠️ Override Mode
|
||||
Opens an input dialog where you can enter custom jdupes arguments for one-time scans.
|
||||
|
||||
**Example inputs:**
|
||||
- `-r -s` - Recursive, follow symlinks
|
||||
|
||||
## Configuration Options
|
||||
|
||||
### Global Settings
|
||||
|
||||
```lua
|
||||
require("dupes"):setup {
|
||||
save_op = false, -- Default: don't save results to file
|
||||
auto_confirm = false, -- Default: prompt before deletion
|
||||
profiles = {
|
||||
-- Your profiles here
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
### Profile Settings
|
||||
|
||||
Each profile can have:
|
||||
|
||||
```lua
|
||||
profile_name = {
|
||||
args = { "-r", "-N" }, -- jdupes command arguments
|
||||
save_op = true, -- Override global save_op for this profile
|
||||
}
|
||||
```
|
||||
|
||||
### Common jdupes Flags
|
||||
|
||||
| Flag | Description |
|
||||
|------|-------------|
|
||||
| `-r` | Recursive search in subdirectories |
|
||||
| `-d` | **DELETE duplicates (DESTRUCTIVE!)** |
|
||||
| `-j` | JSON output (added by plugin) |
|
||||
| `-s` | Follows symbolic links |
|
||||
|
||||
See `jdupes --help` for complete flag list.
|
||||
|
||||
## Custom Examples
|
||||
|
||||
### Example: Find duplicates in current directory only
|
||||
```lua
|
||||
shallow = {
|
||||
args = {}, -- No -r flag, current directory only
|
||||
}
|
||||
```
|
||||
|
||||
## Output Files
|
||||
|
||||
When `save_op = true`, results are saved to:
|
||||
|
||||
- **dupes.json** - JSON format
|
||||
- **dupes.txt** - Text format (when destructive)
|
||||
|
||||
Files are saved in the current working directory.
|
||||
|
||||
## License
|
||||
|
||||
This plugin is MIT-licensed. For more information check the [LICENSE](LICENSE) file.
|
||||
|
||||
## Credits
|
||||
|
||||
- [Yazi](https://github.com/sxyazi/yazi) file manager
|
||||
- [jdupes](https://codeberg.org/jbruchon/jdupes) for duplicate detection
|
||||
- [boydaihungst](https://github.com/boydaihungst) for help on Yazi's [Discord](https://discord.gg/qfADduSdJu) channel
|
||||
|
||||
## See Also
|
||||
|
||||
- [jdupes Documentation](https://codeberg.org/jbruchon/jdupes)
|
||||
- [Yazi Plugins](https://yazi-rs.github.io/docs/plugins/overview)
|
||||
@@ -0,0 +1,600 @@
|
||||
--- Dupes Plugin: Dynamic jdupes runner for Yazi file manager
|
||||
--- @since 25.5.31
|
||||
--- @description Finds and manages duplicate files using jdupes
|
||||
|
||||
local M = {}
|
||||
|
||||
-- ============================================================================
|
||||
-- STATE MANAGEMENT
|
||||
-- ============================================================================
|
||||
|
||||
--- Thread-safe state setter
|
||||
--- @param state table The global state object
|
||||
--- @param key string State key to set
|
||||
--- @param value any Value to store
|
||||
local set_state = ya.sync(function(state, key, value) state[key] = value end)
|
||||
|
||||
--- Thread-safe state getter
|
||||
--- @param state table The global state object
|
||||
--- @param key string State key to retrieve
|
||||
--- @return any The stored value
|
||||
local get_state = ya.sync(function(state, key) return state[key] end)
|
||||
|
||||
--- Get current working directory from Yazi context
|
||||
--- @return string Current working directory path
|
||||
local get_cwd = ya.sync(function() return cx.active.current.cwd end)
|
||||
|
||||
-- ============================================================================
|
||||
-- DISPLAY FUNCTIONS
|
||||
-- ============================================================================
|
||||
|
||||
--- Display duplicate files in Yazi's file list
|
||||
--- @param _cwd string Current working directory
|
||||
--- @param data table Parsed JSON data from jdupes output
|
||||
--- @param style boolean If true, shows dry-run preview with deletion markers
|
||||
local function display_dupes(_cwd, data, style)
|
||||
-- Validate input data structure
|
||||
if not data or not data.matchSets then
|
||||
ya.dbg("Invalid or missing matchSets in JSON data")
|
||||
ya.notify {
|
||||
title = "Dupes Plugin",
|
||||
content = "Invalid JSON data: no matchSets",
|
||||
level = "error",
|
||||
timeout = 5,
|
||||
}
|
||||
return
|
||||
end
|
||||
|
||||
ya.dbg(string.format("Entering display_dupes, cwd: %s", _cwd))
|
||||
|
||||
-- Create unique ID for this file operation
|
||||
local id = ya.id("ft")
|
||||
|
||||
-- Set search context title based on mode
|
||||
local cwd
|
||||
if style then
|
||||
cwd = _cwd:into_search("Duplicate files Dry Run Preview 'X means will be deleted'")
|
||||
else
|
||||
cwd = _cwd:into_search("Duplicate files")
|
||||
end
|
||||
|
||||
-- Navigate to the search view
|
||||
ya.emit("cd", { Url(cwd) })
|
||||
|
||||
-- Initialize empty file list
|
||||
ya.emit("update_files", {
|
||||
op = fs.op("part", { id = id, url = Url(cwd), files = {} }),
|
||||
})
|
||||
|
||||
-- Build file list from duplicate sets
|
||||
local files = {}
|
||||
for i, matchSet in ipairs(data.matchSets) do
|
||||
local dupe_set = string.format("dup-set-%02d", i)
|
||||
ya.dbg(string.format("Processing group: %s", dupe_set))
|
||||
|
||||
-- Process each file in the duplicate set
|
||||
for j, fileObj in ipairs(matchSet.fileList) do
|
||||
local url = Url(cwd):join(fileObj.filePath)
|
||||
local cha = fs.cha(url, true)
|
||||
|
||||
local file
|
||||
if style then
|
||||
-- In dry-run mode, mark files for deletion (except first one)
|
||||
if j == 1 then
|
||||
-- First file in set: keep it (normal display)
|
||||
file = File { url = url, cha = cha }
|
||||
else
|
||||
-- Subsequent files: mark as dummy (will be deleted)
|
||||
local dcha = Cha {
|
||||
kind = 16,
|
||||
is_dummy = true,
|
||||
len = cha.len,
|
||||
gid = cha.gid,
|
||||
uid = cha.uid,
|
||||
atime = cha.atime,
|
||||
btime = cha.btime,
|
||||
mtime = cha.mtime,
|
||||
perm = cha.perm,
|
||||
}
|
||||
file = File { url = url, cha = dcha }
|
||||
end
|
||||
else
|
||||
-- Normal mode: display all files equally
|
||||
file = File { url = url, cha = cha }
|
||||
end
|
||||
|
||||
table.insert(files, file)
|
||||
ya.dbg(string.format("[Dupes] Added file %s", file.url))
|
||||
end
|
||||
end
|
||||
|
||||
-- Update the file list in Yazi
|
||||
ya.emit("update_files", {
|
||||
op = fs.op("part", { id = id, url = Url(cwd), files = files }),
|
||||
})
|
||||
|
||||
-- NOTE: Finalization with 'done' operation breaks file ordering
|
||||
-- Keeping these commented for future investigation
|
||||
-- ya.emit("update_files", {
|
||||
-- op = fs.op("done", {
|
||||
-- id = id,
|
||||
-- url = Url(cwd),
|
||||
-- cha = Cha({ kind = 16, mode = tonumber("100644", 8) })
|
||||
-- })
|
||||
-- })
|
||||
|
||||
-- Show notification with results
|
||||
local mode_text = style and " (DRY RUN)" or ""
|
||||
ya.notify {
|
||||
title = "Dupes Plugin",
|
||||
content = string.format("Found %d files%s", #files, mode_text),
|
||||
level = "info",
|
||||
timeout = 3,
|
||||
}
|
||||
end
|
||||
|
||||
-- ============================================================================
|
||||
-- FILE SAVING FUNCTIONS
|
||||
-- ============================================================================
|
||||
|
||||
--- Save jdupes output to file (JSON or plain text)
|
||||
--- @param cwd string Directory to save the file in
|
||||
--- @param stdout string Raw output from jdupes
|
||||
--- @param format string Output format: "json" or "txt"
|
||||
--- @return boolean success True if file was saved successfully
|
||||
local function save_output(cwd, stdout, format)
|
||||
-- Validate format
|
||||
format = format or "json"
|
||||
if format ~= "json" and format ~= "txt" then
|
||||
ya.err(string.format("Invalid format '%s', defaulting to 'json'", format))
|
||||
format = "json"
|
||||
end
|
||||
|
||||
-- Construct file path
|
||||
local file_path = string.format("%s/dupes.%s", cwd, format)
|
||||
|
||||
-- Attempt to write file
|
||||
local file, err = io.open(file_path, "w")
|
||||
if not file then
|
||||
ya.err(string.format("Failed to write dupes.%s to %s: %s", format, file_path, err or "unknown error"))
|
||||
ya.notify {
|
||||
title = "Dupes Plugin",
|
||||
content = string.format("Failed to save file: %s", err or "unknown error"),
|
||||
level = "error",
|
||||
timeout = 5,
|
||||
}
|
||||
return false
|
||||
end
|
||||
|
||||
-- Write content and close
|
||||
file:write(stdout)
|
||||
file:close()
|
||||
|
||||
-- Success notification
|
||||
ya.notify {
|
||||
title = "Dupes Plugin",
|
||||
content = string.format("Saved dupes.%s to %s", format, file_path),
|
||||
level = "info",
|
||||
timeout = 3,
|
||||
}
|
||||
|
||||
return true
|
||||
end
|
||||
|
||||
-- ============================================================================
|
||||
-- COMMAND BUILDING AND VALIDATION
|
||||
-- ============================================================================
|
||||
|
||||
--- Build final command arguments with proper flag handling
|
||||
--- @param args table User-provided arguments
|
||||
--- @param no_json boolean Whether to exclude JSON flag
|
||||
--- @return table Final argument list
|
||||
local function build_command_args(args, no_json)
|
||||
-- Check if JSON flag already exists
|
||||
local has_j_flag = false
|
||||
for _, arg in ipairs(args) do
|
||||
if arg:match("^%-[^-]*j") or arg == "-j" then
|
||||
has_j_flag = true
|
||||
break
|
||||
end
|
||||
end
|
||||
|
||||
-- Build final argument list
|
||||
local final_args = {}
|
||||
|
||||
-- Add JSON flag if needed and not disabled
|
||||
if not has_j_flag and not no_json then
|
||||
table.insert(final_args, "-j")
|
||||
end
|
||||
|
||||
-- Add all user arguments
|
||||
for _, arg in ipairs(args) do
|
||||
table.insert(final_args, arg)
|
||||
end
|
||||
|
||||
return final_args
|
||||
end
|
||||
|
||||
--- Execute shell command with proper error handling
|
||||
--- @param cmdline string Base command (e.g., "jdupes")
|
||||
--- @param args table Command arguments
|
||||
--- @return table Command result with status, stdout, stderr
|
||||
local function execute_command(cmdline, args)
|
||||
local argstr = table.concat(args, " ")
|
||||
local full_cmd = string.format("%s . %s 2>&1", cmdline, argstr)
|
||||
|
||||
ya.dbg(string.format("Executing: %s", full_cmd))
|
||||
|
||||
local cmd = Command(get_state("shell")):arg({ "-c", full_cmd }):stdout(Command.PIPED):stderr(Command.PIPED):output()
|
||||
|
||||
-- Log execution results
|
||||
ya.dbg(string.format("Exit code: %s", tostring(cmd.status.code)))
|
||||
|
||||
if cmd.stdout and #cmd.stdout > 0 then
|
||||
ya.dbg(string.format("STDOUT length: %d bytes", #cmd.stdout))
|
||||
end
|
||||
|
||||
if cmd.stderr and #cmd.stderr > 0 then
|
||||
ya.err(string.format("STDERR:\n%s", cmd.stderr))
|
||||
end
|
||||
|
||||
return cmd
|
||||
end
|
||||
|
||||
-- ============================================================================
|
||||
-- CORE EXECUTION FUNCTION
|
||||
-- ============================================================================
|
||||
|
||||
--- Execute jdupes with given profile configuration
|
||||
--- @param profile_name string Name of the profile being run
|
||||
--- @param conf table Configuration with cmdline and args
|
||||
--- @param save_to_file boolean Whether to save output to file
|
||||
--- @param no_display boolean Whether to skip displaying results in Yazi
|
||||
--- @param no_json boolean Whether to output plain text instead of JSON
|
||||
local function run_dupes(profile_name, conf, save_to_file, no_display, no_json)
|
||||
-- Validate configuration
|
||||
if not conf then
|
||||
ya.err(string.format("ERROR: Profile '%s' configuration is nil!", profile_name))
|
||||
return
|
||||
end
|
||||
|
||||
if not conf.cmdline then
|
||||
ya.err(string.format("ERROR: Profile '%s' missing cmdline", profile_name))
|
||||
return
|
||||
end
|
||||
|
||||
-- Extract configuration with defaults
|
||||
local cmdline = conf.cmdline
|
||||
local args = conf.args or {}
|
||||
save_to_file = save_to_file or false
|
||||
no_display = no_display or false
|
||||
no_json = no_json or false
|
||||
|
||||
-- Build command arguments
|
||||
local final_args = build_command_args(args, no_json)
|
||||
|
||||
-- Execute command
|
||||
local cwd = get_cwd()
|
||||
local cmd = execute_command(cmdline, final_args)
|
||||
|
||||
-- Handle command results
|
||||
if cmd.status.success then
|
||||
-- Save output to file if requested
|
||||
if save_to_file then
|
||||
local format = no_json and "txt" or "json"
|
||||
save_output(cwd, cmd.stdout, format)
|
||||
end
|
||||
|
||||
-- Display results in Yazi unless suppressed
|
||||
if not no_display and not no_json then
|
||||
local parsed_data = ya.json_decode(cmd.stdout)
|
||||
if parsed_data then
|
||||
local is_dry_run = (profile_name == "dry")
|
||||
display_dupes(cwd, parsed_data, is_dry_run)
|
||||
else
|
||||
ya.err("Failed to parse JSON output from jdupes")
|
||||
ya.notify {
|
||||
title = "Dupes Plugin",
|
||||
content = "Failed to parse command output",
|
||||
level = "error",
|
||||
timeout = 5,
|
||||
}
|
||||
return
|
||||
end
|
||||
end
|
||||
|
||||
-- Success notification
|
||||
ya.notify {
|
||||
title = "Dupes Plugin",
|
||||
content = string.format("Profile '%s' completed successfully", profile_name),
|
||||
level = "info",
|
||||
timeout = 3,
|
||||
}
|
||||
else
|
||||
-- Error notification with details
|
||||
local error_msg = cmd.stderr or "(no error details available)"
|
||||
ya.notify {
|
||||
title = "Dupes Plugin",
|
||||
content = string.format("Command failed:\n%s", error_msg),
|
||||
level = "error",
|
||||
timeout = 5,
|
||||
}
|
||||
end
|
||||
end
|
||||
|
||||
-- ============================================================================
|
||||
-- PROFILE HANDLING
|
||||
-- ============================================================================
|
||||
|
||||
--- Create dry-run configuration from apply profile
|
||||
--- @param apply_conf table Apply profile configuration
|
||||
--- @return table Dry-run configuration
|
||||
local function create_dry_config(apply_conf)
|
||||
local dry_args = {}
|
||||
|
||||
-- Copy all arguments except destructive ones
|
||||
for _, arg in ipairs(apply_conf.args) do
|
||||
if arg ~= "-d" and arg ~= "--delete" then
|
||||
table.insert(dry_args, arg)
|
||||
else
|
||||
ya.dbg(string.format("Excluded destructive flag: %s", arg))
|
||||
end
|
||||
end
|
||||
|
||||
return {
|
||||
cmdline = apply_conf.cmdline,
|
||||
args = dry_args,
|
||||
}
|
||||
end
|
||||
|
||||
--- Parse custom arguments from user input
|
||||
--- @param input string Space-separated argument string
|
||||
--- @return table Parsed arguments
|
||||
local function parse_custom_args(input)
|
||||
local args = {}
|
||||
for arg in input:gmatch("%S+") do
|
||||
table.insert(args, arg)
|
||||
end
|
||||
return args
|
||||
end
|
||||
|
||||
-- ============================================================================
|
||||
-- UTILITY FUNCTIONS
|
||||
-- ============================================================================
|
||||
|
||||
--- Recursively dump table contents for debugging
|
||||
--- @param tbl table Table to dump
|
||||
--- @param indent number Current indentation level
|
||||
--- @return table Array of formatted lines
|
||||
local function dump_table(tbl, indent)
|
||||
indent = indent or 0
|
||||
local lines = {}
|
||||
local prefix = string.rep(" ", indent)
|
||||
|
||||
for k, v in pairs(tbl or {}) do
|
||||
if type(v) == "table" then
|
||||
table.insert(lines, string.format("%s%s = {", prefix, tostring(k)))
|
||||
for _, line in ipairs(dump_table(v, indent + 1)) do
|
||||
table.insert(lines, line)
|
||||
end
|
||||
table.insert(lines, string.format("%s},", prefix))
|
||||
else
|
||||
table.insert(lines, string.format("%s%s = %q,", prefix, tostring(k), tostring(v)))
|
||||
end
|
||||
end
|
||||
|
||||
return lines
|
||||
end
|
||||
|
||||
--- Count table entries
|
||||
--- @param tbl table Table to count
|
||||
--- @return number Number of entries
|
||||
local function count_table(tbl)
|
||||
local count = 0
|
||||
for _ in pairs(tbl or {}) do
|
||||
count = count + 1
|
||||
end
|
||||
return count
|
||||
end
|
||||
|
||||
-- ============================================================================
|
||||
-- PLUGIN LIFECYCLE FUNCTIONS
|
||||
-- ============================================================================
|
||||
|
||||
--- Initialize the plugin with user configuration
|
||||
--- Called from yazi/init.lua
|
||||
--- @param opts table Configuration options
|
||||
function M:setup(opts)
|
||||
opts = opts or {}
|
||||
|
||||
-- Set global options with defaults
|
||||
set_state("save_op", opts.save_op or false)
|
||||
set_state("auto_confirm", opts.auto_confirm or false)
|
||||
set_state("cmdline", "jdupes")
|
||||
set_state("shell", "bash")
|
||||
|
||||
ya.dbg("Dupes Plugin Setup: Starting profile processing")
|
||||
|
||||
-- Process and store user-defined profiles
|
||||
local profiles = {}
|
||||
if opts.profiles then
|
||||
for profile_name, profile_conf in pairs(opts.profiles) do
|
||||
-- Validate profile configuration
|
||||
if not profile_conf then
|
||||
ya.err(string.format("Profile '%s' has nil configuration, skipping", profile_name))
|
||||
else
|
||||
local profile = {
|
||||
cmdline = profile_conf.cmdline or get_state("cmdline"),
|
||||
args = profile_conf.args or {},
|
||||
-- Profile-specific save_op overrides global setting
|
||||
save_op = profile_conf.save_op ~= nil and profile_conf.save_op or get_state("save_op"),
|
||||
}
|
||||
profiles[profile_name] = profile
|
||||
|
||||
-- Log detailed profile configuration
|
||||
local profile_lines = dump_table(profile)
|
||||
ya.dbg(string.format("Setup profile '%s':\n%s", tostring(profile_name), table.concat(profile_lines, "\n")))
|
||||
end
|
||||
end
|
||||
else
|
||||
ya.dbg("Dupes Plugin Setup: No profiles provided in opts.profiles")
|
||||
end
|
||||
|
||||
set_state("profiles", profiles)
|
||||
|
||||
-- Log summary
|
||||
local profile_count = count_table(profiles)
|
||||
ya.dbg(string.format("Dupes Plugin Setup: Complete with %d profiles", profile_count))
|
||||
|
||||
-- Register custom linemode to show deletion markers
|
||||
-- Priority 1500 ensures it runs before most other linemodes
|
||||
Linemode:children_add(function(self)
|
||||
if not self._file.cha.is_dummy then
|
||||
-- Normal file: no marker
|
||||
return ""
|
||||
elseif self._file.is_hovered then
|
||||
-- Hovered dummy file: show black background 'X'
|
||||
return ui.Line { " ", ui.Span("X"):style(ui.Style():bg("black")) }
|
||||
else
|
||||
-- Non-hovered dummy file: show red 'X'
|
||||
return ui.Line({ " ", "X" }):style(ui.Style():fg("red"))
|
||||
end
|
||||
end, 1500)
|
||||
end
|
||||
|
||||
--- Main entry point when plugin is invoked
|
||||
--- @param job string|table Profile name or job configuration
|
||||
function M:entry(job)
|
||||
-- Exit visual mode if active
|
||||
ya.mgr_emit("escape", { visual = true })
|
||||
|
||||
-- Parse profile name from job argument
|
||||
local profile_name = "interactive" -- default profile
|
||||
if type(job) == "string" then
|
||||
profile_name = job
|
||||
elseif type(job) == "table" then
|
||||
profile_name = (type(job.args) == "table" and job.args[1])
|
||||
or (type(job.args) == "string" and job.args)
|
||||
or "interactive"
|
||||
end
|
||||
|
||||
ya.dbg(string.format("== Invoked profile: %s ==", profile_name))
|
||||
|
||||
-- ========================================================================
|
||||
-- SPECIAL PROFILE: override
|
||||
-- Allows user to input custom jdupes arguments interactively
|
||||
-- ========================================================================
|
||||
if profile_name == "override" then
|
||||
ya.dbg("INFO: Waiting for custom input")
|
||||
|
||||
local ov_args, ok = ya.input {
|
||||
title = "Dupes Override - Enter custom args",
|
||||
value = "-j",
|
||||
position = { "top-center", y = 3, w = 45 },
|
||||
}
|
||||
|
||||
if ok ~= 1 then
|
||||
ya.dbg("Override cancelled by user")
|
||||
return
|
||||
end
|
||||
|
||||
-- Parse and execute custom arguments
|
||||
local p_args = parse_custom_args(ov_args)
|
||||
run_dupes("override", {
|
||||
cmdline = get_state("cmdline"),
|
||||
args = p_args,
|
||||
}, get_state("save_op"))
|
||||
return
|
||||
end
|
||||
|
||||
-- ========================================================================
|
||||
-- SPECIAL PROFILE: dry
|
||||
-- Inherits 'apply' profile but removes destructive flags for preview
|
||||
-- ========================================================================
|
||||
if profile_name == "dry" then
|
||||
local profiles = get_state("profiles")
|
||||
local apply_conf = profiles["apply"]
|
||||
|
||||
if not apply_conf then
|
||||
ya.notify {
|
||||
title = "Dupes Plugin",
|
||||
content = "Cannot run dry: 'apply' profile missing.",
|
||||
level = "error",
|
||||
timeout = 4,
|
||||
}
|
||||
return
|
||||
end
|
||||
|
||||
-- Create dry-run configuration
|
||||
local dry_conf = create_dry_config(apply_conf)
|
||||
dry_conf.save_op = apply_conf.save_op
|
||||
|
||||
run_dupes("dry", dry_conf, dry_conf.save_op)
|
||||
return
|
||||
end
|
||||
|
||||
-- ========================================================================
|
||||
-- REGULAR PROFILE EXECUTION
|
||||
-- ========================================================================
|
||||
local profiles = get_state("profiles")
|
||||
local conf = profiles[profile_name]
|
||||
|
||||
if not conf then
|
||||
ya.err(string.format("ERROR: Profile '%s' not found", profile_name))
|
||||
ya.notify {
|
||||
title = "Dupes Plugin",
|
||||
content = string.format("Profile not found: %s", profile_name),
|
||||
level = "error",
|
||||
timeout = 3,
|
||||
}
|
||||
return
|
||||
end
|
||||
|
||||
-- ========================================================================
|
||||
-- SPECIAL PROFILE: apply
|
||||
-- Destructive operation - requires confirmation and runs dry preview first
|
||||
-- ========================================================================
|
||||
if profile_name == "apply" then
|
||||
-- Check for auto-confirm or prompt user
|
||||
local apply_confirm = get_state("auto_confirm")
|
||||
or ya.confirm {
|
||||
pos = { "center", y = -8, w = 36, h = 8 },
|
||||
title = "Confirm Deduplication operation?",
|
||||
content = ui.Text {
|
||||
ui.Line(""),
|
||||
ui.Line("This will DELETE duplicate files!"):style(ui.Style():fg("red")),
|
||||
ui.Line("If unsure, try dry run first"):style(th.confirm.content),
|
||||
ui.Line(""),
|
||||
},
|
||||
}
|
||||
|
||||
if not apply_confirm then
|
||||
ya.dbg("Apply cancelled by user")
|
||||
ya.notify {
|
||||
title = "Dupes Plugin",
|
||||
content = "Operation cancelled",
|
||||
level = "info",
|
||||
timeout = 3,
|
||||
}
|
||||
return
|
||||
end
|
||||
|
||||
ya.dbg("Apply confirmed by user")
|
||||
|
||||
-- First, run silent dry-run preview for logging
|
||||
local dry_conf = create_dry_config(conf)
|
||||
run_dupes("dry", dry_conf, conf.save_op, true) -- no_display = true
|
||||
|
||||
-- Then execute actual deletion
|
||||
run_dupes(profile_name, conf, conf.save_op, true, true) -- no_display, no_json
|
||||
return
|
||||
end
|
||||
|
||||
-- ========================================================================
|
||||
-- STANDARD PROFILE EXECUTION
|
||||
-- For 'interactive' and other custom profiles
|
||||
-- ========================================================================
|
||||
run_dupes(profile_name, conf, conf.save_op)
|
||||
end
|
||||
|
||||
return M
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2025 Shallow-Seek
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,183 @@
|
||||
fazif allows you to search over selected items in Yazi with your configuration of search and fuzzy filter command.
|
||||
|
||||
You can config search command ([fd](https://github.com/sharkdp/fd), [rg](https://github.com/BurntSushi/ripgrep), [rga](https://github.com/phiresky/ripgrep-all), [ag](https://github.com/ggreer/the_silver_searcher), [astgrep](https://github.com/ast-grep/ast-grep) ...), fuzzy filter command ([fzf](https://github.com/junegunn/fzf), [fzy](https://github.com/jhawthorn/fzy), [zf](https://github.com/natecraddock/zf), [skim](https://github.com/lotabout/skim)), and options in a script and spawn all your scripts easily into yazi. Here are some use cases.
|
||||
|
||||
1. Search within the current working directory when none are selected.
|
||||
|
||||
For example, a simple directory jumper. Simply create a file in `~/.config/yazi/plugins/fazif.yazi` with one of the following, make it executable, and set a keybinding.
|
||||
|
||||
```
|
||||
#!/usr/bin/env zsh
|
||||
fd -H -t d|fzf
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```
|
||||
#!/usr/bin/env zsh
|
||||
fd -H -t d|zf
|
||||
```
|
||||
|
||||
or jump to a dir. outside CWD by applying your query to a upper dir. with a shortcut key.
|
||||
|
||||
```
|
||||
#!/usr/bin/env zsh
|
||||
fd -H -t d|fzf \
|
||||
--bind 'ctrl-e:transform:echo "change-prompt(Home_Dir> )+reload(fd . ~ --hidden --type d)"' \
|
||||
```
|
||||
|
||||
2. Search within selected files and directories
|
||||
|
||||
Example 1: to jump to some dir. in the selected folders, simply create a file in `~/.config/yazi/plugins/fazif.yazi` with one of the following, make it executable, and set a keybinding.
|
||||
|
||||
|
||||
```
|
||||
#!/usr/bin/env zsh
|
||||
fd -H -t d "$@"|fzf
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```
|
||||
#!/usr/bin/env zsh
|
||||
fd -H -t d "$@"|zf
|
||||
```
|
||||
|
||||
Example 2: use `fazifrga` script to search for a pattern in selected PDFs and preview the matching pages that have the pattern with fzf.
|
||||
|
||||
3. Reveal the selected file or enter the selected directory in a new yazi tab; if multiple items are selected in fzf (using the `-multi` option in fzf), then show the selected items in the search result view.
|
||||
|
||||
For example, find relevant books using `faziffd` and reveal them in yazi's search result view, then use `fazifrga` to search for a pattern in these books.
|
||||
|
||||
4. show recent modified files.
|
||||
```
|
||||
#!/usr/bin/env zsh
|
||||
fd -H -t f --changed-within 1d|fzf
|
||||
```
|
||||
## How It Works
|
||||
|
||||
This plugin acts as a bridge between Yazi and standalone scripts. The main.lua file serves as a generic wrapper that:
|
||||
1. Passes the current working directory and selected files/directories from Yazi (`"$@"` in the script) to the script
|
||||
2. Executes the specified script (passed as an argument in the keymap)
|
||||
3. Send results in Yazi search pane if multiple selected or reveal/enter the selected item in a yazi new tab
|
||||
|
||||
## Installation
|
||||
|
||||
1. Install via ya:
|
||||
|
||||
```bash
|
||||
ya pkg -a Shallow-Seek/fazif
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```bash
|
||||
git clone https://github.com/Shallow-Seek/fazif.yazi.git ~/.config/yazi/plugins/fazif.yazi
|
||||
```
|
||||
|
||||
2. The 3 default scripts `faziffd`, `fazifrg`, and `fazifrga` provided are examples with features shown in the next section. The plugin still works with your scripts without them.
|
||||
|
||||
Simple put your script in `~/.config/yazi/plugins/fazif.yazi` and set a keybinding to use them. To make your script search on selected items, just add `"$@"` to the search command. Check `faziffd` to see that.
|
||||
|
||||
Also you need change your `rg` or `rga`'s delimiter to `U+00A0` by adding the option `--field-match-separator $'\u00a0'`
|
||||
to your `rg` or `rga` commmand and `--delimiter $'\u00a0'` option to `fzf`. See the default `fazifrg` as an example.
|
||||
|
||||
but you can modify the following line in `main.lua` to use your prefered delimiter.
|
||||
|
||||
```lua
|
||||
local file = line:find("\xC2\xA0") and line:sub(1, line:find("\xC2\xA0") - 1) or line
|
||||
```
|
||||
|
||||
> UTF-8 encoding of `U+00A0` is `\xC2\xA0`
|
||||
|
||||
Make sure your scripts are executable:
|
||||
|
||||
```bash
|
||||
chmod +x ~/.config/yazi/plugins/fazif.yazi/faziffd
|
||||
chmod +x ~/.config/yazi/plugins/fazif.yazi/fazifrg
|
||||
chmod +x ~/.config/yazi/plugins/fazif.yazi/fazifrga
|
||||
chmod +x ~/.config/yazi/plugins/fazif.yazi/yourscript1
|
||||
...
|
||||
```
|
||||
You may need to update the shebang (`#!`) in the example scripts.
|
||||
|
||||
## Add Keymaps to Your Script
|
||||
|
||||
The plugin can be configured to run any of your scripts by passing the script name as an argument. Add the following to your `~/.config/yazi/keymap.toml` to bind each script to a key combination:
|
||||
|
||||
### Setting up all scripts:
|
||||
|
||||
```toml
|
||||
# File/Directory finder using fd + fzf
|
||||
[[mgr.prepend_keymap]]
|
||||
on = [ "b", "d" ]
|
||||
run = "plugin fazif faziffd"
|
||||
desc = "Find files/directories with fd and fzf"
|
||||
|
||||
# Content finder using ripgrep + fzf
|
||||
[[mgr.prepend_keymap]]
|
||||
on = [ "b", "r" ]
|
||||
run = "plugin fazif fazifrg"
|
||||
desc = "Find content in files with ripgrep and fzf"
|
||||
|
||||
# Document content finder using ripgrep-all + fzf
|
||||
[[mgr.prepend_keymap]]
|
||||
on = [ "b", "a" ]
|
||||
run = "plugin fazif fazifrga"
|
||||
desc = "Find content in documents with ripgrep-all and fzf"
|
||||
...
|
||||
```
|
||||
|
||||
That's it. is not the default `:`, you will need to change the delimiter in main.lua.
|
||||
|
||||
---
|
||||
## Example scripts
|
||||
Read this section if you use the default scripts `faziffd`, `fazifrg`, and `fazifrga`.
|
||||
|
||||
### Features
|
||||
|
||||
1. **faziffd** - File/directory jumper using `fd`. Txt preview with `bat` and Directory preview with `eza`
|
||||
2. **fazifrg** - `ripgrep` on selected. Preview shows file content with `bat` when started with no input. With any input, `rg` kicks in, and the preview highlights the matching line.
|
||||
3. **fazifrga** - `ripgrep-all` search in selected PDFs and DjVu. Preview shows the first page of a document when started with no input. With any input, `rga` kicks in, and the preview shows the matching page in the document.
|
||||
|
||||
The 3 scripts use the following tools:
|
||||
|
||||
- [fzf](https://github.com/junegunn/fzf)
|
||||
- [fd](https://github.com/sharkdp/fd) - Used by `faziffd`
|
||||
- [ripgrep](https://github.com/BurntSushi/ripgrep) - Used by `fazifrg`
|
||||
- [ripgrep-all](https://github.com/phiresky/ripgrep-all) - Used by `fazifrga`
|
||||
- [rga djvu adaptor](https://github.com/phiresky/ripgrep-all/discussions/166) - Used by `fazifrga` to search in djvu
|
||||
- Additional tools for document previews:
|
||||
- [kitty](https://sw.kovidgoyal.net/kitty/) Image preview uses kitty icat. You can also use other terminals that support image or use ueberzugpp.
|
||||
- [bat](https://github.com/sharkdp/bat) - Used by `faziffd`, `fazifrg`
|
||||
- [eza](https://github.com/eza-community/eza) - Used by `faziffd`
|
||||
- `pdftoppm` from [poppler-utils](https://github.com/freedesktop/poppler) - Used by `faziffd`, `fazifrga` for pdf prevew.
|
||||
- `ddjvu` from [djvulibre](https://github.com/DjVuLibre/djvulibre) - Used by `faziffd`, `fazifrga` for djvu preview.
|
||||
- [libreoffice](https://github.com/LibreOffice/core) for office documents - Used by `faziffd` for office file preview.
|
||||
|
||||
### Usage
|
||||
|
||||
#### faziffd - File/Directory jumper
|
||||
|
||||
- `Ctrl-w`: Search files in the home directory
|
||||
- `Ctrl-e`: Search directories in the home directory
|
||||
- `Alt-c`: Search directories in the current working directory
|
||||
- `Ctrl-t`: Search files in the current working directory
|
||||
- `Ctrl-f`: Search directories from the root
|
||||
- `Ctrl-p`: Toggle the preview window/position
|
||||
- `Ctrl-x`: Open in Yazi (new instance)(if `setsid` is not available, use `nohup`)
|
||||
|
||||
|
||||
#### fazifrg, fazifrga
|
||||
|
||||
- `Ctrl-y`: Switch between rga search mode and fzf filtering mode
|
||||
- `Ctrl-p`: Toggle the preview window/position
|
||||
- `Ctrl-o`: `fazifrg` open file in Neovim at the matched line. `fazifrga` open document in Zathura at the matched page and highlight the query.
|
||||
|
||||
## License
|
||||
|
||||
This plugin is released under the MIT License.
|
||||
|
||||
## Acknowledgement
|
||||
Plugin is based on the default [Yazi](https://github.com/sxyazi/yazi) fzf plugin and vcs-files plugin. Fzf scripts grow out of [fzf](https://github.com/junegunn/fzf)'s wiki and examples.
|
||||
|
||||
+46
@@ -0,0 +1,46 @@
|
||||
#!/usr/bin/env zsh
|
||||
|
||||
fd . -H "$@" |fzf \
|
||||
--info=inline \
|
||||
--multi \
|
||||
--layout=reverse \
|
||||
--prompt='ctl-wetcrfp_CWD> ' \
|
||||
--bind 'ctrl-w:transform:echo "change-prompt(ctl-wetcrfp_Home_File> )+reload(fd . ~ --hidden --type f)"' \
|
||||
--bind 'ctrl-e:transform:echo "change-prompt(ctl-wetcrfp_Home_Dir> )+reload(fd . ~ --hidden --type d)"' \
|
||||
--bind 'alt-c:transform:echo "change-prompt(ctl-wetcrfp_CWD_Dir> )+reload(fd --hidden --type d)"' \
|
||||
--bind 'ctrl-t:transform:echo "change-prompt(ctl-wetcrfp_CWD_File> )+reload(fd --hidden --type f)"' \
|
||||
--bind 'ctrl-f:transform:echo "change-prompt(ctl-wetcrfp_root_Dir> )+reload(fd . / --hidden --type d)"' \
|
||||
--bind 'ctrl-r:transform:echo "change-prompt(ctl-wetcrfp_Root_File> )+reload(fd . / --hidden --type f)"' \
|
||||
--bind 'focus:transform-preview-label:echo {}' \
|
||||
--bind 'ctrl-p:change-preview-window(right|down|hidden)' \
|
||||
--bind 'focus:transform-preview-label:echo {}' \
|
||||
--bind 'ctrl-o:execute-silent(xdg-open-nvim {} &)' \
|
||||
--preview-window 'hidden' \
|
||||
--preview '
|
||||
printf "\033_Ga=d,q=1\033\\"
|
||||
[ -d {} ] && eza -aTL 2 --group-directories-first --color=always --icons=always {} ||
|
||||
tmp="/tmp/fzf_preview"
|
||||
case $(basename {}) in
|
||||
*.pdf)
|
||||
pdftoppm -q -f 1 -l 1 -jpeg -jpegopt quality=60 -scale-to-x 1000 -scale-to-y -1 -singlefile {} $tmp && \
|
||||
kitty icat --transfer-mode=memory --stdin=no --place=${FZF_PREVIEW_COLUMNS}x${FZF_PREVIEW_LINES}@0x0 $tmp.jpg
|
||||
;;
|
||||
*.doc|*.docx|*.xls|*.xlsx|*.ppt|*.pptx|*.odt|*.ods|*.odp)
|
||||
libreoffice --convert-to jpg --outdir /tmp {} >/dev/null 2>&1
|
||||
mv "/tmp/${$(basename {})%.*}.jpg" $tmp
|
||||
kitty icat --transfer-mode=memory --stdin=no --place=${FZF_PREVIEW_COLUMNS}x${FZF_PREVIEW_LINES}@0x0 $tmp
|
||||
;;
|
||||
*.djvu)
|
||||
ddjvu -format=ppm -page=1 -size 1000x-1 -aspect=yes {} $tmp 2>/dev/null && \
|
||||
kitty icat --transfer-mode=memory --stdin=no --place=${FZF_PREVIEW_COLUMNS}x${FZF_PREVIEW_LINES}@0x0 $tmp
|
||||
;;
|
||||
*)
|
||||
if file --mime-type {} | grep -qP "image/(?!vnd\.djvu)"; then
|
||||
kitty icat --transfer-mode=memory --stdin=no --place=${FZF_PREVIEW_COLUMNS}x${FZF_PREVIEW_LINES}@0x0 {}
|
||||
else
|
||||
bat -p {} --color=always 2>/dev/null
|
||||
fi
|
||||
;;
|
||||
esac
|
||||
'
|
||||
|
||||
+50
@@ -0,0 +1,50 @@
|
||||
#!/usr/bin/env sh
|
||||
FD_COMMAND5="fd --changed-within 5d"
|
||||
FD_COMMAND1="fd --changed-within 1d"
|
||||
|
||||
|
||||
$FD_COMMAND5 -t f . "$@" |fzf \
|
||||
--info=inline \
|
||||
--multi \
|
||||
--layout=reverse \
|
||||
--prompt='ctl-wetcrfp_CWD5d> ' \
|
||||
--bind "ctrl-w:transform:echo 'change-prompt(ctl-wetcrfp_HOME5d> )+reload($FD_COMMAND5 -t f . ~ )'" \
|
||||
--bind "ctrl-e:transform:echo 'change-prompt(ctl-wetcrfp_HOME1d)+reload($FD_COMMAND1 -t f . ~)'" \
|
||||
--bind "ctrl-t:transform:echo 'change-prompt(ctl-wetcrfp_CWD5d> )+reload($FD_COMMAND5 -t f)'" \
|
||||
--bind "alt-c:transform:echo 'change-prompt(ctl-wetcrfp_CWD1d> )+reload($FD_COMMAND1 -t f)'" \
|
||||
--bind "ctrl-r:transform:echo 'change-prompt(ctl-wetcrfp_HOMEA> )+reload($FD_COMMAND5 . ~)'" \
|
||||
--bind "ctrl-f:transform:echo 'change-prompt(ctl-wetcrfp_HOMEA_WithH> )+reload($FD_COMMAND1 -H . ~)'" \
|
||||
--bind 'focus:transform-preview-label:echo {}' \
|
||||
--bind 'ctrl-p:change-preview-window(right|down|hidden)' \
|
||||
--bind 'focus:transform-preview-label:echo {}' \
|
||||
--bind 'ctrl-x:execute-silent(setsid kitty nnn {} &)' \
|
||||
--bind 'ctrl-a:execute-silent(setsid kitty yazi {} &)' \
|
||||
--bind 'ctrl-s:execute-silent(setsid thunar {} &)' \
|
||||
--preview-window 'hidden' \
|
||||
--preview '
|
||||
printf "\033_Ga=d,q=1\033\\"
|
||||
[ -d {} ] && eza -aTL 2 --group-directories-first --color=always --icons=always {} ||
|
||||
tmp="/tmp/fzf_preview"
|
||||
case $(basename {}) in
|
||||
*.pdf)
|
||||
pdftoppm -q -f 1 -l 1 -jpeg -jpegopt quality=60 -scale-to-x 1000 -scale-to-y -1 -singlefile {} $tmp && \
|
||||
kitty icat --transfer-mode=memory --stdin=no --place=${FZF_PREVIEW_COLUMNS}x${FZF_PREVIEW_LINES}@0x0 $tmp.jpg
|
||||
;;
|
||||
*.doc|*.docx|*.xls|*.xlsx|*.ppt|*.pptx|*.odt|*.ods|*.odp)
|
||||
libreoffice --convert-to jpg --outdir /tmp {} >/dev/null 2>&1
|
||||
mv "/tmp/${$(basename {})%.*}.jpg" $tmp
|
||||
kitty icat --transfer-mode=memory --stdin=no --place=${FZF_PREVIEW_COLUMNS}x${FZF_PREVIEW_LINES}@0x0 $tmp
|
||||
;;
|
||||
*.djvu)
|
||||
ddjvu -format=ppm -page=1 -size 1000x-1 -aspect=yes {} $tmp 2>/dev/null && \
|
||||
kitty icat --transfer-mode=memory --stdin=no --place=${FZF_PREVIEW_COLUMNS}x${FZF_PREVIEW_LINES}@0x0 $tmp
|
||||
;;
|
||||
*)
|
||||
if file --mime-type {} | grep -qP "image/(?!vnd\.djvu)"; then
|
||||
kitty icat --transfer-mode=memory --stdin=no --place=${FZF_PREVIEW_COLUMNS}x${FZF_PREVIEW_LINES}@0x0 {}
|
||||
else
|
||||
bat -p {} --color=always 2>/dev/null
|
||||
fi
|
||||
;;
|
||||
esac
|
||||
'
|
||||
+32
@@ -0,0 +1,32 @@
|
||||
#!/usr/bin/env zsh
|
||||
rm -f /tmp/rg-fzf-{r,f} 2>/dev/null
|
||||
RG_PREFIX="rg --with-filename --column --line-number --color=always --smart-case --field-match-separator $'\u00a0'"
|
||||
|
||||
FILES_TO_ADD=""
|
||||
for item in "$@"; do
|
||||
if [ -f "$item" ]; then
|
||||
FILES_TO_ADD="$FILES_TO_ADD$item"$'\n'
|
||||
fi
|
||||
done
|
||||
|
||||
(fd . -H -t f "$@" 2>/dev/null & printf "%s" "$FILES_TO_ADD") | fzf \
|
||||
--ansi \
|
||||
--delimiter $'\u00a0' \
|
||||
--disabled \
|
||||
--prompt '1. ripgrep> ' \
|
||||
--header 'CTRL-Y: Switch between ripgrep/fzf' \
|
||||
--bind "change:reload:sleep 0.1; $RG_PREFIX {q} $([ $# -gt 0 ] && printf "%q " "$@") || true" \
|
||||
--bind 'ctrl-y:transform:[[ ! $FZF_PROMPT =~ ripgrep ]] &&
|
||||
echo "rebind(change)+change-prompt(1. ripgrep> )+disable-search+transform-query:echo \{q} > /tmp/rg-fzf-f; cat /tmp/rg-fzf-r" ||
|
||||
echo "unbind(change)+change-prompt(2. fzf> )+enable-search+transform-query:echo \{q} > /tmp/rg-fzf-r; cat /tmp/rg-fzf-f"' \
|
||||
--color "hl:-1:underline,hl+:-1:underline:reverse" \
|
||||
--preview '[ -n "{2}" ] && bat --color=always {1} --style=numbers --highlight-line {2} || bat --color=always {} --style=numbers' \
|
||||
--preview-window 'down,60%,+{2}+3/3,~3' \
|
||||
--bind 'ctrl-p:change-preview-window(right,60%|hidden|down,60%)' \
|
||||
--bind 'focus:transform-preview-label:echo $(basename {1})' \
|
||||
--bind 'ctrl-o:execute(kitty -1 sh -c "nvim {1} +{2}" & )' \
|
||||
--bind 'ctrl-x:execute-silent(setsid kitty -1 nnn {1} &)' \
|
||||
--bind 'ctrl-a:execute-silent(setsid kitty -1 yazi {1} &)' \
|
||||
--bind 'ctrl-s:execute-silent(setsid thunar {1} &)' \
|
||||
--color 'label:117:bold'
|
||||
|
||||
+50
@@ -0,0 +1,50 @@
|
||||
#!/usr/bin/env zsh
|
||||
rm -f /tmp/rg-fzf-{r,f} 2>/dev/null
|
||||
RG_PREFIX="rga --glob='*.pdf' --glob='*.djvu' --glob='*.djv' --with-filename --color=always --no-heading --smart-case --field-match-separator $'\u00a0'"
|
||||
|
||||
FILES_TO_ADD=""
|
||||
for item in "$@"; do
|
||||
if [ -f "$item" ]; then
|
||||
FILES_TO_ADD="$FILES_TO_ADD$item"$'\n'
|
||||
fi
|
||||
done
|
||||
|
||||
(fd . -e pdf -e djvu -e djv "$@" 2>/dev/null & printf "%s" "$FILES_TO_ADD") | fzf \
|
||||
--ansi \
|
||||
--delimiter $'\u00a0' \
|
||||
--disabled \
|
||||
--with-nth 2,1 \
|
||||
--prompt="rga> " \
|
||||
--color "hl:-1:underline,hl+:-1:underline:reverse" \
|
||||
--bind "change:reload:sleep 0.1; $RG_PREFIX {q} $([ $# -gt 0 ] && printf "%q " "$@") || true" \
|
||||
--bind 'focus:transform-preview-label:echo $(basename {1})' \
|
||||
--bind 'ctrl-p:change-preview-window(right,50%|hidden,50%|down)' \
|
||||
--bind 'ctrl-x:execute-silent(setsid kitty -1 nnn {1} &)' \
|
||||
--bind 'ctrl-a:execute-silent(setsid kitty -1 yazi {1} &)' \
|
||||
--bind 'ctrl-s:execute-silent(setsid thunar {1} &)' \
|
||||
--preview-window 'down' \
|
||||
--bind 'ctrl-y:transform:[[ ! $FZF_PROMPT =~ rga ]] &&
|
||||
echo "rebind(change)+change-prompt(rga> )+disable-search+transform-query:echo \{q} > /tmp/rg-fzf-f; cat /tmp/rg-fzf-r" ||
|
||||
echo "unbind(change)+change-prompt(fzf> )+enable-search+transform-query:echo \{q} > /tmp/rg-fzf-r; cat /tmp/rg-fzf-f"' \
|
||||
--bind 'ctrl-o:execute(
|
||||
page_info={2}
|
||||
pagenumber=${page_info#Page }
|
||||
pagenumber=${pagenumber%%: *}
|
||||
context=${page_info#*: }
|
||||
setsid zathura --page=$pagenumber --find=$context {1} &)' \
|
||||
--preview '
|
||||
printf "\033_Ga=d,q=1\033\\"
|
||||
[ -n {2} ] && pagenumber=$(echo {2} | cut -d: -f1 | sed "s/Page\ //") || pagenumber=1
|
||||
tmp="/tmp/fzf_preview"
|
||||
case {1} in
|
||||
*.pdf)
|
||||
pdftoppm -q -f $pagenumber -l $pagenumber -jpeg -jpegopt quality=60 -scale-to-x 800 -scale-to-y -1 -singlefile {1} $tmp \
|
||||
&& kitty icat --transfer-mode=memory --stdin=no --place=${FZF_PREVIEW_COLUMNS}x${FZF_PREVIEW_LINES}@0x0 $tmp.jpg
|
||||
;;
|
||||
*.djvu)
|
||||
ddjvu -format=ppm -page=$pagenumber -size=800x-1 -aspect=yes {1} $tmp 2>/dev/null \
|
||||
&& kitty icat --transfer-mode=memory --stdin=no --place=${FZF_PREVIEW_COLUMNS}x${FZF_PREVIEW_LINES}@0x0 $tmp
|
||||
;;
|
||||
esac
|
||||
' \
|
||||
# --bind "start:reload:$RG_PREFIX {q} || true" \
|
||||
@@ -0,0 +1,107 @@
|
||||
local state = ya.sync(function()
|
||||
local selected = {}
|
||||
for _, url in pairs(cx.active.selected) do
|
||||
selected[#selected + 1] = url
|
||||
end
|
||||
return cx.active.current.cwd, selected
|
||||
end)
|
||||
|
||||
local function split_urls(cwd, output)
|
||||
if not output or output == "" then return {} end
|
||||
|
||||
local t = {}
|
||||
for line in output:gmatch("[^\r\n]+") do
|
||||
if line ~= "" then
|
||||
-- Get everything before first colon, or entire line if no colon
|
||||
local file = line:find("\xC2\xA0") and line:sub(1, line:find("\xC2\xA0") - 1) or line
|
||||
|
||||
if file and file ~= "" then
|
||||
local u = Url(file)
|
||||
if u.is_absolute then
|
||||
t[#t + 1] = u
|
||||
else
|
||||
t[#t + 1] = cwd:join(u)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
return t
|
||||
end
|
||||
|
||||
local function run_with(cwd, selected, script_name)
|
||||
local script_path = os.getenv("HOME") .. "/.config/yazi/plugins/fazif.yazi/" .. script_name
|
||||
|
||||
local sepaths = {}
|
||||
if #selected > 0 then
|
||||
for _, u in ipairs(selected) do
|
||||
table.insert(sepaths, tostring(u))
|
||||
end
|
||||
end
|
||||
|
||||
local child
|
||||
if #selected == 0 then
|
||||
child = Command(script_path):cwd(tostring(cwd)):stdin(Command.INHERIT):stdout(Command.PIPED):spawn()
|
||||
else
|
||||
child = Command(script_path):arg(sepaths):stdout(Command.PIPED):spawn()
|
||||
end
|
||||
|
||||
if not child then
|
||||
return nil, "Failed to start script"
|
||||
end
|
||||
|
||||
local output, err = child:wait_with_output()
|
||||
if not output then
|
||||
return nil, "Cannot read output: " .. tostring(err)
|
||||
elseif not output.status.success and output.status.code ~= 130 then
|
||||
return nil, "Script exited with code " .. tostring(output.status.code)
|
||||
end
|
||||
return output.stdout, nil
|
||||
end
|
||||
|
||||
local function entry(_, job)
|
||||
local script_name = job.args[1]
|
||||
|
||||
local permit = ui.hide()
|
||||
local cwd, selected = state()
|
||||
|
||||
local output, err = run_with(cwd, selected, script_name)
|
||||
|
||||
if permit then
|
||||
permit:drop()
|
||||
end
|
||||
|
||||
if not output then
|
||||
return ya.notify { title = "Fazif", content = tostring(err), timeout = 5, level = "error" }
|
||||
end
|
||||
|
||||
local urls = split_urls(cwd, output)
|
||||
if #urls == 0 then
|
||||
return
|
||||
elseif #urls == 1 then
|
||||
ya.emit("tab_create", {})
|
||||
ya.emit(fs.cha(urls[1]).is_dir and "cd" or "reveal", { urls[1], raw = true })
|
||||
else
|
||||
ya.emit("tab_create", {})
|
||||
local id = ya.id("ft")
|
||||
local virtual_cwd = cwd:into_search("FZF Results")
|
||||
ya.emit("cd", { Url(virtual_cwd) })
|
||||
ya.emit("update_files", { op = fs.op("part", { id = id, url = Url(virtual_cwd), files = {} }) })
|
||||
|
||||
local files = {}
|
||||
for i = 1, #urls do
|
||||
local url = urls[i]
|
||||
local cha = fs.cha(url, true)
|
||||
if cha then
|
||||
files[#files + 1] = File { url = url, cha = cha }
|
||||
else
|
||||
files[#files + 1] = File { url = url }
|
||||
end
|
||||
end
|
||||
|
||||
ya.emit("update_files", { op = fs.op("part", { id = id, url = Url(virtual_cwd), files = files }) })
|
||||
ya.emit("update_files", { op = fs.op("done", { id = id, url = virtual_cwd, cha = Cha { kind = 16 } }) })
|
||||
end
|
||||
end
|
||||
|
||||
return { entry = entry }
|
||||
|
||||
@@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
@@ -0,0 +1,97 @@
|
||||
<img width="957" height="487" alt="list of files with highlighted matching characters" src="https://github.com/user-attachments/assets/b734d630-ab08-46a2-a6a0-acaf458d36c0" />
|
||||
|
||||
# Features
|
||||
|
||||
- case insensitive matching
|
||||
- supports aliases for different languages
|
||||
- ignores leading non-alphabet
|
||||
- can match characters anywhere in filename
|
||||
|
||||
# Installation
|
||||
|
||||
```sh
|
||||
ya pkg add AminurAlam/yazi-plugins:fchar
|
||||
```
|
||||
|
||||
# Usage
|
||||
|
||||
in `~/.config/yazi/keymap.toml`
|
||||
|
||||
```toml
|
||||
[mgr]
|
||||
prepend_keymap = [
|
||||
{ on = "f", run = "plugin fchar", desc = "Jump to char" },
|
||||
]
|
||||
```
|
||||
|
||||
in `~/.config/yazi/init.lua`
|
||||
|
||||
```lua
|
||||
-- default config
|
||||
require('fchar'):setup {
|
||||
-- if true: f -> file, File, FILE
|
||||
insensitive = true,
|
||||
-- if true: f -> file, .file, @file, #file, ...file
|
||||
skip_symbols = true,
|
||||
-- if {"yazi-"}: f -> file, yazi-file
|
||||
skip_prefix = {},
|
||||
-- start: f -> file
|
||||
-- word: f -> file, also-file
|
||||
-- all: f -> file, also-file, alsofile, elf
|
||||
search_location = 'start',
|
||||
aliases = {},
|
||||
}
|
||||
|
||||
-- aliases for German
|
||||
require('fchar'):setup {
|
||||
aliases = {
|
||||
a = 'ä',
|
||||
o = 'ö',
|
||||
u = 'ü',
|
||||
s = 'ß'
|
||||
},
|
||||
}
|
||||
|
||||
-- aliases for Japanese
|
||||
require('fchar'):setup {
|
||||
aliases = {
|
||||
a = 'あア',
|
||||
b = 'ばびぶべぼバビブベボ',
|
||||
c = 'ちチ',
|
||||
d = 'だぢづでどダヂヅデド',
|
||||
e = 'えエ',
|
||||
g = 'がぎぐげごガギグゲゴ',
|
||||
h = 'はひふへほハヒフヘホ',
|
||||
i = 'いイ',
|
||||
j = 'じジ',
|
||||
k = 'かきくけこカキクケコ',
|
||||
m = 'まみむめもマミムメモ',
|
||||
n = 'なにぬねのんナニヌネノン',
|
||||
o = 'おオ',
|
||||
p = 'ぱぴぷぺぽパピプペポ',
|
||||
r = 'らりるれろラリルレロ',
|
||||
s = 'さしすせそサシスセソ',
|
||||
t = 'たつてとタツテト',
|
||||
u = 'うウ',
|
||||
w = 'わをワヲ',
|
||||
y = 'やゆよヤユヨ',
|
||||
z = 'ざずぜぞザズゼゾ',
|
||||
},
|
||||
}
|
||||
|
||||
-- you may want to turn off the search regex from
|
||||
-- showing up in the header by doing this
|
||||
function Header:flags()
|
||||
local cwd = self._current.cwd
|
||||
local filter = self._current.files.filter
|
||||
|
||||
local t = {}
|
||||
if cwd.is_search then
|
||||
t[#t + 1] = string.format('search: %s', cwd.domain)
|
||||
end
|
||||
if filter then
|
||||
t[#t + 1] = string.format('filter: %s', filter)
|
||||
end
|
||||
return #t == 0 and '' or ' (' .. table.concat(t, ', ') .. ')'
|
||||
end
|
||||
```
|
||||
@@ -0,0 +1,159 @@
|
||||
--- @since 25.5.31
|
||||
|
||||
local M = {}
|
||||
|
||||
local changed = ya.sync(function(st, new)
|
||||
local b = st.last ~= new
|
||||
st.last = new
|
||||
return b or not cx.active.finder
|
||||
end)
|
||||
|
||||
---@type fun(opts: FCharConf): nil
|
||||
local set_config = ya.sync(function(st, opts)
|
||||
st.opts = opts
|
||||
end)
|
||||
|
||||
---@type fun(): FCharConf
|
||||
local get_config = ya.sync(function(st)
|
||||
return st.opts
|
||||
or {
|
||||
-- if true: f -> file, File, FILE
|
||||
insensitive = true,
|
||||
-- if true: f -> file, .file, @file, #file, ...file
|
||||
skip_symbols = true,
|
||||
-- if {"yazi-"}: f -> file, yazi-file
|
||||
skip_prefix = {},
|
||||
-- start: f -> file
|
||||
-- word: f -> file, also-file
|
||||
-- all: f -> file, also-file, twofile, elf
|
||||
search_location = 'start',
|
||||
aliases = {},
|
||||
}
|
||||
end)
|
||||
|
||||
local function tbl_deep_extend(default, config)
|
||||
if type(config) ~= 'table' then
|
||||
return config
|
||||
end
|
||||
|
||||
default = (type(default) == 'table') and default or {}
|
||||
for key, _ in pairs(config) do
|
||||
default[key] = tbl_deep_extend(default[key], config[key])
|
||||
end
|
||||
|
||||
return default
|
||||
end
|
||||
|
||||
---@type fun(self, config: FCharConf): nil
|
||||
function M:setup(config)
|
||||
set_config(tbl_deep_extend(get_config(), config))
|
||||
end
|
||||
|
||||
-- TODO: process `--flags`
|
||||
function M:entry()
|
||||
local cands = {
|
||||
{ on = '0' },
|
||||
{ on = '1' },
|
||||
{ on = '2' },
|
||||
{ on = '3' },
|
||||
{ on = '4' },
|
||||
{ on = '5' },
|
||||
{ on = '6' },
|
||||
{ on = '7' },
|
||||
{ on = '8' },
|
||||
{ on = '9' },
|
||||
{ on = '_' },
|
||||
{ on = 'a' },
|
||||
{ on = 'b' },
|
||||
{ on = 'c' },
|
||||
{ on = 'd' },
|
||||
{ on = 'e' },
|
||||
{ on = 'f' },
|
||||
{ on = 'g' },
|
||||
{ on = 'h' },
|
||||
{ on = 'i' },
|
||||
{ on = 'j' },
|
||||
{ on = 'k' },
|
||||
{ on = 'l' },
|
||||
{ on = 'm' },
|
||||
{ on = 'n' },
|
||||
{ on = 'o' },
|
||||
{ on = 'p' },
|
||||
{ on = 'q' },
|
||||
{ on = 'r' },
|
||||
{ on = 's' },
|
||||
{ on = 't' },
|
||||
{ on = 'u' },
|
||||
{ on = 'v' },
|
||||
{ on = 'w' },
|
||||
{ on = 'x' },
|
||||
{ on = 'y' },
|
||||
{ on = 'z' },
|
||||
{ on = 'A' },
|
||||
{ on = 'B' },
|
||||
{ on = 'C' },
|
||||
{ on = 'D' },
|
||||
{ on = 'E' },
|
||||
{ on = 'F' },
|
||||
{ on = 'G' },
|
||||
{ on = 'H' },
|
||||
{ on = 'I' },
|
||||
{ on = 'J' },
|
||||
{ on = 'K' },
|
||||
{ on = 'L' },
|
||||
{ on = 'M' },
|
||||
{ on = 'N' },
|
||||
{ on = 'O' },
|
||||
{ on = 'P' },
|
||||
{ on = 'Q' },
|
||||
{ on = 'R' },
|
||||
{ on = 'S' },
|
||||
{ on = 'T' },
|
||||
{ on = 'U' },
|
||||
{ on = 'V' },
|
||||
{ on = 'W' },
|
||||
{ on = 'X' },
|
||||
{ on = 'Y' },
|
||||
{ on = 'Z' },
|
||||
}
|
||||
local opts = get_config()
|
||||
|
||||
if opts.skip_symbols then
|
||||
local additional_keys = '~.!@#-'
|
||||
for i = 1, #additional_keys do
|
||||
cands[#cands + 1] = { on = additional_keys:sub(i, i) }
|
||||
end
|
||||
end
|
||||
|
||||
local idx = ya.which { cands = cands, silent = true }
|
||||
if not idx then
|
||||
return
|
||||
end
|
||||
|
||||
local loc = {
|
||||
start = '^',
|
||||
word = '(^|\\W)',
|
||||
all = '',
|
||||
}
|
||||
|
||||
-- TODO: autodetect common prefix
|
||||
local prefixes = ''
|
||||
for _, prefix in ipairs(opts.skip_prefix) do
|
||||
prefixes = prefixes .. '(' .. prefix .. ')?'
|
||||
end
|
||||
|
||||
local re = loc[opts.search_location]
|
||||
.. ((opts.search_location == 'start' and opts.skip_symbols) and [[\W?]] or '')
|
||||
.. prefixes
|
||||
.. '['
|
||||
.. cands[idx].on
|
||||
.. (opts.aliases[cands[idx].on] or '')
|
||||
.. ']'
|
||||
if changed(re) then
|
||||
ya.emit('find_do', { re, insensitive = opts.insensitive })
|
||||
else
|
||||
ya.emit('find_arrow', {})
|
||||
end
|
||||
end
|
||||
|
||||
return M
|
||||
@@ -0,0 +1,19 @@
|
||||
Copyright (c) 2024 boydaihungst
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,110 @@
|
||||
# file-extra-metadata
|
||||
|
||||
<!--toc:start-->
|
||||
|
||||
- [file-extra-metadata](#file-extra-metadata)
|
||||
- [Preview](#preview)
|
||||
- [Before:](#before)
|
||||
- [After:](#after)
|
||||
- [Requirements](#requirements)
|
||||
- [Installation](#installation)
|
||||
- [For developer](#for-developer)
|
||||
<!--toc:end-->
|
||||
|
||||
This is a Yazi plugin that replaces the default file previewer and spotter with extra information.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Minimum version: yazi v25.5.28
|
||||
|
||||
## Preview
|
||||
|
||||
### Before:
|
||||
|
||||
- Previewer
|
||||
|
||||
|
||||
|
||||
- Spotter
|
||||
|
||||
|
||||
|
||||
### After:
|
||||
|
||||
- Previewer
|
||||
|
||||
|
||||
|
||||
- Spotter
|
||||
|
||||
|
||||
|
||||
## Requirements
|
||||
|
||||
- [yazi >= 25.5.28](https://github.com/sxyazi/yazi)
|
||||
- Tested on Linux. For MacOS, Windows: some fields will shows empty values.
|
||||
|
||||
## Installation
|
||||
|
||||
Install the plugin:
|
||||
|
||||
```sh
|
||||
ya pkg add boydaihungst/file-extra-metadata
|
||||
```
|
||||
|
||||
Create `~/.config/yazi/yazi.toml` and add:
|
||||
For yazi < v25.12.29 (29/12/2025) replace `url` with `name`
|
||||
|
||||
```toml
|
||||
[plugin]
|
||||
append_previewers = [
|
||||
{ url = "*", run = "file-extra-metadata" },
|
||||
]
|
||||
|
||||
# Setup keybind for spotter: https://github.com/sxyazi/yazi/pull/1802
|
||||
append_spotters = [
|
||||
{ url = "*", run = "file-extra-metadata" },
|
||||
]
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```toml
|
||||
[plugin]
|
||||
previewers = [
|
||||
# ... the rest
|
||||
# disable default file plugin { name = "*", run = "file" },
|
||||
{ url = "*", run = "file-extra-metadata" },
|
||||
]
|
||||
|
||||
# Setup keybind for spotter: https://github.com/sxyazi/yazi/pull/1802
|
||||
spotters = [
|
||||
# ... the rest
|
||||
# Fallback
|
||||
# { name = "*", run = "file" },
|
||||
{ url = "*", run = "file-extra-metadata" },
|
||||
]
|
||||
```
|
||||
|
||||
### Custom theme
|
||||
|
||||
Read more: https://github.com/sxyazi/yazi/pull/2391
|
||||
|
||||
Edit or add `yazi/theme.toml`:
|
||||
|
||||
```toml
|
||||
[spot]
|
||||
border = { fg = "#4fa6ed" }
|
||||
title = { fg = "#4fa6ed" }
|
||||
|
||||
# Table.
|
||||
tbl_cell = { fg = "#4fa6ed", reversed = true }
|
||||
tbl_col = { fg = "#4fa6ed" }
|
||||
```
|
||||
|
||||
## For developer
|
||||
|
||||
If you want to combine this with other spotter/previewer:
|
||||
|
||||
```lua
|
||||
require("file-extra-metadata"):render_table(job, { show_plugins_section = true })
|
||||
```
|
||||
@@ -0,0 +1,367 @@
|
||||
--- @since 25.5.28
|
||||
|
||||
local M = {}
|
||||
|
||||
local STATE_KEY = {
|
||||
ALTER_DF_COMMAND = "ALTER_DF_COMMAND",
|
||||
}
|
||||
|
||||
local set_state = ya.sync(function(state, key, value)
|
||||
state[key] = value
|
||||
end)
|
||||
|
||||
local get_state = ya.sync(function(state, key)
|
||||
return state[key]
|
||||
end)
|
||||
|
||||
local function permission(file)
|
||||
local h = file
|
||||
if not h then
|
||||
return ""
|
||||
end
|
||||
|
||||
local perm = h.cha:perm()
|
||||
if not perm then
|
||||
return ""
|
||||
end
|
||||
|
||||
local spans = ""
|
||||
for i = 1, #perm do
|
||||
local c = perm:sub(i, i)
|
||||
spans = spans .. c
|
||||
end
|
||||
return spans
|
||||
end
|
||||
|
||||
local function link_count(file)
|
||||
local h = file
|
||||
if h == nil or ya.target_family() ~= "unix" then
|
||||
return ""
|
||||
end
|
||||
|
||||
return h.cha.nlink
|
||||
end
|
||||
|
||||
local function owner_group(file)
|
||||
local h = file
|
||||
if h == nil or ya.target_family() ~= "unix" then
|
||||
return ""
|
||||
end
|
||||
return (ya.user_name(h.cha.uid) or tostring(h.cha.uid)) .. "/" .. (ya.group_name(h.cha.gid) or tostring(h.cha.gid))
|
||||
end
|
||||
|
||||
local file_size_and_folder_childs = function(file)
|
||||
local h = file
|
||||
if not h then
|
||||
return ""
|
||||
end
|
||||
|
||||
return h.cha.len and ya.readable_size(h.cha.len) or ""
|
||||
end
|
||||
|
||||
--- get file timestamp
|
||||
---@param file any
|
||||
---@param type "mtime" | "atime" | "btime"
|
||||
---@return any
|
||||
local function fileTimestamp(file, type)
|
||||
local h = file
|
||||
if not h then
|
||||
return ""
|
||||
end
|
||||
local time = math.floor(h.cha[type] or 0)
|
||||
if time == 0 then
|
||||
return ""
|
||||
else
|
||||
return os.date("%Y-%m-%d %H:%M", time)
|
||||
end
|
||||
end
|
||||
|
||||
-- Function to split a string by spaces (considering multiple spaces as one delimiter)
|
||||
local function split_by_whitespace(input)
|
||||
local result = {}
|
||||
for word in string.gmatch(input, "%S+") do
|
||||
table.insert(result, word)
|
||||
end
|
||||
return result
|
||||
end
|
||||
|
||||
local function get_filesystem_extra(file)
|
||||
local result = {
|
||||
filesystem = "",
|
||||
device = "",
|
||||
type = "",
|
||||
used_space = "",
|
||||
avail_space = "",
|
||||
total_space = "",
|
||||
used_space_percent = "",
|
||||
avail_space_percent = "",
|
||||
error = nil,
|
||||
is_virtual = false,
|
||||
}
|
||||
local h = file
|
||||
local file_url = h.url
|
||||
local is_virtual = file_url.spec and file_url.scheme.is_virtual
|
||||
file_url = is_virtual and (file.path or Url(file_url.scheme.cache .. tostring(file_url.path)))
|
||||
or (file_url.path or file_url.url)
|
||||
if not h or ya.target_family() ~= "unix" then
|
||||
return result
|
||||
end
|
||||
local output, child
|
||||
|
||||
local alter_df_command = get_state(STATE_KEY.ALTER_DF_COMMAND)
|
||||
if not alter_df_command then
|
||||
child, _ = Command("df"):arg({ "-P", "-T", "-h", tostring(file_url) }):stdout(Command.PIPED):spawn()
|
||||
|
||||
if child then
|
||||
-- Ignore header
|
||||
local _, event = child:read_line()
|
||||
if event == 0 then
|
||||
output, _ = child:read_line()
|
||||
end
|
||||
child:start_kill()
|
||||
end
|
||||
end
|
||||
|
||||
-- Fallback for macOS/BSD if -T failed (empty output or error)
|
||||
if not output or output == "" then
|
||||
if not alter_df_command then
|
||||
set_state(STATE_KEY.ALTER_DF_COMMAND, true)
|
||||
end
|
||||
child, _ = Command("df"):arg({ "-P", "-h", tostring(file_url) }):stdout(Command.PIPED):spawn()
|
||||
if child then
|
||||
local _, event = child:read_line() -- skip header
|
||||
if event == 0 then
|
||||
output, _ = child:read_line()
|
||||
end
|
||||
child:start_kill()
|
||||
end
|
||||
end
|
||||
|
||||
if output and output ~= "" then
|
||||
-- Splitting the data
|
||||
local parts = split_by_whitespace(output)
|
||||
|
||||
-- Display the result
|
||||
if #parts >= 7 then
|
||||
result.filesystem = is_virtual and (parts[7] .. " (vfs)") or parts[7]
|
||||
result.device = is_virtual and (parts[1] .. " (vfs)") or parts[1]
|
||||
result.total_space = parts[3]
|
||||
result.used_space = parts[4]
|
||||
result.avail_space = parts[5]
|
||||
result.used_space_percent = parts[6]
|
||||
result.avail_space_percent = 100 - tonumber((string.match(parts[6], "%d+") or "0"))
|
||||
result.type = is_virtual and (parts[2] .. " (vfs)") or parts[2]
|
||||
else
|
||||
result.filesystem = is_virtual and (parts[6] .. " (vfs)") or parts[6]
|
||||
-- result.device (Type) is missing in df output, fetch from mount
|
||||
result.total_space = parts[2]
|
||||
result.used_space = parts[3]
|
||||
result.avail_space = parts[4]
|
||||
result.used_space_percent = parts[5]
|
||||
result.avail_space_percent = 100 - tonumber((string.match(parts[5], "%d+") or "0"))
|
||||
result.device = is_virtual and (parts[1] .. " (vfs)") or parts[1]
|
||||
|
||||
local mount_child = Command("mount"):stdout(Command.PIPED):spawn()
|
||||
if mount_child then
|
||||
while true do
|
||||
local line, event = mount_child:read_line()
|
||||
if not line or event ~= 0 then
|
||||
break
|
||||
end
|
||||
-- Check if line starts with filesystem (e.g. /dev/disk1s1 on ...)
|
||||
local s, e = line:find(parts[1] .. " on ", 1, true)
|
||||
if s == 1 then
|
||||
local fstype = line:match("%(([^,]+)")
|
||||
if fstype then
|
||||
result.type = is_virtual and (fstype .. " (vfs)") or fstype
|
||||
end
|
||||
break
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
result.is_virtual = is_virtual
|
||||
else
|
||||
result.error = "df error: check install"
|
||||
end
|
||||
return result
|
||||
end
|
||||
|
||||
local function attributes(file)
|
||||
local h = file
|
||||
local file_url = h.url
|
||||
if h.cha.is_link then
|
||||
file_url = Url(h.link_to)
|
||||
end
|
||||
local is_virtual = file_url.scheme and file_url.scheme.is_virtual
|
||||
file_url = is_virtual and (file.path or Url(file_url.scheme.cache .. tostring(file_url.path))) or file_url
|
||||
|
||||
if not h or ya.target_family() ~= "unix" then
|
||||
return ""
|
||||
end
|
||||
|
||||
local output, _ = Command("lsattr"):arg({ "-d", tostring(file_url) }):stdout(Command.PIPED):output()
|
||||
|
||||
if output then
|
||||
-- Splitting the data
|
||||
local parts = split_by_whitespace(output.stdout)
|
||||
|
||||
-- Display the result
|
||||
for i, part in ipairs(parts) do
|
||||
if i == 1 then
|
||||
return part
|
||||
end
|
||||
end
|
||||
return ""
|
||||
else
|
||||
return "lsattr error: check install"
|
||||
end
|
||||
end
|
||||
|
||||
---shorten string
|
||||
---@param _s string string
|
||||
---@param _t string tail
|
||||
---@param _w number max characters
|
||||
---@return string
|
||||
local shorten = function(_s, _t, _w)
|
||||
local s = _s or utf8.len(_s)
|
||||
local t = _t or ""
|
||||
local ellipsis = "…" .. t
|
||||
local w = _w < utf8.len(ellipsis) and utf8.len(ellipsis) or _w
|
||||
local n_ellipsis = utf8.len(ellipsis) or 0
|
||||
if utf8.len(s) > w then
|
||||
return s:sub(1, (utf8.offset(s, w - n_ellipsis + 1) or 2) - 1) .. ellipsis
|
||||
end
|
||||
return s
|
||||
end
|
||||
|
||||
function M:render_table(job, opts)
|
||||
local styles = {
|
||||
header = th.spot.title or ui.Style():fg("green"),
|
||||
row_label = ui.Style():fg("reset"),
|
||||
row_value = th.spot.tbl_col or ui.Style():fg("blue"),
|
||||
}
|
||||
local filesystem_extra = get_filesystem_extra(job.file)
|
||||
local prefix = " "
|
||||
local rows = {}
|
||||
local label_max_length = 15
|
||||
local file_name_extension = job.file.cha.is_dir and "…" or ("." .. (job.file.url.ext or ""))
|
||||
|
||||
local row = function(key, value)
|
||||
local h = type(value) == "table" and #value or 1
|
||||
rows[#rows + 1] = ui.Row({ ui.Line(key):style(styles.row_label), ui.Text(value):style(styles.row_value) }):height(h)
|
||||
end
|
||||
|
||||
local file_name = shorten(
|
||||
job.file.name,
|
||||
file_name_extension,
|
||||
math.floor(job.area.w - label_max_length - utf8.len(file_name_extension))
|
||||
)
|
||||
local location = shorten(
|
||||
tostring((job.file.url.path or job.file.url).parent),
|
||||
"",
|
||||
math.floor(job.area.w - label_max_length - utf8.len(prefix))
|
||||
)
|
||||
local filesystem_error = filesystem_extra.error
|
||||
and shorten(filesystem_extra.error, "", math.floor(job.area.w - label_max_length - utf8.len(prefix)))
|
||||
or nil
|
||||
local filesystem =
|
||||
shorten(filesystem_extra.filesystem, "", math.floor(job.area.w - label_max_length - utf8.len(prefix)))
|
||||
|
||||
rows[#rows + 1] = ui.Row({ "Metadata", "" }):style(styles.header)
|
||||
row(prefix .. "File:", file_name)
|
||||
row(prefix .. "Mimetype:", job.mime)
|
||||
row(prefix .. "Location:", location)
|
||||
if job.file.cache then
|
||||
row(prefix .. "Cached:", tostring(job.file.path or job.file.cache))
|
||||
end
|
||||
row(prefix .. "Mode:", permission(job.file))
|
||||
row(prefix .. "Attributes:", attributes(job.file))
|
||||
row(prefix .. "Links:", tostring(link_count(job.file)))
|
||||
if job.file.cha.is_link then
|
||||
row(prefix .. "Linked:", tostring(job.file.cha.is_link and job.file.link_to))
|
||||
end
|
||||
row(prefix .. "Owner:", owner_group(job.file))
|
||||
row(prefix .. "Size:", file_size_and_folder_childs(job.file))
|
||||
row(prefix .. "Created:", fileTimestamp(job.file, "btime"))
|
||||
row(prefix .. "Modified:", fileTimestamp(job.file, "mtime"))
|
||||
row(prefix .. "Accessed:", fileTimestamp(job.file, "atime"))
|
||||
row(prefix .. "Filesystem:", filesystem_error or filesystem)
|
||||
row(prefix .. "Device:", filesystem_error or filesystem_extra.device)
|
||||
row(prefix .. "Type:", filesystem_error or filesystem_extra.type)
|
||||
row(
|
||||
prefix .. "Free space:",
|
||||
filesystem_error
|
||||
or (
|
||||
(filesystem_extra.avail_space and filesystem_extra.total_space and filesystem_extra.avail_space_percent)
|
||||
and (filesystem_extra.avail_space .. " / " .. filesystem_extra.total_space .. " (" .. filesystem_extra.avail_space_percent .. "%)")
|
||||
or ""
|
||||
)
|
||||
)
|
||||
if opts and opts.show_plugins_section then
|
||||
-- TODO: Remove this after the next release
|
||||
local is_yazi_nightly, _ = pcall(require, "mime.dir")
|
||||
local spotter = rt.plugin.spotter(is_yazi_nightly and job.file or job.file.url, job.mime)
|
||||
local previewer = rt.plugin.previewer(is_yazi_nightly and job.file or job.file.url, job.mime)
|
||||
local fetchers = rt.plugin.fetchers(job.file, job.mime)
|
||||
local preloaders = rt.plugin.preloaders(is_yazi_nightly and job.file or job.file.url, job.mime)
|
||||
|
||||
for i, v in ipairs(fetchers) do
|
||||
fetchers[i] = v.cmd
|
||||
end
|
||||
for i, v in ipairs(preloaders) do
|
||||
preloaders[i] = v.cmd
|
||||
end
|
||||
|
||||
rows[#rows + 1] = ui.Row({ { "", "Plugins" }, "" }):height(2):style(styles.header)
|
||||
row(prefix .. "Spotter:", spotter and spotter.cmd or "(none)")
|
||||
row(prefix .. "Previewer:", previewer and previewer.cmd or "(none)")
|
||||
row(prefix .. "Fetchers:", #fetchers ~= 0 and fetchers or "(none)")
|
||||
row(prefix .. "Preloaders:", #preloaders ~= 0 and preloaders or "(none)")
|
||||
end
|
||||
|
||||
return ui.Table(rows):area(job.area):row(1):col(1):col_style(styles.row_value):widths({
|
||||
ui.Constraint.Length(label_max_length),
|
||||
ui.Constraint.Fill(1),
|
||||
})
|
||||
end
|
||||
|
||||
function M:peek(job)
|
||||
local start, cache = os.clock(), ya.file_cache(job)
|
||||
if not cache or not self:preload(job) then
|
||||
return 1
|
||||
end
|
||||
ya.sleep(math.max(0, rt.preview.image_delay / 1000 + start - os.clock()))
|
||||
ya.preview_widget(job, { self:render_table(job) })
|
||||
end
|
||||
|
||||
function M:seek(job)
|
||||
local h = cx.active.current.hovered
|
||||
if h and h.url == job.file.url then
|
||||
local step = math.floor(job.units * job.area.h / 10)
|
||||
ya.emit("peek", {
|
||||
tostring(math.max(0, cx.active.preview.skip + step)),
|
||||
only_if = tostring(job.file.url),
|
||||
})
|
||||
end
|
||||
end
|
||||
|
||||
function M:preload(job)
|
||||
local cache = ya.file_cache(job)
|
||||
if not cache or fs.cha(cache) then
|
||||
return true
|
||||
end
|
||||
return true
|
||||
end
|
||||
|
||||
function M:spot(job)
|
||||
job.area = ui.Pos({ "center", w = 80, h = 25 })
|
||||
ya.spot_table(
|
||||
job,
|
||||
self
|
||||
:render_table(job, { show_plugins_section = true })
|
||||
:cell_style(th.spot.tbl_cell or ui.Style():fg("blue"):reverse())
|
||||
)
|
||||
end
|
||||
|
||||
return M
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2023 yazi-rs
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,32 @@
|
||||
# full-border.yazi
|
||||
|
||||
Add a full border to Yazi to make it look fancier.
|
||||
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
ya pkg add yazi-rs/plugins:full-border
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Add this to your `init.lua` to enable the plugin:
|
||||
|
||||
```lua
|
||||
require("full-border"):setup()
|
||||
```
|
||||
|
||||
Or you can customize the border type:
|
||||
|
||||
```lua
|
||||
require("full-border"):setup {
|
||||
-- Available values: ui.Border.PLAIN, ui.Border.ROUNDED
|
||||
type = ui.Border.ROUNDED,
|
||||
}
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
This plugin is MIT-licensed. For more information check the [LICENSE](LICENSE) file.
|
||||
@@ -0,0 +1,43 @@
|
||||
--- @since 25.2.26
|
||||
|
||||
local function setup(_, opts)
|
||||
local type = opts and opts.type or ui.Border.ROUNDED
|
||||
local old_build = Tab.build
|
||||
|
||||
Tab.build = function(self, ...)
|
||||
local bar = function(c, x, y)
|
||||
if x <= 0 or x == self._area.w - 1 or th.mgr.border_symbol ~= "│" then
|
||||
return ui.Bar(ui.Edge.TOP)
|
||||
end
|
||||
|
||||
return ui.Bar(ui.Edge.TOP)
|
||||
:area(
|
||||
ui.Rect { x = x, y = math.max(0, y), w = ya.clamp(0, self._area.w - x, 1), h = math.min(1, self._area.h) }
|
||||
)
|
||||
:symbol(c)
|
||||
end
|
||||
|
||||
local c = self._chunks
|
||||
self._chunks = {
|
||||
c[1]:pad(ui.Pad.y(1)),
|
||||
c[2]:pad(ui.Pad(1, c[3].w > 0 and 0 or 1, 1, c[1].w > 0 and 0 or 1)),
|
||||
c[3]:pad(ui.Pad.y(1)),
|
||||
}
|
||||
|
||||
local style = th.mgr.border_style
|
||||
self._base = ya.list_merge(self._base or {}, {
|
||||
ui.Border(ui.Edge.ALL):area(self._area):type(type):style(style),
|
||||
ui.Bar(ui.Edge.RIGHT):area(self._chunks[1]):style(style),
|
||||
ui.Bar(ui.Edge.LEFT):area(self._chunks[3]):style(style),
|
||||
|
||||
bar("┬", c[1].right - 1, c[1].y),
|
||||
bar("┴", c[1].right - 1, c[1].bottom - 1),
|
||||
bar("┬", c[2].right, c[2].y),
|
||||
bar("┴", c[2].right, c[2].bottom - 1),
|
||||
})
|
||||
|
||||
old_build(self, ...)
|
||||
end
|
||||
end
|
||||
|
||||
return { setup = setup }
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2023 yazi-rs
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,78 @@
|
||||
# git.yazi
|
||||
|
||||
Show the status of Git file changes as linemode in the file list.
|
||||
|
||||
https://github.com/user-attachments/assets/34976be9-a871-4ffe-9d5a-c4cdd0bf4576
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
ya pkg add yazi-rs/plugins:git
|
||||
```
|
||||
|
||||
## Setup
|
||||
|
||||
Add the following to your `~/.config/yazi/init.lua`:
|
||||
|
||||
```lua
|
||||
require("git"):setup()
|
||||
```
|
||||
|
||||
And register it as fetchers in your `~/.config/yazi/yazi.toml`:
|
||||
|
||||
```toml
|
||||
[[plugin.prepend_fetchers]]
|
||||
id = "git"
|
||||
url = "*"
|
||||
run = "git"
|
||||
|
||||
[[plugin.prepend_fetchers]]
|
||||
id = "git"
|
||||
url = "*/"
|
||||
run = "git"
|
||||
```
|
||||
|
||||
## Advanced
|
||||
|
||||
> [!NOTE]
|
||||
> The following configuration must be put before `require("git"):setup()`
|
||||
|
||||
You can customize the [Style](https://yazi-rs.github.io/docs/plugins/layout#style) of the status sign with:
|
||||
|
||||
- `th.git.modified`
|
||||
- `th.git.added`
|
||||
- `th.git.untracked`
|
||||
- `th.git.ignored`
|
||||
- `th.git.deleted`
|
||||
- `th.git.updated`
|
||||
|
||||
For example:
|
||||
|
||||
```lua
|
||||
-- ~/.config/yazi/init.lua
|
||||
th.git = th.git or {}
|
||||
th.git.modified = ui.Style():fg("blue")
|
||||
th.git.deleted = ui.Style():fg("red"):bold()
|
||||
```
|
||||
|
||||
You can also customize the text of the status sign with:
|
||||
|
||||
- `th.git.modified_sign`
|
||||
- `th.git.added_sign`
|
||||
- `th.git.untracked_sign`
|
||||
- `th.git.ignored_sign`
|
||||
- `th.git.deleted_sign`
|
||||
- `th.git.updated_sign`
|
||||
|
||||
For example:
|
||||
|
||||
```lua
|
||||
-- ~/.config/yazi/init.lua
|
||||
th.git = th.git or {}
|
||||
th.git.modified_sign = "M"
|
||||
th.git.deleted_sign = "D"
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
This plugin is MIT-licensed. For more information check the [LICENSE](LICENSE) file.
|
||||
@@ -0,0 +1,255 @@
|
||||
--- @since 25.12.29
|
||||
|
||||
local WINDOWS = ya.target_family() == "windows"
|
||||
|
||||
-- The code of supported git status,
|
||||
-- also used to determine which status to show for directories when they contain different statuses
|
||||
-- see `bubble_up`
|
||||
---@enum CODES
|
||||
local CODES = {
|
||||
excluded = 100, -- ignored directory
|
||||
ignored = 6, -- ignored file
|
||||
untracked = 5,
|
||||
modified = 4,
|
||||
added = 3,
|
||||
deleted = 2,
|
||||
updated = 1,
|
||||
unknown = 0,
|
||||
}
|
||||
|
||||
local PATTERNS = {
|
||||
{ "!$", CODES.ignored },
|
||||
{ "?$", CODES.untracked },
|
||||
{ "[MT]", CODES.modified },
|
||||
{ "[AC]", CODES.added },
|
||||
{ "D", CODES.deleted },
|
||||
{ "U", CODES.updated },
|
||||
{ "[AD][AD]", CODES.updated },
|
||||
}
|
||||
|
||||
---@param line string
|
||||
---@return CODES, string
|
||||
local function match(line)
|
||||
local signs = line:sub(1, 2)
|
||||
for _, p in ipairs(PATTERNS) do
|
||||
local path, pattern, code = nil, p[1], p[2]
|
||||
if signs:find(pattern) then
|
||||
path = line:sub(4, 4) == '"' and line:sub(5, -2) or line:sub(4)
|
||||
path = WINDOWS and path:gsub("/", "\\") or path
|
||||
end
|
||||
if not path then
|
||||
elseif path:find("[/\\]$") then
|
||||
-- Mark the ignored directory as `excluded`, so we can process it further within `propagate_down`
|
||||
return code == CODES.ignored and CODES.excluded or code, path:sub(1, -2)
|
||||
else
|
||||
return code, path
|
||||
end
|
||||
---@diagnostic disable-next-line: missing-return
|
||||
end
|
||||
end
|
||||
|
||||
---@param cwd Url
|
||||
---@return string?
|
||||
local function root(cwd)
|
||||
local is_worktree = function(url)
|
||||
local file, head = io.open(tostring(url)), nil
|
||||
if file then
|
||||
head = file:read(8)
|
||||
file:close()
|
||||
end
|
||||
return head == "gitdir: "
|
||||
end
|
||||
|
||||
repeat
|
||||
local next = cwd:join(".git")
|
||||
local cha = fs.cha(next)
|
||||
if cha and (cha.is_dir or is_worktree(next)) then
|
||||
return tostring(cwd)
|
||||
end
|
||||
cwd = cwd.parent
|
||||
until not cwd
|
||||
end
|
||||
|
||||
---@param changed Changes
|
||||
---@return Changes
|
||||
local function bubble_up(changed)
|
||||
local new, empty = {}, Url("")
|
||||
for path, code in pairs(changed) do
|
||||
if code ~= CODES.ignored then
|
||||
local url = Url(path).parent
|
||||
while url and url ~= empty do
|
||||
local s = tostring(url)
|
||||
new[s] = (new[s] or CODES.unknown) > code and new[s] or code
|
||||
url = url.parent
|
||||
end
|
||||
end
|
||||
end
|
||||
return new
|
||||
end
|
||||
|
||||
---@param excluded string[]
|
||||
---@param cwd Url
|
||||
---@param repo Url
|
||||
---@return Changes
|
||||
local function propagate_down(excluded, cwd, repo)
|
||||
local new, rel = {}, cwd:strip_prefix(repo)
|
||||
for _, path in ipairs(excluded) do
|
||||
if rel:starts_with(path) then
|
||||
-- If `cwd` is a subdirectory of an excluded directory, also mark it as `excluded`
|
||||
new[tostring(cwd)] = CODES.excluded
|
||||
elseif cwd == repo:join(path).parent then
|
||||
-- If `path` is a direct subdirectory of `cwd`, mark it as `ignored`
|
||||
new[path] = CODES.ignored
|
||||
else
|
||||
-- Skipping, we only care about `cwd` itself and its direct subdirectories for maximum performance
|
||||
end
|
||||
end
|
||||
return new
|
||||
end
|
||||
|
||||
---@param cwd string
|
||||
---@param repo string
|
||||
---@param changed Changes
|
||||
local add = ya.sync(function(st, cwd, repo, changed)
|
||||
---@cast st State
|
||||
|
||||
st.dirs[cwd] = repo
|
||||
st.repos[repo] = st.repos[repo] or {}
|
||||
for path, code in pairs(changed) do
|
||||
if code == CODES.unknown then
|
||||
st.repos[repo][path] = nil
|
||||
elseif code == CODES.excluded then
|
||||
-- Mark the directory with a special value `excluded` so that it can be distinguished during UI rendering
|
||||
st.dirs[path] = CODES.excluded
|
||||
else
|
||||
st.repos[repo][path] = code
|
||||
end
|
||||
end
|
||||
ui.render()
|
||||
end)
|
||||
|
||||
---@param cwd string
|
||||
local remove = ya.sync(function(st, cwd)
|
||||
---@cast st State
|
||||
|
||||
local repo = st.dirs[cwd]
|
||||
if not repo then
|
||||
return
|
||||
end
|
||||
|
||||
ui.render()
|
||||
st.dirs[cwd] = nil
|
||||
if not st.repos[repo] then
|
||||
return
|
||||
end
|
||||
|
||||
for _, r in pairs(st.dirs) do
|
||||
if r == repo then
|
||||
return
|
||||
end
|
||||
end
|
||||
st.repos[repo] = nil
|
||||
end)
|
||||
|
||||
---@param st State
|
||||
---@param opts Options
|
||||
local function setup(st, opts)
|
||||
st.dirs = {}
|
||||
st.repos = {}
|
||||
|
||||
opts = opts or {}
|
||||
opts.order = opts.order or 1500
|
||||
|
||||
local t = th.git or {}
|
||||
local styles = {
|
||||
[CODES.ignored] = t.ignored and ui.Style(t.ignored) or ui.Style():fg("darkgray"),
|
||||
[CODES.untracked] = t.untracked and ui.Style(t.untracked) or ui.Style():fg("magenta"),
|
||||
[CODES.modified] = t.modified and ui.Style(t.modified) or ui.Style():fg("yellow"),
|
||||
[CODES.added] = t.added and ui.Style(t.added) or ui.Style():fg("green"),
|
||||
[CODES.deleted] = t.deleted and ui.Style(t.deleted) or ui.Style():fg("red"),
|
||||
[CODES.updated] = t.updated and ui.Style(t.updated) or ui.Style():fg("yellow"),
|
||||
}
|
||||
local signs = {
|
||||
[CODES.ignored] = t.ignored_sign or " ",
|
||||
[CODES.untracked] = t.untracked_sign or "? ",
|
||||
[CODES.modified] = t.modified_sign or " ",
|
||||
[CODES.added] = t.added_sign or " ",
|
||||
[CODES.deleted] = t.deleted_sign or " ",
|
||||
[CODES.updated] = t.updated_sign or " ",
|
||||
}
|
||||
|
||||
Linemode:children_add(function(self)
|
||||
if not self._file.in_current then
|
||||
return ""
|
||||
end
|
||||
|
||||
local url = self._file.url
|
||||
local repo = st.dirs[tostring(url.base or url.parent)]
|
||||
local code
|
||||
if repo then
|
||||
code = repo == CODES.excluded and CODES.ignored or st.repos[repo][tostring(url):sub(#repo + 2)]
|
||||
end
|
||||
|
||||
if not code or signs[code] == "" then
|
||||
return ""
|
||||
elseif self._file.is_hovered then
|
||||
return ui.Line { " ", signs[code] }
|
||||
else
|
||||
return ui.Line { " ", ui.Span(signs[code]):style(styles[code]) }
|
||||
end
|
||||
end, opts.order)
|
||||
end
|
||||
|
||||
---@type UnstableFetcher
|
||||
local function fetch(_, job)
|
||||
local cwd = job.files[1].url.base or job.files[1].url.parent
|
||||
local repo = root(cwd)
|
||||
if not repo then
|
||||
remove(tostring(cwd))
|
||||
return true
|
||||
end
|
||||
|
||||
local paths = {}
|
||||
for _, file in ipairs(job.files) do
|
||||
paths[#paths + 1] = tostring(file.url)
|
||||
end
|
||||
|
||||
-- stylua: ignore
|
||||
local output, err = Command("git")
|
||||
:cwd(tostring(cwd))
|
||||
:arg({ "--no-optional-locks", "-c", "core.quotePath=", "status", "--porcelain", "-unormal", "--no-renames", "--ignored=matching" })
|
||||
:arg(paths)
|
||||
:stdout(Command.PIPED)
|
||||
:output()
|
||||
if not output then
|
||||
return true, Err("Cannot spawn `git` command, error: %s", err)
|
||||
end
|
||||
|
||||
local changed, excluded = {}, {}
|
||||
for line in output.stdout:gmatch("[^\r\n]+") do
|
||||
local code, path = match(line)
|
||||
if code == CODES.excluded then
|
||||
excluded[#excluded + 1] = path
|
||||
else
|
||||
changed[path] = code
|
||||
end
|
||||
end
|
||||
|
||||
if job.files[1].cha.is_dir then
|
||||
ya.dict_merge(changed, bubble_up(changed))
|
||||
end
|
||||
ya.dict_merge(changed, propagate_down(excluded, cwd, Url(repo)))
|
||||
|
||||
-- Reset the status of any files that don't appear in the output of `git status` to `unknown`,
|
||||
-- so that cleaning up outdated statuses from `st.repos`
|
||||
for _, path in ipairs(paths) do
|
||||
local s = path:sub(#repo + 2)
|
||||
changed[s] = changed[s] or CODES.unknown
|
||||
end
|
||||
|
||||
add(tostring(cwd), repo, changed)
|
||||
|
||||
return false
|
||||
end
|
||||
|
||||
return { setup = setup, fetch = fetch }
|
||||
@@ -0,0 +1,12 @@
|
||||
---@class State
|
||||
---@field dirs table<string, string|CODES> Mapping between a directory and its corresponding repository
|
||||
---@field repos table<string, Changes> Mapping between a repository and the status of each of its files
|
||||
|
||||
---@class Options
|
||||
---@field order number The order in which the status is displayed
|
||||
---@field renamed boolean Whether to include renamed files in the status (or treat them as modified)
|
||||
|
||||
-- TODO: move this to `types.yazi` once it's get stable
|
||||
---@alias UnstableFetcher fun(self: unknown, job: { files: File[] }): boolean, Error?
|
||||
|
||||
---@alias Changes table<string, CODES>
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2024 Darius
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,31 @@
|
||||
# lazygit.yazi
|
||||
Plugin for [Yazi](https://github.com/sxyazi/yazi) to manage git repos with [lazygit](https://github.com/jesseduffield/lazygit)
|
||||
## Dependencies
|
||||
Make sure [lazygit](https://github.com/jesseduffield/lazygit) is installed and in your `PATH`.
|
||||
## Installation
|
||||
|
||||
### Using `ya pkg`
|
||||
```
|
||||
ya pkg add Lil-Dank/lazygit
|
||||
```
|
||||
|
||||
### Manual
|
||||
**Linux/macOS**
|
||||
```
|
||||
git clone https://github.com/Lil-Dank/lazygit.yazi.git ~/.config/yazi/plugins/lazygit.yazi
|
||||
```
|
||||
**Windows**
|
||||
```
|
||||
git clone https://github.com/Lil-Dank/lazygit.yazi.git %AppData%\yazi\config\plugins\lazygit.yazi
|
||||
```
|
||||
## Configuration
|
||||
add this to your **keymap.toml** file
|
||||
```toml
|
||||
[[mgr.prepend_keymap]]
|
||||
on = [ "g", "i" ]
|
||||
run = "plugin lazygit"
|
||||
desc = "run lazygit"
|
||||
```
|
||||
you can customize the keybinding however you like. Please refer to the [keymap.toml](https://yazi-rs.github.io/docs/configuration/keymap) documentation
|
||||
## Disclaimer
|
||||
**THIS PLUGIN IS FOR THE STABLE RELEASE OF YAZI, DON'T PROPOSE ANY CHANGES BASED ON PRE-RELEASES OF YAZI**
|
||||
@@ -0,0 +1,34 @@
|
||||
return {
|
||||
entry = function()
|
||||
local output = Command("git"):arg("status"):stderr(Command.PIPED):output()
|
||||
if output.stderr ~= "" then
|
||||
ya.notify({
|
||||
title = "lazygit",
|
||||
content = "Not in a git directory\nError: " .. output.stderr,
|
||||
level = "warn",
|
||||
timeout = 5,
|
||||
})
|
||||
else
|
||||
permit = ui.hide and ui.hide() or ya.hide()
|
||||
local output, err_code = Command("lazygit"):stdin(Command.INHERIT):stdout(Command.INHERIT):stderr(Command.PIPED):spawn()
|
||||
if output and not err_code then
|
||||
output, err_code = output:wait_with_output()
|
||||
end
|
||||
if err_code ~= nil then
|
||||
ya.notify({
|
||||
title = "Failed to run lazygit command",
|
||||
content = "Status: " .. err_code,
|
||||
level = "error",
|
||||
timeout = 5,
|
||||
})
|
||||
elseif not output.status.success then
|
||||
ya.notify({
|
||||
title = "lazygit in" .. cwd .. "failed, exit code " .. output.status.code,
|
||||
content = output.stderr,
|
||||
level = "error",
|
||||
timeout = 5,
|
||||
})
|
||||
end
|
||||
end
|
||||
end,
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
Copyright (c) 2024 Lauri Niskanen
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,135 @@
|
||||
# mediainfo.yazi (fork)
|
||||
|
||||
<!--toc:start-->
|
||||
|
||||
- [mediainfo.yazi (fork)](#mediainfoyazi-fork)
|
||||
- [Preview](#preview)
|
||||
- [Installation](#installation)
|
||||
- [Configuration:](#configuration)
|
||||
- [Custom theme](#custom-theme)
|
||||
<!--toc:end-->
|
||||
|
||||
This is a Yazi plugin for previewing media files. The preview shows thumbnail
|
||||
using `ffmpeg` if available and media metadata using `mediainfo`.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Minimum version: yazi v25.5.31.
|
||||
|
||||
## Preview
|
||||
|
||||
- Video
|
||||
|
||||
|
||||
|
||||
- Audio file with cover
|
||||
|
||||
|
||||
|
||||
- Images
|
||||
|
||||
|
||||
|
||||
- Subtitle
|
||||
|
||||
|
||||
|
||||
- SVG+XML file doesn't have useful information, so it only show the image preview.
|
||||
- There are more file extensions which are supported by mediainfo. Just add file's MIME type to `prepend_previewers`, `prepend_preloaders`.
|
||||
Use `spotter` to determine File's MIME type. [Default is `<Tab>` key](https://github.com/sxyazi/yazi/blob/1a6abae974370702c8865459344bf256de58359e/yazi-config/preset/keymap-default.toml#L59)
|
||||
|
||||
## Installation
|
||||
|
||||
- Install mediainfo CLI:
|
||||
- [https://mediaarea.net/en/MediaInfo/Download](https://mediaarea.net/en/MediaInfo/Download)
|
||||
- Run this command in terminal to check if it's installed correctly:
|
||||
|
||||
```bash
|
||||
mediainfo --version
|
||||
```
|
||||
|
||||
If it output `Not found` then add it to your PATH environment variable. It's better to ask ChatGPT to help you (Prompt: `Add MediaInfo CLI to PATH environment variable in Windows`).
|
||||
|
||||
- Install ImageMagick (for linux, you can use your distro package manager to install):
|
||||
https://imagemagick.org/script/download.php
|
||||
- Install this plugin:
|
||||
|
||||
```bash
|
||||
ya pkg add boydaihungst/mediainfo
|
||||
```
|
||||
|
||||
## Configuration:
|
||||
|
||||
> [!IMPORTANT]
|
||||
>
|
||||
> `mediainfo` use built-in video, image, svg, magick plugins behind the scene to render preview image, song cover.
|
||||
> So you can remove those 4 plugins from `prepend_preloaders` and `prepend_previewers` sections in `yazi.toml`.
|
||||
|
||||
If you have cache problem, run this cmd, and follow the tips: `yazi --clear-cache`
|
||||
|
||||
Config folder for each OS: https://yazi-rs.github.io/docs/configuration/overview.
|
||||
|
||||
Create `.../yazi/yazi.toml` and add:
|
||||
|
||||
> [!IMPORTANT]
|
||||
>
|
||||
> For yazi (>=v25.12.29) replace `name` with `url`
|
||||
|
||||
```toml
|
||||
[plugin]
|
||||
prepend_preloaders = [
|
||||
# Replace magick, image, video with mediainfo
|
||||
{ mime = "{audio,video,image}/*", run = "mediainfo" },
|
||||
{ mime = "application/subrip", run = "mediainfo" },
|
||||
# Adobe Illustrator, Adobe Photoshop is image/adobe.photoshop, already handled above
|
||||
{ mime = "application/postscript", run = "mediainfo" },
|
||||
]
|
||||
prepend_previewers = [
|
||||
# Replace magick, image, video with mediainfo
|
||||
{ mime = "{audio,video,image}/*", run = "mediainfo"},
|
||||
{ mime = "application/subrip", run = "mediainfo" },
|
||||
# Adobe Illustrator, Adobe Photoshop is image/adobe.photoshop, already handled above
|
||||
{ mime = "application/postscript", run = "mediainfo" },
|
||||
]
|
||||
# There are more extensions which are supported by mediainfo.
|
||||
# Just add file's MIME type to `previewers`, `preloaders` above.
|
||||
# https://mediaarea.net/en/MediaInfo/Support/Formats
|
||||
|
||||
# For a large file like Adobe Illustrator, Adobe Photoshop, etc
|
||||
# you may need to increase the memory limit if no image is rendered.
|
||||
# https://yazi-rs.github.io/docs/configuration/yazi#tasks
|
||||
[tasks]
|
||||
image_alloc = 1073741824 # = 1024*1024*1024 = 1024MB
|
||||
|
||||
```
|
||||
|
||||
## Custom theme
|
||||
|
||||
Using the same style with spotter. [Read more](https://github.com/sxyazi/yazi/pull/2391)
|
||||
|
||||
Edit or add `yazi/theme.toml`:
|
||||
|
||||
```toml
|
||||
[spot]
|
||||
# Section header style.
|
||||
# Example: Video, Text, Image,... with green color in preview images above
|
||||
title = { fg = "green" }
|
||||
|
||||
# Value style.
|
||||
# Example: `Format: FLAC` with blue color in preview images above
|
||||
tbl_col = { fg = "blue" }
|
||||
```
|
||||
|
||||
## (Optional) Keymaps to hide metadata and to preview images in full screen
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Use any key you want, but make sure there is no conflicts with [default Keybindings](https://github.com/sxyazi/yazi/blob/main/yazi-config/preset/keymap-default.toml).
|
||||
|
||||
Since Yazi prioritizes the first matching key, `prepend_keymap` takes precedence over defaults.
|
||||
Or you can use `keymap` to replace all other keys
|
||||
|
||||
```toml
|
||||
[mgr]
|
||||
prepend_keymap = [
|
||||
{ on = "<F9>", run = "plugin mediainfo -- toggle-metadata", desc = "Toggle media preview metadata" },
|
||||
]
|
||||
```
|
||||
@@ -0,0 +1,302 @@
|
||||
--- @since 26.1.22
|
||||
|
||||
local M = {}
|
||||
local const = require(".const")
|
||||
local utils = require(".utils")
|
||||
|
||||
local function image_layer_count(job)
|
||||
local cache = ya.file_cache({ file = job.file, skip = 0 })
|
||||
if not cache then
|
||||
return 0
|
||||
end
|
||||
local layer_count = utils.get_state("f" .. tostring(cache))
|
||||
if layer_count then
|
||||
return layer_count
|
||||
end
|
||||
local output, err = Command("identify")
|
||||
:arg({ tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url) })
|
||||
:output()
|
||||
if err or not output then
|
||||
return 0
|
||||
end
|
||||
layer_count = 0
|
||||
for line in output.stdout:gmatch("[^\r\n]+") do
|
||||
if line:match("%S") then
|
||||
layer_count = layer_count + 1
|
||||
end
|
||||
end
|
||||
utils.set_state("f" .. tostring(cache), layer_count)
|
||||
return layer_count
|
||||
end
|
||||
|
||||
function M:peek(job)
|
||||
local preload_status, preload_err = self:preload(job)
|
||||
-- Stop if preload failed
|
||||
if not preload_status then
|
||||
return
|
||||
end
|
||||
|
||||
local cache_img_url = ya.file_cache(job)
|
||||
|
||||
local cache_img_url_no_skip = ya.file_cache({ file = job.file, skip = 0 })
|
||||
|
||||
local no_metadata = job.args.no_metadata
|
||||
local mediainfo_job_skip = job.skip
|
||||
::recalc_mediainfo_job_skip::
|
||||
local mediainfo_height = 0
|
||||
local lines = {}
|
||||
local limit = job.area.h
|
||||
local last_line = 0
|
||||
local EOF_mediainfo = true
|
||||
local is_wrap = rt.preview.wrap == "yes" or rt.preview.wrap == ui.Wrap.YES
|
||||
|
||||
if not no_metadata then
|
||||
local cache_mediainfo_path = tostring(cache_img_url_no_skip) .. const.suffix
|
||||
local output = utils.read_mediainfo_cached_file(cache_mediainfo_path)
|
||||
if output then
|
||||
local max_width = math.max(1, job.area.w)
|
||||
if output:match("^Error:") then
|
||||
job.args.force_reload_mediainfo = true
|
||||
preload_status, preload_err = self:preload(job)
|
||||
if not preload_status or preload_err then
|
||||
return
|
||||
end
|
||||
output = utils.read_mediainfo_cached_file(cache_mediainfo_path)
|
||||
end
|
||||
|
||||
output = output:gsub("\n+$", "")
|
||||
|
||||
local iter = output:gmatch("[^\n]*")
|
||||
local str = iter()
|
||||
|
||||
while str ~= nil do
|
||||
local next_str = iter()
|
||||
local label, value = str:match("(.*[^ ]) +: (.*)")
|
||||
local line
|
||||
if label then
|
||||
if not (utils.get_state(const.STATE_KEY.skip_labels) or const.skip_labels)[label] then
|
||||
line = ui.Line({
|
||||
ui.Span(label .. ": "):style(ui.Style():fg("reset"):bold()),
|
||||
ui.Span(value):style(th.spot.tbl_col or ui.Style():fg("blue")),
|
||||
})
|
||||
end
|
||||
else
|
||||
if not (utils.get_state(const.STATE_KEY.skip_section_labels) or {})[str] then
|
||||
line = ui.Line({ ui.Span(str):style(th.spot.title or ui.Style():fg("green")) })
|
||||
end
|
||||
end
|
||||
|
||||
if line then
|
||||
local line_height = ui.height
|
||||
and ui.height(str, { width = max_width, ansi = true, wrap = rt.preview.wrap })
|
||||
or (math.max(1, is_wrap and math.ceil(ui.width(line) / max_width) or 1))
|
||||
if next_str == nil and line_height == 1 then
|
||||
EOF_mediainfo = true
|
||||
end
|
||||
if (last_line + line_height) > mediainfo_job_skip then
|
||||
table.insert(lines, line)
|
||||
end
|
||||
if (last_line + line_height) >= mediainfo_job_skip + limit then
|
||||
last_line = mediainfo_job_skip + limit
|
||||
EOF_mediainfo = false
|
||||
break
|
||||
end
|
||||
last_line = last_line + line_height
|
||||
end
|
||||
str = next_str
|
||||
end
|
||||
end
|
||||
mediainfo_height = math.min(limit, last_line)
|
||||
end
|
||||
|
||||
if not no_metadata then
|
||||
if EOF_mediainfo and #lines == 0 and mediainfo_job_skip > 0 then
|
||||
if
|
||||
image_layer_count(job)
|
||||
< (
|
||||
1
|
||||
+ math.floor(
|
||||
math.max(
|
||||
0,
|
||||
utils.get_state(const.STATE_KEY.units)
|
||||
and (math.abs(job.skip / utils.get_state(const.STATE_KEY.units)))
|
||||
or 0
|
||||
)
|
||||
)
|
||||
)
|
||||
then
|
||||
ya.emit("peek", {
|
||||
math.max(0, (job.skip - (utils.get_state(const.STATE_KEY.units) or 0))),
|
||||
only_if = job.file.url,
|
||||
upper_bound = true,
|
||||
})
|
||||
return
|
||||
else
|
||||
local last_valid_mediainfo_skip = utils.get_state(const.STATE_KEY.last_valid_mediainfo_skip)
|
||||
mediainfo_job_skip = last_valid_mediainfo_skip
|
||||
and last_valid_mediainfo_skip[tostring(cache_img_url_no_skip)]
|
||||
or math.max(0, mediainfo_job_skip - (utils.get_state(const.STATE_KEY.units) or 0))
|
||||
|
||||
goto recalc_mediainfo_job_skip
|
||||
end
|
||||
else
|
||||
utils.set_state(
|
||||
const.STATE_KEY.last_valid_mediainfo_skip,
|
||||
{ [tostring(cache_img_url_no_skip)] = mediainfo_job_skip }
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
-- NOTE: Hacky way to prevent image overlap with old metadata area
|
||||
if utils.get_state(const.STATE_KEY.prev_metadata_area) then
|
||||
local old_metadata_area = utils.get_state(const.STATE_KEY.prev_metadata_area)
|
||||
if
|
||||
old_metadata_area.win_x == job.area.x
|
||||
and old_metadata_area.win_y == job.area.y
|
||||
and old_metadata_area.win_w == job.area.w
|
||||
and old_metadata_area.win_h == job.area.h
|
||||
then
|
||||
ya.preview_widget(job, {
|
||||
ui.Clear(ui.Rect({
|
||||
x = old_metadata_area.x,
|
||||
y = old_metadata_area.y,
|
||||
w = old_metadata_area.w,
|
||||
h = old_metadata_area.h,
|
||||
})),
|
||||
})
|
||||
end
|
||||
end
|
||||
utils.force_render()
|
||||
|
||||
local rendered_img_rect = cache_img_url
|
||||
and fs.cha(cache_img_url)
|
||||
and ya.image_show(
|
||||
cache_img_url,
|
||||
ui.Rect({
|
||||
x = job.area.x,
|
||||
y = job.area.y,
|
||||
w = job.area.w,
|
||||
h = mediainfo_height > 0 and math.max(job.area.h - mediainfo_height, job.area.h / 2) or job.area.h,
|
||||
})
|
||||
)
|
||||
or nil
|
||||
local image_height = rendered_img_rect and rendered_img_rect.h or 0
|
||||
|
||||
-- Handle image preload error
|
||||
if preload_err then
|
||||
table.insert(lines, ui.Line(tostring(preload_err)):style(th.spot.title or ui.Style():fg("red")))
|
||||
end
|
||||
|
||||
ya.preview_widget(job, {
|
||||
ui.Text(lines)
|
||||
:area(ui.Rect({
|
||||
x = job.area.x,
|
||||
y = job.area.y + image_height,
|
||||
w = job.area.w,
|
||||
h = job.area.h - image_height,
|
||||
}))
|
||||
:wrap(is_wrap and ui.Wrap.YES or ui.Wrap.NO),
|
||||
})
|
||||
|
||||
-- NOTE: Hacky way to prevent image overlap with old metadata area
|
||||
utils.set_state(const.STATE_KEY.prev_metadata_area, not no_metadata and {
|
||||
x = job.area.x,
|
||||
y = job.area.y + image_height,
|
||||
w = job.area.w,
|
||||
h = job.area.h - image_height,
|
||||
win_x = job.area.x,
|
||||
win_y = job.area.y,
|
||||
win_w = job.area.w,
|
||||
win_h = job.area.h,
|
||||
} or nil)
|
||||
end
|
||||
|
||||
function M:preload(job)
|
||||
local cmd = "mediainfo"
|
||||
local err_msg = ""
|
||||
local is_valid_utf8_path = utils.is_valid_utf8(tostring(job.file.path or job.file.cache or job.file.url))
|
||||
|
||||
-- NOTE: Preload image
|
||||
|
||||
local cache_img_url = ya.file_cache(job)
|
||||
local cache_img_url_cha = cache_img_url and fs.cha(cache_img_url)
|
||||
|
||||
-- NOTE: Only generate preview image when cache image is not exist
|
||||
if not cache_img_url_cha or cache_img_url_cha.len <= 0 then
|
||||
local cache_img_status, image_preload_err
|
||||
local layer_index = 0
|
||||
local units = utils.get_state(const.STATE_KEY.units)
|
||||
if units ~= nil then
|
||||
local max_layer = image_layer_count(job)
|
||||
layer_index = math.floor(math.max(0, math.abs(job.skip / units)))
|
||||
if layer_index + 1 > max_layer then
|
||||
layer_index = math.max(0, max_layer - 1)
|
||||
end
|
||||
end
|
||||
local cache_img_url_tmp = Url(cache_img_url .. ".tmp")
|
||||
if fs.cha(cache_img_url_tmp) then
|
||||
fs.remove("file", cache_img_url_tmp)
|
||||
end
|
||||
local tmp_file_path, _ = type(fs.unique) == "function" and fs.unique("file", cache_img_url_tmp)
|
||||
or fs.unique_name(cache_img_url_tmp)
|
||||
cache_img_status, image_preload_err = require("magick")
|
||||
.with_limit()
|
||||
:arg({
|
||||
"-background",
|
||||
"none",
|
||||
tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url) .. "[" .. tostring(
|
||||
layer_index
|
||||
) .. "]",
|
||||
"-auto-orient",
|
||||
"-strip",
|
||||
"-resize",
|
||||
string.format("%dx%d>", rt.preview.max_width, rt.preview.max_height),
|
||||
"-quality",
|
||||
rt.preview.image_quality,
|
||||
string.format("PNG32:%s", tostring(tmp_file_path)),
|
||||
})
|
||||
:status()
|
||||
if cache_img_status then
|
||||
os.rename(tostring(tmp_file_path), tostring(cache_img_url))
|
||||
end
|
||||
|
||||
if not cache_img_status and image_preload_err then
|
||||
ya.dbg("mediainfo", image_preload_err)
|
||||
err_msg = err_msg .. (image_preload_err and (tostring(image_preload_err)) or "")
|
||||
end
|
||||
end
|
||||
|
||||
-- NOTE: Get mediainfo and save to cache folder
|
||||
local cache_mediainfo_url = Url(tostring(ya.file_cache({ file = job.file, skip = 0 })) .. const.suffix)
|
||||
local cache_mediainfo_cha = fs.cha(cache_mediainfo_url)
|
||||
-- Case peek function called preload to refetch mediainfo
|
||||
if cache_mediainfo_cha and not job.args.force_reload_mediainfo then
|
||||
return true, err_msg ~= "" and ("Error: " .. err_msg) or nil
|
||||
end
|
||||
|
||||
local output, err
|
||||
if is_valid_utf8_path then
|
||||
output, err = Command(cmd)
|
||||
:arg({ tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url) })
|
||||
:output()
|
||||
else
|
||||
cmd = "cd "
|
||||
.. utils.path_quote(tostring((job.file.path or job.file.cache or job.file.url.path or job.file.url).parent))
|
||||
.. " && "
|
||||
.. cmd
|
||||
.. " "
|
||||
.. utils.path_quote(tostring((job.file.path or job.file.cache or job.file.url).name))
|
||||
output, err = Command(const.SHELL):arg({ "-c", cmd }):output()
|
||||
end
|
||||
if err then
|
||||
ya.dbg("mediainfo", tostring(err))
|
||||
err_msg = err_msg .. string.format("Failed to start `%s`. \n Do you have `%s` installed?\n", cmd, cmd)
|
||||
end
|
||||
|
||||
return fs.write(
|
||||
cache_mediainfo_url,
|
||||
(err_msg ~= "" and ("Error: " .. err_msg) or "") .. (output and output.stdout or "")
|
||||
)
|
||||
end
|
||||
|
||||
return M
|
||||
@@ -0,0 +1,338 @@
|
||||
--- @since 26.5.6
|
||||
|
||||
local M = {}
|
||||
local const = require(".const")
|
||||
local utils = require(".utils")
|
||||
|
||||
local function image_layer_count(job)
|
||||
local cache = ya.file_cache({ file = job.file, skip = 0 })
|
||||
if not cache then
|
||||
return 0
|
||||
end
|
||||
local layer_count = utils.get_state("f" .. tostring(cache))
|
||||
if layer_count then
|
||||
return layer_count
|
||||
end
|
||||
local output, err = Command("identify")
|
||||
:arg({ tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url) })
|
||||
:output()
|
||||
if err or not output then
|
||||
return 0
|
||||
end
|
||||
layer_count = 0
|
||||
for line in output.stdout:gmatch("[^\r\n]+") do
|
||||
if line:match("%S") then
|
||||
layer_count = layer_count + 1
|
||||
end
|
||||
end
|
||||
utils.set_state("f" .. tostring(cache), layer_count)
|
||||
return layer_count
|
||||
end
|
||||
|
||||
function M:peek(job)
|
||||
local preload_status, preload_err = self:preload(job)
|
||||
-- Stop if preload failed
|
||||
if not preload_status then
|
||||
return
|
||||
end
|
||||
|
||||
local cache_img_url = ya.file_cache(job)
|
||||
|
||||
local cache_img_url_no_skip = ya.file_cache({ file = job.file, skip = 0 })
|
||||
|
||||
local no_metadata = job.args.no_metadata
|
||||
local mediainfo_job_skip = job.skip
|
||||
::recalc_mediainfo_job_skip::
|
||||
local mediainfo_height = 0
|
||||
local lines = {}
|
||||
local limit = job.area.h
|
||||
local last_line = 0
|
||||
local EOF_mediainfo = true
|
||||
local is_wrap = rt.preview.wrap == "yes" or rt.preview.wrap == ui.Wrap.YES
|
||||
|
||||
if not no_metadata then
|
||||
local cache_mediainfo_path = tostring(cache_img_url_no_skip) .. const.suffix
|
||||
local output = utils.read_mediainfo_cached_file(cache_mediainfo_path)
|
||||
if output then
|
||||
local max_width = math.max(1, job.area.w)
|
||||
if output:match("^Error:") then
|
||||
job.args.force_reload_mediainfo = true
|
||||
preload_status, preload_err = self:preload(job)
|
||||
if not preload_status or preload_err then
|
||||
return
|
||||
end
|
||||
output = utils.read_mediainfo_cached_file(cache_mediainfo_path)
|
||||
end
|
||||
|
||||
output = output:gsub("\n+$", "")
|
||||
|
||||
local iter = output:gmatch("[^\n]*")
|
||||
local str = iter()
|
||||
local opt = { ansi = true, tab_size = rt.preview.tab_size, wrap = rt.preview.wrap, width = max_width }
|
||||
while str ~= nil do
|
||||
local next_str = iter()
|
||||
local label, value = str:match("(.*[^ ]) +: (.*)")
|
||||
|
||||
local line
|
||||
if label then
|
||||
if not (utils.get_state(const.STATE_KEY.skip_labels) or const.skip_labels)[label] then
|
||||
line = label .. ": " .. value
|
||||
end
|
||||
else
|
||||
if not (utils.get_state(const.STATE_KEY.skip_section_labels) or {})[str] then
|
||||
line = str
|
||||
end
|
||||
end
|
||||
|
||||
if line then
|
||||
local wrapped = ui.lines(line, opt)
|
||||
local line_height = #wrapped
|
||||
local from = 1
|
||||
local to = math.min(line_height, mediainfo_job_skip + limit - last_line)
|
||||
|
||||
local total_rendered_text_len = 1
|
||||
local total_label_rendered_len = 1
|
||||
local label_total_len = label and utf8.len(label .. ": ") or 0
|
||||
for j = from, to do
|
||||
local current_line_components = {}
|
||||
local wrapped_line_len = wrapped[j]:width() or 0
|
||||
local wrapped_raw =
|
||||
utils.utf8_sub(line, total_rendered_text_len, total_rendered_text_len + wrapped_line_len)
|
||||
wrapped_line_len = utf8.len(wrapped_raw)
|
||||
total_rendered_text_len = total_rendered_text_len + wrapped_line_len
|
||||
|
||||
if last_line + 1 > mediainfo_job_skip then
|
||||
local label_raw = label_total_len - total_label_rendered_len <= 0 and ""
|
||||
or utils.utf8_sub(wrapped_raw, 1, label_total_len - total_label_rendered_len)
|
||||
local label_raw_len = utf8.len(label_raw)
|
||||
if label_raw_len > 0 then
|
||||
table.insert(
|
||||
current_line_components,
|
||||
ui.Span(label_raw):style(ui.Style():fg("reset"):bold())
|
||||
)
|
||||
total_label_rendered_len = total_label_rendered_len + label_raw_len
|
||||
wrapped_raw = wrapped_raw:gsub("^" .. utils.is_literal_string(label_raw), "", 1)
|
||||
end
|
||||
if total_label_rendered_len >= label_total_len then
|
||||
local value_raw = wrapped_raw
|
||||
table.insert(
|
||||
current_line_components,
|
||||
ui.Span(value_raw or ""):style(
|
||||
label and (th.spot.tbl_col or ui.Style():fg("blue"))
|
||||
or (th.spot.title or ui.Style():fg("green"))
|
||||
)
|
||||
)
|
||||
end
|
||||
table.insert(lines, ui.Line(current_line_components))
|
||||
-- last_line = last_line + 1
|
||||
else
|
||||
total_label_rendered_len = total_label_rendered_len + total_rendered_text_len
|
||||
end
|
||||
last_line = last_line + 1
|
||||
if next_str == nil and not wrapped[j + 1] then
|
||||
EOF_mediainfo = true
|
||||
end
|
||||
if last_line >= mediainfo_job_skip + limit then
|
||||
last_line = mediainfo_job_skip + limit
|
||||
EOF_mediainfo = false
|
||||
break
|
||||
end
|
||||
end
|
||||
end
|
||||
str = next_str
|
||||
end
|
||||
end
|
||||
mediainfo_height = math.min(limit, last_line)
|
||||
end
|
||||
|
||||
if not no_metadata then
|
||||
if EOF_mediainfo and #lines == 0 and mediainfo_job_skip > 0 then
|
||||
if
|
||||
image_layer_count(job)
|
||||
< (
|
||||
1
|
||||
+ math.floor(
|
||||
math.max(
|
||||
0,
|
||||
utils.get_state(const.STATE_KEY.units)
|
||||
and (math.abs(job.skip / utils.get_state(const.STATE_KEY.units)))
|
||||
or 0
|
||||
)
|
||||
)
|
||||
)
|
||||
then
|
||||
ya.emit("peek", {
|
||||
math.max(0, (job.skip - (utils.get_state(const.STATE_KEY.units) or 0))),
|
||||
only_if = job.file.url,
|
||||
upper_bound = true,
|
||||
})
|
||||
return
|
||||
else
|
||||
local last_valid_mediainfo_skip = utils.get_state(const.STATE_KEY.last_valid_mediainfo_skip)
|
||||
mediainfo_job_skip = last_valid_mediainfo_skip
|
||||
and last_valid_mediainfo_skip[tostring(cache_img_url_no_skip)]
|
||||
or math.max(0, mediainfo_job_skip - (utils.get_state(const.STATE_KEY.units) or 0))
|
||||
|
||||
goto recalc_mediainfo_job_skip
|
||||
end
|
||||
else
|
||||
utils.set_state(
|
||||
const.STATE_KEY.last_valid_mediainfo_skip,
|
||||
{ [tostring(cache_img_url_no_skip)] = mediainfo_job_skip }
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
-- NOTE: Hacky way to prevent image overlap with old metadata area
|
||||
if utils.get_state(const.STATE_KEY.prev_metadata_area) then
|
||||
local old_metadata_area = utils.get_state(const.STATE_KEY.prev_metadata_area)
|
||||
if
|
||||
old_metadata_area.win_x == job.area.x
|
||||
and old_metadata_area.win_y == job.area.y
|
||||
and old_metadata_area.win_w == job.area.w
|
||||
and old_metadata_area.win_h == job.area.h
|
||||
then
|
||||
ya.preview_widget(job, {
|
||||
ui.Clear(ui.Rect({
|
||||
x = old_metadata_area.x,
|
||||
y = old_metadata_area.y,
|
||||
w = old_metadata_area.w,
|
||||
h = old_metadata_area.h,
|
||||
})),
|
||||
})
|
||||
end
|
||||
end
|
||||
utils.force_render()
|
||||
|
||||
local rendered_img_rect = cache_img_url
|
||||
and fs.cha(cache_img_url)
|
||||
and ya.image_show(
|
||||
cache_img_url,
|
||||
ui.Rect({
|
||||
x = job.area.x,
|
||||
y = job.area.y,
|
||||
w = job.area.w,
|
||||
h = mediainfo_height > 0 and math.max(job.area.h - mediainfo_height, job.area.h / 2) or job.area.h,
|
||||
})
|
||||
)
|
||||
or nil
|
||||
local image_height = rendered_img_rect and rendered_img_rect.h or 0
|
||||
|
||||
-- Handle image preload error
|
||||
if preload_err then
|
||||
table.insert(lines, ui.Line(tostring(preload_err)):style(th.spot.title or ui.Style():fg("red")))
|
||||
end
|
||||
|
||||
ya.preview_widget(job, {
|
||||
ui.Text(lines)
|
||||
:area(ui.Rect({
|
||||
x = job.area.x,
|
||||
y = job.area.y + image_height,
|
||||
w = job.area.w,
|
||||
h = job.area.h - image_height,
|
||||
}))
|
||||
:wrap(is_wrap and ui.Wrap.YES or ui.Wrap.NO),
|
||||
})
|
||||
|
||||
-- NOTE: Hacky way to prevent image overlap with old metadata area
|
||||
utils.set_state(const.STATE_KEY.prev_metadata_area, not no_metadata and {
|
||||
x = job.area.x,
|
||||
y = job.area.y + image_height,
|
||||
w = job.area.w,
|
||||
h = job.area.h - image_height,
|
||||
win_x = job.area.x,
|
||||
win_y = job.area.y,
|
||||
win_w = job.area.w,
|
||||
win_h = job.area.h,
|
||||
} or nil)
|
||||
end
|
||||
|
||||
function M:preload(job)
|
||||
local cmd = "mediainfo"
|
||||
local err_msg = ""
|
||||
local is_valid_utf8_path = utils.is_valid_utf8(tostring(job.file.path or job.file.cache or job.file.url))
|
||||
|
||||
-- NOTE: Preload image
|
||||
|
||||
local cache_img_url = ya.file_cache(job)
|
||||
local cache_img_url_cha = cache_img_url and fs.cha(cache_img_url)
|
||||
|
||||
-- NOTE: Only generate preview image when cache image is not exist
|
||||
if not cache_img_url_cha or cache_img_url_cha.len <= 0 then
|
||||
local cache_img_status, image_preload_err
|
||||
local layer_index = 0
|
||||
local units = utils.get_state(const.STATE_KEY.units)
|
||||
if units ~= nil then
|
||||
local max_layer = image_layer_count(job)
|
||||
layer_index = math.floor(math.max(0, math.abs(job.skip / units)))
|
||||
if layer_index + 1 > max_layer then
|
||||
layer_index = math.max(0, max_layer - 1)
|
||||
end
|
||||
end
|
||||
local cache_img_url_tmp = Url(cache_img_url .. ".tmp")
|
||||
if fs.cha(cache_img_url_tmp) then
|
||||
fs.remove("file", cache_img_url_tmp)
|
||||
end
|
||||
local tmp_file_path, _ = type(fs.unique) == "function" and fs.unique("file", cache_img_url_tmp)
|
||||
or fs.unique_name(cache_img_url_tmp)
|
||||
cache_img_status, image_preload_err = require("magick")
|
||||
.with_limit()
|
||||
:arg({
|
||||
"-background",
|
||||
"none",
|
||||
tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url) .. "[" .. tostring(
|
||||
layer_index
|
||||
) .. "]",
|
||||
"-auto-orient",
|
||||
"-strip",
|
||||
"-resize",
|
||||
string.format("%dx%d>", rt.preview.max_width, rt.preview.max_height),
|
||||
"-quality",
|
||||
rt.preview.image_quality,
|
||||
string.format("PNG32:%s", tostring(tmp_file_path)),
|
||||
})
|
||||
:status()
|
||||
if cache_img_status then
|
||||
os.rename(tostring(tmp_file_path), tostring(cache_img_url))
|
||||
end
|
||||
|
||||
if not cache_img_status and image_preload_err then
|
||||
ya.dbg("mediainfo", image_preload_err)
|
||||
err_msg = err_msg .. (image_preload_err and (tostring(image_preload_err)) or "")
|
||||
end
|
||||
end
|
||||
|
||||
-- NOTE: Get mediainfo and save to cache folder
|
||||
local cache_mediainfo_url = Url(tostring(ya.file_cache({ file = job.file, skip = 0 })) .. const.suffix)
|
||||
local cache_mediainfo_cha = fs.cha(cache_mediainfo_url)
|
||||
-- Case peek function called preload to refetch mediainfo
|
||||
if cache_mediainfo_cha and not job.args.force_reload_mediainfo then
|
||||
return true, err_msg ~= "" and ("Error: " .. err_msg) or nil
|
||||
end
|
||||
|
||||
local output, err
|
||||
if is_valid_utf8_path then
|
||||
output, err = Command(cmd)
|
||||
:arg({ tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url) })
|
||||
:output()
|
||||
else
|
||||
cmd = "cd "
|
||||
.. utils.path_quote(tostring((job.file.path or job.file.cache or job.file.url.path or job.file.url).parent))
|
||||
.. " && "
|
||||
.. cmd
|
||||
.. " "
|
||||
.. utils.path_quote(tostring((job.file.path or job.file.cache or job.file.url).name))
|
||||
output, err = Command(const.SHELL):arg({ "-c", cmd }):output()
|
||||
end
|
||||
if err then
|
||||
ya.dbg("mediainfo", tostring(err))
|
||||
err_msg = err_msg .. string.format("Failed to start `%s`. \n Do you have `%s` installed?\n", cmd, cmd)
|
||||
end
|
||||
|
||||
return fs.write(
|
||||
cache_mediainfo_url,
|
||||
(err_msg ~= "" and ("Error: " .. err_msg) or "") .. (output and output.stdout or "")
|
||||
)
|
||||
end
|
||||
|
||||
return M
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 186 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 286 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 30 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 261 KiB |
@@ -0,0 +1,345 @@
|
||||
--- @since 26.1.22
|
||||
|
||||
local M = {}
|
||||
local const = require(".const")
|
||||
local utils = require(".utils")
|
||||
|
||||
local function get_cover_layers(job)
|
||||
local cache = ya.file_cache({ file = job.file, skip = 0 })
|
||||
if not cache then
|
||||
return {}
|
||||
end
|
||||
local covers = utils.get_state("f" .. tostring(cache))
|
||||
if covers and type(covers) == "table" then
|
||||
return covers
|
||||
end
|
||||
local output, err = Command("ffprobe"):arg({
|
||||
"-v",
|
||||
"error",
|
||||
"-select_streams",
|
||||
"v",
|
||||
"-show_entries",
|
||||
"stream=index:stream_disposition=attached_pic",
|
||||
"-of",
|
||||
"json",
|
||||
tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url),
|
||||
}):output()
|
||||
if err or not output then
|
||||
return {}
|
||||
end
|
||||
covers = {}
|
||||
local data = ya.json_decode(output.stdout)
|
||||
if type(data.streams) == "table" then
|
||||
for _, stream in ipairs(data.streams) do
|
||||
if stream.disposition and stream.disposition.attached_pic then
|
||||
covers[#covers + 1] = stream.index
|
||||
end
|
||||
end
|
||||
end
|
||||
utils.set_state("f" .. tostring(cache), covers)
|
||||
return covers
|
||||
end
|
||||
|
||||
function M:peek(job)
|
||||
local preload_status, preload_err = self:preload(job)
|
||||
-- Stop if preload failed
|
||||
if not preload_status then
|
||||
return
|
||||
end
|
||||
|
||||
local cache_img_url = ya.file_cache(job)
|
||||
|
||||
local cache_img_url_no_skip = ya.file_cache({ file = job.file, skip = 0 })
|
||||
|
||||
local no_metadata = job.args.no_metadata
|
||||
local mediainfo_job_skip = job.skip
|
||||
::recalc_mediainfo_job_skip::
|
||||
local mediainfo_height = 0
|
||||
local lines = {}
|
||||
local limit = job.area.h
|
||||
local last_line = 0
|
||||
local EOF_mediainfo = true
|
||||
local is_wrap = rt.preview.wrap == "yes" or rt.preview.wrap == ui.Wrap.YES
|
||||
|
||||
if not no_metadata then
|
||||
local cache_mediainfo_path = tostring(cache_img_url_no_skip) .. const.suffix
|
||||
local output = utils.read_mediainfo_cached_file(cache_mediainfo_path)
|
||||
if output then
|
||||
local max_width = math.max(1, job.area.w)
|
||||
if output:match("^Error:") then
|
||||
job.args.force_reload_mediainfo = true
|
||||
preload_status, preload_err = self:preload(job)
|
||||
if not preload_status or preload_err then
|
||||
return
|
||||
end
|
||||
output = utils.read_mediainfo_cached_file(cache_mediainfo_path)
|
||||
end
|
||||
|
||||
output = output:gsub("\n+$", "")
|
||||
|
||||
local iter = output:gmatch("[^\n]*")
|
||||
local str = iter()
|
||||
|
||||
while str ~= nil do
|
||||
local next_str = iter()
|
||||
local label, value = str:match("(.*[^ ]) +: (.*)")
|
||||
local line
|
||||
if label then
|
||||
if not (utils.get_state(const.STATE_KEY.skip_labels) or const.skip_labels)[label] then
|
||||
line = ui.Line({
|
||||
ui.Span(label .. ": "):style(ui.Style():fg("reset"):bold()),
|
||||
ui.Span(value):style(th.spot.tbl_col or ui.Style():fg("blue")),
|
||||
})
|
||||
end
|
||||
else
|
||||
if not (utils.get_state(const.STATE_KEY.skip_section_labels) or {})[str] then
|
||||
line = ui.Line({ ui.Span(str):style(th.spot.title or ui.Style():fg("green")) })
|
||||
end
|
||||
end
|
||||
|
||||
if line then
|
||||
local line_height = ui.height
|
||||
and ui.height(str, { width = max_width, ansi = true, wrap = rt.preview.wrap })
|
||||
or (math.max(1, is_wrap and math.ceil(ui.width(line) / max_width) or 1))
|
||||
if next_str == nil and line_height == 1 then
|
||||
EOF_mediainfo = true
|
||||
end
|
||||
if (last_line + line_height) > mediainfo_job_skip then
|
||||
table.insert(lines, line)
|
||||
end
|
||||
if (last_line + line_height) >= mediainfo_job_skip + limit then
|
||||
last_line = mediainfo_job_skip + limit
|
||||
EOF_mediainfo = false
|
||||
break
|
||||
end
|
||||
last_line = last_line + line_height
|
||||
end
|
||||
str = next_str
|
||||
end
|
||||
end
|
||||
mediainfo_height = math.min(limit, last_line)
|
||||
end
|
||||
|
||||
if not no_metadata then
|
||||
if EOF_mediainfo and #lines == 0 and mediainfo_job_skip > 0 then
|
||||
local covers = get_cover_layers(job)
|
||||
local cover_index = math.floor(
|
||||
math.max(
|
||||
1,
|
||||
utils.get_state(const.STATE_KEY.units)
|
||||
and (math.abs(job.skip / utils.get_state(const.STATE_KEY.units)))
|
||||
or 0
|
||||
)
|
||||
)
|
||||
|
||||
if not covers[cover_index] then
|
||||
ya.emit("peek", {
|
||||
math.max(0, (job.skip - (utils.get_state(const.STATE_KEY.units) or 0))),
|
||||
only_if = job.file.url,
|
||||
upper_bound = true,
|
||||
})
|
||||
return
|
||||
else
|
||||
-- NOTE: Recalculate mediainfo using cached latest valid skip value when reach the end of mediainfo output
|
||||
local last_valid_mediainfo_skip = utils.get_state(const.STATE_KEY.last_valid_mediainfo_skip)
|
||||
mediainfo_job_skip = last_valid_mediainfo_skip
|
||||
and last_valid_mediainfo_skip[tostring(cache_img_url_no_skip)]
|
||||
or math.max(0, mediainfo_job_skip - (utils.get_state(const.STATE_KEY.units) or 0))
|
||||
|
||||
goto recalc_mediainfo_job_skip
|
||||
end
|
||||
else
|
||||
utils.set_state(
|
||||
const.STATE_KEY.last_valid_mediainfo_skip,
|
||||
{ [tostring(cache_img_url_no_skip)] = mediainfo_job_skip }
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
-- NOTE: Hacky way to prevent image overlap with old metadata area
|
||||
if utils.get_state(const.STATE_KEY.prev_metadata_area) then
|
||||
local old_metadata_area = utils.get_state(const.STATE_KEY.prev_metadata_area)
|
||||
if
|
||||
old_metadata_area.win_x == job.area.x
|
||||
and old_metadata_area.win_y == job.area.y
|
||||
and old_metadata_area.win_w == job.area.w
|
||||
and old_metadata_area.win_h == job.area.h
|
||||
then
|
||||
ya.preview_widget(job, {
|
||||
ui.Clear(ui.Rect({
|
||||
x = old_metadata_area.x,
|
||||
y = old_metadata_area.y,
|
||||
w = old_metadata_area.w,
|
||||
h = old_metadata_area.h,
|
||||
})),
|
||||
})
|
||||
end
|
||||
end
|
||||
utils.force_render()
|
||||
|
||||
local rendered_img_rect = cache_img_url
|
||||
and fs.cha(cache_img_url)
|
||||
and ya.image_show(
|
||||
cache_img_url,
|
||||
ui.Rect({
|
||||
x = job.area.x,
|
||||
y = job.area.y,
|
||||
w = job.area.w,
|
||||
h = mediainfo_height > 0 and math.max(job.area.h - mediainfo_height, job.area.h / 2) or job.area.h,
|
||||
})
|
||||
)
|
||||
or nil
|
||||
local image_height = rendered_img_rect and rendered_img_rect.h or 0
|
||||
|
||||
-- Handle image preload error
|
||||
if preload_err then
|
||||
table.insert(lines, ui.Line(tostring(preload_err)):style(th.spot.title or ui.Style():fg("red")))
|
||||
end
|
||||
|
||||
ya.preview_widget(job, {
|
||||
ui.Text(lines)
|
||||
:area(ui.Rect({
|
||||
x = job.area.x,
|
||||
y = job.area.y + image_height,
|
||||
w = job.area.w,
|
||||
h = job.area.h - image_height,
|
||||
}))
|
||||
:wrap(is_wrap and ui.Wrap.YES or ui.Wrap.NO),
|
||||
})
|
||||
|
||||
-- NOTE: Hacky way to prevent image overlap with old metadata area
|
||||
utils.set_state(const.STATE_KEY.prev_metadata_area, not no_metadata and {
|
||||
x = job.area.x,
|
||||
y = job.area.y + image_height,
|
||||
w = job.area.w,
|
||||
h = job.area.h - image_height,
|
||||
win_x = job.area.x,
|
||||
win_y = job.area.y,
|
||||
win_w = job.area.w,
|
||||
win_h = job.area.h,
|
||||
} or nil)
|
||||
end
|
||||
|
||||
function M:preload(job)
|
||||
local cmd = "mediainfo"
|
||||
local err_msg = ""
|
||||
local is_valid_utf8_path = utils.is_valid_utf8(tostring(job.file.path or job.file.cache or job.file.url))
|
||||
|
||||
-- NOTE: Preload image
|
||||
|
||||
local cache_img_url = ya.file_cache(job)
|
||||
local cache_img_url_cha = cache_img_url and fs.cha(cache_img_url)
|
||||
|
||||
-- NOTE: Only generate preview image when cache image is not exist
|
||||
if cache_img_url and (not cache_img_url_cha or cache_img_url_cha.len <= 0) then
|
||||
local units = utils.get_state(const.STATE_KEY.units)
|
||||
local covers = get_cover_layers(job)
|
||||
local cover_index = covers[1] or 0
|
||||
if units ~= nil then
|
||||
cover_index = math.floor(math.max(1, math.abs(job.skip / units)))
|
||||
if not covers[cover_index] then
|
||||
cover_index = math.max(0, #covers - 1)
|
||||
end
|
||||
end
|
||||
local qv = 31 - math.floor(rt.preview.image_quality * 0.3)
|
||||
local audio_preload_output, audio_preload_err = Command("ffmpeg"):arg({
|
||||
"-v",
|
||||
"error",
|
||||
"-threads",
|
||||
1,
|
||||
"-i",
|
||||
tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url),
|
||||
"-map",
|
||||
string.format("0:v:%d?", cover_index),
|
||||
"-an",
|
||||
"-sn",
|
||||
"-dn",
|
||||
"-vframes",
|
||||
1,
|
||||
"-q:v",
|
||||
qv,
|
||||
"-vf",
|
||||
string.format("scale=-1:'min(%d,ih)':flags=fast_bilinear", rt.preview.max_height / 2),
|
||||
"-f",
|
||||
"image2",
|
||||
"-y",
|
||||
tostring(cache_img_url),
|
||||
}):output()
|
||||
-- NOTE: Some audio types doesn't have cover image -> error ""
|
||||
if audio_preload_err then
|
||||
ya.dbg("mediainfo", audio_preload_err)
|
||||
err_msg = err_msg
|
||||
.. string.format(
|
||||
"Failed to start `%s`.\n Error: %s\n",
|
||||
"ffmpeg",
|
||||
tostring(audio_preload_err or (audio_preload_output and audio_preload_output.stderr or ""))
|
||||
)
|
||||
elseif
|
||||
audio_preload_output
|
||||
and type(audio_preload_output.stderr) == "string"
|
||||
and audio_preload_output.stderr:find("does not contain any stream")
|
||||
then
|
||||
ya.dbg("mediainfo", audio_preload_output and audio_preload_output.stderr)
|
||||
cache_img_url_cha, _ = fs.cha(cache_img_url)
|
||||
if cache_img_url_cha then
|
||||
fs.remove("file", Url(cache_img_url))
|
||||
end
|
||||
-- NOTE: Workaround case audio has no cover image. Prevent regenerate preview image
|
||||
audio_preload_output, audio_preload_err = require("magick")
|
||||
.with_limit()
|
||||
:arg({
|
||||
"-size",
|
||||
"1x1",
|
||||
"canvas:none",
|
||||
string.format("PNG32:%s", cache_img_url),
|
||||
})
|
||||
:output()
|
||||
if
|
||||
(audio_preload_output and audio_preload_output.stderr ~= nil and audio_preload_output.stderr ~= "")
|
||||
or audio_preload_err
|
||||
then
|
||||
ya.dbg("mediainfo", audio_preload_err or (audio_preload_output and audio_preload_output.stderr))
|
||||
err_msg = err_msg
|
||||
.. string.format(
|
||||
"Failed to start `%s`.\n Error: %s\n",
|
||||
"magick",
|
||||
tostring(audio_preload_err or (audio_preload_output and audio_preload_output.stderr or ""))
|
||||
)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
-- NOTE: Get mediainfo and save to cache folder
|
||||
local cache_mediainfo_url = Url(tostring(ya.file_cache({ file = job.file, skip = 0 })) .. const.suffix)
|
||||
local cache_mediainfo_cha = fs.cha(cache_mediainfo_url)
|
||||
-- Case peek function called preload to refetch mediainfo
|
||||
if cache_mediainfo_cha and not job.args.force_reload_mediainfo then
|
||||
return true, err_msg ~= "" and ("Error: " .. err_msg) or nil
|
||||
end
|
||||
|
||||
local output, err
|
||||
if is_valid_utf8_path then
|
||||
output, err = Command(cmd)
|
||||
:arg({ tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url) })
|
||||
:output()
|
||||
else
|
||||
cmd = "cd "
|
||||
.. utils.path_quote(tostring((job.file.path or job.file.cache or job.file.url.path or job.file.url).parent))
|
||||
.. " && "
|
||||
.. cmd
|
||||
.. " "
|
||||
.. utils.path_quote(tostring((job.file.path or job.file.cache or job.file.url).name))
|
||||
output, err = Command(const.SHELL):arg({ "-c", cmd }):output()
|
||||
end
|
||||
if err then
|
||||
ya.dbg("mediainfo", tostring(err))
|
||||
err_msg = err_msg .. string.format("Failed to start `%s`. \n Do you have `%s` installed?\n", cmd, cmd)
|
||||
end
|
||||
|
||||
return fs.write(
|
||||
cache_mediainfo_url,
|
||||
(err_msg ~= "" and ("Error: " .. err_msg) or "") .. (output and output.stdout or "")
|
||||
)
|
||||
end
|
||||
|
||||
return M
|
||||
@@ -0,0 +1,381 @@
|
||||
--- @since 26.5.6
|
||||
|
||||
local M = {}
|
||||
local const = require(".const")
|
||||
local utils = require(".utils")
|
||||
|
||||
local function get_cover_layers(job)
|
||||
local cache = ya.file_cache({ file = job.file, skip = 0 })
|
||||
if not cache then
|
||||
return {}
|
||||
end
|
||||
local covers = utils.get_state("f" .. tostring(cache))
|
||||
if covers and type(covers) == "table" then
|
||||
return covers
|
||||
end
|
||||
local output, err = Command("ffprobe"):arg({
|
||||
"-v",
|
||||
"error",
|
||||
"-select_streams",
|
||||
"v",
|
||||
"-show_entries",
|
||||
"stream=index:stream_disposition=attached_pic",
|
||||
"-of",
|
||||
"json",
|
||||
tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url),
|
||||
}):output()
|
||||
if err or not output then
|
||||
return {}
|
||||
end
|
||||
covers = {}
|
||||
local data = ya.json_decode(output.stdout)
|
||||
if type(data.streams) == "table" then
|
||||
for _, stream in ipairs(data.streams) do
|
||||
if stream.disposition and stream.disposition.attached_pic then
|
||||
covers[#covers + 1] = stream.index
|
||||
end
|
||||
end
|
||||
end
|
||||
utils.set_state("f" .. tostring(cache), covers)
|
||||
return covers
|
||||
end
|
||||
|
||||
function M:peek(job)
|
||||
local preload_status, preload_err = self:preload(job)
|
||||
-- Stop if preload failed
|
||||
if not preload_status then
|
||||
return
|
||||
end
|
||||
|
||||
local cache_img_url = ya.file_cache(job)
|
||||
|
||||
local cache_img_url_no_skip = ya.file_cache({ file = job.file, skip = 0 })
|
||||
|
||||
local no_metadata = job.args.no_metadata
|
||||
local mediainfo_job_skip = job.skip
|
||||
::recalc_mediainfo_job_skip::
|
||||
local mediainfo_height = 0
|
||||
local lines = {}
|
||||
local limit = job.area.h
|
||||
local last_line = 0
|
||||
local EOF_mediainfo = true
|
||||
local is_wrap = rt.preview.wrap == "yes" or rt.preview.wrap == ui.Wrap.YES
|
||||
|
||||
if not no_metadata then
|
||||
local cache_mediainfo_path = tostring(cache_img_url_no_skip) .. const.suffix
|
||||
local output = utils.read_mediainfo_cached_file(cache_mediainfo_path)
|
||||
if output then
|
||||
local max_width = math.max(1, job.area.w)
|
||||
if output:match("^Error:") then
|
||||
job.args.force_reload_mediainfo = true
|
||||
preload_status, preload_err = self:preload(job)
|
||||
if not preload_status or preload_err then
|
||||
return
|
||||
end
|
||||
output = utils.read_mediainfo_cached_file(cache_mediainfo_path)
|
||||
end
|
||||
|
||||
output = output:gsub("\n+$", "")
|
||||
|
||||
local iter = output:gmatch("[^\n]*")
|
||||
local str = iter()
|
||||
local opt = { ansi = true, tab_size = rt.preview.tab_size, wrap = rt.preview.wrap, width = max_width }
|
||||
while str ~= nil do
|
||||
local next_str = iter()
|
||||
local label, value = str:match("(.*[^ ]) +: (.*)")
|
||||
|
||||
local line
|
||||
if label then
|
||||
if not (utils.get_state(const.STATE_KEY.skip_labels) or const.skip_labels)[label] then
|
||||
line = label .. ": " .. value
|
||||
end
|
||||
else
|
||||
if not (utils.get_state(const.STATE_KEY.skip_section_labels) or {})[str] then
|
||||
line = str
|
||||
end
|
||||
end
|
||||
|
||||
if line then
|
||||
local wrapped = ui.lines(line, opt)
|
||||
local line_height = #wrapped
|
||||
local from = 1
|
||||
local to = math.min(line_height, mediainfo_job_skip + limit - last_line)
|
||||
|
||||
local total_rendered_text_len = 1
|
||||
local total_label_rendered_len = 1
|
||||
local label_total_len = label and utf8.len(label .. ": ") or 0
|
||||
for j = from, to do
|
||||
local current_line_components = {}
|
||||
local wrapped_line_len = wrapped[j]:width() or 0
|
||||
local wrapped_raw =
|
||||
utils.utf8_sub(line, total_rendered_text_len, total_rendered_text_len + wrapped_line_len)
|
||||
wrapped_line_len = utf8.len(wrapped_raw)
|
||||
total_rendered_text_len = total_rendered_text_len + wrapped_line_len
|
||||
|
||||
if last_line + 1 > mediainfo_job_skip then
|
||||
local label_raw = label_total_len - total_label_rendered_len <= 0 and ""
|
||||
or utils.utf8_sub(wrapped_raw, 1, label_total_len - total_label_rendered_len)
|
||||
local label_raw_len = utf8.len(label_raw)
|
||||
if label_raw_len > 0 then
|
||||
table.insert(
|
||||
current_line_components,
|
||||
ui.Span(label_raw):style(ui.Style():fg("reset"):bold())
|
||||
)
|
||||
total_label_rendered_len = total_label_rendered_len + label_raw_len
|
||||
wrapped_raw = wrapped_raw:gsub("^" .. utils.is_literal_string(label_raw), "", 1)
|
||||
end
|
||||
if total_label_rendered_len >= label_total_len then
|
||||
local value_raw = wrapped_raw
|
||||
table.insert(
|
||||
current_line_components,
|
||||
ui.Span(value_raw or ""):style(
|
||||
label and (th.spot.tbl_col or ui.Style():fg("blue"))
|
||||
or (th.spot.title or ui.Style():fg("green"))
|
||||
)
|
||||
)
|
||||
end
|
||||
table.insert(lines, ui.Line(current_line_components))
|
||||
-- last_line = last_line + 1
|
||||
else
|
||||
total_label_rendered_len = total_label_rendered_len + total_rendered_text_len
|
||||
end
|
||||
last_line = last_line + 1
|
||||
if next_str == nil and not wrapped[j + 1] then
|
||||
EOF_mediainfo = true
|
||||
end
|
||||
if last_line >= mediainfo_job_skip + limit then
|
||||
last_line = mediainfo_job_skip + limit
|
||||
EOF_mediainfo = false
|
||||
break
|
||||
end
|
||||
end
|
||||
end
|
||||
str = next_str
|
||||
end
|
||||
end
|
||||
mediainfo_height = math.min(limit, last_line)
|
||||
end
|
||||
|
||||
if not no_metadata then
|
||||
if EOF_mediainfo and #lines == 0 and mediainfo_job_skip > 0 then
|
||||
local covers = get_cover_layers(job)
|
||||
local cover_index = math.floor(
|
||||
math.max(
|
||||
1,
|
||||
utils.get_state(const.STATE_KEY.units)
|
||||
and (math.abs(job.skip / utils.get_state(const.STATE_KEY.units)))
|
||||
or 0
|
||||
)
|
||||
)
|
||||
|
||||
if not covers[cover_index] then
|
||||
ya.emit("peek", {
|
||||
math.max(0, (job.skip - (utils.get_state(const.STATE_KEY.units) or 0))),
|
||||
only_if = job.file.url,
|
||||
upper_bound = true,
|
||||
})
|
||||
return
|
||||
else
|
||||
-- NOTE: Recalculate mediainfo using cached latest valid skip value when reach the end of mediainfo output
|
||||
local last_valid_mediainfo_skip = utils.get_state(const.STATE_KEY.last_valid_mediainfo_skip)
|
||||
mediainfo_job_skip = last_valid_mediainfo_skip
|
||||
and last_valid_mediainfo_skip[tostring(cache_img_url_no_skip)]
|
||||
or math.max(0, mediainfo_job_skip - (utils.get_state(const.STATE_KEY.units) or 0))
|
||||
|
||||
goto recalc_mediainfo_job_skip
|
||||
end
|
||||
else
|
||||
utils.set_state(
|
||||
const.STATE_KEY.last_valid_mediainfo_skip,
|
||||
{ [tostring(cache_img_url_no_skip)] = mediainfo_job_skip }
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
-- NOTE: Hacky way to prevent image overlap with old metadata area
|
||||
if utils.get_state(const.STATE_KEY.prev_metadata_area) then
|
||||
local old_metadata_area = utils.get_state(const.STATE_KEY.prev_metadata_area)
|
||||
if
|
||||
old_metadata_area.win_x == job.area.x
|
||||
and old_metadata_area.win_y == job.area.y
|
||||
and old_metadata_area.win_w == job.area.w
|
||||
and old_metadata_area.win_h == job.area.h
|
||||
then
|
||||
ya.preview_widget(job, {
|
||||
ui.Clear(ui.Rect({
|
||||
x = old_metadata_area.x,
|
||||
y = old_metadata_area.y,
|
||||
w = old_metadata_area.w,
|
||||
h = old_metadata_area.h,
|
||||
})),
|
||||
})
|
||||
end
|
||||
end
|
||||
utils.force_render()
|
||||
|
||||
local rendered_img_rect = cache_img_url
|
||||
and fs.cha(cache_img_url)
|
||||
and ya.image_show(
|
||||
cache_img_url,
|
||||
ui.Rect({
|
||||
x = job.area.x,
|
||||
y = job.area.y,
|
||||
w = job.area.w,
|
||||
h = mediainfo_height > 0 and math.max(job.area.h - mediainfo_height, job.area.h / 2) or job.area.h,
|
||||
})
|
||||
)
|
||||
or nil
|
||||
local image_height = rendered_img_rect and rendered_img_rect.h or 0
|
||||
|
||||
-- Handle image preload error
|
||||
if preload_err then
|
||||
table.insert(lines, ui.Line(tostring(preload_err)):style(th.spot.title or ui.Style():fg("red")))
|
||||
end
|
||||
|
||||
ya.preview_widget(job, {
|
||||
ui.Text(lines)
|
||||
:area(ui.Rect({
|
||||
x = job.area.x,
|
||||
y = job.area.y + image_height,
|
||||
w = job.area.w,
|
||||
h = job.area.h - image_height,
|
||||
}))
|
||||
:wrap(is_wrap and ui.Wrap.YES or ui.Wrap.NO),
|
||||
})
|
||||
|
||||
-- NOTE: Hacky way to prevent image overlap with old metadata area
|
||||
utils.set_state(const.STATE_KEY.prev_metadata_area, not no_metadata and {
|
||||
x = job.area.x,
|
||||
y = job.area.y + image_height,
|
||||
w = job.area.w,
|
||||
h = job.area.h - image_height,
|
||||
win_x = job.area.x,
|
||||
win_y = job.area.y,
|
||||
win_w = job.area.w,
|
||||
win_h = job.area.h,
|
||||
} or nil)
|
||||
end
|
||||
|
||||
function M:preload(job)
|
||||
local cmd = "mediainfo"
|
||||
local err_msg = ""
|
||||
local is_valid_utf8_path = utils.is_valid_utf8(tostring(job.file.path or job.file.cache or job.file.url))
|
||||
|
||||
-- NOTE: Preload image
|
||||
|
||||
local cache_img_url = ya.file_cache(job)
|
||||
local cache_img_url_cha = cache_img_url and fs.cha(cache_img_url)
|
||||
|
||||
-- NOTE: Only generate preview image when cache image is not exist
|
||||
if cache_img_url and (not cache_img_url_cha or cache_img_url_cha.len <= 0) then
|
||||
local units = utils.get_state(const.STATE_KEY.units)
|
||||
local covers = get_cover_layers(job)
|
||||
local cover_index = covers[1] or 0
|
||||
if units ~= nil then
|
||||
cover_index = math.floor(math.max(1, math.abs(job.skip / units)))
|
||||
if not covers[cover_index] then
|
||||
cover_index = math.max(0, #covers - 1)
|
||||
end
|
||||
end
|
||||
local qv = 31 - math.floor(rt.preview.image_quality * 0.3)
|
||||
local audio_preload_output, audio_preload_err = Command("ffmpeg"):arg({
|
||||
"-v",
|
||||
"error",
|
||||
"-threads",
|
||||
1,
|
||||
"-i",
|
||||
tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url),
|
||||
"-map",
|
||||
string.format("0:v:%d?", cover_index),
|
||||
"-an",
|
||||
"-sn",
|
||||
"-dn",
|
||||
"-vframes",
|
||||
1,
|
||||
"-q:v",
|
||||
qv,
|
||||
"-vf",
|
||||
string.format("scale=-1:'min(%d,ih)':flags=fast_bilinear", rt.preview.max_height / 2),
|
||||
"-f",
|
||||
"image2",
|
||||
"-y",
|
||||
tostring(cache_img_url),
|
||||
}):output()
|
||||
-- NOTE: Some audio types doesn't have cover image -> error ""
|
||||
if audio_preload_err then
|
||||
ya.dbg("mediainfo", audio_preload_err)
|
||||
err_msg = err_msg
|
||||
.. string.format(
|
||||
"Failed to start `%s`.\n Error: %s\n",
|
||||
"ffmpeg",
|
||||
tostring(audio_preload_err or (audio_preload_output and audio_preload_output.stderr or ""))
|
||||
)
|
||||
elseif
|
||||
audio_preload_output
|
||||
and type(audio_preload_output.stderr) == "string"
|
||||
and audio_preload_output.stderr:find("does not contain any stream")
|
||||
then
|
||||
ya.dbg("mediainfo", audio_preload_output and audio_preload_output.stderr)
|
||||
cache_img_url_cha, _ = fs.cha(cache_img_url)
|
||||
if cache_img_url_cha then
|
||||
fs.remove("file", Url(cache_img_url))
|
||||
end
|
||||
-- NOTE: Workaround case audio has no cover image. Prevent regenerate preview image
|
||||
audio_preload_output, audio_preload_err = require("magick")
|
||||
.with_limit()
|
||||
:arg({
|
||||
"-size",
|
||||
"1x1",
|
||||
"canvas:none",
|
||||
string.format("PNG32:%s", cache_img_url),
|
||||
})
|
||||
:output()
|
||||
if
|
||||
(audio_preload_output and audio_preload_output.stderr ~= nil and audio_preload_output.stderr ~= "")
|
||||
or audio_preload_err
|
||||
then
|
||||
ya.dbg("mediainfo", audio_preload_err or (audio_preload_output and audio_preload_output.stderr))
|
||||
err_msg = err_msg
|
||||
.. string.format(
|
||||
"Failed to start `%s`.\n Error: %s\n",
|
||||
"magick",
|
||||
tostring(audio_preload_err or (audio_preload_output and audio_preload_output.stderr or ""))
|
||||
)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
-- NOTE: Get mediainfo and save to cache folder
|
||||
local cache_mediainfo_url = Url(tostring(ya.file_cache({ file = job.file, skip = 0 })) .. const.suffix)
|
||||
local cache_mediainfo_cha = fs.cha(cache_mediainfo_url)
|
||||
-- Case peek function called preload to refetch mediainfo
|
||||
if cache_mediainfo_cha and not job.args.force_reload_mediainfo then
|
||||
return true, err_msg ~= "" and ("Error: " .. err_msg) or nil
|
||||
end
|
||||
|
||||
local output, err
|
||||
if is_valid_utf8_path then
|
||||
output, err = Command(cmd)
|
||||
:arg({ tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url) })
|
||||
:output()
|
||||
else
|
||||
cmd = "cd "
|
||||
.. utils.path_quote(tostring((job.file.path or job.file.cache or job.file.url.path or job.file.url).parent))
|
||||
.. " && "
|
||||
.. cmd
|
||||
.. " "
|
||||
.. utils.path_quote(tostring((job.file.path or job.file.cache or job.file.url).name))
|
||||
output, err = Command(const.SHELL):arg({ "-c", cmd }):output()
|
||||
end
|
||||
if err then
|
||||
ya.dbg("mediainfo", tostring(err))
|
||||
err_msg = err_msg .. string.format("Failed to start `%s`. \n Do you have `%s` installed?\n", cmd, cmd)
|
||||
end
|
||||
|
||||
return fs.write(
|
||||
cache_mediainfo_url,
|
||||
(err_msg ~= "" and ("Error: " .. err_msg) or "") .. (output and output.stdout or "")
|
||||
)
|
||||
end
|
||||
|
||||
return M
|
||||
@@ -0,0 +1,68 @@
|
||||
--- @since 26.1.22
|
||||
|
||||
local M = {}
|
||||
|
||||
M.skip_labels = {
|
||||
["Complete name"] = true,
|
||||
["CompleteName_Last"] = true,
|
||||
["Unique ID"] = true,
|
||||
["File size"] = true,
|
||||
["Format/Info"] = true,
|
||||
["Codec ID/Info"] = true,
|
||||
["MD5 of the unencoded content"] = true,
|
||||
}
|
||||
|
||||
M.ENTRY_ACTION = {
|
||||
toggle_metadata = "toggle-metadata",
|
||||
toggle_preview = "toggle-preview",
|
||||
hide_metadata = "hide-metadata",
|
||||
hide_preview = "hide-preview",
|
||||
show_metadata = "show-metadata",
|
||||
show_preview = "show-preview",
|
||||
reset = "reset",
|
||||
}
|
||||
|
||||
M.STATE_KEY = {
|
||||
skip_labels = "skip_labels",
|
||||
skip_section_labels = "skip_section_labels",
|
||||
units = "units",
|
||||
no_metadata = "no_metadata",
|
||||
no_preview = "no_preview",
|
||||
prev_metadata_area = "prev_metadata_area",
|
||||
prev_image_height = "prev_image_height",
|
||||
last_valid_mediainfo_skip = "last_valid_mediainfo_skip",
|
||||
cached_mediainfo = "cached_mediainfo",
|
||||
cached_job_args = "cached_job_args",
|
||||
}
|
||||
|
||||
M.magick_image_mimes = {
|
||||
avif = true,
|
||||
hei = true,
|
||||
heic = true,
|
||||
heif = true,
|
||||
["heif-sequence"] = true,
|
||||
["heic-sequence"] = true,
|
||||
jxl = true,
|
||||
tiff = true,
|
||||
xml = true,
|
||||
-- ["svg+xml"] = true,
|
||||
["canon-cr2"] = true,
|
||||
}
|
||||
|
||||
M.seekable_mimes = {
|
||||
-- NOTE: Adobe illustrator photoshop mimetypes
|
||||
["application/postscript"] = true,
|
||||
["application/dvb.ait"] = true,
|
||||
["application/illustrator"] = true,
|
||||
["application/vnd.adobe.illustrator"] = true,
|
||||
["image/x-eps"] = true,
|
||||
["application/eps"] = true,
|
||||
["application/pdf"] = true,
|
||||
|
||||
["image/adobe.photoshop"] = true,
|
||||
}
|
||||
|
||||
M.suffix = "_mediainfo"
|
||||
M.SHELL = os.getenv("SHELL") or ""
|
||||
|
||||
return M
|
||||
@@ -0,0 +1,253 @@
|
||||
--- @since 26.1.22
|
||||
|
||||
local M = {}
|
||||
local const = require(".const")
|
||||
local utils = require(".utils")
|
||||
|
||||
function M:peek(job)
|
||||
local preload_status, preload_err = self:preload(job)
|
||||
-- Stop if preload failed
|
||||
if not preload_status then
|
||||
return
|
||||
end
|
||||
|
||||
local cache_img_url = ya.file_cache({
|
||||
skip = 0,
|
||||
args = job.args,
|
||||
file = job.file,
|
||||
area = job.area,
|
||||
})
|
||||
|
||||
local cache_img_url_no_skip = ya.file_cache({ file = job.file, skip = 0 })
|
||||
|
||||
local no_metadata = job.args.no_metadata
|
||||
local mediainfo_height = 0
|
||||
local lines = {}
|
||||
local limit = job.area.h
|
||||
local last_line = 0
|
||||
local EOF_mediainfo = true
|
||||
local is_wrap = rt.preview.wrap == "yes" or rt.preview.wrap == ui.Wrap.YES
|
||||
|
||||
if not no_metadata then
|
||||
local cache_mediainfo_path = tostring(cache_img_url_no_skip) .. const.suffix
|
||||
local output = utils.read_mediainfo_cached_file(cache_mediainfo_path)
|
||||
if output then
|
||||
local max_width = math.max(1, job.area.w)
|
||||
if output:match("^Error:") then
|
||||
job.args.force_reload_mediainfo = true
|
||||
preload_status, preload_err = self:preload(job)
|
||||
if not preload_status or preload_err then
|
||||
return
|
||||
end
|
||||
output = utils.read_mediainfo_cached_file(cache_mediainfo_path)
|
||||
end
|
||||
|
||||
output = output:gsub("\n+$", "")
|
||||
|
||||
local iter = output:gmatch("[^\n]*")
|
||||
local str = iter()
|
||||
|
||||
while str ~= nil do
|
||||
local next_str = iter()
|
||||
local label, value = str:match("(.*[^ ]) +: (.*)")
|
||||
local line
|
||||
if label then
|
||||
if not (utils.get_state(const.STATE_KEY.skip_labels) or const.skip_labels)[label] then
|
||||
line = ui.Line({
|
||||
ui.Span(label .. ": "):style(ui.Style():fg("reset"):bold()),
|
||||
ui.Span(value):style(th.spot.tbl_col or ui.Style():fg("blue")),
|
||||
})
|
||||
end
|
||||
else
|
||||
if not (utils.get_state(const.STATE_KEY.skip_section_labels) or {})[str] then
|
||||
line = ui.Line({ ui.Span(str):style(th.spot.title or ui.Style():fg("green")) })
|
||||
end
|
||||
end
|
||||
|
||||
if line then
|
||||
local line_height = ui.height
|
||||
and ui.height(str, { width = max_width, ansi = true, wrap = rt.preview.wrap })
|
||||
or (math.max(1, is_wrap and math.ceil(ui.width(line) / max_width) or 1))
|
||||
if next_str == nil and line_height == 1 then
|
||||
EOF_mediainfo = true
|
||||
end
|
||||
if (last_line + line_height) > job.skip then
|
||||
table.insert(lines, line)
|
||||
end
|
||||
if (last_line + line_height) >= job.skip + limit then
|
||||
last_line = job.skip + limit
|
||||
EOF_mediainfo = false
|
||||
break
|
||||
end
|
||||
last_line = last_line + line_height
|
||||
end
|
||||
str = next_str
|
||||
end
|
||||
end
|
||||
mediainfo_height = math.min(limit, last_line)
|
||||
end
|
||||
|
||||
if not no_metadata and EOF_mediainfo and #lines == 0 and job.skip > 0 then
|
||||
ya.emit("peek", {
|
||||
math.max(0, (job.skip - (utils.get_state(const.STATE_KEY.units) or 0))),
|
||||
only_if = job.file.url,
|
||||
upper_bound = true,
|
||||
})
|
||||
return
|
||||
end
|
||||
|
||||
utils.force_render()
|
||||
-- NOTE: Hacky way to prevent image overlap with old metadata area
|
||||
if utils.get_state(const.STATE_KEY.prev_metadata_area) then
|
||||
local old_metadata_area = utils.get_state(const.STATE_KEY.prev_metadata_area)
|
||||
if
|
||||
old_metadata_area.win_x == job.area.x
|
||||
and old_metadata_area.win_y == job.area.y
|
||||
and old_metadata_area.win_w == job.area.w
|
||||
and old_metadata_area.win_h == job.area.h
|
||||
then
|
||||
ya.preview_widget(job, {
|
||||
ui.Clear(ui.Rect({
|
||||
x = old_metadata_area.x,
|
||||
y = old_metadata_area.y,
|
||||
w = old_metadata_area.w,
|
||||
h = old_metadata_area.h,
|
||||
})),
|
||||
})
|
||||
end
|
||||
end
|
||||
|
||||
local rendered_img_rect = cache_img_url
|
||||
and fs.cha(cache_img_url)
|
||||
and ya.image_show(
|
||||
cache_img_url,
|
||||
ui.Rect({
|
||||
x = job.area.x,
|
||||
y = job.area.y,
|
||||
w = job.area.w,
|
||||
h = mediainfo_height > 0 and math.max(job.area.h - mediainfo_height, job.area.h / 2) or job.area.h,
|
||||
})
|
||||
)
|
||||
or nil
|
||||
local image_height = rendered_img_rect and rendered_img_rect.h or 0
|
||||
|
||||
-- Handle image preload error
|
||||
if preload_err then
|
||||
table.insert(lines, ui.Line(tostring(preload_err)):style(th.spot.title or ui.Style():fg("red")))
|
||||
end
|
||||
|
||||
ya.preview_widget(job, {
|
||||
ui.Text(lines)
|
||||
:area(ui.Rect({
|
||||
x = job.area.x,
|
||||
y = job.area.y + image_height,
|
||||
w = job.area.w,
|
||||
h = job.area.h - image_height,
|
||||
}))
|
||||
:wrap(is_wrap and ui.Wrap.YES or ui.Wrap.NO),
|
||||
})
|
||||
|
||||
-- NOTE: Hacky way to prevent image overlap with old metadata area
|
||||
utils.set_state(const.STATE_KEY.prev_metadata_area, not no_metadata and {
|
||||
x = job.area.x,
|
||||
y = job.area.y + image_height,
|
||||
w = job.area.w,
|
||||
h = job.area.h - image_height,
|
||||
win_x = job.area.x,
|
||||
win_y = job.area.y,
|
||||
win_w = job.area.w,
|
||||
win_h = job.area.h,
|
||||
} or nil)
|
||||
end
|
||||
|
||||
function M:preload(job)
|
||||
local cmd = "mediainfo"
|
||||
local err_msg = ""
|
||||
local is_valid_utf8_path = utils.is_valid_utf8(tostring(job.file.path or job.file.cache or job.file.url))
|
||||
|
||||
-- NOTE: Preload image
|
||||
|
||||
local mime = job.mime:match(".*/(.*)$")
|
||||
local is_svg = mime == "svg+xml"
|
||||
local is_magick = const.magick_image_mimes[mime]
|
||||
local no_skip_job = { skip = 0, file = job.file, args = job.args, area = job.area }
|
||||
local cache_img_url = ya.file_cache(no_skip_job)
|
||||
local cache_img_url_cha = cache_img_url and fs.cha(cache_img_url)
|
||||
|
||||
-- NOTE: Only generate preview image when cache image is not exist
|
||||
if not cache_img_url_cha or cache_img_url_cha.len <= 0 then
|
||||
local cache_img_status, image_preload_err
|
||||
if not is_valid_utf8_path then
|
||||
-- NOTE: Case not valid utf8 path, use trick to generate preview image
|
||||
if is_svg then
|
||||
local cache_img_url_tmp = Url(cache_img_url .. ".tmp")
|
||||
if fs.cha(cache_img_url_tmp) then
|
||||
fs.remove("file", cache_img_url_tmp)
|
||||
end
|
||||
local tmp_file_path, _ = type(fs.unique) == "function" and fs.unique("file", cache_img_url_tmp)
|
||||
or fs.unique_name(cache_img_url_tmp)
|
||||
-- svg under invalid utf8 path
|
||||
cache_img_status, image_preload_err = require("magick")
|
||||
.with_limit()
|
||||
:arg({
|
||||
"-background",
|
||||
"none",
|
||||
tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url),
|
||||
"-auto-orient",
|
||||
"-strip",
|
||||
string.format("%dx%d>", rt.preview.max_width, rt.preview.max_height),
|
||||
"-quality",
|
||||
rt.preview.image_quality,
|
||||
string.format("PNG32:%s", tostring(tmp_file_path)),
|
||||
})
|
||||
:status()
|
||||
if cache_img_status then
|
||||
os.rename(tostring(tmp_file_path), tostring(cache_img_url))
|
||||
end
|
||||
end
|
||||
else
|
||||
-- NOTE: Case valid utf8 path, use image, svg, or magick module
|
||||
local image_module = is_svg and "svg" or (is_magick and "magick" or "image")
|
||||
cache_img_status, image_preload_err = require(image_module):preload(no_skip_job)
|
||||
end
|
||||
|
||||
if not cache_img_status and image_preload_err then
|
||||
ya.dbg("mediainfo", image_preload_err)
|
||||
err_msg = err_msg .. (image_preload_err and (tostring(image_preload_err)) or "")
|
||||
end
|
||||
end
|
||||
|
||||
-- NOTE: Get mediainfo and save to cache folder
|
||||
local cache_mediainfo_url = Url(tostring(ya.file_cache({ file = job.file, skip = 0 })) .. const.suffix)
|
||||
local cache_mediainfo_cha = fs.cha(cache_mediainfo_url)
|
||||
-- Case peek function called preload to refetch mediainfo
|
||||
if cache_mediainfo_cha and not job.args.force_reload_mediainfo then
|
||||
return true, err_msg ~= "" and ("Error: " .. err_msg) or nil
|
||||
end
|
||||
|
||||
local output, err
|
||||
if is_valid_utf8_path then
|
||||
output, err = Command(cmd)
|
||||
:arg({ tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url) })
|
||||
:output()
|
||||
else
|
||||
cmd = "cd "
|
||||
.. utils.path_quote(tostring((job.file.path or job.file.cache or job.file.url.path or job.file.url).parent))
|
||||
.. " && "
|
||||
.. cmd
|
||||
.. " "
|
||||
.. utils.path_quote(tostring((job.file.path or job.file.cache or job.file.url).name))
|
||||
output, err = Command(const.SHELL):arg({ "-c", cmd }):output()
|
||||
end
|
||||
if err then
|
||||
ya.dbg("mediainfo", tostring(err))
|
||||
err_msg = err_msg .. string.format("Failed to start `%s`. \n Do you have `%s` installed?\n", cmd, cmd)
|
||||
end
|
||||
|
||||
return fs.write(
|
||||
cache_mediainfo_url,
|
||||
(err_msg ~= "" and ("Error: " .. err_msg) or "") .. (output and output.stdout or "")
|
||||
)
|
||||
end
|
||||
|
||||
return M
|
||||
@@ -0,0 +1,290 @@
|
||||
--- @since 26.5.6
|
||||
|
||||
local M = {}
|
||||
local const = require(".const")
|
||||
local utils = require(".utils")
|
||||
|
||||
function M:peek(job)
|
||||
local preload_status, preload_err = self:preload(job)
|
||||
-- Stop if preload failed
|
||||
if not preload_status then
|
||||
return
|
||||
end
|
||||
|
||||
local cache_img_url = ya.file_cache({
|
||||
skip = 0,
|
||||
args = job.args,
|
||||
file = job.file,
|
||||
area = job.area,
|
||||
})
|
||||
|
||||
local cache_img_url_no_skip = ya.file_cache({ file = job.file, skip = 0 })
|
||||
|
||||
local no_metadata = job.args.no_metadata
|
||||
local mediainfo_job_skip = job.skip
|
||||
local mediainfo_height = 0
|
||||
local lines = {}
|
||||
local limit = job.area.h
|
||||
local last_line = 0
|
||||
local EOF_mediainfo = true
|
||||
local is_wrap = rt.preview.wrap == "yes" or rt.preview.wrap == ui.Wrap.YES
|
||||
|
||||
if not no_metadata then
|
||||
local cache_mediainfo_path = tostring(cache_img_url_no_skip) .. const.suffix
|
||||
local output = utils.read_mediainfo_cached_file(cache_mediainfo_path)
|
||||
if output then
|
||||
local max_width = math.max(1, job.area.w)
|
||||
if output:match("^Error:") then
|
||||
job.args.force_reload_mediainfo = true
|
||||
preload_status, preload_err = self:preload(job)
|
||||
if not preload_status or preload_err then
|
||||
return
|
||||
end
|
||||
output = utils.read_mediainfo_cached_file(cache_mediainfo_path)
|
||||
end
|
||||
|
||||
output = output:gsub("\n+$", "")
|
||||
|
||||
local iter = output:gmatch("[^\n]*")
|
||||
local str = iter()
|
||||
local opt = { ansi = true, tab_size = rt.preview.tab_size, wrap = rt.preview.wrap, width = max_width }
|
||||
while str ~= nil do
|
||||
local next_str = iter()
|
||||
local label, value = str:match("(.*[^ ]) +: (.*)")
|
||||
|
||||
local line
|
||||
if label then
|
||||
if not (utils.get_state(const.STATE_KEY.skip_labels) or const.skip_labels)[label] then
|
||||
line = label .. ": " .. value
|
||||
end
|
||||
else
|
||||
if not (utils.get_state(const.STATE_KEY.skip_section_labels) or {})[str] then
|
||||
line = str
|
||||
end
|
||||
end
|
||||
|
||||
if line then
|
||||
local wrapped = ui.lines(line, opt)
|
||||
local line_height = #wrapped
|
||||
local from = 1
|
||||
local to = math.min(line_height, mediainfo_job_skip + limit - last_line)
|
||||
|
||||
local total_rendered_text_len = 1
|
||||
local total_label_rendered_len = 1
|
||||
local label_total_len = label and utf8.len(label .. ": ") or 0
|
||||
for j = from, to do
|
||||
local current_line_components = {}
|
||||
local wrapped_line_len = wrapped[j]:width() or 0
|
||||
local wrapped_raw =
|
||||
utils.utf8_sub(line, total_rendered_text_len, total_rendered_text_len + wrapped_line_len)
|
||||
wrapped_line_len = utf8.len(wrapped_raw)
|
||||
total_rendered_text_len = total_rendered_text_len + wrapped_line_len
|
||||
|
||||
if last_line + 1 > mediainfo_job_skip then
|
||||
local label_raw = label_total_len - total_label_rendered_len <= 0 and ""
|
||||
or utils.utf8_sub(wrapped_raw, 1, label_total_len - total_label_rendered_len)
|
||||
local label_raw_len = utf8.len(label_raw)
|
||||
if label_raw_len > 0 then
|
||||
table.insert(
|
||||
current_line_components,
|
||||
ui.Span(label_raw):style(ui.Style():fg("reset"):bold())
|
||||
)
|
||||
total_label_rendered_len = total_label_rendered_len + label_raw_len
|
||||
wrapped_raw = wrapped_raw:gsub("^" .. utils.is_literal_string(label_raw), "", 1)
|
||||
end
|
||||
if total_label_rendered_len >= label_total_len then
|
||||
local value_raw = wrapped_raw
|
||||
table.insert(
|
||||
current_line_components,
|
||||
ui.Span(value_raw or ""):style(
|
||||
label and (th.spot.tbl_col or ui.Style():fg("blue"))
|
||||
or (th.spot.title or ui.Style():fg("green"))
|
||||
)
|
||||
)
|
||||
end
|
||||
table.insert(lines, ui.Line(current_line_components))
|
||||
-- last_line = last_line + 1
|
||||
else
|
||||
total_label_rendered_len = total_label_rendered_len + total_rendered_text_len
|
||||
end
|
||||
last_line = last_line + 1
|
||||
if next_str == nil and not wrapped[j + 1] then
|
||||
EOF_mediainfo = true
|
||||
end
|
||||
if last_line >= mediainfo_job_skip + limit then
|
||||
last_line = mediainfo_job_skip + limit
|
||||
EOF_mediainfo = false
|
||||
break
|
||||
end
|
||||
end
|
||||
end
|
||||
str = next_str
|
||||
end
|
||||
end
|
||||
mediainfo_height = math.min(limit, last_line)
|
||||
end
|
||||
|
||||
if not no_metadata and EOF_mediainfo and #lines == 0 and job.skip > 0 then
|
||||
ya.emit("peek", {
|
||||
math.max(0, (job.skip - (utils.get_state(const.STATE_KEY.units) or 0))),
|
||||
only_if = job.file.url,
|
||||
upper_bound = true,
|
||||
})
|
||||
return
|
||||
end
|
||||
|
||||
utils.force_render()
|
||||
-- NOTE: Hacky way to prevent image overlap with old metadata area
|
||||
if utils.get_state(const.STATE_KEY.prev_metadata_area) then
|
||||
local old_metadata_area = utils.get_state(const.STATE_KEY.prev_metadata_area)
|
||||
if
|
||||
old_metadata_area.win_x == job.area.x
|
||||
and old_metadata_area.win_y == job.area.y
|
||||
and old_metadata_area.win_w == job.area.w
|
||||
and old_metadata_area.win_h == job.area.h
|
||||
then
|
||||
ya.preview_widget(job, {
|
||||
ui.Clear(ui.Rect({
|
||||
x = old_metadata_area.x,
|
||||
y = old_metadata_area.y,
|
||||
w = old_metadata_area.w,
|
||||
h = old_metadata_area.h,
|
||||
})),
|
||||
})
|
||||
end
|
||||
end
|
||||
|
||||
local rendered_img_rect = cache_img_url
|
||||
and fs.cha(cache_img_url)
|
||||
and ya.image_show(
|
||||
cache_img_url,
|
||||
ui.Rect({
|
||||
x = job.area.x,
|
||||
y = job.area.y,
|
||||
w = job.area.w,
|
||||
h = mediainfo_height > 0 and math.max(job.area.h - mediainfo_height, job.area.h / 2) or job.area.h,
|
||||
})
|
||||
)
|
||||
or nil
|
||||
local image_height = rendered_img_rect and rendered_img_rect.h or 0
|
||||
|
||||
-- Handle image preload error
|
||||
if preload_err then
|
||||
table.insert(lines, ui.Line(tostring(preload_err)):style(th.spot.title or ui.Style():fg("red")))
|
||||
end
|
||||
|
||||
ya.preview_widget(job, {
|
||||
ui.Text(lines)
|
||||
:area(ui.Rect({
|
||||
x = job.area.x,
|
||||
y = job.area.y + image_height,
|
||||
w = job.area.w,
|
||||
h = job.area.h - image_height,
|
||||
}))
|
||||
:wrap(is_wrap and ui.Wrap.YES or ui.Wrap.NO),
|
||||
})
|
||||
|
||||
-- NOTE: Hacky way to prevent image overlap with old metadata area
|
||||
utils.set_state(const.STATE_KEY.prev_metadata_area, not no_metadata and {
|
||||
x = job.area.x,
|
||||
y = job.area.y + image_height,
|
||||
w = job.area.w,
|
||||
h = job.area.h - image_height,
|
||||
win_x = job.area.x,
|
||||
win_y = job.area.y,
|
||||
win_w = job.area.w,
|
||||
win_h = job.area.h,
|
||||
} or nil)
|
||||
end
|
||||
|
||||
function M:preload(job)
|
||||
local cmd = "mediainfo"
|
||||
local err_msg = ""
|
||||
local is_valid_utf8_path = utils.is_valid_utf8(tostring(job.file.path or job.file.cache or job.file.url))
|
||||
|
||||
-- NOTE: Preload image
|
||||
|
||||
local mime = job.mime:match(".*/(.*)$")
|
||||
local is_svg = mime == "svg+xml"
|
||||
local is_magick = const.magick_image_mimes[mime]
|
||||
local no_skip_job = { skip = 0, file = job.file, args = job.args, area = job.area }
|
||||
local cache_img_url = ya.file_cache(no_skip_job)
|
||||
local cache_img_url_cha = cache_img_url and fs.cha(cache_img_url)
|
||||
|
||||
-- NOTE: Only generate preview image when cache image is not exist
|
||||
if not cache_img_url_cha or cache_img_url_cha.len <= 0 then
|
||||
local cache_img_status, image_preload_err
|
||||
if not is_valid_utf8_path then
|
||||
-- NOTE: Case not valid utf8 path, use trick to generate preview image
|
||||
if is_svg then
|
||||
local cache_img_url_tmp = Url(cache_img_url .. ".tmp")
|
||||
if fs.cha(cache_img_url_tmp) then
|
||||
fs.remove("file", cache_img_url_tmp)
|
||||
end
|
||||
local tmp_file_path, _ = type(fs.unique) == "function" and fs.unique("file", cache_img_url_tmp)
|
||||
or fs.unique_name(cache_img_url_tmp)
|
||||
-- svg under invalid utf8 path
|
||||
cache_img_status, image_preload_err = require("magick")
|
||||
.with_limit()
|
||||
:arg({
|
||||
"-background",
|
||||
"none",
|
||||
tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url),
|
||||
"-auto-orient",
|
||||
"-strip",
|
||||
string.format("%dx%d>", rt.preview.max_width, rt.preview.max_height),
|
||||
"-quality",
|
||||
rt.preview.image_quality,
|
||||
string.format("PNG32:%s", tostring(tmp_file_path)),
|
||||
})
|
||||
:status()
|
||||
if cache_img_status then
|
||||
os.rename(tostring(tmp_file_path), tostring(cache_img_url))
|
||||
end
|
||||
end
|
||||
else
|
||||
-- NOTE: Case valid utf8 path, use image, svg, or magick module
|
||||
local image_module = is_svg and "svg" or (is_magick and "magick" or "image")
|
||||
cache_img_status, image_preload_err = require(image_module):preload(no_skip_job)
|
||||
end
|
||||
|
||||
if not cache_img_status and image_preload_err then
|
||||
ya.dbg("mediainfo", image_preload_err)
|
||||
err_msg = err_msg .. (image_preload_err and (tostring(image_preload_err)) or "")
|
||||
end
|
||||
end
|
||||
|
||||
-- NOTE: Get mediainfo and save to cache folder
|
||||
local cache_mediainfo_url = Url(tostring(ya.file_cache({ file = job.file, skip = 0 })) .. const.suffix)
|
||||
local cache_mediainfo_cha = fs.cha(cache_mediainfo_url)
|
||||
-- Case peek function called preload to refetch mediainfo
|
||||
if cache_mediainfo_cha and not job.args.force_reload_mediainfo then
|
||||
return true, err_msg ~= "" and ("Error: " .. err_msg) or nil
|
||||
end
|
||||
|
||||
local output, err
|
||||
if is_valid_utf8_path then
|
||||
output, err = Command(cmd)
|
||||
:arg({ tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url) })
|
||||
:output()
|
||||
else
|
||||
cmd = "cd "
|
||||
.. utils.path_quote(tostring((job.file.path or job.file.cache or job.file.url.path or job.file.url).parent))
|
||||
.. " && "
|
||||
.. cmd
|
||||
.. " "
|
||||
.. utils.path_quote(tostring((job.file.path or job.file.cache or job.file.url).name))
|
||||
output, err = Command(const.SHELL):arg({ "-c", cmd }):output()
|
||||
end
|
||||
if err then
|
||||
ya.dbg("mediainfo", tostring(err))
|
||||
err_msg = err_msg .. string.format("Failed to start `%s`. \n Do you have `%s` installed?\n", cmd, cmd)
|
||||
end
|
||||
|
||||
return fs.write(
|
||||
cache_mediainfo_url,
|
||||
(err_msg ~= "" and ("Error: " .. err_msg) or "") .. (output and output.stdout or "")
|
||||
)
|
||||
end
|
||||
|
||||
return M
|
||||
@@ -0,0 +1,498 @@
|
||||
--- @since 25.5.31
|
||||
|
||||
local skip_labels = {
|
||||
["Complete name"] = true,
|
||||
["CompleteName_Last"] = true,
|
||||
["Unique ID"] = true,
|
||||
["File size"] = true,
|
||||
["Format/Info"] = true,
|
||||
["Codec ID/Info"] = true,
|
||||
["MD5 of the unencoded content"] = true,
|
||||
}
|
||||
|
||||
local ENTRY_ACTION = {
|
||||
toggle_metadata = "toggle-metadata",
|
||||
}
|
||||
|
||||
local STATE_KEY = {
|
||||
units = "units",
|
||||
hide_metadata = "hide_metadata",
|
||||
prev_metadata_area = "prev_metadata_area",
|
||||
prev_peek_data = "prev_peek_data",
|
||||
}
|
||||
|
||||
local magick_image_mimes = {
|
||||
avif = true,
|
||||
hei = true,
|
||||
heic = true,
|
||||
heif = true,
|
||||
["heif-sequence"] = true,
|
||||
["heic-sequence"] = true,
|
||||
jxl = true,
|
||||
xml = true,
|
||||
["svg+xml"] = true,
|
||||
["canon-cr2"] = true,
|
||||
}
|
||||
|
||||
local seekable_mimes = {
|
||||
["application/postscript"] = true,
|
||||
["image/adobe.photoshop"] = true,
|
||||
}
|
||||
|
||||
local M = {}
|
||||
local suffix = "_mediainfo"
|
||||
local SHELL = os.getenv("SHELL") or ""
|
||||
|
||||
local function is_valid_utf8(str)
|
||||
return utf8.len(str) ~= nil
|
||||
end
|
||||
|
||||
local function path_quote(path)
|
||||
if not path or tostring(path) == "" then
|
||||
return path
|
||||
end
|
||||
local result = "'" .. string.gsub(tostring(path), "'", "'\\''") .. "'"
|
||||
return result
|
||||
end
|
||||
|
||||
local function read_mediainfo_cached_file(file_path)
|
||||
-- Open the file in read mode
|
||||
local file = io.open(file_path, "r")
|
||||
|
||||
if file then
|
||||
-- Read the entire file content
|
||||
local content = file:read("*all")
|
||||
file:close()
|
||||
return content
|
||||
end
|
||||
end
|
||||
|
||||
local set_state = ya.sync(function(state, key, value)
|
||||
state[key] = value
|
||||
end)
|
||||
|
||||
local get_state = ya.sync(function(state, key)
|
||||
return state[key]
|
||||
end)
|
||||
|
||||
local force_render = ya.sync(function(_, _)
|
||||
(ui.render or ya.render)()
|
||||
end)
|
||||
|
||||
local function image_layer_count(job)
|
||||
local cache = ya.file_cache({ file = job.file, skip = 0 })
|
||||
if not cache then
|
||||
return 0
|
||||
end
|
||||
local layer_count = get_state("f" .. tostring(cache))
|
||||
if layer_count then
|
||||
return layer_count
|
||||
end
|
||||
local output, err = Command("identify")
|
||||
:arg({ tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url) })
|
||||
:output()
|
||||
if err then
|
||||
return 0
|
||||
end
|
||||
layer_count = 0
|
||||
for line in output.stdout:gmatch("[^\r\n]+") do
|
||||
if line:match("%S") then
|
||||
layer_count = layer_count + 1
|
||||
end
|
||||
end
|
||||
set_state("f" .. tostring(cache), layer_count)
|
||||
return layer_count
|
||||
end
|
||||
|
||||
function M:peek(job)
|
||||
local start = os.clock()
|
||||
local cache_img_url_no_skip = ya.file_cache({ file = job.file, skip = 0 })
|
||||
if not job.mime then
|
||||
return
|
||||
end
|
||||
set_state(STATE_KEY.prev_peek_data, {
|
||||
file = tostring(job.file.path or job.file.cache or job.file.url),
|
||||
mime = job.mime,
|
||||
area = {
|
||||
x = job.area.x,
|
||||
y = job.area.y,
|
||||
w = job.area.w,
|
||||
h = job.area.h,
|
||||
},
|
||||
args = job.args,
|
||||
skip = job.skip,
|
||||
})
|
||||
local is_video = string.find(job.mime, "^video/")
|
||||
local is_audio = string.find(job.mime, "^audio/")
|
||||
local is_image = string.find(job.mime, "^image/")
|
||||
local is_seekable = seekable_mimes[job.mime] or is_video
|
||||
local cache_img_url = (is_audio or is_image) and cache_img_url_no_skip
|
||||
|
||||
if is_seekable then
|
||||
cache_img_url = ya.file_cache(job)
|
||||
end
|
||||
local preload_status, preload_err = self:preload(job)
|
||||
if not preload_status then
|
||||
return
|
||||
end
|
||||
ya.sleep(math.max(0, rt.preview.image_delay / 1000 + start - os.clock()))
|
||||
local hide_metadata = get_state(STATE_KEY.hide_metadata)
|
||||
local mediainfo_height = 0
|
||||
local lines = {}
|
||||
local limit = job.area.h
|
||||
local last_line = 0
|
||||
local is_wrap = rt.preview.wrap == "yes"
|
||||
if not hide_metadata then
|
||||
local cache_mediainfo_path = tostring(cache_img_url_no_skip) .. suffix
|
||||
local output = read_mediainfo_cached_file(cache_mediainfo_path)
|
||||
if output then
|
||||
local max_width = math.max(1, job.area.w)
|
||||
if output:match("^Error:") then
|
||||
job.args.force_reload_mediainfo = true
|
||||
preload_status, preload_err = self:preload(job)
|
||||
if not preload_status or preload_err then
|
||||
return
|
||||
end
|
||||
output = read_mediainfo_cached_file(cache_mediainfo_path)
|
||||
end
|
||||
|
||||
for str in output:gsub("\n+$", ""):gmatch("[^\n]*") do
|
||||
local label, value = str:match("(.*[^ ]) +: (.*)")
|
||||
local line
|
||||
if label then
|
||||
if not skip_labels[label] then
|
||||
line = ui.Line({
|
||||
ui.Span(label .. ": "):style(ui.Style():fg("reset"):bold()),
|
||||
ui.Span(value):style(th.spot.tbl_col or ui.Style():fg("blue")),
|
||||
})
|
||||
end
|
||||
elseif str ~= "General" then
|
||||
line = ui.Line({ ui.Span(str):style(th.spot.title or ui.Style():fg("green")) })
|
||||
end
|
||||
|
||||
if line then
|
||||
local line_height = math.max(1, is_wrap and math.ceil(ui.width(line) / max_width) or 1)
|
||||
if (last_line + line_height) > job.skip then
|
||||
table.insert(lines, line)
|
||||
end
|
||||
if (last_line + line_height) >= job.skip + limit then
|
||||
last_line = job.skip + limit
|
||||
break
|
||||
end
|
||||
last_line = last_line + line_height
|
||||
end
|
||||
end
|
||||
end
|
||||
mediainfo_height = math.min(limit, last_line)
|
||||
end
|
||||
|
||||
if
|
||||
(job.skip > 0 and #lines == 0 and not hide_metadata)
|
||||
and (
|
||||
not is_seekable
|
||||
or (is_video and job.skip >= 90)
|
||||
or (
|
||||
(job.mime == "image/adobe.photoshop" or job.mime == "application/postscript")
|
||||
and image_layer_count(job)
|
||||
< (1 + math.floor(
|
||||
math.max(0, get_state(STATE_KEY.units) and (job.skip / get_state(STATE_KEY.units)) or 0)
|
||||
))
|
||||
)
|
||||
)
|
||||
then
|
||||
ya.emit("peek", {
|
||||
math.max(0, job.skip - (get_state(STATE_KEY.units) or limit)),
|
||||
only_if = job.file.url,
|
||||
upper_bound = true,
|
||||
})
|
||||
return
|
||||
end
|
||||
force_render()
|
||||
-- NOTE: Hacky way to prevent image overlap with old metadata area
|
||||
if hide_metadata and get_state(STATE_KEY.prev_metadata_area) then
|
||||
ya.preview_widget(job, {
|
||||
ui.Clear(ui.Rect(get_state(STATE_KEY.prev_metadata_area))),
|
||||
})
|
||||
end
|
||||
local rendered_img_rect = cache_img_url
|
||||
and fs.cha(cache_img_url)
|
||||
and ya.image_show(
|
||||
cache_img_url,
|
||||
ui.Rect({
|
||||
x = job.area.x,
|
||||
y = job.area.y,
|
||||
w = job.area.w,
|
||||
h = mediainfo_height > 0 and math.max(job.area.h - mediainfo_height, job.area.h / 2) or job.area.h,
|
||||
})
|
||||
)
|
||||
or nil
|
||||
local image_height = rendered_img_rect and rendered_img_rect.h or 0
|
||||
|
||||
-- NOTE: Workaround case audio has no cover image. Prevent regenerate preview image
|
||||
if is_audio and image_height == 1 then
|
||||
local info = ya.image_info(cache_img_url)
|
||||
if not info or (info.w == 1 and info.h == 1) then
|
||||
image_height = 0
|
||||
end
|
||||
end
|
||||
|
||||
-- NOTE: Workaround case video.lua doesn't doesn't generate preview image because of `skip` overflow video duration
|
||||
if is_video and not rendered_img_rect then
|
||||
image_height = math.max(job.area.h - mediainfo_height, 0)
|
||||
end
|
||||
|
||||
-- Handle image preload error
|
||||
if preload_err then
|
||||
table.insert(lines, ui.Line(tostring(preload_err)):style(th.spot.title or ui.Style():fg("red")))
|
||||
end
|
||||
|
||||
ya.preview_widget(job, {
|
||||
ui.Text(lines)
|
||||
:area(ui.Rect({
|
||||
x = job.area.x,
|
||||
y = job.area.y + image_height,
|
||||
w = job.area.w,
|
||||
h = job.area.h - image_height,
|
||||
}))
|
||||
:wrap(is_wrap and ui.Wrap.YES or ui.Wrap.NO),
|
||||
})
|
||||
-- NOTE: Hacky way to prevent image overlap with old metadata area
|
||||
if not hide_metadata then
|
||||
set_state(STATE_KEY.prev_metadata_area, {
|
||||
x = job.area.x,
|
||||
y = job.area.y + image_height,
|
||||
w = job.area.w,
|
||||
h = job.area.h - image_height,
|
||||
})
|
||||
end
|
||||
end
|
||||
|
||||
function M:seek(job)
|
||||
local h = cx.active.current.hovered
|
||||
if h and h.url == job.file.url then
|
||||
set_state(STATE_KEY.units, job.units)
|
||||
ya.emit("peek", {
|
||||
math.max(0, cx.active.preview.skip + job.units),
|
||||
only_if = job.file.url,
|
||||
})
|
||||
end
|
||||
end
|
||||
|
||||
function M:re_peek()
|
||||
local prev_peek_data = get_state(STATE_KEY.prev_peek_data)
|
||||
if prev_peek_data then
|
||||
prev_peek_data.file = File({
|
||||
url = Url(prev_peek_data.file),
|
||||
cha = fs.cha(Url(prev_peek_data.file)),
|
||||
})
|
||||
prev_peek_data.area = ui.area and ui.area("preview") or ui.Rect(prev_peek_data.area)
|
||||
|
||||
self:peek(prev_peek_data)
|
||||
end
|
||||
end
|
||||
|
||||
function M:preload(job)
|
||||
local cache_img_url = ya.file_cache({ file = job.file, skip = 0 })
|
||||
if not cache_img_url then
|
||||
return true
|
||||
end
|
||||
local cache_mediainfo_url = Url(tostring(cache_img_url) .. suffix)
|
||||
cache_img_url = seekable_mimes[job.mime] and ya.file_cache(job) or cache_img_url
|
||||
local cache_img_url_cha = cache_img_url and fs.cha(cache_img_url)
|
||||
local err_msg = ""
|
||||
local is_valid_utf8_path = is_valid_utf8(tostring(job.file.path or job.file.cache or job.file.url))
|
||||
-- video mimetype
|
||||
if job.mime then
|
||||
if string.find(job.mime, "^video/") then
|
||||
local cache_img_status, video_preload_err = require("video"):preload(job)
|
||||
if not cache_img_status and video_preload_err then
|
||||
err_msg = err_msg
|
||||
.. string.format("Failed to start `%s`, Do you have `%s` installed?\n", "ffmpeg", "ffmpeg")
|
||||
end
|
||||
-- audo and image mimetype
|
||||
elseif cache_img_url and (not cache_img_url_cha or cache_img_url_cha.len <= 0) then
|
||||
-- audio
|
||||
if string.find(job.mime, "^audio/") then
|
||||
local qv = 31 - math.floor(rt.preview.image_quality * 0.3)
|
||||
local audio_preload_output, audio_preload_err = Command("ffmpeg"):arg({
|
||||
"-v",
|
||||
"error",
|
||||
"-threads",
|
||||
1,
|
||||
"-skip_frame",
|
||||
"nokey",
|
||||
"-an",
|
||||
"-sn",
|
||||
"-dn",
|
||||
"-i",
|
||||
tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url),
|
||||
"-vframes",
|
||||
1,
|
||||
"-q:v",
|
||||
qv,
|
||||
"-vf",
|
||||
string.format("scale=-1:'min(%d,ih)':flags=fast_bilinear", rt.preview.max_height / 2),
|
||||
"-f",
|
||||
"image2",
|
||||
"-y",
|
||||
tostring(cache_img_url),
|
||||
}):output()
|
||||
-- NOTE: Some audio types doesn't have cover image -> error ""
|
||||
if
|
||||
(audio_preload_output and audio_preload_output.stderr ~= nil and audio_preload_output.stderr ~= "")
|
||||
or audio_preload_err
|
||||
then
|
||||
err_msg = err_msg
|
||||
.. string.format("Failed to start `%s`, Do you have `%s` installed?\n", "ffmpeg", "ffmpeg")
|
||||
else
|
||||
cache_img_url_cha, _ = fs.cha(cache_img_url)
|
||||
if not cache_img_url_cha then
|
||||
-- NOTE: Workaround case audio has no cover image. Prevent regenerate preview image
|
||||
audio_preload_output, audio_preload_err = require("magick")
|
||||
.with_limit()
|
||||
:arg({
|
||||
"-size",
|
||||
"1x1",
|
||||
"canvas:none",
|
||||
string.format("PNG32:%s", cache_img_url),
|
||||
})
|
||||
:output()
|
||||
if
|
||||
(audio_preload_output.stderr ~= nil and audio_preload_output.stderr ~= "")
|
||||
or audio_preload_err
|
||||
then
|
||||
err_msg = err_msg
|
||||
.. string.format(
|
||||
"Failed to start `%s`, Do you have `%s` installed?\n",
|
||||
"magick",
|
||||
"magick"
|
||||
)
|
||||
end
|
||||
end
|
||||
end
|
||||
-- image
|
||||
elseif string.find(job.mime, "^image/") or job.mime == "application/postscript" then
|
||||
local svg_plugin_ok, svg_plugin = pcall(require, "svg")
|
||||
local _, magick_plugin = pcall(require, "magick")
|
||||
local mime = job.mime:match(".*/(.*)$")
|
||||
|
||||
local image_plugin = magick_image_mimes[mime]
|
||||
and ((mime == "svg+xml" and svg_plugin_ok) and svg_plugin or magick_plugin)
|
||||
or require("image")
|
||||
|
||||
local cache_img_status, image_preload_err
|
||||
-- psd, ai, eps
|
||||
if mime == "adobe.photoshop" or job.mime == "application/postscript" then
|
||||
local layer_index = 0
|
||||
local units = get_state(STATE_KEY.units)
|
||||
if units ~= nil then
|
||||
local max_layer = image_layer_count(job)
|
||||
layer_index = math.floor(math.max(0, job.skip / units))
|
||||
if layer_index + 1 > max_layer then
|
||||
layer_index = max_layer - 1
|
||||
end
|
||||
end
|
||||
local cache_img_url_tmp = Url(cache_img_url .. ".tmp")
|
||||
if fs.cha(cache_img_url_tmp) then
|
||||
fs.remove("file", cache_img_url_tmp)
|
||||
end
|
||||
local tmp_file_path, _ = fs.unique_name(cache_img_url_tmp)
|
||||
cache_img_status, image_preload_err = magick_plugin
|
||||
.with_limit()
|
||||
:arg({
|
||||
"-background",
|
||||
"none",
|
||||
tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url)
|
||||
.. "["
|
||||
.. tostring(layer_index)
|
||||
.. "]",
|
||||
"-auto-orient",
|
||||
"-strip",
|
||||
"-resize",
|
||||
string.format("%dx%d>", rt.preview.max_width, rt.preview.max_height),
|
||||
"-quality",
|
||||
rt.preview.image_quality,
|
||||
string.format("PNG32:%s", tostring(tmp_file_path)),
|
||||
})
|
||||
:status()
|
||||
if cache_img_status then
|
||||
os.rename(tostring(tmp_file_path), tostring(cache_img_url))
|
||||
end
|
||||
elseif mime == "svg+xml" and not is_valid_utf8_path then
|
||||
local cache_img_url_tmp = Url(cache_img_url .. ".tmp")
|
||||
if fs.cha(cache_img_url_tmp) then
|
||||
fs.remove("file", cache_img_url_tmp)
|
||||
end
|
||||
local tmp_file_path, _ = fs.unique_name(cache_img_url_tmp)
|
||||
-- svg under invalid utf8 path
|
||||
cache_img_status, image_preload_err = magick_plugin
|
||||
.with_limit()
|
||||
:arg({
|
||||
"-background",
|
||||
"none",
|
||||
tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url),
|
||||
"-auto-orient",
|
||||
"-strip",
|
||||
"-flatten",
|
||||
"-resize",
|
||||
string.format("%dx%d>", rt.preview.max_width, rt.preview.max_height),
|
||||
"-quality",
|
||||
rt.preview.image_quality,
|
||||
string.format("PNG32:%s", tostring(tmp_file_path)),
|
||||
})
|
||||
:status()
|
||||
if cache_img_status then
|
||||
os.rename(tostring(tmp_file_path), tostring(cache_img_url))
|
||||
end
|
||||
else
|
||||
-- other image
|
||||
local no_skip_job = { skip = 0, file = job.file, args = {} }
|
||||
cache_img_status, image_preload_err = image_plugin:preload(no_skip_job)
|
||||
end
|
||||
if not cache_img_status then
|
||||
err_msg = err_msg .. (image_preload_err and (tostring(image_preload_err)) or "")
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
local cache_mediainfo_cha = fs.cha(cache_mediainfo_url)
|
||||
if cache_mediainfo_cha and not job.args.force_reload_mediainfo then
|
||||
return true, err_msg ~= "" and ("Error: " .. err_msg) or nil
|
||||
end
|
||||
local cmd = "mediainfo"
|
||||
local output, err
|
||||
if is_valid_utf8_path then
|
||||
output, err = Command(cmd)
|
||||
:arg({ tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url) })
|
||||
:output()
|
||||
else
|
||||
cmd = "cd "
|
||||
.. path_quote(job.file.path or job.file.cache or (job.file.url.path or job.file.url).parent)
|
||||
.. " && "
|
||||
.. cmd
|
||||
.. " "
|
||||
.. path_quote(tostring(job.file.path or job.file.cache or job.file.url.name))
|
||||
output, err = Command(SHELL)
|
||||
:arg({ "-c", cmd })
|
||||
:arg({ tostring(job.file.path or job.file.cache or (job.file.url.path or job.file.url)) })
|
||||
:output()
|
||||
end
|
||||
if err then
|
||||
err_msg = err_msg .. string.format("Failed to start `%s`, Do you have `%s` installed?\n", cmd, cmd)
|
||||
end
|
||||
return fs.write(
|
||||
cache_mediainfo_url,
|
||||
(err_msg ~= "" and ("Error: " .. err_msg) or "") .. (output and output.stdout or "")
|
||||
)
|
||||
end
|
||||
|
||||
function M:entry(job)
|
||||
local action = job.args[1]
|
||||
|
||||
if action == ENTRY_ACTION.toggle_metadata then
|
||||
set_state(STATE_KEY.hide_metadata, not get_state(STATE_KEY.hide_metadata))
|
||||
M:re_peek()
|
||||
end
|
||||
end
|
||||
|
||||
return M
|
||||
@@ -0,0 +1,149 @@
|
||||
--- @since 26.1.22
|
||||
|
||||
local M = {}
|
||||
local const = require(".const")
|
||||
local utils = require(".utils")
|
||||
|
||||
function M:peek(job)
|
||||
local preload_status, preload_err = self:preload(job)
|
||||
-- Stop if preload failed
|
||||
if not preload_status then
|
||||
return
|
||||
end
|
||||
|
||||
local cache_img_url_no_skip = ya.file_cache({ file = job.file, skip = 0 })
|
||||
|
||||
local lines = {}
|
||||
local limit = job.area.h
|
||||
local last_line = 0
|
||||
local EOF_mediainfo = true
|
||||
local is_wrap = rt.preview.wrap == "yes" or rt.preview.wrap == ui.Wrap.YES
|
||||
|
||||
local cache_mediainfo_path = tostring(cache_img_url_no_skip) .. const.suffix
|
||||
local output = utils.read_mediainfo_cached_file(cache_mediainfo_path)
|
||||
if output then
|
||||
local max_width = math.max(1, job.area.w)
|
||||
if output:match("^Error:") then
|
||||
job.args.force_reload_mediainfo = true
|
||||
preload_status, preload_err = self:preload(job)
|
||||
if not preload_status or preload_err then
|
||||
return
|
||||
end
|
||||
output = utils.read_mediainfo_cached_file(cache_mediainfo_path)
|
||||
end
|
||||
|
||||
output = output:gsub("\n+$", "")
|
||||
|
||||
local iter = output:gmatch("[^\n]*")
|
||||
local str = iter()
|
||||
|
||||
while str ~= nil do
|
||||
local next_str = iter()
|
||||
local label, value = str:match("(.*[^ ]) +: (.*)")
|
||||
local line
|
||||
if label then
|
||||
if not (utils.get_state(const.STATE_KEY.skip_labels) or const.skip_labels)[label] then
|
||||
line = ui.Line({
|
||||
ui.Span(label .. ": "):style(ui.Style():fg("reset"):bold()),
|
||||
ui.Span(value):style(th.spot.tbl_col or ui.Style():fg("blue")),
|
||||
})
|
||||
end
|
||||
else
|
||||
if not (utils.get_state(const.STATE_KEY.skip_section_labels) or {})[str] then
|
||||
line = ui.Line({ ui.Span(str):style(th.spot.title or ui.Style():fg("green")) })
|
||||
end
|
||||
end
|
||||
|
||||
if line then
|
||||
local line_height = ui.height
|
||||
and ui.height(str, { width = max_width, ansi = true, wrap = rt.preview.wrap })
|
||||
or (math.max(1, is_wrap and math.ceil(ui.width(line) / max_width) or 1))
|
||||
if next_str == nil and line_height == 1 then
|
||||
EOF_mediainfo = true
|
||||
end
|
||||
if (last_line + line_height) > job.skip then
|
||||
table.insert(lines, line)
|
||||
end
|
||||
if (last_line + line_height) >= job.skip + limit then
|
||||
last_line = job.skip + limit
|
||||
EOF_mediainfo = false
|
||||
break
|
||||
end
|
||||
last_line = last_line + line_height
|
||||
end
|
||||
str = next_str
|
||||
end
|
||||
end
|
||||
|
||||
if EOF_mediainfo and #lines == 0 and job.skip > 0 then
|
||||
ya.emit("peek", {
|
||||
math.max(0, (job.skip - (utils.get_state(const.STATE_KEY.units) or 0))),
|
||||
only_if = job.file.url,
|
||||
upper_bound = true,
|
||||
})
|
||||
return
|
||||
end
|
||||
|
||||
utils.force_render()
|
||||
-- Handle preload error
|
||||
if preload_err then
|
||||
table.insert(lines, ui.Line(tostring(preload_err)):style(th.spot.title or ui.Style():fg("red")))
|
||||
end
|
||||
|
||||
ya.preview_widget(job, {
|
||||
ui.Clear(job.area),
|
||||
ui.Text(lines):area(job.area):wrap(is_wrap and ui.Wrap.YES or ui.Wrap.NO),
|
||||
})
|
||||
|
||||
-- NOTE: Hacky way to prevent image overlap with old metadata area
|
||||
utils.set_state(const.STATE_KEY.prev_metadata_area, {
|
||||
x = job.area.x,
|
||||
y = job.area.y,
|
||||
w = job.area.w,
|
||||
h = job.area.h,
|
||||
win_x = job.area.x,
|
||||
win_y = job.area.y,
|
||||
win_w = job.area.w,
|
||||
win_h = job.area.h,
|
||||
} or nil)
|
||||
end
|
||||
|
||||
function M:preload(job)
|
||||
local cmd = "mediainfo"
|
||||
local err_msg = ""
|
||||
local is_valid_utf8_path = utils.is_valid_utf8(tostring(job.file.path or job.file.cache or job.file.url))
|
||||
|
||||
-- NOTE: Get mediainfo and save to cache folder
|
||||
local cache_mediainfo_url = Url(tostring(ya.file_cache({ file = job.file, skip = 0 })) .. const.suffix)
|
||||
local cache_mediainfo_cha = fs.cha(cache_mediainfo_url)
|
||||
-- Case peek function called preload to refetch mediainfo
|
||||
if cache_mediainfo_cha and not job.args.force_reload_mediainfo then
|
||||
return true, err_msg ~= "" and ("Error: " .. err_msg) or nil
|
||||
end
|
||||
|
||||
local output, err
|
||||
if is_valid_utf8_path then
|
||||
output, err = Command(cmd)
|
||||
:arg({ tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url) })
|
||||
:output()
|
||||
else
|
||||
cmd = "cd "
|
||||
.. utils.path_quote(tostring((job.file.path or job.file.cache or job.file.url.path or job.file.url).parent))
|
||||
.. " && "
|
||||
.. cmd
|
||||
.. " "
|
||||
.. utils.path_quote(tostring((job.file.path or job.file.cache or job.file.url).name))
|
||||
output, err = Command(const.SHELL):arg({ "-c", cmd }):output()
|
||||
end
|
||||
if err then
|
||||
ya.dbg("mediainfo", tostring(err))
|
||||
err_msg = err_msg .. string.format("Failed to start `%s`. \n Do you have `%s` installed?\n", cmd, cmd)
|
||||
end
|
||||
|
||||
return fs.write(
|
||||
cache_mediainfo_url,
|
||||
(err_msg ~= "" and ("Error: " .. err_msg) or "") .. (output and output.stdout or "")
|
||||
)
|
||||
end
|
||||
|
||||
return M
|
||||
@@ -0,0 +1,185 @@
|
||||
--- @since 26.5.6
|
||||
|
||||
local M = {}
|
||||
local const = require(".const")
|
||||
local utils = require(".utils")
|
||||
|
||||
function M:peek(job)
|
||||
local preload_status, preload_err = self:preload(job)
|
||||
-- Stop if preload failed
|
||||
if not preload_status then
|
||||
return
|
||||
end
|
||||
|
||||
local cache_img_url_no_skip = ya.file_cache({ file = job.file, skip = 0 })
|
||||
|
||||
local lines = {}
|
||||
local limit = job.area.h
|
||||
local last_line = 0
|
||||
local EOF_mediainfo = true
|
||||
local is_wrap = rt.preview.wrap == "yes" or rt.preview.wrap == ui.Wrap.YES
|
||||
|
||||
local cache_mediainfo_path = tostring(cache_img_url_no_skip) .. const.suffix
|
||||
local output = utils.read_mediainfo_cached_file(cache_mediainfo_path)
|
||||
if output then
|
||||
local max_width = math.max(1, job.area.w)
|
||||
if output:match("^Error:") then
|
||||
job.args.force_reload_mediainfo = true
|
||||
preload_status, preload_err = self:preload(job)
|
||||
if not preload_status or preload_err then
|
||||
return
|
||||
end
|
||||
output = utils.read_mediainfo_cached_file(cache_mediainfo_path)
|
||||
end
|
||||
|
||||
output = output:gsub("\n+$", "")
|
||||
|
||||
local iter = output:gmatch("[^\n]*")
|
||||
local str = iter()
|
||||
local opt = { ansi = true, tab_size = rt.preview.tab_size, wrap = rt.preview.wrap, width = max_width }
|
||||
while str ~= nil do
|
||||
local next_str = iter()
|
||||
local label, value = str:match("(.*[^ ]) +: (.*)")
|
||||
|
||||
local line
|
||||
if label then
|
||||
if not (utils.get_state(const.STATE_KEY.skip_labels) or const.skip_labels)[label] then
|
||||
line = label .. ": " .. value
|
||||
end
|
||||
else
|
||||
if not (utils.get_state(const.STATE_KEY.skip_section_labels) or {})[str] then
|
||||
line = str
|
||||
end
|
||||
end
|
||||
|
||||
if line then
|
||||
local wrapped = ui.lines(line, opt)
|
||||
local line_height = #wrapped
|
||||
local from = 1
|
||||
local to = math.min(line_height, job.skip + limit - last_line)
|
||||
|
||||
local total_rendered_text_len = 1
|
||||
local total_label_rendered_len = 1
|
||||
local label_total_len = label and utf8.len(label .. ": ") or 0
|
||||
for j = from, to do
|
||||
local current_line_components = {}
|
||||
local wrapped_line_len = wrapped[j]:width() or 0
|
||||
local wrapped_raw =
|
||||
utils.utf8_sub(line, total_rendered_text_len, total_rendered_text_len + wrapped_line_len)
|
||||
wrapped_line_len = utf8.len(wrapped_raw)
|
||||
total_rendered_text_len = total_rendered_text_len + wrapped_line_len
|
||||
|
||||
if last_line + 1 > job.skip then
|
||||
local label_raw = label_total_len - total_label_rendered_len <= 0 and ""
|
||||
or utils.utf8_sub(wrapped_raw, 1, label_total_len - total_label_rendered_len)
|
||||
local label_raw_len = utf8.len(label_raw)
|
||||
if label_raw_len > 0 then
|
||||
table.insert(
|
||||
current_line_components,
|
||||
ui.Span(label_raw):style(ui.Style():fg("reset"):bold())
|
||||
)
|
||||
total_label_rendered_len = total_label_rendered_len + label_raw_len
|
||||
wrapped_raw = wrapped_raw:gsub("^" .. utils.is_literal_string(label_raw), "", 1)
|
||||
end
|
||||
if total_label_rendered_len >= label_total_len then
|
||||
local value_raw = wrapped_raw
|
||||
table.insert(
|
||||
current_line_components,
|
||||
ui.Span(value_raw or ""):style(
|
||||
label and (th.spot.tbl_col or ui.Style():fg("blue"))
|
||||
or (th.spot.title or ui.Style():fg("green"))
|
||||
)
|
||||
)
|
||||
end
|
||||
table.insert(lines, ui.Line(current_line_components))
|
||||
-- last_line = last_line + 1
|
||||
else
|
||||
total_label_rendered_len = total_label_rendered_len + total_rendered_text_len
|
||||
end
|
||||
last_line = last_line + 1
|
||||
if next_str == nil and not wrapped[j + 1] then
|
||||
EOF_mediainfo = true
|
||||
end
|
||||
if last_line >= job.skip + limit then
|
||||
last_line = job.skip + limit
|
||||
EOF_mediainfo = false
|
||||
break
|
||||
end
|
||||
end
|
||||
end
|
||||
str = next_str
|
||||
end
|
||||
end
|
||||
|
||||
if EOF_mediainfo and #lines == 0 and job.skip > 0 then
|
||||
ya.emit("peek", {
|
||||
math.max(0, (job.skip - (utils.get_state(const.STATE_KEY.units) or 0))),
|
||||
only_if = job.file.url,
|
||||
upper_bound = true,
|
||||
})
|
||||
return
|
||||
end
|
||||
|
||||
utils.force_render()
|
||||
-- Handle preload error
|
||||
if preload_err then
|
||||
table.insert(lines, ui.Line(tostring(preload_err)):style(th.spot.title or ui.Style():fg("red")))
|
||||
end
|
||||
|
||||
ya.preview_widget(job, {
|
||||
ui.Clear(job.area),
|
||||
ui.Text(lines):area(job.area):wrap(is_wrap and ui.Wrap.YES or ui.Wrap.NO),
|
||||
})
|
||||
|
||||
-- NOTE: Hacky way to prevent image overlap with old metadata area
|
||||
utils.set_state(const.STATE_KEY.prev_metadata_area, {
|
||||
x = job.area.x,
|
||||
y = job.area.y,
|
||||
w = job.area.w,
|
||||
h = job.area.h,
|
||||
win_x = job.area.x,
|
||||
win_y = job.area.y,
|
||||
win_w = job.area.w,
|
||||
win_h = job.area.h,
|
||||
} or nil)
|
||||
end
|
||||
|
||||
function M:preload(job)
|
||||
local cmd = "mediainfo"
|
||||
local err_msg = ""
|
||||
local is_valid_utf8_path = utils.is_valid_utf8(tostring(job.file.path or job.file.cache or job.file.url))
|
||||
|
||||
-- NOTE: Get mediainfo and save to cache folder
|
||||
local cache_mediainfo_url = Url(tostring(ya.file_cache({ file = job.file, skip = 0 })) .. const.suffix)
|
||||
local cache_mediainfo_cha = fs.cha(cache_mediainfo_url)
|
||||
-- Case peek function called preload to refetch mediainfo
|
||||
if cache_mediainfo_cha and not job.args.force_reload_mediainfo then
|
||||
return true, err_msg ~= "" and ("Error: " .. err_msg) or nil
|
||||
end
|
||||
|
||||
local output, err
|
||||
if is_valid_utf8_path then
|
||||
output, err = Command(cmd)
|
||||
:arg({ tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url) })
|
||||
:output()
|
||||
else
|
||||
cmd = "cd "
|
||||
.. utils.path_quote(tostring((job.file.path or job.file.cache or job.file.url.path or job.file.url).parent))
|
||||
.. " && "
|
||||
.. cmd
|
||||
.. " "
|
||||
.. utils.path_quote(tostring((job.file.path or job.file.cache or job.file.url).name))
|
||||
output, err = Command(const.SHELL):arg({ "-c", cmd }):output()
|
||||
end
|
||||
if err then
|
||||
ya.dbg("mediainfo", tostring(err))
|
||||
err_msg = err_msg .. string.format("Failed to start `%s`. \n Do you have `%s` installed?\n", cmd, cmd)
|
||||
end
|
||||
|
||||
return fs.write(
|
||||
cache_mediainfo_url,
|
||||
(err_msg ~= "" and ("Error: " .. err_msg) or "") .. (output and output.stdout or "")
|
||||
)
|
||||
end
|
||||
|
||||
return M
|
||||
@@ -0,0 +1,127 @@
|
||||
--- @since 26.1.22
|
||||
|
||||
local const = require(".const")
|
||||
|
||||
local M = {}
|
||||
local MAX_ITEMS_IN_CACHE = 10
|
||||
|
||||
function M.is_valid_utf8(str)
|
||||
return utf8.len(str) ~= nil
|
||||
end
|
||||
|
||||
function M.utf8_sub(str, start_char, end_char)
|
||||
local start_byte = utf8.offset(str, start_char) -- Expects start_char to be a character index
|
||||
local end_byte = end_char and (utf8.offset(str, end_char + 1) or (#str + 1)) - 1 -- Expects end_char
|
||||
if not start_byte then
|
||||
return ""
|
||||
end
|
||||
return str:sub(start_byte, end_byte)
|
||||
end
|
||||
function M.is_literal_string(str)
|
||||
return str and str:gsub("([%^%$%(%)%%%.%[%]%*%+%-%?])", "%%%1")
|
||||
end
|
||||
function M.path_quote(path)
|
||||
if not path or tostring(path) == "" then
|
||||
return path
|
||||
end
|
||||
local result = "'" .. string.gsub(tostring(path), "'", "'\\''") .. "'"
|
||||
return result
|
||||
end
|
||||
|
||||
M.force_render = ya.sync(function(_, _)
|
||||
(ui.render or ya.render)()
|
||||
end)
|
||||
|
||||
M.set_state = ya.sync(function(state, key, value)
|
||||
state[key] = value
|
||||
end)
|
||||
|
||||
M.get_state = ya.sync(function(state, key)
|
||||
return state[key]
|
||||
end)
|
||||
|
||||
M.set_states = ya.sync(function(state, namespace, key, value, limit_cached_items)
|
||||
if not limit_cached_items then
|
||||
limit_cached_items = MAX_ITEMS_IN_CACHE
|
||||
end
|
||||
if not state[namespace] then
|
||||
state[namespace] = {}
|
||||
end
|
||||
local storage = state[namespace]
|
||||
if limit_cached_items and #storage > limit_cached_items then
|
||||
table.remove(storage, 1)
|
||||
end
|
||||
storage[key] = value
|
||||
end)
|
||||
|
||||
M.get_states = ya.sync(function(state, namespace, key)
|
||||
local storage = state[namespace]
|
||||
if not storage then
|
||||
return nil
|
||||
end
|
||||
|
||||
if storage then
|
||||
return storage[key]
|
||||
end
|
||||
end)
|
||||
function M.read_mediainfo_cached_file(file_path)
|
||||
local cached = M.get_states(const.STATE_KEY.cached_mediainfo, file_path)
|
||||
if cached then
|
||||
return cached
|
||||
end
|
||||
-- Open the file in read mode
|
||||
local file = io.open(file_path, "r")
|
||||
|
||||
if file then
|
||||
-- Read the entire file content
|
||||
local content = file:read("*all")
|
||||
file:close()
|
||||
M.set_states(const.STATE_KEY.cached_mediainfo, file_path, content)
|
||||
return content
|
||||
end
|
||||
end
|
||||
|
||||
M.current_file = ya.sync(function()
|
||||
local h = cx.active.current.hovered
|
||||
if not h then
|
||||
return
|
||||
end
|
||||
return tostring(h.url)
|
||||
end)
|
||||
|
||||
function M.error(s, ...)
|
||||
ya.notify({ title = "mediainfo", content = string.format(s, ...), timeout = 3, level = "error" })
|
||||
end
|
||||
|
||||
function M.info(s, ...)
|
||||
ya.notify({ title = "mediainfo", content = string.format(s, ...), timeout = 3, level = "info" })
|
||||
end
|
||||
|
||||
--- return a string array with unique value
|
||||
---@param tbl string[]
|
||||
---@return string[] table with only unique strings
|
||||
function M.tbl_unique_strings(tbl)
|
||||
local unique_table = {}
|
||||
local seen = {}
|
||||
|
||||
for _, str in ipairs(tbl) do
|
||||
if not seen[str] then
|
||||
seen[str] = true
|
||||
table.insert(unique_table, str)
|
||||
end
|
||||
end
|
||||
|
||||
return unique_table
|
||||
end
|
||||
|
||||
function M.tbl_to_set(t1)
|
||||
local set = {}
|
||||
|
||||
for _, v in ipairs(t1) do
|
||||
set[v] = true
|
||||
end
|
||||
|
||||
return set
|
||||
end
|
||||
|
||||
return M
|
||||
@@ -0,0 +1,241 @@
|
||||
--- @since 26.1.22
|
||||
|
||||
local M = {}
|
||||
local const = require(".const")
|
||||
local utils = require(".utils")
|
||||
|
||||
function M:peek(job)
|
||||
local preload_status, preload_err = self:preload(job)
|
||||
-- Stop if preload failed
|
||||
if not preload_status then
|
||||
return
|
||||
end
|
||||
|
||||
local cache_img_url = ya.file_cache({
|
||||
skip = job.skip > 90 and 90 or job.skip,
|
||||
args = job.args,
|
||||
file = job.file,
|
||||
area = job.area,
|
||||
})
|
||||
local cache_img_url_no_skip = ya.file_cache({ file = job.file, skip = 0 })
|
||||
|
||||
local no_metadata = job.args.no_metadata
|
||||
local mediainfo_job_skip = job.skip
|
||||
::recalc_mediainfo_job_skip::
|
||||
local mediainfo_height = 0
|
||||
local lines = {}
|
||||
local limit = job.area.h
|
||||
local last_line = 0
|
||||
local EOF_mediainfo = true
|
||||
local is_wrap = rt.preview.wrap == "yes" or rt.preview.wrap == ui.Wrap.YES
|
||||
|
||||
if not no_metadata then
|
||||
local cache_mediainfo_path = tostring(cache_img_url_no_skip) .. const.suffix
|
||||
local output = utils.read_mediainfo_cached_file(cache_mediainfo_path)
|
||||
if output then
|
||||
local max_width = math.max(1, job.area.w)
|
||||
if output:match("^Error:") then
|
||||
job.args.force_reload_mediainfo = true
|
||||
preload_status, preload_err = self:preload(job)
|
||||
if not preload_status or preload_err then
|
||||
return
|
||||
end
|
||||
output = utils.read_mediainfo_cached_file(cache_mediainfo_path)
|
||||
end
|
||||
|
||||
output = output:gsub("\n+$", "")
|
||||
|
||||
local iter = output:gmatch("[^\n]*")
|
||||
local str = iter()
|
||||
|
||||
while str ~= nil do
|
||||
local next_str = iter()
|
||||
local label, value = str:match("(.*[^ ]) +: (.*)")
|
||||
local line
|
||||
if label then
|
||||
if not (utils.get_state(const.STATE_KEY.skip_labels) or const.skip_labels)[label] then
|
||||
line = ui.Line({
|
||||
ui.Span(label .. ": "):style(ui.Style():fg("reset"):bold()),
|
||||
ui.Span(value):style(th.spot.tbl_col or ui.Style():fg("blue")),
|
||||
})
|
||||
end
|
||||
else
|
||||
if not (utils.get_state(const.STATE_KEY.skip_section_labels) or {})[str] then
|
||||
line = ui.Line({ ui.Span(str):style(th.spot.title or ui.Style():fg("green")) })
|
||||
end
|
||||
end
|
||||
|
||||
if line then
|
||||
local line_height = ui.height
|
||||
and ui.height(str, { width = max_width, ansi = true, wrap = rt.preview.wrap })
|
||||
or (math.max(1, is_wrap and math.ceil(ui.width(line) / max_width) or 1))
|
||||
if next_str == nil and line_height == 1 then
|
||||
EOF_mediainfo = true
|
||||
end
|
||||
if (last_line + line_height) > mediainfo_job_skip then
|
||||
table.insert(lines, line)
|
||||
end
|
||||
if (last_line + line_height) >= mediainfo_job_skip + limit then
|
||||
last_line = mediainfo_job_skip + limit
|
||||
EOF_mediainfo = false
|
||||
break
|
||||
end
|
||||
last_line = last_line + line_height
|
||||
end
|
||||
str = next_str
|
||||
end
|
||||
end
|
||||
mediainfo_height = math.min(limit, last_line)
|
||||
end
|
||||
|
||||
if not no_metadata then
|
||||
if EOF_mediainfo and #lines == 0 and mediainfo_job_skip > 0 then
|
||||
if job.skip > 90 then
|
||||
ya.emit("peek", {
|
||||
math.max(0, (job.skip - (utils.get_state(const.STATE_KEY.units) or 0))),
|
||||
only_if = job.file.url,
|
||||
upper_bound = true,
|
||||
})
|
||||
return
|
||||
else
|
||||
-- NOTE: Recalculate mediainfo using cached latest valid skip value when reach the end of mediainfo output
|
||||
local last_valid_mediainfo_skip = utils.get_state(const.STATE_KEY.last_valid_mediainfo_skip)
|
||||
mediainfo_job_skip = last_valid_mediainfo_skip
|
||||
and last_valid_mediainfo_skip[tostring(cache_img_url_no_skip)]
|
||||
or math.max(0, mediainfo_job_skip - (utils.get_state(const.STATE_KEY.units) or 0))
|
||||
|
||||
goto recalc_mediainfo_job_skip
|
||||
end
|
||||
else
|
||||
utils.set_state(
|
||||
const.STATE_KEY.last_valid_mediainfo_skip,
|
||||
{ [tostring(cache_img_url_no_skip)] = mediainfo_job_skip }
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
-- NOTE: Hacky way to prevent image overlap with old metadata area
|
||||
if utils.get_state(const.STATE_KEY.prev_metadata_area) then
|
||||
local old_metadata_area = utils.get_state(const.STATE_KEY.prev_metadata_area)
|
||||
if
|
||||
old_metadata_area.win_x == job.area.x
|
||||
and old_metadata_area.win_y == job.area.y
|
||||
and old_metadata_area.win_w == job.area.w
|
||||
and old_metadata_area.win_h == job.area.h
|
||||
then
|
||||
ya.preview_widget(job, {
|
||||
ui.Clear(ui.Rect({
|
||||
x = old_metadata_area.x,
|
||||
y = old_metadata_area.y,
|
||||
w = old_metadata_area.w,
|
||||
h = old_metadata_area.h,
|
||||
})),
|
||||
})
|
||||
end
|
||||
end
|
||||
|
||||
utils.force_render()
|
||||
local rendered_img_rect = cache_img_url
|
||||
and fs.cha(cache_img_url)
|
||||
and ya.image_show(
|
||||
cache_img_url,
|
||||
ui.Rect({
|
||||
x = job.area.x,
|
||||
y = job.area.y,
|
||||
w = job.area.w,
|
||||
h = mediainfo_height > 0 and math.max(job.area.h - mediainfo_height, job.area.h / 2) or job.area.h,
|
||||
})
|
||||
)
|
||||
or nil
|
||||
local image_height = rendered_img_rect and rendered_img_rect.h or 0
|
||||
|
||||
-- NOTE: Workaround case video.lua doesn't doesn't generate preview image because of `skip` overflow video duration
|
||||
if not rendered_img_rect then
|
||||
local prev_image_height = utils.get_state(const.STATE_KEY.prev_image_height)
|
||||
image_height = prev_image_height and prev_image_height[tostring(cache_img_url_no_skip)] or 0
|
||||
else
|
||||
utils.set_state(const.STATE_KEY.prev_image_height, { [tostring(cache_img_url_no_skip)] = image_height })
|
||||
end
|
||||
|
||||
-- Handle image preload error
|
||||
if preload_err then
|
||||
table.insert(lines, ui.Line(tostring(preload_err)):style(th.spot.title or ui.Style():fg("red")))
|
||||
end
|
||||
|
||||
ya.preview_widget(job, {
|
||||
ui.Text(lines)
|
||||
:area(ui.Rect({
|
||||
x = job.area.x,
|
||||
y = job.area.y + image_height,
|
||||
w = job.area.w,
|
||||
h = job.area.h - image_height,
|
||||
}))
|
||||
:wrap(is_wrap and ui.Wrap.YES or ui.Wrap.NO),
|
||||
})
|
||||
|
||||
-- NOTE: Hacky way to prevent image overlap with old metadata area
|
||||
utils.set_state(const.STATE_KEY.prev_metadata_area, not no_metadata and {
|
||||
x = job.area.x,
|
||||
y = job.area.y + image_height,
|
||||
w = job.area.w,
|
||||
h = job.area.h - image_height,
|
||||
win_x = job.area.x,
|
||||
win_y = job.area.y,
|
||||
win_w = job.area.w,
|
||||
win_h = job.area.h,
|
||||
} or nil)
|
||||
end
|
||||
|
||||
function M:preload(job)
|
||||
local cmd = "mediainfo"
|
||||
local err_msg = ""
|
||||
|
||||
-- NOTE: Preload image from video
|
||||
|
||||
local cache_img_status, video_preload_err = require("video"):preload({
|
||||
skip = job.skip > 90 and 90 or job.skip,
|
||||
args = job.args,
|
||||
file = job.file,
|
||||
area = job.area,
|
||||
})
|
||||
|
||||
if not cache_img_status and video_preload_err then
|
||||
ya.dbg("mediainfo", video_preload_err)
|
||||
err_msg = err_msg .. string.format("Failed to start `%s`.\n Do you have `%s` installed?\n", "ffmpeg", "ffmpeg")
|
||||
end
|
||||
|
||||
-- NOTE: Get mediainfo and save to cache folder
|
||||
local cache_mediainfo_url = Url(tostring(ya.file_cache({ file = job.file, skip = 0 })) .. const.suffix)
|
||||
local cache_mediainfo_cha = fs.cha(cache_mediainfo_url)
|
||||
-- Case peek function called preload to refetch mediainfo
|
||||
if cache_mediainfo_cha and not job.args.force_reload_mediainfo then
|
||||
return true, err_msg ~= "" and ("Error: " .. err_msg) or nil
|
||||
end
|
||||
|
||||
local output, err
|
||||
local is_valid_utf8_path = utils.is_valid_utf8(tostring(job.file.path or job.file.cache or job.file.url))
|
||||
if is_valid_utf8_path then
|
||||
output, err = Command(cmd)
|
||||
:arg({ tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url) })
|
||||
:output()
|
||||
else
|
||||
cmd = "cd "
|
||||
.. utils.path_quote(tostring((job.file.path or job.file.cache or job.file.url.path or job.file.url).parent))
|
||||
.. " && "
|
||||
.. cmd
|
||||
.. " "
|
||||
.. utils.path_quote(tostring((job.file.path or job.file.cache or job.file.url).name))
|
||||
output, err = Command(const.SHELL):arg({ "-c", cmd }):output()
|
||||
end
|
||||
if err then
|
||||
ya.dbg("mediainfo", tostring(err))
|
||||
err_msg = err_msg .. string.format("Failed to start `%s`. \n Do you have `%s` installed?\n", cmd, cmd)
|
||||
end
|
||||
|
||||
return fs.write(
|
||||
cache_mediainfo_url,
|
||||
(err_msg ~= "" and ("Error: " .. err_msg) or "") .. (output and output.stdout or "")
|
||||
)
|
||||
end
|
||||
|
||||
return M
|
||||
@@ -0,0 +1,277 @@
|
||||
--- @since 26.5.6
|
||||
|
||||
local M = {}
|
||||
local const = require(".const")
|
||||
local utils = require(".utils")
|
||||
|
||||
function M:peek(job)
|
||||
local preload_status, preload_err = self:preload(job)
|
||||
-- Stop if preload failed
|
||||
if not preload_status then
|
||||
return
|
||||
end
|
||||
|
||||
local cache_img_url = ya.file_cache({
|
||||
skip = job.skip > 90 and 90 or job.skip,
|
||||
args = job.args,
|
||||
file = job.file,
|
||||
area = job.area,
|
||||
})
|
||||
local cache_img_url_no_skip = ya.file_cache({ file = job.file, skip = 0 })
|
||||
|
||||
local no_metadata = job.args.no_metadata
|
||||
local mediainfo_job_skip = job.skip
|
||||
::recalc_mediainfo_job_skip::
|
||||
local mediainfo_height = 0
|
||||
local lines = {}
|
||||
local limit = job.area.h
|
||||
local last_line = 0
|
||||
local EOF_mediainfo = true
|
||||
local is_wrap = rt.preview.wrap == "yes" or rt.preview.wrap == ui.Wrap.YES
|
||||
|
||||
if not no_metadata then
|
||||
local cache_mediainfo_path = tostring(cache_img_url_no_skip) .. const.suffix
|
||||
local output = utils.read_mediainfo_cached_file(cache_mediainfo_path)
|
||||
if output then
|
||||
local max_width = math.max(1, job.area.w)
|
||||
if output:match("^Error:") then
|
||||
job.args.force_reload_mediainfo = true
|
||||
preload_status, preload_err = self:preload(job)
|
||||
if not preload_status or preload_err then
|
||||
return
|
||||
end
|
||||
output = utils.read_mediainfo_cached_file(cache_mediainfo_path)
|
||||
end
|
||||
|
||||
output = output:gsub("\n+$", "")
|
||||
|
||||
local iter = output:gmatch("[^\n]*")
|
||||
local str = iter()
|
||||
local opt = { ansi = true, tab_size = rt.preview.tab_size, wrap = rt.preview.wrap, width = max_width }
|
||||
while str ~= nil do
|
||||
local next_str = iter()
|
||||
local label, value = str:match("(.*[^ ]) +: (.*)")
|
||||
|
||||
local line
|
||||
if label then
|
||||
if not (utils.get_state(const.STATE_KEY.skip_labels) or const.skip_labels)[label] then
|
||||
line = label .. ": " .. value
|
||||
end
|
||||
else
|
||||
if not (utils.get_state(const.STATE_KEY.skip_section_labels) or {})[str] then
|
||||
line = str
|
||||
end
|
||||
end
|
||||
|
||||
if line then
|
||||
local wrapped = ui.lines(line, opt)
|
||||
local line_height = #wrapped
|
||||
local from = 1
|
||||
local to = math.min(line_height, mediainfo_job_skip + limit - last_line)
|
||||
|
||||
local total_rendered_text_len = 1
|
||||
local total_label_rendered_len = 1
|
||||
local label_total_len = label and utf8.len(label .. ": ") or 0
|
||||
for j = from, to do
|
||||
local current_line_components = {}
|
||||
local wrapped_line_len = wrapped[j]:width() or 0
|
||||
local wrapped_raw =
|
||||
utils.utf8_sub(line, total_rendered_text_len, total_rendered_text_len + wrapped_line_len)
|
||||
wrapped_line_len = utf8.len(wrapped_raw)
|
||||
total_rendered_text_len = total_rendered_text_len + wrapped_line_len
|
||||
|
||||
if last_line + 1 > mediainfo_job_skip then
|
||||
local label_raw = label_total_len - total_label_rendered_len <= 0 and ""
|
||||
or utils.utf8_sub(wrapped_raw, 1, label_total_len - total_label_rendered_len)
|
||||
local label_raw_len = utf8.len(label_raw)
|
||||
if label_raw_len > 0 then
|
||||
table.insert(
|
||||
current_line_components,
|
||||
ui.Span(label_raw):style(ui.Style():fg("reset"):bold())
|
||||
)
|
||||
total_label_rendered_len = total_label_rendered_len + label_raw_len
|
||||
wrapped_raw = wrapped_raw:gsub("^" .. utils.is_literal_string(label_raw), "", 1)
|
||||
end
|
||||
if total_label_rendered_len >= label_total_len then
|
||||
local value_raw = wrapped_raw
|
||||
table.insert(
|
||||
current_line_components,
|
||||
ui.Span(value_raw or ""):style(
|
||||
label and (th.spot.tbl_col or ui.Style():fg("blue"))
|
||||
or (th.spot.title or ui.Style():fg("green"))
|
||||
)
|
||||
)
|
||||
end
|
||||
table.insert(lines, ui.Line(current_line_components))
|
||||
-- last_line = last_line + 1
|
||||
else
|
||||
total_label_rendered_len = total_label_rendered_len + total_rendered_text_len
|
||||
end
|
||||
last_line = last_line + 1
|
||||
if next_str == nil and not wrapped[j + 1] then
|
||||
EOF_mediainfo = true
|
||||
end
|
||||
if last_line >= mediainfo_job_skip + limit then
|
||||
last_line = mediainfo_job_skip + limit
|
||||
EOF_mediainfo = false
|
||||
break
|
||||
end
|
||||
end
|
||||
end
|
||||
str = next_str
|
||||
end
|
||||
end
|
||||
mediainfo_height = math.min(limit, last_line)
|
||||
end
|
||||
|
||||
if not no_metadata then
|
||||
if EOF_mediainfo and #lines == 0 and mediainfo_job_skip > 0 then
|
||||
if job.skip > 90 then
|
||||
ya.emit("peek", {
|
||||
math.max(0, (job.skip - (utils.get_state(const.STATE_KEY.units) or 0))),
|
||||
only_if = job.file.url,
|
||||
upper_bound = true,
|
||||
})
|
||||
return
|
||||
else
|
||||
-- NOTE: Recalculate mediainfo using cached latest valid skip value when reach the end of mediainfo output
|
||||
local last_valid_mediainfo_skip = utils.get_state(const.STATE_KEY.last_valid_mediainfo_skip)
|
||||
mediainfo_job_skip = last_valid_mediainfo_skip
|
||||
and last_valid_mediainfo_skip[tostring(cache_img_url_no_skip)]
|
||||
or math.max(0, mediainfo_job_skip - (utils.get_state(const.STATE_KEY.units) or 0))
|
||||
|
||||
goto recalc_mediainfo_job_skip
|
||||
end
|
||||
else
|
||||
utils.set_state(
|
||||
const.STATE_KEY.last_valid_mediainfo_skip,
|
||||
{ [tostring(cache_img_url_no_skip)] = mediainfo_job_skip }
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
-- NOTE: Hacky way to prevent image overlap with old metadata area
|
||||
if utils.get_state(const.STATE_KEY.prev_metadata_area) then
|
||||
local old_metadata_area = utils.get_state(const.STATE_KEY.prev_metadata_area)
|
||||
if
|
||||
old_metadata_area.win_x == job.area.x
|
||||
and old_metadata_area.win_y == job.area.y
|
||||
and old_metadata_area.win_w == job.area.w
|
||||
and old_metadata_area.win_h == job.area.h
|
||||
then
|
||||
ya.preview_widget(job, {
|
||||
ui.Clear(ui.Rect({
|
||||
x = old_metadata_area.x,
|
||||
y = old_metadata_area.y,
|
||||
w = old_metadata_area.w,
|
||||
h = old_metadata_area.h,
|
||||
})),
|
||||
})
|
||||
end
|
||||
end
|
||||
|
||||
utils.force_render()
|
||||
local rendered_img_rect = cache_img_url
|
||||
and fs.cha(cache_img_url)
|
||||
and ya.image_show(
|
||||
cache_img_url,
|
||||
ui.Rect({
|
||||
x = job.area.x,
|
||||
y = job.area.y,
|
||||
w = job.area.w,
|
||||
h = mediainfo_height > 0 and math.max(job.area.h - mediainfo_height, job.area.h / 2) or job.area.h,
|
||||
})
|
||||
)
|
||||
or nil
|
||||
local image_height = rendered_img_rect and rendered_img_rect.h or 0
|
||||
|
||||
-- NOTE: Workaround case video.lua doesn't doesn't generate preview image because of `skip` overflow video duration
|
||||
if not rendered_img_rect then
|
||||
local prev_image_height = utils.get_state(const.STATE_KEY.prev_image_height)
|
||||
image_height = prev_image_height and prev_image_height[tostring(cache_img_url_no_skip)] or 0
|
||||
else
|
||||
utils.set_state(const.STATE_KEY.prev_image_height, { [tostring(cache_img_url_no_skip)] = image_height })
|
||||
end
|
||||
|
||||
-- Handle image preload error
|
||||
if preload_err then
|
||||
table.insert(lines, ui.Line(tostring(preload_err)):style(th.spot.title or ui.Style():fg("red")))
|
||||
end
|
||||
|
||||
ya.preview_widget(job, {
|
||||
ui.Text(lines)
|
||||
:area(ui.Rect({
|
||||
x = job.area.x,
|
||||
y = job.area.y + image_height,
|
||||
w = job.area.w,
|
||||
h = job.area.h - image_height,
|
||||
}))
|
||||
:wrap(is_wrap and ui.Wrap.YES or ui.Wrap.NO),
|
||||
})
|
||||
|
||||
-- NOTE: Hacky way to prevent image overlap with old metadata area
|
||||
utils.set_state(const.STATE_KEY.prev_metadata_area, not no_metadata and {
|
||||
x = job.area.x,
|
||||
y = job.area.y + image_height,
|
||||
w = job.area.w,
|
||||
h = job.area.h - image_height,
|
||||
win_x = job.area.x,
|
||||
win_y = job.area.y,
|
||||
win_w = job.area.w,
|
||||
win_h = job.area.h,
|
||||
} or nil)
|
||||
end
|
||||
|
||||
function M:preload(job)
|
||||
local cmd = "mediainfo"
|
||||
local err_msg = ""
|
||||
|
||||
-- NOTE: Preload image from video
|
||||
|
||||
local cache_img_status, video_preload_err = require("video"):preload({
|
||||
skip = job.skip > 90 and 90 or job.skip,
|
||||
args = job.args,
|
||||
file = job.file,
|
||||
area = job.area,
|
||||
})
|
||||
|
||||
if not cache_img_status and video_preload_err then
|
||||
ya.dbg("mediainfo", video_preload_err)
|
||||
err_msg = err_msg .. string.format("Failed to start `%s`.\n Do you have `%s` installed?\n", "ffmpeg", "ffmpeg")
|
||||
end
|
||||
|
||||
-- NOTE: Get mediainfo and save to cache folder
|
||||
local cache_mediainfo_url = Url(tostring(ya.file_cache({ file = job.file, skip = 0 })) .. const.suffix)
|
||||
local cache_mediainfo_cha = fs.cha(cache_mediainfo_url)
|
||||
-- Case peek function called preload to refetch mediainfo
|
||||
if cache_mediainfo_cha and not job.args.force_reload_mediainfo then
|
||||
return true, err_msg ~= "" and ("Error: " .. err_msg) or nil
|
||||
end
|
||||
|
||||
local output, err
|
||||
local is_valid_utf8_path = utils.is_valid_utf8(tostring(job.file.path or job.file.cache or job.file.url))
|
||||
if is_valid_utf8_path then
|
||||
output, err = Command(cmd)
|
||||
:arg({ tostring(job.file.path or job.file.cache or job.file.url.path or job.file.url) })
|
||||
:output()
|
||||
else
|
||||
cmd = "cd "
|
||||
.. utils.path_quote(tostring((job.file.path or job.file.cache or job.file.url.path or job.file.url).parent))
|
||||
.. " && "
|
||||
.. cmd
|
||||
.. " "
|
||||
.. utils.path_quote(tostring((job.file.path or job.file.cache or job.file.url).name))
|
||||
output, err = Command(const.SHELL):arg({ "-c", cmd }):output()
|
||||
end
|
||||
if err then
|
||||
ya.dbg("mediainfo", tostring(err))
|
||||
err_msg = err_msg .. string.format("Failed to start `%s`. \n Do you have `%s` installed?\n", cmd, cmd)
|
||||
end
|
||||
|
||||
return fs.write(
|
||||
cache_mediainfo_url,
|
||||
(err_msg ~= "" and ("Error: " .. err_msg) or "") .. (output and output.stdout or "")
|
||||
)
|
||||
end
|
||||
|
||||
return M
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2023 yazi-rs
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,56 @@
|
||||
# mime-ext.yazi
|
||||
|
||||
A mime-type provider based on a file extension database, replacing the [builtin `file(1)`](https://github.com/sxyazi/yazi/blob/main/yazi-plugin/preset/plugins/mime.lua) to speed up mime-type retrieval at the expense of accuracy.
|
||||
|
||||
See https://yazi-rs.github.io/docs/tips#make-yazi-even-faster for more information.
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
ya pkg add yazi-rs/plugins:mime-ext
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Add this to your `~/.config/yazi/yazi.toml`:
|
||||
|
||||
```toml
|
||||
[[plugin.prepend_fetchers]]
|
||||
id = "mime"
|
||||
url = "*"
|
||||
run = "mime-ext"
|
||||
prio = "high"
|
||||
```
|
||||
|
||||
## Advanced
|
||||
|
||||
You can also customize it in your `~/.config/yazi/init.lua` with:
|
||||
|
||||
```lua
|
||||
require("mime-ext"):setup {
|
||||
-- Expand the existing filename database (lowercase), for example:
|
||||
with_files = {
|
||||
makefile = "text/makefile",
|
||||
-- ...
|
||||
},
|
||||
|
||||
-- Expand the existing extension database (lowercase), for example:
|
||||
with_exts = {
|
||||
mk = "text/makefile",
|
||||
-- ...
|
||||
},
|
||||
|
||||
-- If the mime-type is not in both filename and extension databases,
|
||||
-- then fallback to Yazi's preset `mime` plugin, which uses `file(1)`
|
||||
fallback_file1 = false,
|
||||
}
|
||||
```
|
||||
|
||||
## TODO
|
||||
|
||||
- Add more file types (PRs welcome!).
|
||||
- Compress mime-type tables.
|
||||
|
||||
## License
|
||||
|
||||
This plugin is MIT-licensed. For more information check the [LICENSE](LICENSE) file.
|
||||
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,53 @@
|
||||
--- @since 26.8.15
|
||||
local M = {}
|
||||
|
||||
local function stale_cache(file)
|
||||
local url = file.url
|
||||
local stamp = url.spec.stamp:join(url:hash(true))
|
||||
|
||||
local fd = fs.access():read(true):open(Url(stamp))
|
||||
if not fd then
|
||||
return true
|
||||
end
|
||||
|
||||
local sig = fd:read(26)
|
||||
ya.drop(fd)
|
||||
return sig ~= file.cha:hash(true)
|
||||
end
|
||||
|
||||
function M:fetch(job)
|
||||
return ya.co(function()
|
||||
local updates, unknown = {}, {}
|
||||
for _, file in ipairs(job.files) do
|
||||
if file.cha.is_dummy then
|
||||
coroutine.yield(file, {})
|
||||
elseif not file.cache then
|
||||
unknown[#unknown + 1] = file
|
||||
elseif not fs.cha(Url(file.cache)) then
|
||||
updates[file.url] = coroutine.yield(file, { "vfs/absent" }) and "vfs/absent" or nil
|
||||
elseif stale_cache(file) then
|
||||
updates[file.url] = coroutine.yield(file, { "vfs/stale" }) and "vfs/stale" or nil
|
||||
else
|
||||
unknown[#unknown + 1] = file
|
||||
end
|
||||
end
|
||||
|
||||
if next(updates) then
|
||||
ya.emit("update_mimes", { updates = updates })
|
||||
end
|
||||
|
||||
if #unknown > 0 then
|
||||
self.fallback_local(job, unknown)
|
||||
end
|
||||
end)
|
||||
end
|
||||
|
||||
function M.fallback_local(job, unknown)
|
||||
local next = require(".local"):fetch(ya.dict_merge(job, { files = unknown }))
|
||||
local file, result = next()
|
||||
while file do
|
||||
file, result = next(coroutine.yield(file, result))
|
||||
end
|
||||
end
|
||||
|
||||
return M
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2023 yazi-rs
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,50 @@
|
||||
# mount.yazi
|
||||
|
||||
A mount manager for Yazi, providing disk mount, unmount, and eject functionality.
|
||||
|
||||
Supported platforms:
|
||||
|
||||
- Linux with [`udisksctl`](https://github.com/storaged-project/udisks), `lsblk` and `eject` both provided by [`util-linux`](https://github.com/util-linux/util-linux)
|
||||
- macOS with `diskutil`, which is pre-installed
|
||||
|
||||
https://github.com/user-attachments/assets/c6f780ab-458b-420f-85cf-2fc45fcfe3a2
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
ya pkg add yazi-rs/plugins:mount
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Add this to your `~/.config/yazi/keymap.toml`:
|
||||
|
||||
```toml
|
||||
[[mgr.prepend_keymap]]
|
||||
on = "M"
|
||||
run = "plugin mount"
|
||||
```
|
||||
|
||||
Note that, the keybindings above are just examples, please tune them up as needed to ensure they don't conflict with your other commands/plugins.
|
||||
|
||||
## Actions
|
||||
|
||||
| Key binding | Alternate key | Action |
|
||||
| ------------ | ------------- | --------------------- |
|
||||
| <kbd>q</kbd> | - | Quit the plugin |
|
||||
| <kbd>k</kbd> | <kbd>↑</kbd> | Move up |
|
||||
| <kbd>j</kbd> | <kbd>↓</kbd> | Move down |
|
||||
| <kbd>l</kbd> | <kbd>→</kbd> | Enter the mount point |
|
||||
| <kbd>m</kbd> | - | Mount the partition |
|
||||
| <kbd>u</kbd> | - | Unmount the partition |
|
||||
| <kbd>e</kbd> | - | Eject the disk |
|
||||
|
||||
## TODO
|
||||
|
||||
- Custom keybindings
|
||||
- Windows support (I don't use Windows myself, PRs welcome!)
|
||||
- Support mount, unmount, and eject the entire disk
|
||||
|
||||
## License
|
||||
|
||||
This plugin is MIT-licensed. For more information check the [LICENSE](LICENSE) file.
|
||||
@@ -0,0 +1,148 @@
|
||||
local M = {}
|
||||
|
||||
--- @param type "mount"|"unmount"|"eject"
|
||||
--- @param partition table
|
||||
function M.operate(type, partition)
|
||||
if not partition then
|
||||
return
|
||||
elseif not partition.sub then
|
||||
return -- TODO: mount/unmount main disk
|
||||
end
|
||||
|
||||
local cmd, output, err
|
||||
if ya.target_os() == "macos" then
|
||||
cmd, output, err = "diskutil", M.diskutil(type, partition.src)
|
||||
elseif ya.target_os() == "linux" then
|
||||
if type == "eject" and partition.src:match("^/dev/sr%d+") then
|
||||
M.udisksctl("unmount", partition.src)
|
||||
cmd, output, err = "eject", M.eject(partition.src)
|
||||
elseif type == "eject" then
|
||||
M.udisksctl("unmount", partition.src)
|
||||
cmd, output, err = "udisksctl", M.udisksctl("power-off", partition.src)
|
||||
else
|
||||
cmd, output, err = "udisksctl", M.udisksctl(type, partition.src)
|
||||
end
|
||||
end
|
||||
|
||||
if not cmd then
|
||||
M.fail("mount.yazi is not currently supported on your platform")
|
||||
elseif not output then
|
||||
M.fail("Failed to spawn `%s`: %s", cmd, err)
|
||||
elseif not output.status.success then
|
||||
M.fail("Failed to %s `%s`: %s", type, partition.src, output.stderr)
|
||||
end
|
||||
end
|
||||
|
||||
--- @param type "mount"|"unmount"|"eject"
|
||||
--- @param src string
|
||||
--- @return Output? output
|
||||
--- @return Error? err
|
||||
function M.diskutil(type, src) return Command("diskutil"):arg({ type, src }):output() end
|
||||
|
||||
--- @param type "mount"|"unmount"|"power-off"
|
||||
--- @param src string
|
||||
--- @return Output? output
|
||||
--- @return Error? err
|
||||
function M.udisksctl(type, src)
|
||||
local args = { type, "-b", src, "--no-user-interaction" }
|
||||
local output, err = Command("udisksctl"):arg(args):output()
|
||||
|
||||
if not output or err then
|
||||
return nil, err
|
||||
elseif output.stderr:find("org.freedesktop.UDisks2.Error.NotAuthorizedCanObtain", 1, true) then
|
||||
local tx, rx = table.unpack(require(".main").permit)
|
||||
tx:send(true)
|
||||
ya.emit("which:dismiss", {})
|
||||
output, err = M.udisks_dbus(type, src)
|
||||
if not output then
|
||||
output, err = M.udisksctl_interactive(type, src)
|
||||
end
|
||||
rx:recv()
|
||||
return output, err
|
||||
else
|
||||
return output
|
||||
end
|
||||
end
|
||||
|
||||
--- @param type "mount"|"unmount"|"power-off"
|
||||
--- @param src string
|
||||
--- @return Output? output
|
||||
--- @return Error? err
|
||||
function M.udisks_dbus(type, src)
|
||||
local obj, err = M.gdbus_resolve(
|
||||
"/org/freedesktop/UDisks2/Manager",
|
||||
"org.freedesktop.UDisks2.Manager.ResolveDevice",
|
||||
string.format("{'path': <%q>}", src),
|
||||
"{}"
|
||||
)
|
||||
if not obj then
|
||||
return nil, err
|
||||
end
|
||||
|
||||
local method, options = "", "{}"
|
||||
if type == "mount" then
|
||||
local user = ya.user_name()
|
||||
if not user then
|
||||
return nil, Err("Cannot determine the current user")
|
||||
end
|
||||
method = "org.freedesktop.UDisks2.Filesystem.Mount"
|
||||
options = string.format("{'as-user': <%q>}", user)
|
||||
elseif type == "unmount" then
|
||||
method = "org.freedesktop.UDisks2.Filesystem.Unmount"
|
||||
elseif type == "power-off" then
|
||||
obj, err = M.gdbus_resolve(obj, "org.freedesktop.UDisks2.Block.GetDrive")
|
||||
if not obj then
|
||||
return nil, err
|
||||
end
|
||||
method = "org.freedesktop.UDisks2.Drive.PowerOff"
|
||||
else
|
||||
return nil, Err("Unsupported UDisks operation: %s", type)
|
||||
end
|
||||
|
||||
return require(".sudo").run_with_sudo("gdbus", M.gdbus_args(obj, method, options))
|
||||
end
|
||||
|
||||
--- @param type "mount"|"unmount"|"power-off"
|
||||
--- @param src string
|
||||
--- @return Output? output
|
||||
--- @return Error? err
|
||||
function M.udisksctl_interactive(type, src)
|
||||
local permit = ui.hide()
|
||||
local output, err = Command("udisksctl"):arg({ type, "-b", src }):stdin(Command.INHERIT):output()
|
||||
permit:drop()
|
||||
return output, err
|
||||
end
|
||||
|
||||
--- @param src string
|
||||
--- @return Output? output
|
||||
--- @return Error? err
|
||||
function M.eject(src) return Command("eject"):arg({ "--traytoggle", src }):output() end
|
||||
|
||||
function M.fail(...) ya.notify { title = "Mount", content = string.format(...), timeout = 10, level = "error" } end
|
||||
|
||||
--- @param obj string
|
||||
--- @param method string
|
||||
--- @param ... string
|
||||
--- @return string? obj
|
||||
--- @return Error? err
|
||||
function M.gdbus_resolve(obj, method, ...)
|
||||
local output, err = Command("gdbus"):arg(M.gdbus_args(obj, method, ...)):output()
|
||||
if not output or err then
|
||||
return nil, err
|
||||
elseif not output.status.success then
|
||||
return nil, Err("%s", output.stderr)
|
||||
else
|
||||
local result = output.stdout:match("objectpath '([^']+)'")
|
||||
return result, result and nil or Err("Unexpected `gdbus` response: %s", output.stdout)
|
||||
end
|
||||
end
|
||||
|
||||
--- @param obj string
|
||||
--- @param method string
|
||||
--- @param ... string
|
||||
--- @return string[] args
|
||||
function M.gdbus_args(obj, method, ...)
|
||||
return { "call", "--system", "--dest", "org.freedesktop.UDisks2", "--object-path", obj, "--method", method, ... }
|
||||
end
|
||||
|
||||
return M
|
||||
@@ -0,0 +1,291 @@
|
||||
--- @since 25.12.29
|
||||
|
||||
local toggle_ui = ya.sync(function(self)
|
||||
if self.children then
|
||||
Modal:children_remove(self.children)
|
||||
self.children = nil
|
||||
else
|
||||
self.children = Modal:children_add(self, 10)
|
||||
end
|
||||
ui.render()
|
||||
end)
|
||||
|
||||
local subscribe = ya.sync(function(self)
|
||||
ps.unsub("mount")
|
||||
ps.sub("mount", function() ya.emit("plugin", { self._id, "refresh" }) end)
|
||||
end)
|
||||
|
||||
local update_partitions = ya.sync(function(self, partitions)
|
||||
self.partitions = partitions
|
||||
self.cursor = math.max(0, math.min(self.cursor or 0, #self.partitions - 1))
|
||||
ui.render()
|
||||
end)
|
||||
|
||||
local active_partition = ya.sync(function(self) return self.partitions[self.cursor + 1] end)
|
||||
|
||||
local update_cursor = ya.sync(function(self, cursor)
|
||||
if #self.partitions == 0 then
|
||||
self.cursor = 0
|
||||
else
|
||||
self.cursor = ya.clamp(0, self.cursor + cursor, #self.partitions - 1)
|
||||
end
|
||||
ui.render()
|
||||
end)
|
||||
|
||||
local M = {
|
||||
keys = {
|
||||
{ on = "q", run = "quit" },
|
||||
{ on = "<Esc>", run = "quit" },
|
||||
{ on = "<Enter>", run = { "enter", "quit" } },
|
||||
|
||||
{ on = "k", run = "up" },
|
||||
{ on = "j", run = "down" },
|
||||
{ on = "l", run = { "enter", "quit" } },
|
||||
|
||||
{ on = "<Up>", run = "up" },
|
||||
{ on = "<Down>", run = "down" },
|
||||
{ on = "<Right>", run = { "enter", "quit" } },
|
||||
|
||||
{ on = "m", run = "mount" },
|
||||
{ on = "u", run = "unmount" },
|
||||
{ on = "e", run = "eject" },
|
||||
},
|
||||
}
|
||||
|
||||
function M:new(area)
|
||||
self:layout(area)
|
||||
return self
|
||||
end
|
||||
|
||||
function M:layout(area)
|
||||
local chunks = ui.Layout()
|
||||
:constraints({
|
||||
ui.Constraint.Percentage(10),
|
||||
ui.Constraint.Percentage(80),
|
||||
ui.Constraint.Percentage(10),
|
||||
})
|
||||
:split(area)
|
||||
|
||||
local chunks = ui.Layout()
|
||||
:direction(ui.Layout.HORIZONTAL)
|
||||
:constraints({
|
||||
ui.Constraint.Percentage(10),
|
||||
ui.Constraint.Percentage(80),
|
||||
ui.Constraint.Percentage(10),
|
||||
})
|
||||
:split(chunks[2])
|
||||
|
||||
self._area = chunks[2]
|
||||
end
|
||||
|
||||
function M:entry(job)
|
||||
if job.args[1] == "refresh" then
|
||||
return update_partitions(self.obtain())
|
||||
end
|
||||
|
||||
toggle_ui()
|
||||
update_partitions(self.obtain())
|
||||
subscribe()
|
||||
|
||||
local tx1, rx1 = ya.chan("mpsc")
|
||||
local tx2, rx2 = ya.chan("mpsc")
|
||||
function producer()
|
||||
while true do
|
||||
local cand = self.keys[ya.which { cands = self.keys, silent = true }] or { run = {} }
|
||||
for _, r in ipairs(type(cand.run) == "table" and cand.run or { cand.run }) do
|
||||
tx1:send(r)
|
||||
if r == "quit" then
|
||||
toggle_ui()
|
||||
return
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
function consumer1()
|
||||
repeat
|
||||
local run = rx1:recv()
|
||||
if run == "quit" then
|
||||
tx2:send(run)
|
||||
break
|
||||
elseif run == "up" then
|
||||
update_cursor(-1)
|
||||
elseif run == "down" then
|
||||
update_cursor(1)
|
||||
elseif run == "enter" then
|
||||
local active = active_partition()
|
||||
if active and active.dist then
|
||||
ya.emit("cd", { active.dist })
|
||||
end
|
||||
else
|
||||
tx2:send(run)
|
||||
end
|
||||
until not run
|
||||
end
|
||||
|
||||
function consumer2()
|
||||
repeat
|
||||
local run = rx2:recv()
|
||||
if run == "quit" then
|
||||
break
|
||||
elseif run == "mount" then
|
||||
self.operate("mount")
|
||||
elseif run == "unmount" then
|
||||
self.operate("unmount")
|
||||
elseif run == "eject" then
|
||||
self.operate("eject")
|
||||
end
|
||||
until not run
|
||||
end
|
||||
|
||||
ya.join(producer, consumer1, consumer2)
|
||||
end
|
||||
|
||||
function M:reflow() return { self } end
|
||||
|
||||
function M:redraw()
|
||||
local rows = {}
|
||||
for _, p in ipairs(self.partitions or {}) do
|
||||
if not p.sub then
|
||||
rows[#rows + 1] = ui.Row { p.main }
|
||||
elseif p.sub == "" then
|
||||
rows[#rows + 1] = ui.Row { p.main, p.label or "", p.dist or "", p.fstype or "" }
|
||||
else
|
||||
rows[#rows + 1] = ui.Row { " " .. p.sub, p.label or "", p.dist or "", p.fstype or "" }
|
||||
end
|
||||
end
|
||||
|
||||
return {
|
||||
ui.Clear(self._area),
|
||||
ui.Border(ui.Edge.ALL)
|
||||
:area(self._area)
|
||||
:type(ui.Border.ROUNDED)
|
||||
:style(ui.Style():fg("blue"))
|
||||
:title(ui.Line("Mount"):align(ui.Align.CENTER)),
|
||||
ui.Table(rows)
|
||||
:area(self._area:pad(ui.Pad(1, 2, 1, 2)))
|
||||
:header(ui.Row({ "Src", "Label", "Dist", "FSType" }):style(ui.Style():bold()))
|
||||
:row(self.cursor)
|
||||
:row_style(ui.Style():fg("blue"):underline())
|
||||
:widths {
|
||||
ui.Constraint.Length(20),
|
||||
ui.Constraint.Length(20),
|
||||
ui.Constraint.Percentage(70),
|
||||
ui.Constraint.Length(10),
|
||||
},
|
||||
}
|
||||
end
|
||||
|
||||
function M.obtain()
|
||||
local tbl = {}
|
||||
local last
|
||||
for _, p in ipairs(fs.partitions()) do
|
||||
local main, sub = M.split(p.src)
|
||||
if main and last ~= main then
|
||||
if p.src == main then
|
||||
last, p.main, p.sub, tbl[#tbl + 1] = p.src, p.src, "", p
|
||||
else
|
||||
last, tbl[#tbl + 1] = main, { src = main, main = main, sub = "" }
|
||||
end
|
||||
end
|
||||
if sub then
|
||||
if tbl[#tbl].sub == "" and tbl[#tbl].main == main then
|
||||
tbl[#tbl].sub = nil
|
||||
end
|
||||
p.main, p.sub, tbl[#tbl + 1] = main, sub, p
|
||||
end
|
||||
end
|
||||
table.sort(M.fillin(tbl), function(a, b)
|
||||
if a.main == b.main then
|
||||
return (a.sub or "") < (b.sub or "")
|
||||
else
|
||||
return a.main > b.main
|
||||
end
|
||||
end)
|
||||
return tbl
|
||||
end
|
||||
|
||||
function M.split(src)
|
||||
local pats = {
|
||||
{ "^/dev/sd[a-z]", "%d+$" }, -- /dev/sda1
|
||||
{ "^/dev/nvme%d+n%d+", "p%d+$" }, -- /dev/nvme0n1p1
|
||||
{ "^/dev/mmcblk%d+", "p%d+$" }, -- /dev/mmcblk0p1
|
||||
{ "^/dev/disk%d+", ".+$" }, -- /dev/disk1s1
|
||||
{ "^/dev/sr%d+", ".+$" }, -- /dev/sr0
|
||||
}
|
||||
for _, p in ipairs(pats) do
|
||||
local main = src:match(p[1])
|
||||
if main then
|
||||
return main, src:sub(#main + 1):match(p[2])
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
function M.fillin(tbl)
|
||||
if ya.target_os() ~= "linux" then
|
||||
return tbl
|
||||
end
|
||||
|
||||
local sources, indices = {}, {}
|
||||
for i, p in ipairs(tbl) do
|
||||
if p.sub and not p.fstype then
|
||||
sources[#sources + 1], indices[p.src] = p.src, i
|
||||
end
|
||||
end
|
||||
if #sources == 0 then
|
||||
return tbl
|
||||
end
|
||||
|
||||
local output, err = Command("lsblk"):arg({ "-p", "-o", "name,fstype", "-J" }):arg(sources):output()
|
||||
if err then
|
||||
ya.dbg("Failed to fetch filesystem types for unmounted partitions: " .. err)
|
||||
return tbl
|
||||
end
|
||||
|
||||
local t = ya.json_decode(output and output.stdout or "")
|
||||
for _, p in ipairs(t and t.blockdevices or {}) do
|
||||
tbl[indices[p.name]].fstype = p.fstype
|
||||
end
|
||||
return tbl
|
||||
end
|
||||
|
||||
function M.operate(type)
|
||||
local active = active_partition()
|
||||
if not active then
|
||||
return
|
||||
elseif not active.sub then
|
||||
return -- TODO: mount/unmount main disk
|
||||
end
|
||||
|
||||
local output, err
|
||||
if ya.target_os() == "macos" then
|
||||
output, err = Command("diskutil"):arg({ type, active.src }):output()
|
||||
end
|
||||
if ya.target_os() == "linux" then
|
||||
if type == "eject" and active.src:match("^/dev/sr%d+") then
|
||||
Command("udisksctl"):arg({ "unmount", "-b", active.src }):status()
|
||||
output, err = Command("eject"):arg({ "--traytoggle", active.src }):output()
|
||||
elseif type == "eject" then
|
||||
Command("udisksctl"):arg({ "unmount", "-b", active.src }):status()
|
||||
output, err = Command("udisksctl"):arg({ "power-off", "-b", active.src }):output()
|
||||
else
|
||||
output, err = Command("udisksctl"):arg({ type, "-b", active.src }):output()
|
||||
end
|
||||
end
|
||||
|
||||
if not output then
|
||||
M.fail("Failed to %s `%s`: %s", type, active.src, err)
|
||||
elseif not output.status.success then
|
||||
M.fail("Failed to %s `%s`: %s", type, active.src, output.stderr)
|
||||
end
|
||||
end
|
||||
|
||||
function M.fail(...) ya.notify { title = "Mount", content = string.format(...), timeout = 10, level = "error" } end
|
||||
|
||||
function M:click() end
|
||||
|
||||
function M:scroll() end
|
||||
|
||||
function M:touch() end
|
||||
|
||||
return M
|
||||
@@ -0,0 +1,65 @@
|
||||
local M = {}
|
||||
|
||||
--- Verify if `sudo` is already authenticated
|
||||
--- @return boolean
|
||||
--- @return Error?
|
||||
function M.sudo_already()
|
||||
local status, err = Command("sudo"):arg({ "--validate", "--non-interactive" }):status()
|
||||
return status and status.success or false, err
|
||||
end
|
||||
|
||||
--- Authenticate `sudo` through Yazi's input component
|
||||
--- @param program string
|
||||
--- @return boolean authenticated
|
||||
--- @return Error? err
|
||||
function M.authenticate(program)
|
||||
if M.sudo_already() then
|
||||
return true
|
||||
end
|
||||
|
||||
local value, event = ya.input {
|
||||
pos = { "top-center", y = 3, w = 40 },
|
||||
title = string.format("Password for `sudo %s`:", program),
|
||||
obscure = true,
|
||||
}
|
||||
if not value or event ~= 1 then
|
||||
return false, Err("Sudo password input cancelled")
|
||||
end
|
||||
|
||||
local child, err = Command("sudo")
|
||||
:arg({ "--stdin", "--validate" })
|
||||
:stdin(Command.PIPED)
|
||||
:stdout(Command.PIPED)
|
||||
:stderr(Command.PIPED)
|
||||
:spawn()
|
||||
if not child or err then
|
||||
return false, err
|
||||
end
|
||||
|
||||
child:write_all(value .. "\n")
|
||||
child:flush()
|
||||
local output, err = child:wait_with_output()
|
||||
if not output or err then
|
||||
return false, err
|
||||
elseif not output.status.success then
|
||||
return false, Err("Incorrect sudo password")
|
||||
else
|
||||
return true
|
||||
end
|
||||
end
|
||||
|
||||
--- Run a program with `sudo` privilege
|
||||
--- @param program string
|
||||
--- @param args table
|
||||
--- @return Output? output
|
||||
--- @return Error? err
|
||||
function M.run_with_sudo(program, args)
|
||||
local authenticated, err = M.authenticate(program)
|
||||
if authenticated then
|
||||
return Command("sudo"):arg({ "--non-interactive", "--", program }):arg(args):output()
|
||||
else
|
||||
return nil, err
|
||||
end
|
||||
end
|
||||
|
||||
return M
|
||||
Submodule
+1
Submodule yazi_1/.config/yazi/plugins/omp.yazi added at 7a0624c23b.
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2024 Ou
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,43 @@
|
||||
# open-git-remote.yazi
|
||||
Plugin for [Yazi](https://github.com/sxyazi/yazi) to open git repos's remote url quickly with a shortcut.
|
||||
Jump to the github page from yazi!
|
||||
|
||||
Inspired by [Sylvan Franklin](https://www.youtube.com/watch?v=YDd0MYtfIp8&t=153s)
|
||||
## Dependencies
|
||||
- Git
|
||||
- A web browser
|
||||
- A browser opener:
|
||||
- `open` (macOS)
|
||||
- `xdg-open` (Linux)
|
||||
- `start` (Windows/Git Bash)
|
||||
- `wslview` (WSL)
|
||||
- [GitHub CLI (`gh`)](https://cli.github.com/) - (**and/or** - just opens github links)
|
||||
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
### Using `ya pkg`
|
||||
```
|
||||
ya pkg add larry-oates/open-git-remote
|
||||
```
|
||||
|
||||
### Manual
|
||||
**Linux/macOS**
|
||||
```
|
||||
git clone https://github.com/larry-oates/open-git-remote.yazi.git ~/.config/yazi/plugins/open-git-remote.yazi
|
||||
```
|
||||
**Windows**
|
||||
```
|
||||
git clone https://github.com/larry-oates/open-git-remote.yazi.git %AppData%\yazi\config\plugins\open-git-remote.yazi
|
||||
```
|
||||
## Configuration
|
||||
add this to your **keymap.toml** file:
|
||||
```toml
|
||||
[[mgr.prepend_keymap]]
|
||||
on = [ "g", "l" ]
|
||||
run = "plugin open-git-remote"
|
||||
desc = "open git remote url"
|
||||
```
|
||||
I use g then l for "Git Link" but you can customize the keybinding however you like. Please refer to the [keymap.toml](https://yazi-rs.github.io/docs/configuration/keymap) documentation
|
||||
|
||||
@@ -0,0 +1,58 @@
|
||||
-- ~/.config/yazi/plugins/git-open.yazi/init.lua
|
||||
-- Plugin to open Git remote URL in browser
|
||||
|
||||
return {
|
||||
entry = function()
|
||||
ya.emit("shell", {
|
||||
[[
|
||||
# Check if we're in a git repository
|
||||
if ! git rev-parse --git-dir >/dev/null 2>&1; then
|
||||
echo "Not in a Git repository" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Try gh browse first (best option for GitHub repos)
|
||||
if command -v gh >/dev/null 2>&1; then
|
||||
if gh browse 2>/dev/null; then
|
||||
echo "Opened with gh browse"
|
||||
exit 0
|
||||
fi
|
||||
fi
|
||||
|
||||
# Fallback: Get remote URL and open manually
|
||||
remote_url=$(git remote get-url origin 2>/dev/null) || {
|
||||
echo "No remote 'origin' found" >&2
|
||||
exit 1
|
||||
}
|
||||
|
||||
# Convert SSH URL to HTTPS
|
||||
browser_url=$(echo "$remote_url" | sed -E '
|
||||
s|^https?://(.+)\.git$|https://\1|;
|
||||
s|^https?://(.+)$|https://\1|;
|
||||
s|^git@([^:]+):(.+)\.git$|https://\1/\2|;
|
||||
s|^git@([^:]+):(.+)$|https://\1/\2|;
|
||||
s|^ssh://git@([^/]+)/(.+)\.git$|https://\1/\2|;
|
||||
s|^ssh://git@([^/]+)/(.+)$|https://\1/\2|
|
||||
')
|
||||
|
||||
# Open in browser
|
||||
if command -v open >/dev/null 2>&1; then
|
||||
open "$browser_url"
|
||||
elif command -v xdg-open >/dev/null 2>&1; then
|
||||
xdg-open "$browser_url"
|
||||
elif command -v start >/dev/null 2>&1; then
|
||||
start "$browser_url"
|
||||
elif command -v wslview >/dev/null 2>&1; then
|
||||
wslview "$browser_url"
|
||||
else
|
||||
echo "No browser opener found" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "Opened: $browser_url"
|
||||
]],
|
||||
confirm = false,
|
||||
orphan = true,
|
||||
})
|
||||
end,
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
Copyright (c) 2024 Lauri Niskanen
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,25 @@
|
||||
# open-with-cmd.yazi
|
||||
|
||||
This is a Yazi plugin for opening files with a prompted command.
|
||||
|
||||
## Installation
|
||||
|
||||
Install the plugin:
|
||||
|
||||
```
|
||||
ya pkg add Ape/open-with-cmd
|
||||
```
|
||||
|
||||
Create `~/.config/yazi/keymap.toml` and add:
|
||||
|
||||
```
|
||||
[[manager.prepend_keymap]]
|
||||
on = "o"
|
||||
run = "plugin open-with-cmd -- block"
|
||||
desc = "Open with command in the terminal"
|
||||
|
||||
[[manager.prepend_keymap]]
|
||||
on = "O"
|
||||
run = "plugin open-with-cmd"
|
||||
desc = "Open with command"
|
||||
```
|
||||
@@ -0,0 +1,19 @@
|
||||
return {
|
||||
entry = function(_, job)
|
||||
local block = job.args[1] and job.args[1] == "block"
|
||||
|
||||
local value, event = ya.input({
|
||||
title = block and "Open with (block):" or "Open with:",
|
||||
pos = { "hovered", y = 1, w = 50 },
|
||||
})
|
||||
|
||||
if event == 1 then
|
||||
local s = ya.target_family() == "windows" and " %*" or ' "$@"'
|
||||
ya.mgr_emit("shell", {
|
||||
value .. s,
|
||||
block = block,
|
||||
orphan = not block,
|
||||
})
|
||||
end
|
||||
end,
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2024 ndtoan96
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,92 @@
|
||||
# ouch.yazi
|
||||
|
||||
[ouch](https://github.com/ouch-org/ouch) plugin for [Yazi](https://github.com/sxyazi/yazi).
|
||||
|
||||
|
||||
|
||||
## Features
|
||||
- Archive preview
|
||||
- Compression
|
||||
|
||||
## Installation
|
||||
|
||||
### Yazi package manager
|
||||
```bash
|
||||
ya pkg add ndtoan96/ouch
|
||||
```
|
||||
|
||||
### Git
|
||||
```bash
|
||||
# Linux/macOS
|
||||
git clone https://github.com/ndtoan96/ouch.yazi.git ~/.config/yazi/plugins/ouch.yazi
|
||||
|
||||
# Windows with cmd
|
||||
git clone https://github.com/ndtoan96/ouch.yazi.git %AppData%\yazi\config\plugins\ouch.yazi
|
||||
|
||||
# Windows with powershell
|
||||
git clone https://github.com/ndtoan96/ouch.yazi.git "$($env:APPDATA)\yazi\config\plugins\ouch.yazi"
|
||||
```
|
||||
|
||||
Make sure you have [ouch](https://github.com/ouch-org/ouch) installed and in your `PATH`.
|
||||
|
||||
## Usage
|
||||
|
||||
### Preview
|
||||
For archive preview, add this to your `yazi.toml`:
|
||||
|
||||
```toml
|
||||
[[plugin.prepend_previewers]]
|
||||
mime = "application/{*zip,tar,bzip2,7z*,rar,xz,zstd,java-archive}"
|
||||
run = "ouch"
|
||||
```
|
||||
|
||||
Now go to an archive on Yazi, you should see the archive's content in the preview pane. You can use `J` and `K` to roll up and down the preview.
|
||||
|
||||
#### Customization
|
||||
|
||||
Previews can be customized by adding extra arguments in the `run` string:
|
||||
|
||||
```toml
|
||||
[plugin]
|
||||
prepend_previewers = [
|
||||
# Change the top-level archive icon
|
||||
{ ..., run = "ouch --archive-icon='🗄️ '" },
|
||||
# Or remove it by setting it to ''
|
||||
{ ..., run = "ouch --archive-icon=''" },
|
||||
|
||||
# Enable file icons
|
||||
{ ..., run = "ouch --show-file-icons" },
|
||||
|
||||
# Disable tree view
|
||||
{ ..., run = "ouch --list-view" },
|
||||
|
||||
# These can be combined
|
||||
{ ..., run = "ouch --archive-icon='🗄️ ' --show-file-icons --list-view" },
|
||||
]
|
||||
```
|
||||
|
||||
### Compression
|
||||
For compession, add this to your `keymap.toml`:
|
||||
|
||||
```toml
|
||||
[[mgr.prepend_keymap]]
|
||||
on = ["C"]
|
||||
run = "plugin ouch"
|
||||
desc = "Compress with ouch"
|
||||
```
|
||||
|
||||
The plugin uses `zip` format by default. You can change the format when you name the output file, `ouch` will detect format based on file extension.
|
||||
|
||||
And, for example, if you would like to set `7z` as default format, you can use `plugin ouch 7z`.
|
||||
|
||||
### Decompression
|
||||
This plugin does not provide a decompression feature because it already is supported by Yazi.
|
||||
To decompress with `ouch`, configure the opener in `yazi.toml`.
|
||||
|
||||
```toml
|
||||
[opener]
|
||||
extract = [
|
||||
{ run = 'ouch d -y %*', desc = "Extract here with ouch", for = "windows" },
|
||||
{ run = 'ouch d -y "$@"', desc = "Extract here with ouch", for = "unix" },
|
||||
]
|
||||
```
|
||||
@@ -0,0 +1,195 @@
|
||||
local M = {}
|
||||
|
||||
-- Extract the tree prefix (if any) from a line
|
||||
local function get_tree_prefix(line)
|
||||
local _, prefix_len = line:find("─ ", 1, true)
|
||||
if prefix_len then
|
||||
return line:sub(1, prefix_len)
|
||||
else
|
||||
return ""
|
||||
end
|
||||
end
|
||||
|
||||
-- Add a filetype icon to a line
|
||||
local function line_with_icon(line)
|
||||
line = line:gsub("[\r\n]+$", "") -- Trailing newlines mess with filetype detection
|
||||
|
||||
local tree_prefix = get_tree_prefix(line)
|
||||
local url = line:sub(#tree_prefix + 1)
|
||||
local icon = File({
|
||||
url = Url(url),
|
||||
cha = Cha {
|
||||
mode = tonumber(url:sub(-1) == "/" and "40700" or "100644", 8),
|
||||
kind = url:sub(-1) == "/" and 1 or 0, -- For Yazi <25.9.x compatibility
|
||||
}
|
||||
}):icon()
|
||||
|
||||
if icon then
|
||||
line = ui.Line { tree_prefix, ui.Span(icon.text .. " "):style(icon.style), url }
|
||||
end
|
||||
|
||||
return line
|
||||
end
|
||||
|
||||
function M:peek(job)
|
||||
local cmd = Command("ouch"):arg("l")
|
||||
if not job.args.list_view then
|
||||
cmd:arg("-t")
|
||||
end
|
||||
cmd:arg({ "-y", tostring(job.file.url) })
|
||||
:stdout(Command.PIPED)
|
||||
:stderr(Command.PIPED)
|
||||
|
||||
local child = cmd:spawn()
|
||||
local limit = job.area.h
|
||||
local archive_icon = job.args.archive_icon or "\u{1f4c1} "
|
||||
local file_name = string.match(tostring(job.file.url), ".*[/\\](.*)")
|
||||
local lines = { string.format(" %s%s", archive_icon, file_name) }
|
||||
local num_skip = 0
|
||||
repeat
|
||||
local line, event = child:read_line()
|
||||
if event == 1 then
|
||||
ya.err(tostring(event))
|
||||
elseif event ~= 0 then
|
||||
break
|
||||
end
|
||||
|
||||
if line:find('Archive', 1, true) ~= 1 and line:find('[INFO]', 1, true) ~= 1 then
|
||||
if num_skip >= job.skip then
|
||||
if job.args.show_file_icons then
|
||||
if line:find ('[ERROR]', 1, true) == 1 then
|
||||
-- On error, disable file icons for the rest of the output
|
||||
job.args.show_file_icons = false
|
||||
elseif line:find ('[WARNING]', 1, true) ~= 1 then
|
||||
-- Show icons for non-warning lines only
|
||||
line = line_with_icon(line)
|
||||
end
|
||||
end
|
||||
|
||||
line = ui.Line { " ", line } -- One space padding
|
||||
table.insert(lines, line)
|
||||
else
|
||||
num_skip = num_skip + 1
|
||||
end
|
||||
end
|
||||
until #lines >= limit
|
||||
|
||||
child:start_kill()
|
||||
if job.skip > 0 and #lines < limit then
|
||||
ya.emit(
|
||||
"peek",
|
||||
{ tostring(math.max(0, job.skip - (limit - #lines))), only_if = tostring(job.file.url), upper_bound = "" }
|
||||
)
|
||||
else
|
||||
ya.preview_widget(job, { ui.Text(lines):area(job.area) })
|
||||
end
|
||||
end
|
||||
|
||||
function M:seek(job)
|
||||
local h = cx.active.current.hovered
|
||||
if h and h.url == job.file.url then
|
||||
local step = math.floor(job.units * job.area.h / 10)
|
||||
ya.emit("peek", {
|
||||
math.max(0, cx.active.preview.skip + step),
|
||||
only_if = tostring(job.file.url),
|
||||
})
|
||||
end
|
||||
end
|
||||
|
||||
-- Check if file exists
|
||||
local function file_exists(name)
|
||||
local f = io.open(name, "r")
|
||||
if f ~= nil then
|
||||
io.close(f)
|
||||
return true
|
||||
else
|
||||
return false
|
||||
end
|
||||
end
|
||||
|
||||
-- Get the files that need to be compressed and infer a default archive name
|
||||
local get_compression_target = ya.sync(function()
|
||||
local tab = cx.active
|
||||
local default_name
|
||||
local paths = {}
|
||||
if #tab.selected == 0 then
|
||||
if tab.current.hovered then
|
||||
local name = tab.current.hovered.name
|
||||
default_name = name
|
||||
table.insert(paths, name)
|
||||
else
|
||||
return
|
||||
end
|
||||
else
|
||||
default_name = tab.current.cwd.name
|
||||
for _, url in pairs(tab.selected) do
|
||||
table.insert(paths, tostring(url))
|
||||
end
|
||||
-- The compression targets are aquired, now unselect them
|
||||
ya.emit("escape", {})
|
||||
end
|
||||
return paths, default_name
|
||||
end)
|
||||
|
||||
local function invoke_compress_command(paths, name)
|
||||
local cmd_output, err_code = Command("ouch")
|
||||
:arg({ "c", "-y" })
|
||||
:arg(paths)
|
||||
:arg(name)
|
||||
:stderr(Command.PIPED)
|
||||
:output()
|
||||
if err_code ~= nil then
|
||||
ya.notify({
|
||||
title = "Failed to run ouch command",
|
||||
content = "Status: " .. err_code,
|
||||
timeout = 5.0,
|
||||
level = "error",
|
||||
})
|
||||
elseif not cmd_output.status.success then
|
||||
ya.notify({
|
||||
title = "Compression failed: status code " .. cmd_output.status.code,
|
||||
content = cmd_output.stderr,
|
||||
timeout = 5.0,
|
||||
level = "error",
|
||||
})
|
||||
end
|
||||
end
|
||||
|
||||
function M:entry(job)
|
||||
local default_fmt = job.args[1]
|
||||
if default_fmt == nil then
|
||||
default_fmt = "zip"
|
||||
end
|
||||
|
||||
ya.emit("escape", { visual = true })
|
||||
|
||||
-- Get the files that need to be compressed and infer a default archive name
|
||||
local paths, default_name = get_compression_target()
|
||||
|
||||
-- Get archive name from user
|
||||
local output_name, name_event = ya.input({
|
||||
title = "Create archive:",
|
||||
value = default_name .. "." .. default_fmt,
|
||||
position = { "top-center", y = 3, w = 40 },
|
||||
pos = { "top-center", y = 3, w = 40 },
|
||||
})
|
||||
if name_event ~= 1 then
|
||||
return
|
||||
end
|
||||
|
||||
-- Get confirmation if file exists
|
||||
if file_exists(output_name) then
|
||||
local confirm, confirm_event = ya.input({
|
||||
title = "Overwrite " .. output_name .. "? (y/N)",
|
||||
position = { "top-center", y = 3, w = 40 },
|
||||
pos = { "top-center", y = 3, w = 40 },
|
||||
})
|
||||
if not (confirm_event == 1 and confirm:lower() == "y") then
|
||||
return
|
||||
end
|
||||
end
|
||||
|
||||
invoke_compress_command(paths, output_name)
|
||||
end
|
||||
|
||||
return M
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2023 yazi-rs
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,98 @@
|
||||
# piper.yazi
|
||||
|
||||
Pipe any shell command as a previewer.
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
ya pkg add 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/yazi.toml
|
||||
[[plugin.prepend_previewers]]
|
||||
url = "*"
|
||||
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 tarballs with [`tar`](https://man7.org/linux/man-pages/man1/tar.1.html)
|
||||
|
||||
```toml
|
||||
[[plugin.prepend_previewers]]
|
||||
url = "*.tar*"
|
||||
run = 'piper --format=url -- tar tf "$1"'
|
||||
```
|
||||
|
||||
In this example, `--format=url` tells `piper` to parse the `tar` output as file URLs, so you'll be able to get a list of files with icons.
|
||||
|
||||
### Preview CSV with [`bat`](https://github.com/sharkdp/bat)
|
||||
|
||||
```toml
|
||||
[[plugin.prepend_previewers]]
|
||||
url = "*.csv"
|
||||
run = 'piper -- bat -p --color=always "$1"'
|
||||
```
|
||||
|
||||
Note that certain distributions might use a different name for `bat`, like Debian and Ubuntu uses `batcat` instead, so please adjust accordingly.
|
||||
|
||||
### Preview Markdown with [`glow`](https://github.com/charmbracelet/glow)
|
||||
|
||||
```toml
|
||||
[[plugin.prepend_previewers]]
|
||||
url = "*.md"
|
||||
run = 'piper -- CLICOLOR_FORCE=1 glow -w=$w -s=dark "$1"'
|
||||
```
|
||||
|
||||
Note that there's [a bug in Glow v2.0](https://github.com/charmbracelet/glow/issues/440#issuecomment-2307992634) that causes slight color differences between tty and non-tty environments.
|
||||
|
||||
### Preview directory tree with [`eza`](https://github.com/eza-community/eza)
|
||||
|
||||
```toml
|
||||
[[plugin.prepend_previewers]]
|
||||
url = "*/"
|
||||
run = 'piper -- eza -TL=3 --color=always --icons=always --group-directories-first --no-quotes "$1"'
|
||||
```
|
||||
|
||||
### Preview the schema of a SQLite database
|
||||
|
||||
```toml
|
||||
[[plugin.prepend_previewers]]
|
||||
mime = "application/sqlite3"
|
||||
run = 'piper -- sqlite3 "$1" ".schema --indent"'
|
||||
```
|
||||
|
||||
### Use [`hexyl`](https://github.com/sharkdp/hexyl) as fallback previewer
|
||||
|
||||
Yazi defaults to using [`file -bL "$1"`](https://github.com/sxyazi/yazi/blob/main/yazi-plugin/preset/plugins/file.lua) if there's no matched previewer.
|
||||
|
||||
This example uses `hexyl` as a fallback previewer instead of `file`.
|
||||
|
||||
```toml
|
||||
[[plugin.append_previewers]]
|
||||
url = "*"
|
||||
run = 'piper -- hexyl --border=none --terminal-width=$w "$1"'
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
This plugin is MIT-licensed. For more information check the [LICENSE](LICENSE) file.
|
||||
@@ -0,0 +1,71 @@
|
||||
--- @since 25.9.15
|
||||
|
||||
local M = {}
|
||||
|
||||
local function fail(job, s) ya.preview_widget(job, ui.Text.parse(s):area(job.area):wrap(ui.Wrap.YES)) end
|
||||
|
||||
function M:peek(job)
|
||||
local child, err = Command("sh")
|
||||
-- TODO: use `job.file.path` instead
|
||||
:arg({ "-c", job.args[1], "sh", tostring(job.file.cache or job.file.url) })
|
||||
:env("w", job.area.w)
|
||||
:env("h", job.area.h)
|
||||
:stdout(Command.PIPED)
|
||||
:stderr(Command.PIPED)
|
||||
:spawn()
|
||||
|
||||
if not child then
|
||||
return fail(job, "sh: " .. err)
|
||||
end
|
||||
|
||||
local limit = job.area.h
|
||||
local i, outs, errs = 0, {}, {}
|
||||
repeat
|
||||
local next, event = child:read_line()
|
||||
if event == 1 then
|
||||
errs[#errs + 1] = next
|
||||
elseif event ~= 0 then
|
||||
break
|
||||
end
|
||||
|
||||
i = i + 1
|
||||
if i > job.skip then
|
||||
outs[#outs + 1] = next
|
||||
end
|
||||
until i >= job.skip + limit
|
||||
|
||||
child:start_kill()
|
||||
if #errs > 0 then
|
||||
fail(job, table.concat(errs, ""))
|
||||
elseif job.skip > 0 and i < job.skip + limit then
|
||||
ya.emit("peek", { math.max(0, i - limit), only_if = job.file.url, upper_bound = true })
|
||||
else
|
||||
ya.preview_widget(job, M.format(job, outs))
|
||||
end
|
||||
end
|
||||
|
||||
function M:seek(job) require("code"):seek(job) end
|
||||
|
||||
function M.format(job, lines)
|
||||
local format = job.args.format
|
||||
if format ~= "url" then
|
||||
local s = table.concat(lines, ""):gsub("\r", ""):gsub("\t", string.rep(" ", rt.preview.tab_size))
|
||||
return ui.Text.parse(s):area(job.area)
|
||||
end
|
||||
|
||||
for i = 1, #lines do
|
||||
lines[i] = lines[i]:gsub("[\r\n]+$", "")
|
||||
|
||||
local icon = File({
|
||||
url = Url(lines[i]),
|
||||
cha = Cha { mode = tonumber(lines[i]:sub(-1) == "/" and "40700" or "100644", 8) },
|
||||
}):icon()
|
||||
|
||||
if icon then
|
||||
lines[i] = ui.Line { ui.Span(" " .. icon.text .. " "):style(icon.style), lines[i] }
|
||||
end
|
||||
end
|
||||
return ui.Text(lines):area(job.area)
|
||||
end
|
||||
|
||||
return M
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2024 MasouShizuka
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,214 @@
|
||||
# projects.yazi
|
||||
|
||||
A [Yazi](https://github.com/sxyazi/yazi) plugin that adds the functionality to save, load and merge projects.
|
||||
A project means all `tabs` and their status, including `cwd` and so on.
|
||||
|
||||
> [!NOTE]
|
||||
> The latest release of Yazi is required at the moment.
|
||||
|
||||
https://github.com/MasouShizuka/projects.yazi/assets/44764707/79c3559a-7776-48cd-8317-dd1478314eed
|
||||
|
||||
## Features
|
||||
|
||||
- Save/load projects
|
||||
- Load last project
|
||||
- Projects persistence
|
||||
- Merge a project or its current tab to other projects
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
ya pkg add MasouShizuka/projects
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```sh
|
||||
# Windows
|
||||
git clone https://github.com/MasouShizuka/projects.yazi.git %AppData%\yazi\config\plugins\projects.yazi
|
||||
|
||||
# Linux/macOS
|
||||
git clone https://github.com/MasouShizuka/projects.yazi.git ~/.config/yazi/plugins/projects.yazi
|
||||
```
|
||||
|
||||
## Keymap
|
||||
|
||||
Add this to your `keymap.toml`:
|
||||
|
||||
```toml
|
||||
[[mgr.prepend_keymap]]
|
||||
on = [ "P", "s" ]
|
||||
run = "plugin projects save"
|
||||
desc = "Save current project"
|
||||
|
||||
[[mgr.prepend_keymap]]
|
||||
on = [ "P", "l" ]
|
||||
run = "plugin projects load"
|
||||
desc = "Load project"
|
||||
|
||||
[[mgr.prepend_keymap]]
|
||||
on = [ "P", "P" ]
|
||||
run = "plugin projects load_last"
|
||||
desc = "Load last project"
|
||||
|
||||
[[mgr.prepend_keymap]]
|
||||
on = [ "P", "d" ]
|
||||
run = "plugin projects delete"
|
||||
desc = "Delete project"
|
||||
|
||||
[[mgr.prepend_keymap]]
|
||||
on = [ "P", "D" ]
|
||||
run = "plugin projects delete_all"
|
||||
desc = "Delete all projects"
|
||||
|
||||
[[mgr.prepend_keymap]]
|
||||
on = [ "P", "m" ]
|
||||
run = "plugin projects 'merge current'"
|
||||
desc = "Merge current tab to other projects"
|
||||
|
||||
[[mgr.prepend_keymap]]
|
||||
on = [ "P", "M" ]
|
||||
run = "plugin projects 'merge all'"
|
||||
desc = "Merge current project to other projects"
|
||||
```
|
||||
|
||||
### Load project by name or key
|
||||
|
||||
If you want to load a specific project with a keybinding (you can use either the key or the name of the project):
|
||||
|
||||
```toml
|
||||
[[mgr.prepend_keymap]]
|
||||
on = [ "P", "p" ]
|
||||
run = "plugin projects 'load SomeProject'"
|
||||
desc = "Load the 'SomeProject' project"
|
||||
```
|
||||
|
||||
You can also load a specific project by using the below Bash/Zsh function (uses the "official" [shell wrapper](https://yazi-rs.github.io/docs/quick-start/#shell-wrapper), but you can also replace `y` with `yazi`):
|
||||
|
||||
```bash
|
||||
function yap() {
|
||||
local yaziProject="$1"
|
||||
shift
|
||||
if [ -z "$yaziProject" ]; then
|
||||
>&2 echo "ERROR: The first argument must be a project"
|
||||
return 64
|
||||
fi
|
||||
|
||||
# Generate random Yazi client ID (DDS / `ya emit` uses `YAZI_ID`)
|
||||
local yaziId=$RANDOM
|
||||
|
||||
# Use Yazi's DDS to run a plugin command after Yazi has started
|
||||
# (the nested subshell is only to suppress "Done" output for the job)
|
||||
( (sleep 0.1; YAZI_ID=$yaziId ya emit plugin projects "load $yaziProject") &)
|
||||
|
||||
# Run Yazi with the generated client ID
|
||||
y --client-id $yaziId "$@" || return $?
|
||||
}
|
||||
```
|
||||
|
||||
With the above function you can open a specific project by running e.g. `yap SomeProject`
|
||||
|
||||
## Config
|
||||
|
||||
Don't forget to add the plugin's `setup` function in Yazi's `init.lua`, i.e. `~/.config/yazi/init.lua`.
|
||||
The following are the default configurations:
|
||||
|
||||
```lua
|
||||
require("projects"):setup({
|
||||
event = {
|
||||
save = {
|
||||
enable = true,
|
||||
name = "project-saved",
|
||||
},
|
||||
load = {
|
||||
enable = true,
|
||||
name = "project-loaded",
|
||||
},
|
||||
delete = {
|
||||
enable = true,
|
||||
name = "project-deleted",
|
||||
},
|
||||
delete_all = {
|
||||
enable = true,
|
||||
name = "project-deleted-all",
|
||||
},
|
||||
merge = {
|
||||
enable = true,
|
||||
name = "project-merged",
|
||||
},
|
||||
},
|
||||
save = {
|
||||
method = "yazi", -- yazi | lua
|
||||
yazi_load_event = "@projects-load", -- event name when loading projects in `yazi` method
|
||||
lua_save_path = "", -- path of saved file in `lua` method, comment out or assign explicitly
|
||||
-- default value:
|
||||
-- windows: "%APPDATA%/yazi/state/projects.json"
|
||||
-- unix: "~/.local/state/yazi/projects.json"
|
||||
},
|
||||
last = {
|
||||
update_after_save = true,
|
||||
update_after_load = true,
|
||||
update_before_quit = false,
|
||||
load_after_start = false,
|
||||
},
|
||||
merge = {
|
||||
event = "projects-merge",
|
||||
quit_after_merge = false,
|
||||
},
|
||||
notify = {
|
||||
enable = true,
|
||||
title = "Projects",
|
||||
timeout = 3,
|
||||
level = "info",
|
||||
},
|
||||
})
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> Settings that are not set will use the default value.
|
||||
|
||||
### `event`
|
||||
|
||||
The corresponding event will be sent when the corresponding function is executed.
|
||||
|
||||
For specific usage, please refer to [#5](https://github.com/MasouShizuka/projects.yazi/issues/5) and [#12](https://github.com/MasouShizuka/projects.yazi/issues/12).
|
||||
|
||||
### `save`
|
||||
|
||||
> [!NOTE]
|
||||
> Yazi's api sometimes doesn't work on Windows, which is why the `lua` method is proposed
|
||||
|
||||
`method`: the method of saving projects:
|
||||
- `yazi`: using `yazi` api to save to `.dds` file
|
||||
- `lua`: using `lua` api to save
|
||||
|
||||
`yazi_load_event`: event name when loading projects in `yazi` method
|
||||
|
||||
`lua_save_path`: path of saved file in `lua` method, the defalut value is
|
||||
- `Windows`: `%APPDATA%/yazi/state/projects.json`
|
||||
- `Unix`: `~/.local/state/yazi/projects.json`
|
||||
|
||||
### `last`
|
||||
|
||||
The last project is loaded by `load_last` command.
|
||||
|
||||
`update_after_save`: the saved project will be saved to last project.
|
||||
|
||||
`update_after_load`: the loaded project will be saved to last project.
|
||||
|
||||
`update_before_quit`: the current project will be saved to last project before quit.
|
||||
|
||||
`load_after_start`: the last project will be loaded after starting.
|
||||
- Only work with `lua` method, please refer to [#2](https://github.com/MasouShizuka/projects.yazi/issues/2)
|
||||
|
||||
### `merge`
|
||||
|
||||
`event`: the name of event used by merge feature.
|
||||
|
||||
`quit_after_merge`: the merged project will be exited after merging.
|
||||
|
||||
### `notify`
|
||||
|
||||
When enabled, notifications are displayed when actions are performed.
|
||||
|
||||
`title`, `timeout`, `level` are the same as [ya.notify](https://yazi-rs.github.io/docs/plugins/utils/#ya.notify).
|
||||
@@ -0,0 +1,386 @@
|
||||
--
|
||||
-- json.lua
|
||||
--
|
||||
-- Copyright (c) 2020 rxi
|
||||
--
|
||||
-- Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
-- this software and associated documentation files (the "Software"), to deal in
|
||||
-- the Software without restriction, including without limitation the rights to
|
||||
-- use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
||||
-- of the Software, and to permit persons to whom the Software is furnished to do
|
||||
-- so, subject to the following conditions:
|
||||
--
|
||||
-- The above copyright notice and this permission notice shall be included in all
|
||||
-- copies or substantial portions of the Software.
|
||||
--
|
||||
-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
-- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
-- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
-- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
-- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
-- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
-- SOFTWARE.
|
||||
--
|
||||
|
||||
local json = { _version = "0.1.2" }
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
-- Encode
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
local encode
|
||||
|
||||
local escape_char_map = {
|
||||
["\\"] = "\\",
|
||||
["\""] = "\"",
|
||||
["\b"] = "b",
|
||||
["\f"] = "f",
|
||||
["\n"] = "n",
|
||||
["\r"] = "r",
|
||||
["\t"] = "t",
|
||||
}
|
||||
|
||||
local escape_char_map_inv = { ["/"] = "/" }
|
||||
for k, v in pairs(escape_char_map) do
|
||||
escape_char_map_inv[v] = k
|
||||
end
|
||||
|
||||
|
||||
local function escape_char(c)
|
||||
return "\\" .. (escape_char_map[c] or string.format("u%04x", c:byte()))
|
||||
end
|
||||
|
||||
|
||||
local function encode_nil(val)
|
||||
return "null"
|
||||
end
|
||||
|
||||
|
||||
local function encode_table(val, stack)
|
||||
local res = {}
|
||||
stack = stack or {}
|
||||
|
||||
-- Circular reference?
|
||||
if stack[val] then error("circular reference") end
|
||||
|
||||
stack[val] = true
|
||||
|
||||
if rawget(val, 1) ~= nil or next(val) == nil then
|
||||
-- Treat as array -- check keys are valid and it is not sparse
|
||||
local n = 0
|
||||
for k in pairs(val) do
|
||||
if type(k) ~= "number" then
|
||||
error("invalid table: mixed or invalid key types")
|
||||
end
|
||||
n = n + 1
|
||||
end
|
||||
if n ~= #val then
|
||||
error("invalid table: sparse array")
|
||||
end
|
||||
-- Encode
|
||||
for i, v in ipairs(val) do
|
||||
table.insert(res, encode(v, stack))
|
||||
end
|
||||
stack[val] = nil
|
||||
return "[" .. table.concat(res, ",") .. "]"
|
||||
else
|
||||
-- Treat as an object
|
||||
for k, v in pairs(val) do
|
||||
if type(k) ~= "string" then
|
||||
error("invalid table: mixed or invalid key types")
|
||||
end
|
||||
table.insert(res, encode(k, stack) .. ":" .. encode(v, stack))
|
||||
end
|
||||
stack[val] = nil
|
||||
return "{" .. table.concat(res, ",") .. "}"
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
local function encode_string(val)
|
||||
return '"' .. val:gsub('[%z\1-\31\\"]', escape_char) .. '"'
|
||||
end
|
||||
|
||||
|
||||
local function encode_number(val)
|
||||
-- Check for NaN, -inf and inf
|
||||
if val ~= val or val <= -math.huge or val >= math.huge then
|
||||
error("unexpected number value '" .. tostring(val) .. "'")
|
||||
end
|
||||
return string.format("%.14g", val)
|
||||
end
|
||||
|
||||
|
||||
local type_func_map = {
|
||||
["nil"] = encode_nil,
|
||||
["table"] = encode_table,
|
||||
["string"] = encode_string,
|
||||
["number"] = encode_number,
|
||||
["boolean"] = tostring,
|
||||
}
|
||||
|
||||
|
||||
encode = function(val, stack)
|
||||
local t = type(val)
|
||||
local f = type_func_map[t]
|
||||
if f then
|
||||
return f(val, stack)
|
||||
end
|
||||
error("unexpected type '" .. t .. "'")
|
||||
end
|
||||
|
||||
|
||||
function json.encode(val)
|
||||
return (encode(val))
|
||||
end
|
||||
|
||||
-------------------------------------------------------------------------------
|
||||
-- Decode
|
||||
-------------------------------------------------------------------------------
|
||||
|
||||
local parse
|
||||
|
||||
local function create_set(...)
|
||||
local res = {}
|
||||
for i = 1, select("#", ...) do
|
||||
res[select(i, ...)] = true
|
||||
end
|
||||
return res
|
||||
end
|
||||
|
||||
local space_chars = create_set(" ", "\t", "\r", "\n")
|
||||
local delim_chars = create_set(" ", "\t", "\r", "\n", "]", "}", ",")
|
||||
local escape_chars = create_set("\\", "/", '"', "b", "f", "n", "r", "t", "u")
|
||||
local literals = create_set("true", "false", "null")
|
||||
|
||||
local literal_map = {
|
||||
["true"] = true,
|
||||
["false"] = false,
|
||||
["null"] = nil,
|
||||
}
|
||||
|
||||
|
||||
local function next_char(str, idx, set, negate)
|
||||
for i = idx, #str do
|
||||
if set[str:sub(i, i)] ~= negate then
|
||||
return i
|
||||
end
|
||||
end
|
||||
return #str + 1
|
||||
end
|
||||
|
||||
|
||||
local function decode_error(str, idx, msg)
|
||||
local line_count = 1
|
||||
local col_count = 1
|
||||
for i = 1, idx - 1 do
|
||||
col_count = col_count + 1
|
||||
if str:sub(i, i) == "\n" then
|
||||
line_count = line_count + 1
|
||||
col_count = 1
|
||||
end
|
||||
end
|
||||
error(string.format("%s at line %d col %d", msg, line_count, col_count))
|
||||
end
|
||||
|
||||
|
||||
local function codepoint_to_utf8(n)
|
||||
-- http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=iws-appendixa
|
||||
local f = math.floor
|
||||
if n <= 0x7f then
|
||||
return string.char(n)
|
||||
elseif n <= 0x7ff then
|
||||
return string.char(f(n / 64) + 192, n % 64 + 128)
|
||||
elseif n <= 0xffff then
|
||||
return string.char(f(n / 4096) + 224, f(n % 4096 / 64) + 128, n % 64 + 128)
|
||||
elseif n <= 0x10ffff then
|
||||
return string.char(f(n / 262144) + 240, f(n % 262144 / 4096) + 128,
|
||||
f(n % 4096 / 64) + 128, n % 64 + 128)
|
||||
end
|
||||
error(string.format("invalid unicode codepoint '%x'", n))
|
||||
end
|
||||
|
||||
|
||||
local function parse_unicode_escape(s)
|
||||
local n1 = tonumber(s:sub(1, 4), 16)
|
||||
local n2 = tonumber(s:sub(7, 10), 16)
|
||||
-- Surrogate pair?
|
||||
if n2 then
|
||||
return codepoint_to_utf8((n1 - 0xd800) * 0x400 + (n2 - 0xdc00) + 0x10000)
|
||||
else
|
||||
return codepoint_to_utf8(n1)
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
local function parse_string(str, i)
|
||||
local res = ""
|
||||
local j = i + 1
|
||||
local k = j
|
||||
|
||||
while j <= #str do
|
||||
local x = str:byte(j)
|
||||
|
||||
if x < 32 then
|
||||
decode_error(str, j, "control character in string")
|
||||
elseif x == 92 then -- `\`: Escape
|
||||
res = res .. str:sub(k, j - 1)
|
||||
j = j + 1
|
||||
local c = str:sub(j, j)
|
||||
if c == "u" then
|
||||
local hex = str:match("^[dD][89aAbB]%x%x\\u%x%x%x%x", j + 1)
|
||||
or str:match("^%x%x%x%x", j + 1)
|
||||
or decode_error(str, j - 1, "invalid unicode escape in string")
|
||||
res = res .. parse_unicode_escape(hex)
|
||||
j = j + #hex
|
||||
else
|
||||
if not escape_chars[c] then
|
||||
decode_error(str, j - 1, "invalid escape char '" .. c .. "' in string")
|
||||
end
|
||||
res = res .. escape_char_map_inv[c]
|
||||
end
|
||||
k = j + 1
|
||||
elseif x == 34 then -- `"`: End of string
|
||||
res = res .. str:sub(k, j - 1)
|
||||
return res, j + 1
|
||||
end
|
||||
|
||||
j = j + 1
|
||||
end
|
||||
|
||||
decode_error(str, i, "expected closing quote for string")
|
||||
end
|
||||
|
||||
|
||||
local function parse_number(str, i)
|
||||
local x = next_char(str, i, delim_chars)
|
||||
local s = str:sub(i, x - 1)
|
||||
local n = tonumber(s)
|
||||
if not n then
|
||||
decode_error(str, i, "invalid number '" .. s .. "'")
|
||||
end
|
||||
return n, x
|
||||
end
|
||||
|
||||
|
||||
local function parse_literal(str, i)
|
||||
local x = next_char(str, i, delim_chars)
|
||||
local word = str:sub(i, x - 1)
|
||||
if not literals[word] then
|
||||
decode_error(str, i, "invalid literal '" .. word .. "'")
|
||||
end
|
||||
return literal_map[word], x
|
||||
end
|
||||
|
||||
|
||||
local function parse_array(str, i)
|
||||
local res = {}
|
||||
local n = 1
|
||||
i = i + 1
|
||||
while 1 do
|
||||
local x
|
||||
i = next_char(str, i, space_chars, true)
|
||||
-- Empty / end of array?
|
||||
if str:sub(i, i) == "]" then
|
||||
i = i + 1
|
||||
break
|
||||
end
|
||||
-- Read token
|
||||
x, i = parse(str, i)
|
||||
res[n] = x
|
||||
n = n + 1
|
||||
-- Next token
|
||||
i = next_char(str, i, space_chars, true)
|
||||
local chr = str:sub(i, i)
|
||||
i = i + 1
|
||||
if chr == "]" then break end
|
||||
if chr ~= "," then decode_error(str, i, "expected ']' or ','") end
|
||||
end
|
||||
return res, i
|
||||
end
|
||||
|
||||
|
||||
local function parse_object(str, i)
|
||||
local res = {}
|
||||
i = i + 1
|
||||
while 1 do
|
||||
local key, val
|
||||
i = next_char(str, i, space_chars, true)
|
||||
-- Empty / end of object?
|
||||
if str:sub(i, i) == "}" then
|
||||
i = i + 1
|
||||
break
|
||||
end
|
||||
-- Read key
|
||||
if str:sub(i, i) ~= '"' then
|
||||
decode_error(str, i, "expected string for key")
|
||||
end
|
||||
key, i = parse(str, i)
|
||||
-- Read ':' delimiter
|
||||
i = next_char(str, i, space_chars, true)
|
||||
if str:sub(i, i) ~= ":" then
|
||||
decode_error(str, i, "expected ':' after key")
|
||||
end
|
||||
i = next_char(str, i + 1, space_chars, true)
|
||||
-- Read value
|
||||
val, i = parse(str, i)
|
||||
-- Set
|
||||
res[key] = val
|
||||
-- Next token
|
||||
i = next_char(str, i, space_chars, true)
|
||||
local chr = str:sub(i, i)
|
||||
i = i + 1
|
||||
if chr == "}" then break end
|
||||
if chr ~= "," then decode_error(str, i, "expected '}' or ','") end
|
||||
end
|
||||
return res, i
|
||||
end
|
||||
|
||||
|
||||
local char_func_map = {
|
||||
['"'] = parse_string,
|
||||
["0"] = parse_number,
|
||||
["1"] = parse_number,
|
||||
["2"] = parse_number,
|
||||
["3"] = parse_number,
|
||||
["4"] = parse_number,
|
||||
["5"] = parse_number,
|
||||
["6"] = parse_number,
|
||||
["7"] = parse_number,
|
||||
["8"] = parse_number,
|
||||
["9"] = parse_number,
|
||||
["-"] = parse_number,
|
||||
["t"] = parse_literal,
|
||||
["f"] = parse_literal,
|
||||
["n"] = parse_literal,
|
||||
["["] = parse_array,
|
||||
["{"] = parse_object,
|
||||
}
|
||||
|
||||
|
||||
parse = function(str, idx)
|
||||
local chr = str:sub(idx, idx)
|
||||
local f = char_func_map[chr]
|
||||
if f then
|
||||
return f(str, idx)
|
||||
end
|
||||
decode_error(str, idx, "unexpected character '" .. chr .. "'")
|
||||
end
|
||||
|
||||
|
||||
function json.decode(str)
|
||||
if type(str) ~= "string" then
|
||||
error("expected argument of type string, got " .. type(str))
|
||||
end
|
||||
local res, idx = parse(str, next_char(str, 1, space_chars, true))
|
||||
idx = next_char(str, idx, space_chars, true)
|
||||
if idx <= #str then
|
||||
decode_error(str, idx, "trailing garbage")
|
||||
end
|
||||
return res
|
||||
end
|
||||
|
||||
return {
|
||||
encode = json.encode,
|
||||
decode = json.decode,
|
||||
}
|
||||
@@ -0,0 +1,652 @@
|
||||
local SUPPORTED_KEYS_MAP = {
|
||||
["0"] = 1,
|
||||
["1"] = 2,
|
||||
["2"] = 3,
|
||||
["3"] = 4,
|
||||
["4"] = 5,
|
||||
["5"] = 6,
|
||||
["6"] = 7,
|
||||
["7"] = 8,
|
||||
["8"] = 9,
|
||||
["9"] = 10,
|
||||
["A"] = 11,
|
||||
["B"] = 12,
|
||||
["C"] = 13,
|
||||
["D"] = 14,
|
||||
["E"] = 15,
|
||||
["F"] = 16,
|
||||
["G"] = 17,
|
||||
["H"] = 18,
|
||||
["I"] = 19,
|
||||
["J"] = 20,
|
||||
["K"] = 21,
|
||||
["L"] = 22,
|
||||
["M"] = 23,
|
||||
["N"] = 24,
|
||||
["O"] = 25,
|
||||
["P"] = 26,
|
||||
["Q"] = 27,
|
||||
["R"] = 28,
|
||||
["S"] = 29,
|
||||
["T"] = 30,
|
||||
["U"] = 31,
|
||||
["V"] = 32,
|
||||
["W"] = 33,
|
||||
["X"] = 34,
|
||||
["Y"] = 35,
|
||||
["Z"] = 36,
|
||||
["a"] = 37,
|
||||
["b"] = 38,
|
||||
["c"] = 39,
|
||||
["d"] = 40,
|
||||
["e"] = 41,
|
||||
["f"] = 42,
|
||||
["g"] = 43,
|
||||
["h"] = 44,
|
||||
["i"] = 45,
|
||||
["j"] = 46,
|
||||
["k"] = 47,
|
||||
["l"] = 48,
|
||||
["m"] = 49,
|
||||
["n"] = 50,
|
||||
["o"] = 51,
|
||||
["p"] = 52,
|
||||
["q"] = 53,
|
||||
["r"] = 54,
|
||||
["s"] = 55,
|
||||
["t"] = 56,
|
||||
["u"] = 57,
|
||||
["v"] = 58,
|
||||
["w"] = 59,
|
||||
["x"] = 60,
|
||||
["y"] = 61,
|
||||
["z"] = 62,
|
||||
}
|
||||
|
||||
local SUPPORTED_KEYS = {
|
||||
{ on = "0" },
|
||||
{ on = "1" },
|
||||
{ on = "2" },
|
||||
{ on = "3" },
|
||||
{ on = "4" },
|
||||
{ on = "5" },
|
||||
{ on = "6" },
|
||||
{ on = "7" },
|
||||
{ on = "8" },
|
||||
{ on = "9" },
|
||||
{ on = "A" },
|
||||
{ on = "B" },
|
||||
{ on = "C" },
|
||||
{ on = "D" },
|
||||
{ on = "E" },
|
||||
{ on = "F" },
|
||||
{ on = "G" },
|
||||
{ on = "H" },
|
||||
{ on = "I" },
|
||||
{ on = "J" },
|
||||
{ on = "K" },
|
||||
{ on = "L" },
|
||||
{ on = "M" },
|
||||
{ on = "N" },
|
||||
{ on = "O" },
|
||||
{ on = "P" },
|
||||
{ on = "Q" },
|
||||
{ on = "R" },
|
||||
{ on = "S" },
|
||||
{ on = "T" },
|
||||
{ on = "U" },
|
||||
{ on = "V" },
|
||||
{ on = "W" },
|
||||
{ on = "X" },
|
||||
{ on = "Y" },
|
||||
{ on = "Z" },
|
||||
{ on = "a" },
|
||||
{ on = "b" },
|
||||
{ on = "c" },
|
||||
{ on = "d" },
|
||||
{ on = "e" },
|
||||
{ on = "f" },
|
||||
{ on = "g" },
|
||||
{ on = "h" },
|
||||
{ on = "i" },
|
||||
{ on = "j" },
|
||||
{ on = "k" },
|
||||
{ on = "l" },
|
||||
{ on = "m" },
|
||||
{ on = "n" },
|
||||
{ on = "o" },
|
||||
{ on = "p" },
|
||||
{ on = "q" },
|
||||
{ on = "r" },
|
||||
{ on = "s" },
|
||||
{ on = "t" },
|
||||
{ on = "u" },
|
||||
{ on = "v" },
|
||||
{ on = "w" },
|
||||
{ on = "x" },
|
||||
{ on = "y" },
|
||||
{ on = "z" },
|
||||
}
|
||||
|
||||
local _notify = ya.sync(function(state, message)
|
||||
ya.notify({
|
||||
title = state.notify.title,
|
||||
content = message,
|
||||
timeout = state.notify.timeout,
|
||||
level = state.notify.level,
|
||||
})
|
||||
end)
|
||||
|
||||
local _get_default_projects = ya.sync(function(state)
|
||||
return {
|
||||
list = {},
|
||||
last = nil,
|
||||
}
|
||||
end)
|
||||
|
||||
local _get_projects = ya.sync(function(state)
|
||||
return not state.projects and _get_default_projects() or state.projects
|
||||
end)
|
||||
|
||||
local _get_real_idx = ya.sync(function(state, idx)
|
||||
for real_idx, value in ipairs(_get_projects().list) do
|
||||
if value.on == SUPPORTED_KEYS[idx].on then
|
||||
return real_idx
|
||||
end
|
||||
end
|
||||
return nil
|
||||
end)
|
||||
|
||||
local _get_current_project = ya.sync(function(state)
|
||||
local tabs = cx.tabs
|
||||
|
||||
-- TODO: add more tab properties
|
||||
local project = {
|
||||
active_idx = tonumber(tabs.idx),
|
||||
tabs = {},
|
||||
}
|
||||
|
||||
for index, tab in ipairs(tabs) do
|
||||
project.tabs[#project.tabs + 1] = {
|
||||
idx = index,
|
||||
cwd = tostring(tab.current.cwd):gsub("\\", "/"),
|
||||
}
|
||||
end
|
||||
|
||||
return project
|
||||
end)
|
||||
|
||||
local _save_projects = ya.sync(function(state, projects)
|
||||
state.projects = projects
|
||||
|
||||
if state.save.method == "yazi" then
|
||||
ps.pub_to(0, state.save.yazi_load_event, projects)
|
||||
elseif state.save.method == "lua" then
|
||||
local f = io.open(state.save.lua_save_path, "w")
|
||||
if not f then
|
||||
return
|
||||
end
|
||||
f:write(state.json.encode(projects))
|
||||
io.close(f)
|
||||
end
|
||||
end)
|
||||
|
||||
local save_project = ya.sync(function(state, idx, desc)
|
||||
local projects = _get_projects()
|
||||
|
||||
local real_idx = _get_real_idx(idx)
|
||||
if not real_idx then
|
||||
real_idx = #projects.list + 1
|
||||
end
|
||||
|
||||
local project = _get_current_project()
|
||||
projects.list[real_idx] = {
|
||||
on = SUPPORTED_KEYS[idx].on,
|
||||
desc = desc,
|
||||
project = project,
|
||||
}
|
||||
|
||||
if state.last.update_after_save then
|
||||
projects.last = project
|
||||
end
|
||||
|
||||
_save_projects(projects)
|
||||
|
||||
if state.event.save.enable then
|
||||
ps.pub_to(0, state.event.save.name, project)
|
||||
end
|
||||
|
||||
if state.notify.enable then
|
||||
local message = string.format("Project saved to %s", state.projects.list[real_idx].on)
|
||||
_notify(message)
|
||||
end
|
||||
end)
|
||||
|
||||
local load_project = ya.sync(function(state, project, desc)
|
||||
-- TODO: add more tab properties to restore
|
||||
|
||||
-- when cx is nil, it is called in setup
|
||||
if cx then
|
||||
for _ = 1, #cx.tabs - 1 do
|
||||
ya.emit("tab_close", { 0 })
|
||||
end
|
||||
end
|
||||
|
||||
local sorted_tabs = {}
|
||||
for _, tab in pairs(project.tabs) do
|
||||
sorted_tabs[tonumber(tab.idx)] = tab
|
||||
end
|
||||
for _, tab in pairs(sorted_tabs) do
|
||||
ya.emit("tab_create", { tab.cwd })
|
||||
end
|
||||
|
||||
ya.emit("tab_close", { 0 })
|
||||
ya.emit("tab_switch", { project.active_idx - 1 })
|
||||
|
||||
if state.last.update_after_load then
|
||||
local projects = _get_projects()
|
||||
projects.last = project
|
||||
_save_projects(projects)
|
||||
end
|
||||
|
||||
if state.event.load.enable then
|
||||
ps.pub_to(0, state.event.load.name, project)
|
||||
end
|
||||
|
||||
if state.notify.enable then
|
||||
local message
|
||||
if desc then
|
||||
message = string.format([["%s" loaded]], desc)
|
||||
else
|
||||
message = string.format([[Last project loaded]], desc)
|
||||
end
|
||||
_notify(message)
|
||||
end
|
||||
end)
|
||||
|
||||
local _load_projects = ya.sync(function(state)
|
||||
if state.save.method == "yazi" then
|
||||
ps.sub_remote(state.save.yazi_load_event, function(body)
|
||||
state.projects = body
|
||||
end)
|
||||
elseif state.save.method == "lua" then
|
||||
local f = io.open(state.save.lua_save_path, "r")
|
||||
if f then
|
||||
state.projects = state.json.decode(f:read("*a"))
|
||||
io.close(f)
|
||||
end
|
||||
end
|
||||
|
||||
if not state.projects then
|
||||
state.projects = _get_default_projects()
|
||||
end
|
||||
|
||||
if state.last.load_after_start then
|
||||
local last_project = _get_projects().last
|
||||
if last_project then
|
||||
load_project(last_project)
|
||||
end
|
||||
end
|
||||
end)
|
||||
|
||||
local delete_all_projects = ya.sync(function(state)
|
||||
_save_projects(_get_default_projects())
|
||||
|
||||
local msg = "All projects deleted"
|
||||
|
||||
if state.event.delete_all.enable then
|
||||
ps.pub_to(0, state.event.delete_all.name, msg)
|
||||
end
|
||||
|
||||
if state.notify.enable then
|
||||
_notify(msg)
|
||||
end
|
||||
end)
|
||||
|
||||
local delete_project = ya.sync(function(state, idx)
|
||||
local projects = _get_projects()
|
||||
|
||||
local message = string.format([["%s" deleted]], tostring(projects.list[idx].desc))
|
||||
|
||||
local deleted_project = projects.list[idx]
|
||||
table.remove(projects.list, idx)
|
||||
_save_projects(projects)
|
||||
|
||||
if state.event.delete.enable then
|
||||
ps.pub_to(0, state.event.delete.name, deleted_project)
|
||||
end
|
||||
|
||||
if state.notify.enable then
|
||||
_notify(message)
|
||||
end
|
||||
end)
|
||||
|
||||
local merge_project = ya.sync(function(state, opt)
|
||||
local project = _get_current_project()
|
||||
project.opt = opt or "all"
|
||||
ps.pub_to(0, state.merge.event, project)
|
||||
|
||||
if state.event.merge.enable then
|
||||
ps.pub_to(0, state.event.merge.name, project)
|
||||
end
|
||||
|
||||
if state.merge.quit_after_merge then
|
||||
ya.emit("quit", {})
|
||||
end
|
||||
end)
|
||||
|
||||
local _merge_tab = ya.sync(function(state, tab)
|
||||
ya.emit("tab_create", { tab.cwd })
|
||||
end)
|
||||
|
||||
local _merge_event = ya.sync(function(state)
|
||||
ps.sub_remote(state.merge.event, function(body)
|
||||
if body then
|
||||
local active_idx = tonumber(cx.tabs.idx)
|
||||
|
||||
local opt = body.opt
|
||||
if opt == "all" then
|
||||
local sorted_tabs = {}
|
||||
for _, tab in pairs(body.tabs) do
|
||||
sorted_tabs[tonumber(tab.idx)] = tab
|
||||
end
|
||||
|
||||
for _, tab in ipairs(sorted_tabs) do
|
||||
_merge_tab(tab)
|
||||
end
|
||||
|
||||
if state.notify.enable then
|
||||
local message = "A project is merged"
|
||||
_notify(message)
|
||||
end
|
||||
elseif opt == "current" then
|
||||
local tab = body.tabs[tonumber(body.active_idx)]
|
||||
_merge_tab(tab)
|
||||
|
||||
if state.notify.enable then
|
||||
local message = "A tab is merged"
|
||||
_notify(message)
|
||||
end
|
||||
end
|
||||
|
||||
ya.emit("tab_switch", { active_idx - 1 })
|
||||
end
|
||||
end)
|
||||
end)
|
||||
|
||||
local _find_project_index = ya.sync(function(state, list, search_term)
|
||||
if not search_term then
|
||||
return nil
|
||||
end
|
||||
|
||||
for i, project in ipairs(list) do
|
||||
-- Match the project by the "on" key or by "desc"
|
||||
if project.on == search_term or project.desc == search_term then
|
||||
return i
|
||||
end
|
||||
end
|
||||
|
||||
return nil
|
||||
end)
|
||||
|
||||
local _load_config = ya.sync(function(state, opts)
|
||||
state.event = {
|
||||
save = {
|
||||
enable = true,
|
||||
name = "project-saved",
|
||||
},
|
||||
load = {
|
||||
enable = true,
|
||||
name = "project-loaded",
|
||||
},
|
||||
delete = {
|
||||
enable = true,
|
||||
name = "project-deleted",
|
||||
},
|
||||
delete_all = {
|
||||
enable = true,
|
||||
name = "project-deleted-all",
|
||||
},
|
||||
merge = {
|
||||
enable = true,
|
||||
name = "project-merged",
|
||||
},
|
||||
}
|
||||
if type(opts.event) == "table" then
|
||||
if type(opts.event.save) == "table" then
|
||||
if type(opts.event.save.enable) == "boolean" then
|
||||
state.event.save.enable = opts.event.save.enable
|
||||
end
|
||||
if type(opts.event.save.name) == "string" then
|
||||
state.event.save.name = opts.event.save.name
|
||||
end
|
||||
elseif type(opts.event.save) == "boolean" then
|
||||
state.event.save.enable = opts.event.save
|
||||
end
|
||||
if type(opts.event.load) == "table" then
|
||||
if type(opts.event.load.enable) == "boolean" then
|
||||
state.event.load.enable = opts.event.load.enable
|
||||
end
|
||||
if type(opts.event.load.name) == "string" then
|
||||
state.event.load.name = opts.event.load.name
|
||||
end
|
||||
elseif type(opts.event.load) == "boolean" then
|
||||
state.event.load.enable = opts.event.load
|
||||
end
|
||||
if type(opts.event.delete) == "table" then
|
||||
if type(opts.event.delete.enable) == "boolean" then
|
||||
state.event.delete.enable = opts.event.delete.enable
|
||||
end
|
||||
if type(opts.event.delete.name) == "string" then
|
||||
state.event.delete.name = opts.event.delete.name
|
||||
end
|
||||
elseif type(opts.event.delete) == "boolean" then
|
||||
state.event.delete.enable = opts.event.delete
|
||||
end
|
||||
if type(opts.event.delete_all) == "table" then
|
||||
if type(opts.event.delete_all.enable) == "boolean" then
|
||||
state.event.delete_all.enable = opts.event.delete_all.enable
|
||||
end
|
||||
if type(opts.event.delete_all.name) == "string" then
|
||||
state.event.delete_all.name = opts.event.delete_all.name
|
||||
end
|
||||
elseif type(opts.event.delete_all) == "boolean" then
|
||||
state.event.delete_all.enable = opts.event.delete_all
|
||||
end
|
||||
if type(opts.event.merge) == "table" then
|
||||
if type(opts.event.merge.enable) == "boolean" then
|
||||
state.event.merge.enable = opts.event.merge.enable
|
||||
end
|
||||
if type(opts.event.merge.name) == "string" then
|
||||
state.event.merge.name = opts.event.merge.name
|
||||
end
|
||||
elseif type(opts.event.merge) == "boolean" then
|
||||
state.event.merge.enable = opts.event.merge
|
||||
end
|
||||
end
|
||||
|
||||
state.save = {
|
||||
method = "yazi",
|
||||
yazi_load_event = "@projects-load",
|
||||
lua_save_path = "",
|
||||
}
|
||||
if type(opts.save) == "table" then
|
||||
if type(opts.save.method) == "string" then
|
||||
state.save.method = opts.save.method
|
||||
end
|
||||
if type(opts.save.yazi_load_event) == "string" then
|
||||
state.save.yazi_load_event = opts.save.yazi_load_event
|
||||
end
|
||||
if type(opts.save.lua_save_path) == "string" then
|
||||
state.save.lua_save_path = opts.save.lua_save_path
|
||||
else
|
||||
local lua_save_path
|
||||
local appdata = os.getenv("APPDATA")
|
||||
if appdata then
|
||||
lua_save_path = appdata:gsub("\\", "/") .. "/yazi/state/projects.json"
|
||||
else
|
||||
lua_save_path = os.getenv("HOME") .. "/.local/state/yazi/projects.json"
|
||||
end
|
||||
|
||||
state.save.lua_save_path = lua_save_path
|
||||
end
|
||||
end
|
||||
|
||||
state.last = {
|
||||
update_after_save = true,
|
||||
update_after_load = true,
|
||||
update_before_quit = false,
|
||||
load_after_start = false,
|
||||
}
|
||||
if type(opts.last) == "table" then
|
||||
if type(opts.last.update_after_save) == "boolean" then
|
||||
state.last.update_after_save = opts.last.update_after_save
|
||||
end
|
||||
if type(opts.last.update_after_load) == "boolean" then
|
||||
state.last.update_after_load = opts.last.update_after_load
|
||||
end
|
||||
if type(opts.last.update_before_quit) == "boolean" then
|
||||
state.last.update_before_quit = opts.last.update_before_quit
|
||||
end
|
||||
if type(opts.last.load_after_start) == "boolean" then
|
||||
state.last.load_after_start = opts.last.load_after_start
|
||||
end
|
||||
end
|
||||
if state.last.update_before_quit then
|
||||
ps.sub("key-quit", function(body)
|
||||
local projects = _get_projects()
|
||||
local current_project = _get_current_project()
|
||||
projects.last = current_project
|
||||
_save_projects(projects)
|
||||
|
||||
if state.event.save.enable then
|
||||
ps.pub_to(0, state.event.save.name, current_project)
|
||||
end
|
||||
|
||||
ya.emit("quit", {})
|
||||
return true
|
||||
end)
|
||||
end
|
||||
|
||||
state.merge = {
|
||||
event = "projects-merge",
|
||||
quit_after_merge = false,
|
||||
}
|
||||
if type(opts.merge) == "table" then
|
||||
if type(opts.merge.event) == "string" then
|
||||
state.merge.event = opts.merge.event
|
||||
end
|
||||
if type(opts.merge.quit_after_merge) == "boolean" then
|
||||
state.merge.quit_after_merge = opts.merge.quit_after_merge
|
||||
end
|
||||
end
|
||||
|
||||
state.notify = {
|
||||
enable = true,
|
||||
title = "Projects",
|
||||
timeout = 3,
|
||||
level = "info",
|
||||
}
|
||||
if type(opts.notify) == "table" then
|
||||
if type(opts.notify.enable) == "boolean" then
|
||||
state.notify.enable = opts.notify.enable
|
||||
end
|
||||
if type(opts.notify.title) == "string" then
|
||||
state.notify.title = opts.notify.title
|
||||
end
|
||||
if type(opts.notify.timeout) == "number" then
|
||||
state.notify.timeout = opts.notify.timeout
|
||||
end
|
||||
if type(opts.notify.level) == "string" then
|
||||
state.notify.level = opts.notify.level
|
||||
end
|
||||
end
|
||||
end)
|
||||
|
||||
return {
|
||||
setup = function(state, opts)
|
||||
state.json = require(".json")
|
||||
_load_config(opts)
|
||||
_load_projects()
|
||||
_merge_event()
|
||||
end,
|
||||
entry = function(_, job)
|
||||
local action = job.args[1]
|
||||
if not action then
|
||||
return
|
||||
end
|
||||
|
||||
if action == "delete_all" then
|
||||
delete_all_projects()
|
||||
return
|
||||
end
|
||||
|
||||
if action == "merge" then
|
||||
local opt = job.args[2]
|
||||
merge_project(opt)
|
||||
return
|
||||
end
|
||||
|
||||
local projects = _get_projects()
|
||||
|
||||
if action == "load_last" then
|
||||
local last_project = projects.last
|
||||
if last_project then
|
||||
load_project(last_project)
|
||||
end
|
||||
return
|
||||
end
|
||||
|
||||
local list = projects.list
|
||||
|
||||
if action == "save" then
|
||||
-- load the desc of saved projects
|
||||
for _, value in pairs(list) do
|
||||
local idx = SUPPORTED_KEYS_MAP[value.on]
|
||||
if idx then
|
||||
SUPPORTED_KEYS[idx].desc = value.desc
|
||||
end
|
||||
end
|
||||
|
||||
local idx = ya.which({ cands = SUPPORTED_KEYS, silent = false })
|
||||
if not idx then
|
||||
return
|
||||
end
|
||||
|
||||
-- if target is not empty, use the saved desc as default desc
|
||||
local default_desc = SUPPORTED_KEYS[idx].desc or string.format("Project %s", SUPPORTED_KEYS[idx].on)
|
||||
local value, event = ya.input({
|
||||
pos = { "center", w = 40 },
|
||||
title = "Project name:",
|
||||
value = default_desc,
|
||||
})
|
||||
if event ~= 1 then
|
||||
return
|
||||
end
|
||||
|
||||
local desc
|
||||
if value ~= "" then
|
||||
desc = value
|
||||
else
|
||||
desc = default_desc
|
||||
end
|
||||
|
||||
save_project(idx, desc)
|
||||
return
|
||||
end
|
||||
|
||||
-- Search for the project, if an argument was given
|
||||
-- Or ask interactively
|
||||
local selected_idx = _find_project_index(list, job.args[2]) or ya.which({ cands = list, silent = false })
|
||||
if not selected_idx then
|
||||
return
|
||||
end
|
||||
|
||||
if action == "load" then
|
||||
local selected = list[selected_idx]
|
||||
load_project(selected.project, selected.desc)
|
||||
elseif action == "delete" then
|
||||
delete_project(selected_idx)
|
||||
end
|
||||
end,
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2025 Robert
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,183 @@
|
||||
<p align="center">
|
||||
<img
|
||||
src="https://cdn.jsdelivr.net/gh/twitter/twemoji@14.0.2/assets/svg/1f5d1.svg"
|
||||
width="128" height="128" alt="Trash emoji" />
|
||||
</p>
|
||||
<h1 align="center">recycle-bin.yazi</h1>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/uhs-robert/recycle-bin.yazi/stargazers"><img src="https://img.shields.io/github/stars/uhs-robert/recycle-bin.yazi?colorA=192330&colorB=khaki&style=for-the-badge&cacheSeconds=4300"></a>
|
||||
<a href="https://github.com/sxyazi/yazi" target="_blank" rel="noopener noreferrer"><img alt="Yazi 0.25+" src="https://img.shields.io/badge/Yazi-0.25%2B-blue?style=for-the-badge&cacheSeconds=4300&labelColor=192330" /></a>
|
||||
<a href="https://github.com/uhs-robert/recycle-bin.yazi/issues"><img src="https://img.shields.io/github/issues/uhs-robert/recycle-bin.yazi?colorA=192330&colorB=skyblue&style=for-the-badge&cacheSeconds=4300"></a>
|
||||
<a href="https://github.com/uhs-robert/recycle-bin.yazi/contributors"><img src="https://img.shields.io/github/contributors/uhs-robert/recycle-bin.yazi?colorA=192330&colorB=8FD1C7&style=for-the-badge&cacheSeconds=4300"></a>
|
||||
<a href="https://github.com/uhs-robert/recycle-bin.yazi/network/members"><img src="https://img.shields.io/github/forks/uhs-robert/recycle-bin.yazi?colorA=192330&colorB=CFA7FF&style=for-the-badge&cacheSeconds=4300"></a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
A blazing fast, minimal <strong>Recycle Bin</strong> for the <a target="_blank" rel="noopener noreferrer" href="https://github.com/sxyazi/yazi">Yazi</a> terminal file‑manager.
|
||||
</p>
|
||||
|
||||
## 🕶️ What does it do?
|
||||
|
||||
Browse, restore, or permanently delete trashed files without leaving your terminal. Includes age-based cleanup and bulk actions.
|
||||
|
||||
<https://github.com/user-attachments/assets/1f7ab9b2-33e3-4262-94c5-b27ad9dc142e>
|
||||
|
||||
> [!NOTE]
|
||||
>
|
||||
> **Cross-Platform Support**
|
||||
>
|
||||
> This plugin supports Linux and macOS systems.
|
||||
|
||||
## 🧠 What it does under the hood
|
||||
|
||||
This plugin serves as a wrapper for the [trash-cli](https://github.com/andreafrancia/trash-cli) command, integrating it seamlessly with Yazi.
|
||||
|
||||
## ✨ Features
|
||||
|
||||
- **📂 Browse trash**: Navigate to trash directory directly in Yazi
|
||||
- **🔄 Restore files**: Bulk restore selected files from trash to their original locations
|
||||
- **⚠️ Conflict resolution**: Intelligent handling when restored files already exist at destination
|
||||
- **🛡️ Safety dialogs**: Preview conflicts with skip/overwrite options before restoration
|
||||
- **🗑️ Empty trash**: Clear entire trash with detailed file previews and confirmation dialog
|
||||
- **📅 Empty by days**: Remove trash items older than specified number of days with size information
|
||||
- **❌ Permanent delete**: Bulk delete selected files from trash permanently
|
||||
- **🔧 Configurable**: Customize trash directory
|
||||
|
||||
## 📋 Requirements
|
||||
|
||||
| Software | Minimum | Notes |
|
||||
| --------- | ----------- | ----------------------------------------------------------------------------------------- |
|
||||
| Yazi | `>=25.5.31` | untested on 25.6+ |
|
||||
| trash-cli | any | **Linux**: `sudo dnf/apt/pacman install trash-cli`<br>**macOS**: `brew install trash-cli` |
|
||||
|
||||
The plugin uses the following trash-cli commands: `trash-list`, `trash-empty`, `trash-restore`, and `trash-rm`.
|
||||
|
||||
## 📦 Installation
|
||||
|
||||
Install the plugin via Yazi's package manager:
|
||||
|
||||
```sh
|
||||
# via Yazi’s package manager
|
||||
ya pkg add uhs-robert/recycle-bin
|
||||
```
|
||||
|
||||
Then add the following to your `~/.config/yazi/init.lua` to enable the plugin with default settings:
|
||||
|
||||
```lua
|
||||
require("recycle-bin"):setup()
|
||||
```
|
||||
|
||||
## ⚙️ Configuration
|
||||
|
||||
The plugin automatically discovers your system's trash directories using `trash-list --trash-dirs`. If you need to customize the behavior, you can pass a config table to `setup()`:
|
||||
|
||||
```lua
|
||||
require("recycle-bin"):setup({
|
||||
-- Optional: Override automatic trash directory discovery
|
||||
-- trash_dir = "~/.local/share/Trash/", -- Uncomment to use specific directory
|
||||
})
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> The plugin supports multiple trash directories and will prompt you to choose which one to use if multiple are found.
|
||||
|
||||
## 🎹 Key Mapping
|
||||
|
||||
### 🗝️ Recommended: Preset
|
||||
|
||||
Add this to your `~/.config/yazi/keymap.toml` (substitute `on = ["R","b"]` with your keybind preference):
|
||||
|
||||
```toml
|
||||
[mgr]
|
||||
prepend_keymap = [
|
||||
{ on = ["R","b"], run = "plugin recycle-bin", desc = "Open Recycle Bin menu" },
|
||||
]
|
||||
```
|
||||
|
||||
The `R b` menu provides access to all trash management functions:
|
||||
|
||||
- `o` → Open Trash
|
||||
- `r` → Restore from Trash
|
||||
- `d` → Delete from Trash
|
||||
- `e` → Empty Trash
|
||||
- `D` → Empty by Days
|
||||
|
||||
> [!TIP]
|
||||
> `recycle-bin.yazi` uses the [array form for its keymap example](https://yazi-rs.github.io/docs/configuration/keymap).
|
||||
> You must pick **only one style** per file; mixing with `[[mgr.prepend_keymap]]` will fail.
|
||||
>
|
||||
> **Also note:** some plugins may suggest binding a bare key like `on = "R"`,
|
||||
> which blocks all `R <key>` chords (including `R b`). Change those to chords
|
||||
> (e.g. `["R","r"]`) or choose a different non-conflicting prefix.
|
||||
|
||||
---
|
||||
|
||||
### 🛠️ Alternative: Custom direct keybinds
|
||||
|
||||
If you prefer direct keybinds, you may also set your own using our API. Here are the available options:
|
||||
|
||||
```toml
|
||||
[mgr]
|
||||
prepend_keymap = [
|
||||
{ on = ["R","o"], run = "plugin recycle-bin -- open", desc = "Open Trash" },
|
||||
{ on = ["R","e"], run = "plugin recycle-bin -- empty", desc = "Empty Trash" },
|
||||
{ on = ["R","D"], run = "plugin recycle-bin -- emptyDays", desc = "Empty by days deleted" },
|
||||
{ on = ["R","d"], run = "plugin recycle-bin -- delete", desc = "Delete from Trash" },
|
||||
{ on = ["R","r"], run = "plugin recycle-bin -- restore", desc = "Restore from Trash" },
|
||||
]
|
||||
```
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Remember that you are the only one who is responsible for managing and resolving your keybind conflicts.
|
||||
|
||||
## 🚀 Usage
|
||||
|
||||
### 📝 Example using the recommended preset
|
||||
|
||||
- **Recycle Bin Menu (`R b`):** Opens an interactive menu with all trash management options
|
||||
- **Open Trash (`o`):** Navigate to trash directory directly in Yazi
|
||||
- **Restore from Trash (`r`):** Bulk restore selected files from trash to their original locations. The plugin automatically detects conflicts when files already exist at the original location and prompts you to skip or overwrite conflicting files with detailed information.
|
||||
- **Delete from Trash (`d`):** Permanently delete selected files from trash. Shows confirmation dialog before deletion.
|
||||
- **Empty Trash (`e`):** Clear entire trash with detailed file previews including names, sizes, and deletion dates before confirmation.
|
||||
- **Empty by Days (`D`):** Remove trash items older than specified number of days (defaults to 30 days). Displays filtered list with file details and total size information.
|
||||
|
||||
> [!TIP]
|
||||
> Use Yazi's visual selection (`v` or `V` followed by `ESC` to select items) or toggle select (press `Space` on individual files) to select multiple files from the Trash before restoring or deleting
|
||||
>
|
||||
> The plugin will show a confirmation dialog for destructive operations
|
||||
|
||||
## 🛠️ Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
**"trashcli not found" error:**
|
||||
|
||||
- Ensure trash-cli is installed: `sudo dnf/apt/pacman install trash-cli`
|
||||
- Verify installation: `trash-list --version`
|
||||
- Check if trash-cli commands are in your PATH
|
||||
|
||||
**"Trash directory not found" error:**
|
||||
|
||||
- The plugin automatically discovers trash directories using `trash-list --trash-dirs`
|
||||
- If no directories are found, create the standard location:
|
||||
- **Linux**: `mkdir -p ~/.local/share/Trash/{files,info}`
|
||||
- **macOS**: `mkdir -p ~/.Trash`
|
||||
- You can also specify a custom path in your configuration
|
||||
|
||||
**"No files selected" warning:**
|
||||
|
||||
- Make sure you have files selected in Yazi before running restore/delete operations
|
||||
- Use `Space` to select files or `v`/`V` for visual selection mode
|
||||
|
||||
## 💡 Recommendations
|
||||
|
||||
### Companion Plugin
|
||||
|
||||
For an even better trash management experience, pair this plugin with:
|
||||
|
||||
**[restore.yazi](https://github.com/boydaihungst/restore.yazi)** - Undo your delete history by your latest deleted files/folders
|
||||
|
||||
This companion plugin adds an "undo" feature that lets you press `u` to instantly restore the last deleted file. You can keep hitting `u` repeatedly to step through your entire delete history, making accidental deletions a thing of the past.
|
||||
|
||||
**Perfect combination:** Use `restore.yazi` for quick single-file undos and `recycle-bin.yazi` for comprehensive trash management and bulk operations.
|
||||
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2024 Anirudh Gupta
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,89 @@
|
||||
# rich-preview.yazi
|
||||
|
||||
Preview file types using `rich` command in Yazi. This plugin allows preview for various filetypes including -
|
||||
|
||||
- Markdown
|
||||
- Jupyter notebook
|
||||
- JSON
|
||||
- CSV
|
||||
- RestructuredText
|
||||
|
||||
## Previews/Screenshots
|
||||
|
||||
[rich-preview1.webm](https://github.com/user-attachments/assets/580e36a8-249f-48a8-95fc-8c3d60e6a7d7)
|
||||
|
||||
## Requirements
|
||||
|
||||
- [Yazi](https://github.com/sxyazi/yazi) v25.4.8 or higher.
|
||||
- [rich-cli](https://github.com/Textualize/rich-cli) v13.7.1 or higher.
|
||||
|
||||
## Installation
|
||||
|
||||
To install this plugin, simply run-
|
||||
|
||||
```bash
|
||||
ya pkg add AnirudhG07/rich-preview
|
||||
## For linux and MacOS
|
||||
git clone https://github.com/AnirudhG07/rich-preview.yazi.git ~/.config/yazi/plugins/rich-preview.yazi
|
||||
|
||||
## For Windows
|
||||
git clone https://github.com/AnirudhG07/rich-preview.yazi.git %AppData%\yazi\config\plugins\rich-preview.yazi
|
||||
```
|
||||
|
||||
## Usages
|
||||
|
||||
The `rich` commands automatically detects if the file is markdown, csv, json, etc. files and accordingly the preview is viewed.
|
||||
|
||||
Add the below to your `yazi.toml` file to allow the respective file to previewed using `rich`.
|
||||
|
||||
```toml
|
||||
[plugin]
|
||||
|
||||
prepend_previewers = [
|
||||
{ url = "*.csv", run = "rich-preview"}, # for csv files
|
||||
{ url = "*.md", run = "rich-preview" }, # for markdown (.md) files
|
||||
{ url = "*.rst", run = "rich-preview"}, # for restructured text (.rst) files
|
||||
{ url = "*.ipynb", run = "rich-preview"}, # for jupyter notebooks (.ipynb)
|
||||
{ url = "*.json", run = "rich-preview"}, # for json (.json) files
|
||||
# { url = "*.lang_type", run = "rich-preview"} # for particular language files eg. .py, .go., .lua, etc.
|
||||
]
|
||||
```
|
||||
|
||||
## Configurations
|
||||
|
||||
If you would like to use `rich` with more configurations, you can go to `init.lua` and edit the arguments in the code with your preferences. You can view the options using `rich --help`.
|
||||
|
||||
```lua
|
||||
-- init.lua
|
||||
"-j",
|
||||
"--left",
|
||||
"--line-numbers",
|
||||
"--force-terminal",
|
||||
"--panel=rounded",
|
||||
"--guides",
|
||||
"--max-width" -- to area of preview
|
||||
```
|
||||
|
||||
You can add more, remove and choose themes as you wish. You can set styles or Themes(as mentioned in `rich --help`) by `--theme=your_theme` and similarly for style.
|
||||
|
||||
## Notes
|
||||
|
||||
Currently the colors maynot be uniformly present, along with weird lines here and there. This is due to `"--force-terminal"` option. You can disable it if you find it annoying. Work is in progress to possibly fix the issue.
|
||||
|
||||
## Using piper.yazi
|
||||
|
||||
[piper.yazi](https://github.com/yazi-rs/plugins/tree/main/piper.yazi) 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.
|
||||
|
||||
To use `rich` with piper, you can add this in your `yazi.toml` file:
|
||||
|
||||
```toml
|
||||
[[plugin.prepend_previewers]]
|
||||
url = "*.md"
|
||||
run = 'piper -- rich -j --left --panel=rounded --guides --line-numbers --force-terminal "$1"'
|
||||
```
|
||||
|
||||
Note you can also add other filetypes as mentioned above in the same format.
|
||||
|
||||
# Explore Yazi
|
||||
|
||||
Yazi is an amazing, blazing fast terminal file manager, with a variety of plugins, flavors and themes. Check them out at [awesome-yazi](https://github.com/AnirudhG07/awesome-yazi) and the official [yazi webpage](https://yazi-rs.github.io/).
|
||||
@@ -0,0 +1,56 @@
|
||||
local M = {}
|
||||
|
||||
function M:peek(job)
|
||||
local child = Command("rich")
|
||||
:arg({
|
||||
"-j",
|
||||
"--left",
|
||||
"--line-numbers",
|
||||
"--force-terminal",
|
||||
"--panel=rounded",
|
||||
"--guides",
|
||||
"--max-width",
|
||||
tostring(job.area.w),
|
||||
tostring(job.file.url),
|
||||
})
|
||||
:stdout(Command.PIPED)
|
||||
:stderr(Command.PIPED)
|
||||
:spawn()
|
||||
|
||||
if not child then
|
||||
return require("code"):peek(job)
|
||||
end
|
||||
|
||||
local limit = job.area.h
|
||||
local i, lines = 0, ""
|
||||
repeat
|
||||
local next, event = child:read_line()
|
||||
if event == 1 then
|
||||
return require("code"):peek(job)
|
||||
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.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_widget(
|
||||
job,
|
||||
ui.Text.parse(lines):area(job.area):wrap(rt.preview.wrap == "yes" and ui.Wrap.YES or ui.Wrap.NO)
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
function M:seek(job)
|
||||
require("code"):seek(job)
|
||||
end
|
||||
|
||||
return M
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2023 yazi-rs
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,56 @@
|
||||
# rsync.yazi
|
||||
|
||||
A [yazi](https://yazi-rs.github.io/) plugin for simple rsync copying locally and up to remote servers.
|
||||
|
||||
|
||||
Thanks to [chrissabug](https://x.com/chrissabug) for creating lovely art!
|
||||
|
||||
## Pre-reqs
|
||||
|
||||
1. yazi 3.0+
|
||||
2. rsync
|
||||
3. passwordless authentication if copying to a remote server
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
ya pkg add GianniBYoung/rsync
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Add the binds to your `~/.config/yazi/keymap.toml`
|
||||
|
||||
**WARNING:** Make sure the chosen binding isn't already in use!!
|
||||
|
||||
```toml
|
||||
[[mgr.prepend_keymap]]
|
||||
on = [ "R" ]
|
||||
run = "plugin rsync"
|
||||
desc = "Copy files using rsync"
|
||||
```
|
||||
|
||||
### Specify Default Remote Server
|
||||
|
||||
```toml
|
||||
[[mgr.prepend_keymap]]
|
||||
on = [ "R" ]
|
||||
run = "plugin rsync 'user@server.com'"
|
||||
desc = "Copy files using rsync to default location"
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Basic logging information is sent to `~/.local/state/yazi/yazi.log`
|
||||
|
||||
*Note: This plugin has only been tested on linux
|
||||
|
||||
## Contributing
|
||||
|
||||
Run into a bug or want a certain feature added? Submit an issue!
|
||||
|
||||
PRs welcome :)
|
||||
|
||||
Please keep in mind the yazi plugin system is still very new - as more features are added
|
||||
|
||||
more possibilities will open up for this plugin!
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 9.1 MiB |
Binary file not shown.
@@ -0,0 +1,117 @@
|
||||
-- function borrowed from chmod.yazi plugin
|
||||
local selected_or_hovered = ya.sync(function()
|
||||
local tab = cx.active
|
||||
local paths = {}
|
||||
|
||||
-- count up selected files
|
||||
for _, url in pairs(tab.selected) do
|
||||
paths[#paths + 1] = tostring(url)
|
||||
end
|
||||
|
||||
-- if no files are selected use the hovered file
|
||||
-- a tab has folders which have files which have urls
|
||||
if #paths == 0 and tab.current.hovered then
|
||||
-- lua so we are 1 indexed
|
||||
paths[1] = tostring(tab.current.hovered.url)
|
||||
end
|
||||
return paths
|
||||
end)
|
||||
|
||||
-- Helper function to expand tilde (~) in a path
|
||||
local function expand_tilde(path)
|
||||
if not path then
|
||||
return nil
|
||||
end
|
||||
|
||||
if path:sub(1, 1) == "~" then
|
||||
local home = os.getenv("HOME") -- Get HOME environment variable
|
||||
if not home then
|
||||
-- Fallback for Windows-specific environment variables
|
||||
home = os.getenv("USERPROFILE") -- Primary user profile directory on Windows
|
||||
end
|
||||
if home then
|
||||
return home .. path:sub(2) -- Concatenate home path with the rest of the path
|
||||
else
|
||||
-- Fallback if HOME is not set
|
||||
ya.notify({
|
||||
title = "Rsync Plugin",
|
||||
content = "Could not expand '~': HOME environment variable not set.",
|
||||
level = "warn",
|
||||
timeout = 5,
|
||||
})
|
||||
return path -- Return original path if home cannot be determined
|
||||
end
|
||||
end
|
||||
return path -- Return original path if no tilde
|
||||
end
|
||||
|
||||
return {
|
||||
entry = function(_, job)
|
||||
ya.mgr_emit("escape", { visual = true })
|
||||
local remote_target = job.args and #job.args >= 1 and job.args[1] or nil
|
||||
|
||||
local files = selected_or_hovered()
|
||||
if #files == 0 then
|
||||
return ya.notify({ title = "Rsync", content = "No files selected", level = "warn", timeout = 3 })
|
||||
end
|
||||
|
||||
local default_dest = ""
|
||||
if #files == 1 and remote_target ~= nil then
|
||||
local base_name = files[1]:match("([^/]+)$")
|
||||
default_dest = remote_target .. ":" .. base_name
|
||||
ya.err({ default_dest = default_dest })
|
||||
end
|
||||
|
||||
local dest, ok = ya.input({
|
||||
title = "Rsync - [user]@[remote]:<destination>",
|
||||
value = default_dest or nil,
|
||||
pos = { "top-center", y = 3, w = 45 },
|
||||
})
|
||||
if ok ~= 1 then
|
||||
return
|
||||
end
|
||||
|
||||
-- Only expand tilde if it's a local path (doesn't contain ':')
|
||||
if not dest:match(":") then
|
||||
dest = expand_tilde(dest)
|
||||
if not dest then
|
||||
return
|
||||
end -- If expand_tilde failed and returned nil
|
||||
end
|
||||
|
||||
-- local cmd, err = Command("rsync"):args(files):arg(dest):stderr(Command.PIPED):output()
|
||||
local cmd, err = Command("rsync")
|
||||
:arg({ "-ahP", "--no-motd" })
|
||||
:arg(files)
|
||||
:arg(dest)
|
||||
:stdout(Command.PIPED)
|
||||
:stderr(Command.PIPED)
|
||||
:output()
|
||||
local stderr = cmd.stderr
|
||||
local stdout = cmd.stdout
|
||||
local return_code = cmd.status.code
|
||||
ya.err({
|
||||
stderr = stderr,
|
||||
stdout = stdout,
|
||||
err = err,
|
||||
res = cmd.status.success,
|
||||
return_code = return_code,
|
||||
default_dest = default_dest,
|
||||
})
|
||||
|
||||
if return_code ~= 0 then
|
||||
ya.notify({
|
||||
title = "Rsync Plugin",
|
||||
content = string.format("stderr below, exit code %s\n\n%s", cmd.status.code, stderr),
|
||||
level = "error",
|
||||
timeout = 10,
|
||||
})
|
||||
else
|
||||
ya.notify({
|
||||
title = "Rsync Plugin",
|
||||
content = "Rsync Completed!",
|
||||
timeout = 3,
|
||||
})
|
||||
end
|
||||
end,
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
Copyright (c) 2025 boydaihungst
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,424 @@
|
||||
# simple-tag
|
||||
|
||||
<!--toc:start-->
|
||||
|
||||
- [simple-tag](#simple-tag)
|
||||
- [Overview](#overview)
|
||||
- [Features](#features)
|
||||
- [Requirements](#requirements)
|
||||
- [Installation](#installation)
|
||||
- [Previews](#previews)
|
||||
- [Configuration](#configuration)
|
||||
- [Add setup function in `yazi/init.lua`.](#add-setup-function-in-yaziinitlua)
|
||||
- [Fetcher Configuration in `yazi.toml`](#fetcher-configuration-in-yazitoml)
|
||||
- [Keybindings in `keymap.toml`](#keybindings-in-keymaptoml)
|
||||
- [Customizing the Theme for tag hints window](#customizing-the-theme-for-tag-hints-window)
|
||||
- [For Developers](#for-developers)
|
||||
<!--toc:end-->
|
||||
|
||||
## Overview
|
||||
|
||||
simple-tag is a Yazi plugin that allows you to add tags to files and folders. Each tag is associated with a unique key.
|
||||
|
||||
> Disclaimer: This is not mactag and does not utilize mactag.
|
||||
|
||||
## Features
|
||||
|
||||
- Toggle, Add, Remove, Replace, Clear, Edit Tag(s). Supported input multiple tags.
|
||||
- Filter Files/Folders by Tag(s).
|
||||
- Visual Selection files/folders by Tag(s) (Replace, Unite, Subtract, Intersect, Exclude). Undo/Redo visual selection.
|
||||
- Change Tag Icon/Text/Hidden Indicator.
|
||||
- Tag Hints, will show up whenever you need to input or select tag(s).
|
||||
- Automatically transfer tags after moving/renaming/bulk-renaming files/folders.
|
||||
- Automatically clear tags when files/folders are deleted or trashed.
|
||||
|
||||
## Requirements
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Minimum supported version: Yazi v25.5.31.
|
||||
|
||||
- [Yazi](https://github.com/sxyazi/yazi)
|
||||
- Tested on Linux and Windows
|
||||
|
||||
## Installation
|
||||
|
||||
Install the plugin:
|
||||
|
||||
```sh
|
||||
ya pkg add boydaihungst/simple-tag
|
||||
```
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Tags are automatically cleared when files/folders are deleted or moved to trash within Yazi.
|
||||
> However, if deleted outside Yazi and then recreated, their tags will be restored.
|
||||
> It also apply with renaming and moving files/folders.
|
||||
|
||||
## Previews
|
||||
|
||||
- Tag Hints, will show up whenever you need to input or select tag(s).
|
||||
Only custom Icons or colors are shown.
|
||||
|
||||
|
||||
|
||||
- Tag Icon/Text/Hidden Indicator:
|
||||
|
||||
|
||||
|
||||
- Toggle Tag(s):
|
||||
|
||||
|
||||
|
||||
- Add, Remove, Replace, Edit Tag(s):
|
||||
|
||||
|
||||
|
||||
- Filter Files by Tag(s) and Modes:
|
||||
In all of examples below, I didn't use fixed tag keys with `--keys`/`--key`/`--tag`/`--tags`
|
||||
- Mode = and (Default), match all of the selected tags:
|
||||
|
||||
|
||||
|
||||
- Mode = or, match at least one of the selected tags:
|
||||
|
||||
|
||||
|
||||
- Visual Selection Modes:
|
||||
In all of examples below, I didn't use fixed tag keys with `--keys`/`--key`/`--tag`/`--tags`
|
||||
|
||||
|
||||
- Replace selection:
|
||||
|
||||
|
||||
|
||||
- Unite selection:
|
||||
|
||||
|
||||
|
||||
- Subtract selection:
|
||||
|
||||
|
||||
|
||||
- Intersect selection:
|
||||
|
||||
|
||||
|
||||
- Exclude selection:
|
||||
|
||||
|
||||
|
||||
- Undo selection:
|
||||
|
||||
|
||||
|
||||
## Configuration
|
||||
|
||||
### Add setup function in `yazi/init.lua`.
|
||||
|
||||
The setup function is required, while preferences are optional.
|
||||
|
||||
```lua
|
||||
require("simple-tag"):setup({
|
||||
-- UI display mode (icon, text, hidden)
|
||||
ui_mode = "icon", -- (Optional)
|
||||
|
||||
-- Disable tag key hints (popup in bottom right corner)
|
||||
hints_disabled = false, -- (Optional)
|
||||
|
||||
-- linemode order: adjusts icon/text position. For example, if you want icon to be on the most left of linemode then set linemode_order larger than 1000.
|
||||
-- More info: https://github.com/sxyazi/yazi/blob/077faacc9a84bb5a06c5a8185a71405b0cb3dc8a/yazi-plugin/preset/components/linemode.lua#L4-L5
|
||||
linemode_order = 500, -- (Optional)
|
||||
|
||||
-- You can backup/restore this folder within the same OS (Linux, windows, or MacOS).
|
||||
-- But you can't restore backed up folder in the different OS because they use difference absolute path.
|
||||
-- save_path = -- full path to save tags folder (Optional)
|
||||
-- - Linux/MacOS: os.getenv("HOME") .. "/.config/yazi/tags"
|
||||
-- - Windows: os.getenv("APPDATA") .. "\\yazi\\config\\tags"
|
||||
|
||||
-- Set tag colors
|
||||
colors = { -- (Optional)
|
||||
-- Set this same value with `theme.toml` > [mgr] > hovered > reversed
|
||||
-- Default theme use "reversed = true".
|
||||
-- More info: https://github.com/sxyazi/yazi/blob/077faacc9a84bb5a06c5a8185a71405b0cb3dc8a/yazi-config/preset/theme-dark.toml#L25
|
||||
reversed = true, -- (Optional)
|
||||
|
||||
-- More colors: https://yazi-rs.github.io/docs/configuration/theme#types.color
|
||||
-- format: [tag key] = "color"
|
||||
["*"] = "#bf68d9", -- (Optional)
|
||||
["$"] = "green",
|
||||
["!"] = "#cc9057",
|
||||
["1"] = "cyan",
|
||||
["p"] = "red",
|
||||
},
|
||||
|
||||
-- Set tag icons. Only show when ui_mode = "icon".
|
||||
-- Any text or nerdfont icons should work as long as you use nerdfont to render yazi.
|
||||
-- Default icon from mactag.yazi: ●; Some generic icons: , ,
|
||||
-- More icon from nerd fonts: https://www.nerdfonts.com/cheat-sheet
|
||||
icons = { -- (Optional)
|
||||
-- default icon
|
||||
default = "",
|
||||
|
||||
-- format: [tag key] = "tag icon"
|
||||
["*"] = "*",
|
||||
["$"] = "",
|
||||
["!"] = "",
|
||||
["p"] = "",
|
||||
},
|
||||
|
||||
})
|
||||
```
|
||||
|
||||
### Fetcher Configuration in `yazi.toml`
|
||||
|
||||
Use one of the following methods:
|
||||
|
||||
> [!IMPORTANT]
|
||||
>
|
||||
> For yazi before v25.12.29 replace `url` with `name`
|
||||
|
||||
```toml
|
||||
[plugin]
|
||||
|
||||
fetchers = [
|
||||
{ id = "simple-tag", url = "*", run = "simple-tag" },
|
||||
{ id = "simple-tag", url = "*/", run = "simple-tag" },
|
||||
]
|
||||
# or
|
||||
prepend_fetchers = [
|
||||
{ id = "simple-tag", url = "*", run = "simple-tag" },
|
||||
{ id = "simple-tag", url = "*/", run = "simple-tag" },
|
||||
]
|
||||
# or
|
||||
append_fetchers = [
|
||||
{ id = "simple-tag", url = "*", run = "simple-tag" },
|
||||
{ id = "simple-tag", url = "*/", run = "simple-tag" },
|
||||
]
|
||||
```
|
||||
|
||||
### Keybindings in `keymap.toml`
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Ensure there are no conflicts with [default Keybindings](https://github.com/sxyazi/yazi/blob/main/yazi-config/preset/keymap-default.toml).
|
||||
|
||||
Since Yazi prioritizes the first matching key, `prepend_keymap` takes precedence over defaults.
|
||||
Or you can use `keymap` to replace all other keys
|
||||
|
||||
```toml
|
||||
[mgr]
|
||||
prepend_keymap = [
|
||||
# Tagging plugin
|
||||
|
||||
#─────────────────────────── TOGGLE TAG(S) ────────────────────────────
|
||||
# Toggle a tag (press any tag key)
|
||||
# A tag hint window will show up.
|
||||
# Simply press any tag key to toggle that tag for selected or hovered files/folders.
|
||||
{ on = [ "t", "t", "k" ], run = "plugin simple-tag -- toggle-tag", desc = "Toggle a tag (press any key)" },
|
||||
|
||||
# Fast Toggle tag(s) with fixed keys=!1q. key=!1q tag=!1q or tags=!1q also work
|
||||
# NOTE: For key=" (Quotation mark), then use key=\" (Backslash + Quotation mark) instead.
|
||||
{ on = [ "`" ], run = "plugin simple-tag -- toggle-tag --keys=!1q", desc = "Toggle tag(s) with fixed tag key(s) = (! and 1 and q)" },
|
||||
{ on = [ "`" ], run = "plugin simple-tag -- toggle-tag --keys=*", desc = "Toggle tag with fixed tag key = *" },
|
||||
{ on = [ "`" ], run = "plugin simple-tag -- toggle-tag --key=*", desc = "Toggle tag with fixed tag key = *" },
|
||||
|
||||
# Toggle tag(s) with value from input box.
|
||||
# A tag hint window and an input box will show up.
|
||||
# Simply input tag key(s) to toggle that tags for selected or hovered files/folders.
|
||||
# Do not input any delimiter.
|
||||
{ on = [ "t", "t", "i" ], run = "plugin simple-tag -- toggle-tag --input", desc = "Toggle tag(s) with value from (input box)" },
|
||||
|
||||
|
||||
#─────────────────────────── ADD TAG(S) ───────────────────────────────
|
||||
# Add a tag (press any tag key)
|
||||
# A tag hint window will show up.
|
||||
# Simply press any new tag key to add to selected or hovered files/folders.
|
||||
{ on = [ "t", "a", "k" ], run = "plugin simple-tag -- add-tag", desc = "Add a tag (press any key)" },
|
||||
|
||||
# Fast Add tag(s) with fixed keys=!1q. key=!1q tag=!1q or tags=!1q also work
|
||||
{ on = [ "t", "a", "f" ], run = "plugin simple-tag -- add-tag --keys=!1q", desc = "Add tag(s) with fixed tag keys = (! and 1 and q)" },
|
||||
{ on = [ "t", "a", "f" ], run = "plugin simple-tag -- add-tag --keys=*", desc = "Add tag with fixed tag key = *" },
|
||||
{ on = [ "t", "a", "f" ], run = "plugin simple-tag -- add-tag --key=*", desc = "Add tag with fixed tag key = *" },
|
||||
|
||||
# Add tag(s) with value from input box.
|
||||
# A tag hint window and an input box will show up.
|
||||
# Simply input new tag key(s) to add to selected or hovered files/folders.
|
||||
# Do not input any delimiter.
|
||||
{ on = [ "t", "a", "i" ], run = "plugin simple-tag -- add-tag --input", desc = "Add tag(s) with value from (input box)" },
|
||||
|
||||
|
||||
#─────────────────────────── REMOVE/DELETE TAG(S) ───────────────────────────
|
||||
# Remove a tag (press any tag key)
|
||||
# A tag hint window will show up.
|
||||
# Simply press any tag key to be removed from selected or hovered files/folders.
|
||||
{ on = [ "t", "d", "k" ], run = "plugin simple-tag -- remove-tag", desc = "Remove a tag (press any key)" },
|
||||
|
||||
# Fast Remove tag(s) with fixed keys=!1q. key=!1q tag=!1q or tags=!1q also work
|
||||
{ on = [ "t", "d", "f" ], run = "plugin simple-tag -- remove-tag --keys=!1q", desc = "Remove tag(s) with fixed tag keys = (! and 1 and q)" },
|
||||
{ on = [ "t", "d", "f" ], run = "plugin simple-tag -- remove-tag --keys=*", desc = "Remove tag with fixed tag key = *" },
|
||||
{ on = [ "t", "d", "f" ], run = "plugin simple-tag -- remove-tag --key=*", desc = "Remove tag with fixed tag key = *" },
|
||||
|
||||
# Remove tag(s) with value from input box.
|
||||
# A tag hint window and an input box will show up.
|
||||
# Simply input tag key(s) to be removed from selected or hovered files/folders.
|
||||
# Do not input any delimiter.
|
||||
{ on = [ "t", "d", "i" ], run = "plugin simple-tag -- remove-tag --input", desc = "Remove tag(s) with value from (input box)" },
|
||||
|
||||
|
||||
#─────────────────────────── REPLACE ALL OLD TAG(S) WITH NEW TAG(S) ───────────────────────────
|
||||
# Replace a tag (press any tag key)
|
||||
# A tag hint window will show up.
|
||||
# Simply press any new tag key for selected or hovered files/folders.
|
||||
{ on = [ "t", "r", "k" ], run = "plugin simple-tag -- replace-tag", desc = "Replace with a new tag (press any key)" },
|
||||
|
||||
# Fast Replace tag(s) with fixed keys=!1q. key=!1q tag=!1q or tags=!1q also work
|
||||
{ on = [ "t", "r", "f" ], run = "plugin simple-tag -- replace-tag --keys=!1q", desc = "Replace tag(s) with fixed tag keys = (! and 1 and q)" },
|
||||
{ on = [ "t", "r", "f" ], run = "plugin simple-tag -- replace-tag --keys=*", desc = "Replace tag(s) with fixed tag key = *" },
|
||||
{ on = [ "t", "r", "f" ], run = "plugin simple-tag -- replace-tag --key=*", desc = "Replace tag(s) with fixed tag key = *" },
|
||||
|
||||
# Replace tag(s) with value from input box.
|
||||
# A tag hint window and an input box will show up.
|
||||
# Simply input new tag key(s) for selected or hovered files/folders.
|
||||
# Do not input any delimiter.
|
||||
{ on = [ "t", "r", "i" ], run = "plugin simple-tag -- replace-tag --input", desc = "Replace tag(s) with value from (input box)" },
|
||||
|
||||
|
||||
#─────────────────────────── EDIT TAG(S) ───────────────────────────
|
||||
# Edit a tag for hovered or selected files/folders
|
||||
# An input box with current tagged keys and a tag hint window will show up for each hovered or selected files/folders.
|
||||
# Simply edit tag key(s) for selected or hovered files/folders.
|
||||
# If you cancel any input box, all changes will be discarded.
|
||||
{ on = [ "t", "e" ], run = "plugin simple-tag -- edit-tag ", desc = "Edit tag(s) (input box)" },
|
||||
|
||||
|
||||
# ───────────────────────────── CLEAR TAG(S) ─────────────────────────────
|
||||
# Clear all tags from selected or hovered files/folders
|
||||
{ on = [ "t", "c" ], run = "plugin simple-tag -- clear", desc = "Clear all tags from selected or hovered files" },
|
||||
|
||||
|
||||
# ───────────────────────────── CHANGE UI ─────────────────────────────
|
||||
# Switch tag indicator between icon > tag key > hidden.
|
||||
# Useful when u don't remember the tag key
|
||||
{ on = [ "t", "u", "s" ], run = "plugin simple-tag -- toggle-ui", desc = "Toggle tag indicator (icon > tag key > hidden)" },
|
||||
|
||||
# Fixed tag indicator mode = hidden (Available modes: hidden|icon|text)
|
||||
{ on = [ "t", "u", "h" ], run = "plugin simple-tag -- toggle-ui --mode=hidden", desc = "Hide all tags indicator" },
|
||||
|
||||
# ─────────────────────── FILTER FILES/FOLDERS BY TAGS: ───────────────────────
|
||||
# Available filter modes:
|
||||
# and → Filter files which contain all of selected tags (Default if mode isn't specified).
|
||||
# or → Filter files which contain at least one of selected tags.
|
||||
|
||||
# NOTE: Not available in vfs mode (Remote Virtual Filesystem)
|
||||
|
||||
# Filter files/folders by tags
|
||||
|
||||
# Filter files/folders by a tag (press any tag key)
|
||||
# A tag hint window will show up.
|
||||
# Simply press any new tag key to filter files/folders containing that tag in current directory.
|
||||
{ on = [ "t", "f" ], run = "plugin simple-tag -- filter", desc = "Filter files/folders by a tag (press any key)" },
|
||||
|
||||
# Fast Filter files/folders with fixed keys=!1q. key=!1q tag=!1q or tags=!1q also work
|
||||
# { on = [ "t", "f" ], run = "plugin simple-tag -- filter --key=!", desc = "Filter files/folders by a fixed tag = !" },
|
||||
# { on = [ "t", "f" ], run = "plugin simple-tag -- filter --keys=!1q", desc = "Filter files/folders by multiple fixed tag(s) (! and 1 and q)" },
|
||||
|
||||
# Filter files/folders by tag(s) with value from input box.
|
||||
# An input box and a tag hint window will show up.
|
||||
# Simply input tag key(s) to filter files/folders of current directory.
|
||||
# Do not input any delimiter.
|
||||
# For example: Input value or --keys=!1q -> filter any files/folders contain all of these tags (! and 1 and q) in current directory.
|
||||
{ on = [ "t", "F" ], run = "plugin simple-tag -- filter --input", desc = "Filter files/folders by tag(s) (input box)" },
|
||||
|
||||
# Filter files/folders by tag(s) with --mode=or.
|
||||
# --mode=or -> Input value or --keys = !1q -> filter any files/folders contain at least one of these tags (! or 1 or q)
|
||||
{ on = [ "t", "F" ], run = "plugin simple-tag -- filter --input --mode=or", desc = "Filter files/folders by contain tags (input box)" },
|
||||
# { on = [ "t", "F" ], run = "plugin simple-tag -- filter --keys=!1q --mode=or", desc = "Filter files/folders by multiple fixed tag(s) (! or 1 or q)" },
|
||||
|
||||
|
||||
# ─────────────────────── VISUAL SELECT FILES/FOLDERS BY TAGS: ───────────────────────
|
||||
|
||||
# Available selection actions:
|
||||
# replace → Replaces the current selection list with files/folders that have the selected tag.
|
||||
# unite → Combines the currently selected files/folders with those that have the selected tag.
|
||||
# intersect → Keeps only the files/folders that are present in both the current selection and the tagged items.
|
||||
# subtract → Deselects files/folders that have the selected tag from the current selection.
|
||||
# exclude → Combines the currently selected files/folders with the tagged items, then deselects any overlapping items between the current selection and the tagged items.
|
||||
# undo → Undos or redoes the last selection action.
|
||||
|
||||
# which_key will popup to choose selection mode
|
||||
# And a tag hint window will show up.
|
||||
# Simply select a selection mode then press any tag key to select files/folders
|
||||
{ on = [ "t", "s", "t" ], run = "plugin simple-tag -- toggle-select", desc = "Select a selection action then select a tag key (toggle-select)" },
|
||||
# fixed tag(s). --keys=!1q or --key=!1q or --tag=!1q or --tags=!1q. They are the same.
|
||||
{ on = [ "t", "s", "t" ], run = "plugin simple-tag -- toggle-select --keys=!1q", desc = "" },
|
||||
|
||||
# Run action on files/folders by a tag.
|
||||
# A tag hint window will show up.
|
||||
# Simply press any tag key to do the following action:
|
||||
{ on = [ "t", "s", "r" ], run = "plugin simple-tag -- replace-select", desc = "replace-select" },
|
||||
{ on = [ "t", "s", "u" ], run = "plugin simple-tag -- unite-select", desc = "unite-select" },
|
||||
{ on = [ "t", "s", "i" ], run = "plugin simple-tag -- intersect-select", desc = "intersect-select" },
|
||||
{ on = [ "t", "s", "s" ], run = "plugin simple-tag -- subtract-select", desc = "subtract-select" },
|
||||
{ on = [ "t", "s", "e" ], run = "plugin simple-tag -- exclude-select", desc = "exclude-select" },
|
||||
# Run action on files/folders by fixed tag(s). --keys=!1q or --key=!1q or --tag=!1q or --tags=!1q. They are the same.
|
||||
{ on = [ "t", "s", "e" ], run = "plugin simple-tag -- replace-select --keys=!1q", desc = "Replaces the current selection list with files/folders that have (! and 1 and q) tag(s)" },
|
||||
|
||||
# Run action on files/folders by tag(s) with value from input box.
|
||||
# A tag hint window will show up.
|
||||
# Simply input tag key(s) to do the following action:
|
||||
{ on = [ "t", "s", "R" ], run = "plugin simple-tag -- replace-select --input", desc = "replace-select --input" },
|
||||
{ on = [ "t", "s", "U" ], run = "plugin simple-tag -- unite-select --input", desc = "unite-select --input" },
|
||||
{ on = [ "t", "s", "I" ], run = "plugin simple-tag -- intersect-select --input", desc = "intersect-select --input" },
|
||||
{ on = [ "t", "s", "S" ], run = "plugin simple-tag -- subtract-select --input", desc = "subtract-select --input" },
|
||||
{ on = [ "t", "s", "E" ], run = "plugin simple-tag -- exclude-select --input", desc = "exclude-select --input" },
|
||||
# it also support --mode=or when using with --input or --keys=!1q or --key=!1q or --tag=!1q or --tags=!1q
|
||||
{ on = [ "t", "s", "R" ], run = "plugin simple-tag -- replace-select --input --mode=or", desc = "replace-select --input --mode=or" },
|
||||
{ on = [ "t", "s", "R" ], run = "plugin simple-tag -- replace-select --keys=!1q --mode=or", desc = "replace-select --keys=!1q --mode=or" },
|
||||
|
||||
# Undo/Redo selection (only works after using 5 modes above)
|
||||
{ on = [ "t", "s", "u" ], run = "plugin simple-tag -- undo-select", desc = "Undos/Redos the last selection action" },
|
||||
]
|
||||
```
|
||||
|
||||
### Customizing the Theme for tag hints window
|
||||
|
||||
To modify the tag hints window appearance, edit `.../yazi/theme.toml`:
|
||||
You can also use Flavors file instead.
|
||||
|
||||
```toml
|
||||
|
||||
[spot]
|
||||
border = { fg = "#4fa6ed" }
|
||||
title = { fg = "#4fa6ed" }
|
||||
```
|
||||
|
||||
## For Developers
|
||||
|
||||
You can trigger this plugin programmatically:
|
||||
|
||||
```lua
|
||||
-- In your plugin:
|
||||
local simple_tag = require("simple-tag")
|
||||
-- Available actions: toggle-tag, toggle-ui, clear, toggle-select, filter, add-tag, remove-tag, replace-tag, edit-tag
|
||||
local action = "toggle-select"
|
||||
local args = ya.quote(action)
|
||||
args = args .. " " .. ya.quote("--mode=unite")
|
||||
-- another arguments
|
||||
-- args = args .. " " .. ya.quote("--tag=q")
|
||||
ya.emit("plugin", {
|
||||
simple_tag._id,
|
||||
args,
|
||||
})
|
||||
|
||||
|
||||
-- Special action: "files-deleted" -> clear all tags from these files/folders
|
||||
local args = ya.quote("files-deleted")
|
||||
-- A array of string url
|
||||
local files_to_clear_tags = selected_or_hovered_files()
|
||||
for _, url in ipairs(files_to_clear_tags) do
|
||||
args = args .. " " .. ya.quote(url)
|
||||
end
|
||||
ya.emit("plugin", {
|
||||
simple_tag._id,
|
||||
args,
|
||||
})
|
||||
|
||||
```
|
||||
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2023 yazi-rs
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,40 @@
|
||||
# smart-enter.yazi
|
||||
|
||||
[`Open`][open] files or [`enter`][enter] directories all in one key!
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
ya pkg add yazi-rs/plugins:smart-enter
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Bind your <kbd>l</kbd> key to the plugin, in your `~/.config/yazi/keymap.toml`:
|
||||
|
||||
```toml
|
||||
[[mgr.prepend_keymap]]
|
||||
on = "l"
|
||||
run = "plugin smart-enter"
|
||||
desc = "Enter the child directory, or open the file"
|
||||
```
|
||||
|
||||
## Advanced
|
||||
|
||||
By default, `--hovered` is passed to the [`open`][open] command, make the behavior consistent with [`enter`][enter] avoiding accidental triggers,
|
||||
which means both will only target the currently hovered file.
|
||||
|
||||
If you still want `open` to target multiple selected files, add this to your `~/.config/yazi/init.lua`:
|
||||
|
||||
```lua
|
||||
require("smart-enter"):setup {
|
||||
open_multi = true,
|
||||
}
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
This plugin is MIT-licensed. For more information check the [LICENSE](LICENSE) file.
|
||||
|
||||
[open]: https://yazi-rs.github.io/docs/configuration/keymap/#mgr.open
|
||||
[enter]: https://yazi-rs.github.io/docs/configuration/keymap/#mgr.enter
|
||||
@@ -0,0 +1,11 @@
|
||||
--- @since 25.5.31
|
||||
--- @sync entry
|
||||
|
||||
local function setup(self, opts) self.open_multi = opts.open_multi end
|
||||
|
||||
local function entry(self)
|
||||
local h = cx.active.current.hovered
|
||||
ya.emit(h and h.cha.is_dir and "enter" or "open", { hovered = not self.open_multi })
|
||||
end
|
||||
|
||||
return { entry = entry, setup = setup }
|
||||
@@ -0,0 +1 @@
|
||||
../LICENSE
|
||||
@@ -0,0 +1,28 @@
|
||||
# smart-paste.yazi
|
||||
|
||||
Paste files into the hovered directory or to the CWD if hovering over a file.
|
||||
|
||||
https://github.com/user-attachments/assets/b3f6348e-abbe-42fe-9a67-a96e68f11255
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
ya pkg add yazi-rs/plugins:smart-paste
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Add this to your `~/.config/yazi/keymap.toml`:
|
||||
|
||||
```toml
|
||||
[[mgr.prepend_keymap]]
|
||||
on = "p"
|
||||
run = "plugin smart-paste"
|
||||
desc = "Paste into the hovered directory or CWD"
|
||||
```
|
||||
|
||||
Note that, the keybindings above are just examples, please tune them up as needed to ensure they don't conflict with your other commands/plugins.
|
||||
|
||||
## License
|
||||
|
||||
This plugin is MIT-licensed. For more information check the [LICENSE](LICENSE) file.
|
||||
@@ -0,0 +1,14 @@
|
||||
--- @since 25.5.31
|
||||
--- @sync entry
|
||||
return {
|
||||
entry = function()
|
||||
local h = cx.active.current.hovered
|
||||
if h and h.cha.is_dir then
|
||||
ya.emit("enter", {})
|
||||
ya.emit("paste", {})
|
||||
ya.emit("leave", {})
|
||||
else
|
||||
ya.emit("paste", {})
|
||||
end
|
||||
end,
|
||||
}
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2023 yazi-rs
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,80 @@
|
||||
# toggle-pane.yazi
|
||||
|
||||
Toggle the show, hide, and maximize states for different panes: parent, current, and preview. It respects the user's [`ratio` settings](https://yazi-rs.github.io/docs/configuration/yazi#mgr.ratio)!
|
||||
|
||||
Assume the user's `ratio` is $$[A, B, C]$$, that is, $$\text{parent}=A, \text{current}=B, \text{preview}=C$$:
|
||||
|
||||
- `min-parent`: Toggles between $$0$$ and $$A$$ - the parent is either completely hidden or showed with width $$A$$.
|
||||
- `max-parent`: Toggles between $$A$$ and $$\infty$$ - the parent is either showed with width $$A$$ or fills the entire screen.
|
||||
- `min-current`: Toggles between $$0$$ and $$B$$ - the current is either completely hidden or showed with width $$B$$.
|
||||
- `max-current`: Toggles between $$B$$ and $$\infty$$ - the current is either showed with width $$B$$ or fills the entire screen.
|
||||
- `min-preview`: Toggles between $$0$$ and $$C$$ - the preview is either completely hidden or showed with width $$C$$.
|
||||
- `max-preview`: Toggles between $$C$$ and $$\infty$$ - the preview is either showed with width $$C$$ or fills the entire screen.
|
||||
- `reset`: Resets to the user's configured `ratio`.
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
ya pkg add yazi-rs/plugins:toggle-pane
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Hide/Show preview:
|
||||
|
||||
```toml
|
||||
# keymap.toml
|
||||
[[mgr.prepend_keymap]]
|
||||
on = "T"
|
||||
run = "plugin toggle-pane min-preview"
|
||||
desc = "Show or hide the preview pane"
|
||||
```
|
||||
|
||||
Maximize/Restore preview:
|
||||
|
||||
```toml
|
||||
# keymap.toml
|
||||
[[mgr.prepend_keymap]]
|
||||
on = "T"
|
||||
run = "plugin toggle-pane max-preview"
|
||||
desc = "Maximize or restore the preview pane"
|
||||
```
|
||||
|
||||
You can replace `preview` with `current` or `parent` to toggle the other panes.
|
||||
|
||||
Note that, the keybindings above are just examples, please tune them up as needed to ensure they don't conflict with your other commands/plugins.
|
||||
|
||||
## Advanced
|
||||
|
||||
In addition to triggering the plugin with a keypress, you can also trigger it in your `init.lua` file:
|
||||
|
||||
```lua
|
||||
if os.getenv("NVIM") then
|
||||
require("toggle-pane"):entry("min-preview")
|
||||
end
|
||||
```
|
||||
|
||||
In the example above, when it detects that you're [using Yazi in nvim](https://yazi-rs.github.io/docs/resources#vim), the preview is hidden by default — you can always press `T` (or any key you've bound) to show it again.
|
||||
|
||||
## Tips
|
||||
|
||||
This plugin only maximizes the "available preview area", without actually changing the content size.
|
||||
|
||||
This means that the appearance of your preview largely depends on the previewer you are using.
|
||||
However, most previewers tend to make the most of the available space, so this usually isn't an issue.
|
||||
|
||||
For image previews, you may want to tune up the [`max_width`][max-width] and [`max_height`][max-height] options in your `yazi.toml`:
|
||||
|
||||
```toml
|
||||
[preview]
|
||||
# Change them to your desired values
|
||||
max_width = 1000
|
||||
max_height = 1000
|
||||
```
|
||||
|
||||
[max-width]: https://yazi-rs.github.io/docs/configuration/yazi/#preview.max_width
|
||||
[max-height]: https://yazi-rs.github.io/docs/configuration/yazi/#preview.max_height
|
||||
|
||||
## License
|
||||
|
||||
This plugin is MIT-licensed. For more information, check the [LICENSE](LICENSE) file.
|
||||
Loaded 100 of 226 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user