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

question: status of the dev branch #60

Open
WieeRd opened this issue Oct 17, 2024 · 8 comments
Open

question: status of the dev branch #60

WieeRd opened this issue Oct 17, 2024 · 8 comments

Comments

@WieeRd
Copy link

WieeRd commented Oct 17, 2024

I've noticed the dev branch going on and switched to test it - around 2 months ago. So far, it has worked flawlessly. The LspAttach based automatic setup really did make my config cleaner as well, compared to manual setup using on_attach().

Today I rechecked this repo and was surprised that it still hasn't been merged yet. Both the master and dev branch have been quite for a while, so I assume you are busy with other things.

Are there unresolved problems / unimplemented features in dev branch that's stopping it from being merged? Whatever it is, I am willing to help. I really appreciate this plugin - I needed that 'add to dictionary' support :)

@barreiroleo
Copy link
Owner

Hi hi!
The main blocker to doing the merge it's the feedback. Giving the nature of this plugin the last thing that I want is to release a breaking change with knock-ons. So, glad to hear dev branch is working without problems.
I think I can push a tagged version for master though.

@WieeRd
Copy link
Author

WieeRd commented Oct 24, 2024

Isn't current dev branch already quite backwards compatible? The ideal way to introduce breaking change is to

  1. Keep the legacy config fully functional for a while.
  2. Notice the user with deprecation warnings when the use of legacy features is detected.

And looks like you are already doing both:

-- Legacy support for server start. Deprecated soon.
if opts.server_start and opts.server_opts then
LtexExtra:CallLtexServer(opts.server_opts)
end

local deprecated_in_use = {}
if opts.server_start then
table.insert(deprecated_in_use, "server_start")
end
if opts.server_opts then
table.insert(deprecated_in_use, "server_opts")
end
for _, opt in pairs(deprecated_in_use) do
vim.notify(string.format("[LtexExtra] %s will be deprecatd soon. Please consider updating your settings." ..
" Raise an issue at github.com/barreiroleo/ltex_extra.nvim if you have any concerns.", opt),
vim.log.levels.WARN)
end

If you just tag the current master as v0.3 and dev as v1.0 after merging, I think it's good to go!

@WieeRd
Copy link
Author

WieeRd commented Oct 24, 2024

Perhaps it might be worthwhile to add a check / deprecation notice for the 2nd invocation of require("ltex_extra").setup(), since it strongly indicates that the setup is being called inside on_attach() as a legacy method of setting up this plugin, and being called every time a new markdown buffer is opened.

@barreiroleo
Copy link
Owner

Yeah, it's supposed to be backwards compatible as it is, but you know.. each nvim config is a different world.
I saw the PR, many thanks. I'll give it a try and then merge it as soon as posible. Busy days

@WieeRd
Copy link
Author

WieeRd commented Oct 30, 2024

These days, with other Neovim plugins making breaking changes like every other week, I appreciate your efforts to keep the code compatible and minimize the friction for the users. Wish you good luck with whatever irl stuffs you're working on :)

@89iuv
Copy link

89iuv commented Nov 29, 2024

I am on the dev branch and it works without a problem for me.
If there is anything i can do to help please let me know.

This plugin saved me a lot of time and headaches.

@WieeRd
Copy link
Author

WieeRd commented Jan 1, 2025

@barreiroleo Happy new year! Just a small reminder ping since 3 months have passed since.

@barreiroleo
Copy link
Owner

Hi all, happy holidays and happy new year!

Sorry for missing the thread, last part of the year was a bit crazy.
I will try to give the #61 a shot over the weekend, push a new tag for the current version and move on.

Ty for the reminder btw

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

No branches or pull requests

3 participants