Refactoring codebase

[kevinhwang91]

It sounds harsh, but I like the idea of this plugin. If you don't mind, I will make a PR with help.

[danymat]

No, the code is a little bit messy lol (I did not have a good understanding of Lua at the time)
I think the code that is messy is really inside the granulator and generator, so maybe we could start from there.
I'm currently improving the templates part, and providing some docs and API for it.

Feel free to open a PR, and let me know what do you plan to refactor ;)
Thanks for your contribution !

[kevinhwang91]

I'm looking cursor.lua, just using a singleton table for the positions is enough. Using extmarks is overkilled, less stable, and has more side-effects for Neovim.

[danymat]

Sure, thanks for your contribution ! 💯

[kevinhwang91]

Are you using extmarks because you want to support inserting a new line for the comments? If yes, I think must use extmarks or marks, but extmarks are better than the limited marks.

[danymat]

What do you mean exactly ?

[kevinhwang91]

Once the template is generated, the positions are computed that are immutable, but the position of extmarks are mutable.

:h extmarks

Extended marks (extmarks) represent buffer annotations that track text changes
in the buffer. They can represent cursors, folds, misspelled words, anything
that needs to track a logical location in the buffer over time.

[danymat]

Oh yeah, I use extmarks because we can jump between annotation types even after we create some annotation and modify the lines

[kevinhwang91]

Thanks, I will deep into the codebase and refactor it later, maybe tomorrow or the day after tomorrow.

[danymat]

No problem, take your time, feel free to ping me if you need anything

[kevinhwang91]

Why

neogen/lua/neogen/generators/default.lua

Line 96 in 271260c

elseif type(template) == "function" then

may be a function type? I can't find and grep any information about this.

[danymat]

Why

neogen/lua/neogen/generators/default.lua

Line 96 in 271260c

elseif type(template) == "function" then

may be a function type? I can't find and grep any information about this.

Yes, during initial development it was assumed we could pass templates as functions, but I guess we'll not use them anymore. Even the granulator and generator, I'm not really found of creating your own.
Maybe we could simplify the process by making granulator and generator a default one, and only make templates and locators modifiable.
Because right now, the generator is used everywhere and with some special options..

[kevinhwang91]

Why

neogen/lua/neogen/generators/default.lua

Line 96 in 271260c

elseif type(template) == "function" then

may be a function type? I can't find and grep any information about this.

Yes, during initial development it was assumed we could pass templates as functions, but I guess we'll not use them anymore. Even the granulator and generator, I'm not really found of creating your own. Maybe we could simplify the process by making granulator and generator a default one, and only make templates and locators modifiable. Because right now, the generator is used everywhere and with some special options..

Thanks, refactor is going to be done, WIP in my local repo.

Maybe we could simplify the process by making granulator and generator a default one, and only make templates and locators modifiable.

I'm doing this idea, but I have no idea how to write the doc and tell the users what's the change is breaking.

[danymat]

I'm doing this idea, but I have no idea how to write the doc and tell the users what's the change is breaking.

No worries, I will update the docs in your pr before merging