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

plugins/null-ls: migrate null-ls to none-ls #641

Merged
merged 1 commit into from
Oct 21, 2023

Conversation

siph
Copy link
Contributor

@siph siph commented Oct 13, 2023

null-ls was archived some time ago and none-ls is a fork and a drop-in replacement.

none-ls is packaged but not merged onto unstable yet (https://nixpk.gs/pr-tracker.html?pr=258774), so I am marking this as a draft.

This pr just replaces the default package with none-ls. I don't think this requires any deprecations or warnings because it doesn't make any breaking changes, plus the package is still configurable. From the none-ls readme:

Only the repo name is changed for compatibility concerns.
All the API and future changes will keep in place as-is.

FWIW, LazyVim has also migrated to none-ls: LazyVim/LazyVim#1517

@GaetanLepage
Copy link
Member

GaetanLepage commented Oct 13, 2023

Good idea !
I would also rename the plugin in nixvim to none-ls.

  • Rename the file (and change plugins/default.nix accordingly), and the test file as well
  • Add a rename warning in none-ls.nix:
imports = [
  (
    mkRenamedOptionModule
    ["plugins" "null-ls"]
    ["plugins" "none-ls"]
  )
];

@GaetanLepage GaetanLepage self-requested a review October 13, 2023 22:00
@GaetanLepage GaetanLepage self-assigned this Oct 13, 2023
@siph siph changed the title plugins/null-ls: none-ls-nvim as default package plugins/null-ls: migrate null-ls to none-ls Oct 21, 2023
Copy link
Member

@GaetanLepage GaetanLepage left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM !
Thank you for doing that :)

@GaetanLepage GaetanLepage marked this pull request as ready for review October 21, 2023 22:46
@GaetanLepage
Copy link
Member

@siph This PR was marked as a draft. Do you agree to merge it now ?

@siph
Copy link
Contributor Author

siph commented Oct 21, 2023

I think this is ready. I left the config documentation as-is because none-ls still refers to itself as null-ls in its docs.

@GaetanLepage GaetanLepage merged commit 56f4616 into nix-community:main Oct 21, 2023
1 check passed
@siph siph deleted the none-ls branch October 21, 2023 22:51
@GaetanLepage
Copy link
Member

Shouldn't this be none-ls @siph ?

finalString = ''require("null-ls").builtins.${withArgs}'';

There are also still some occurences of null-ls in the option descriptions and tests.

@traxys
Copy link
Member

traxys commented Nov 1, 2023

It think not according to

Only the repo name is changed for compatibility concerns.
All the API and future changes will keep in place as-is.

From the PR request. Maybe they changed that stance, but that's another problem.

@siph
Copy link
Contributor Author

siph commented Nov 1, 2023

It's kind of weird. none-ls is basically just the repo name. The plugin is still named null-ls internally. For example, running :h null-ls still works and all the documentation (and the APIs) still refer to null-ls, with only a small section about migrating to none-ls.

That's why this PR originally only changed the default package and nothing else. When you asked me to rename to none-ls I left the documentation unchanged because it's basically unchanged in none-ls.

@GaetanLepage
Copy link
Member

Ok, makes sense. Thank you for those explanations !

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.

3 participants