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

Rename incorrectly named vim Dracula plugin #95371

Closed
wants to merge 1 commit into from

Conversation

nasadorian
Copy link

@nasadorian nasadorian commented Aug 13, 2020

The Dracula plugin for vim seems to be named vim due to the automation script and the structure of the repo dracula/vim. Updating the name of the package to not have a name collision with vim itself, and use the appropriate name for the plugin. https://github.com/dracula/vim/

Motivation for this change
Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

Copy link
Member

@prusnak prusnak left a comment

Choose a reason for hiding this comment

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

Use the following commit message:

vimPlugins.dracula: use the correct name for the package

The Dracula plugin for vim seems to be named `vim` due to the automation script. Updating the name of the package to not clash with `vim` itself, and use the appropriate name. https://github.com/dracula/vim/
@nasadorian
Copy link
Author

@prusnak amended the commit message.

@jonringer
Copy link
Contributor

I'm afraid this will be overwritten next time someone updates the package set... We would need to fix the name of the repo itself

@nasadorian
Copy link
Author

nasadorian commented Aug 15, 2020

@jonringer Another option would be to special-case the script to avoid using the key vim and defaulting to owner-repo. So in this case dracula-vim would be the resulting key. There might be other plugins out there that have this issue.

@jonringer
Copy link
Contributor

I think this could lead to some odd behavior, I would like to hear from some others that use vim

cc @timokau @colemickens @Mic92 @teto

@teto
Copy link
Member

teto commented Aug 15, 2020

we could change vim-plugin-names format to be able to specify the nix attribute name. This is how I addressed it for the lua ecosystem (see https://github.com/NixOS/nixpkgs/blob/master/maintainers/scripts/luarocks-packages.csv , haskell has a similar .yaml configuration).
It may sound overkill but I believe we will eventually get there to specify a maintainer or pin a version when the need arises (some plugins are more complex than others, aka coc.nvim/unicode.vim etc).

At some point, we might want to standardize such a configuration file across the different "language packages to nix derivation" ecosystems.

@jonringer
Copy link
Contributor

I think having a mechanism to do some of the renaming makes sense

@timokau
Copy link
Member

timokau commented Aug 20, 2020

That was already implemented by @gjabell a while ago in 8eb8fa1. You can just specify dracula/vim as dracula-vim in vim-plugin-names.

@jonringer
Copy link
Contributor

That was already implemented by @gjabell a while ago in 8eb8fa1. You can just specify dracula/vim as dracula-vim in vim-plugin-names.

good point, I totally forgot about that indirection

@nasadorian
Copy link
Author

@timokau @jonringer Does that mean I should just edit https://github.com/NixOS/nixpkgs/blob/master/pkgs/misc/vim-plugins/vim-plugin-names and submit a new PR? Do I have to run the update script myself or does the build do that?

@jonringer
Copy link
Contributor

you can see there's a similar example:

gruvbox-community/gruvbox as gruvbox-community

I would just edit it to say:

dracula/vim as dracula-vim

and then re-run the update.py

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants