I'd like to add annotations for redis scripting into your organisation

[ochaton]

Hello!

I've noticed, that annotations for redis scripting are missing everywhere, and I want to add them into your organisation.
I won't have much time to maintain them properly, but I can go through redis public documentation and write extensive annotations for what already exists (good initial commit).

Should I first create repository in my home account and then you "fork" it to yours, so we won't pollute LLS-Addons? Or maybe you have any other idea?

[ochaton]

Please, take a look when you'll have time: https://github.com/ochaton/redis
if repository fits your guidelines I would be happy if you fork it and add to LLS-Addons (or I can PR the last part myself)

[carsakiller]

Hi, thanks for the interest in creating Redis documentation! I have a few thoughts 🙂.

Your addon bundles documentation for multiple projects (Redis, cjson, cmsgpack, LuaJIT's bit). The bit library for LuaJIT is actually already included in the language server and can be enabled by adding "bit": "enable" to runtime.builtin. I did notice though that your definitions have nice descriptions for things, which are currently lacking in the definitions included in the language server. It would be best if you could open a PR improving the descriptions for bit there instead!

There is also already a lua-cjson addon that can be depended on instead of included in this Redis addon.

As for cmsgpack, it would instead make more sense to split it out into its own addon and depend on it, rather than including it in this Redis one. This will cut down on the redundant definitions should someone have two addons that both depend on cmsgpack.

The addon manager unfortunately does not support automatic dependency resolution, but the new method for installing addons via LuaRocks, does! The plan is to transition to just using LuaRocks instead of LLS-Addons, so I'd recommend migrating to that instead.

Let me know if you have any questions!

[ochaton]

Thank you for your reply!

Well, the fun part is that redis provides own lua-cjson, cmsgpack and bit library. I'll definitely check that they are completely replaceable (as they ship their own libraries, it may cause some issues for lua scripters for Redis).

For the bit library, let me double check once again, and maybe for it I'll better create PR to lua-language-server directly, thus I can remove it from redis.

So, if everything goes well, and I remove annotations from ochaton/redis for json, bit and cmsgpack, will you ship what's left into LuaCATS?

[carsakiller]

Hmm, right, Redis' provided libraries may differ. If they are not just the standardly available versions, then I suppose they will just have to be included in the addon, otherwise, it would be great for use by others if they could be made their own addons.

Sure, once you are done, you can transfer ownership of the repo(s) (in the repo settings) to me, and I'll move it into LuaCATS 🙂.