search

sxyazi / yazi

💥 Blazing fast terminal file manager written in Rust, based on async I/O.
https://yazi-rs.github.io
MIT License
16.33k stars 377 forks source link

Type annotations for Lua #657

Closed UtkarshVerma closed 8 months ago

UtkarshVerma commented 9 months ago

Is your feature request related to a problem? Please describe

When defining the configuration in Lua, I have to hop between my editor and the docs. Having type annotations for classes and functions in the code base would greatly help this.

For example, users can hover over the function or class and get up-to-date information about them through language servers like lua-language-server.

Will you be willing to contribute this feature?

Describe the solution you'd like

The Neovim ecosystem has already embraced the LuaCATS annotations and it would fit in this project as well.

Describe alternatives you've considered

No response

Additional context

No response

teto commented 9 months ago

if sxyazi agrees, would you be ready to contribute those annotations ? I find them quite powerful in the neovim ecosystem

sxyazi commented 8 months ago

I agree, this is a great improvement for plugin development experience, but I don't have enough time to maintain another set of type definitions besides documentation. I would be very grateful if someone is willing to help maintain them 🙏🏻

sxyazi commented 8 months ago

Closing as not in the plan

github-actions[bot] commented 7 months ago

I'm going to lock this issue because it has been closed for 30 days. ⏳ This helps our maintainers find and focus on the active issues. If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.