Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Render images with image.nvim #115

Closed
wants to merge 19 commits into from

Conversation

benlubas
Copy link

@benlubas benlubas commented Sep 25, 2023

this will stay in draft state until todo items are done

The What

image.nvim is a NeoVim plugin that adds image support. This PR uses the plugin like a library to render image outputs.

This PR also incorporates some performance improvements that were proposed in #43, with a few bugs ironed out.

The Why

  1. Consistency. Before, we had our own image implementations. There was a kitty graphics image implementation, and an uberzug image implementation. I never used uberzug, but the kitty implementation was inconsistent at best, and buggy at worst for me. I've found image.nvim's implementation to be very solid, and the maintainer very interested in fixing bugs that I've brought up.

  2. Maintainability. Handling our own image rendering is far less maintainable than simply outsourcing the heavy lifting to another plugin.

  3. Image.nvim has sixel support on the road map. I'm not sure if/when that'll be, but we'll get it for free if it even happens.

Considerations

  • Image.nvim is very new, and subject to change. The API that we're using might change. Modern package managers can pin versions, so I'm not too concerned. But this is still something to watch out for.

  • I've just ripped out the old image backends, but it might be worth to keep them in with a deprecation notice for a month or so to let people migrate to image.nvim without everything breaking right away.

todo

@benlubas
Copy link
Author

benlubas commented Oct 5, 2023

I think I'm just going to close this PR out, and maintain a fork of this plugin under a different name.

I don't want to bother others with an excessive number of PRs, and I'd like to make many large and some breaking changes to improve the plugin. I think it's best to just work in my own repo.

@benlubas benlubas closed this Oct 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant