rxvt-unicode: rewrite plugin system #77347

rnhmjoj · 2020-01-08T22:49:19Z

Motivation for this change

The current way to add plugins to urxvt is not extensible and very much not user friendly: let's change that!

Things done

Notify maintainers

cc @doronbehar

nixos-discourse · 2020-01-09T21:42:07Z

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/what-are-your-goals-for-20-03/4773/11

doronbehar

Besides what I commented, this is definitely a state of the art packaging. Thanks for your contribution!

doronbehar · 2020-01-10T15:34:02Z

doc/builders/packages/urxvt.xml

+   includes all available plugins. To make use of this functionality, use an
+   overlay or directly install an expression that overrides its configuration
+   such as
+   <programlisting>rxvt-unicode.override { configure = { availablePlugins, ... }: {


I'm not sure I'm totally fond of this type of override. Why not go with the usual with<Plugin> scheme? I.e withVtwheel or withResizefont?

I pretty much stole this design from the weechat package. You can see it in the nixpkgs manual It's a little verbose but it's completely configurable.

withVtwheel would require some kind of code generation or hard-coding a few combinations of plugins.

On the same note of my confusion below, I tend to think it will be better... EDIT: if it'll end up as a matter of postInstall and + lib.optional it will be easy to do what ever a user may wish with an override such as:

postInstall = oldAttrs.postInstall + '' # shell code here ''

doc/builders/packages/urxvt.xml

doronbehar · 2020-01-10T15:38:38Z

doc/builders/packages/urxvt.xml

+    <literal>extraDeps</literal> and <literal>perlDeps</literal> can be used
+    to install extra packages. This is a handy way to provide dependencies to
+    your custom perl plugins or install some tools needed by a script.
+    <programlisting>rxvt-unicode.override { configure = { availablePlugins, ... }: {


Whatever the override scheme will go like eventually, I would like this part to list the required Perl / other dependencies for each plugin. The plugin I packaged once - bidi, requires fribidi.

If a plugin is perl module simply adding it to the plugins should just work because its closure already contains all the dependencies.
perlDeps is meant to add some perl modules you may need if you are testing/working on a custom plugin (not installed but somewhere in ~)

Oh right I'm confused, why are there also plugins, perlDeps, and extraDeps if any given derivation which has a file in it's $out/lib/urxvt/perl/ will pull all of it's needed dependencies if added to plugins? It seems overly complicated now.

BTW 1 more thing I've noticed is that urxvt_bidi, the plugin I contributed in the past, is generally a normal perl module, the only thing it has relevant for urxvt is just another file that is installed with postInstall, see:

https://github.com/rnhmjoj/nixpkgs/blob/16c22b01b5e706cc0e3b5371ae5409977e618ed8/pkgs/applications/misc/rxvt-unicode-plugins/urxvt-bidi/default.nix#L15-L17

Yet in the old plugins configuration system, it needed to be added also to perlDeps in addition to plugins... I'm just trying to understand what makes it an exception and perhaps we could overcome this. Perhaps putting the external dependency fribidi (which was the original trouble maker) to propagatedBuildInputs might help?

Oh right I'm confused, why are there also plugins, perlDeps, and extraDeps if any given derivation which has a file in it's $out/lib/urxvt/perl/ will pull all of it's needed dependencies if added to plugins? It seems overly complicated now.

I've rephrased the explanation I give in the manual and added two examples. I hope it's clear now. The idea is basically:

plugins: to add urxvt plugins

extraDeps: to add any kind of package that it's not specifically a plugin to the wrapper

perlDeps: to add Perl packages/modules so that you can use them in your plugins, which are not packaged in nixpkgs but are in ~/.urxvt/ext

BTW 1 more thing I've noticed is that urxvt_bidi

What's special about urxvt_bidi is that it's a Perl package (you built it with buildPerlPackage) and that it needs to be added to the PERL5LIB path. Other plugins are simple Perl scripts that urxvt looks for in the URXVT_PERL_LIB path.

doronbehar · 2020-01-10T15:41:31Z

doc/builders/packages/urxvt.xml

+</programlisting>
+   This will make the urxvt wrapper pick up the dependency and set up the perl
+   path accordingly.
+  </para>


On the same note as in the comment just above this, It'd be nice if another paragraph will kindly ask packagers to document the required dependencies for their plugin, if needed.

@rnhmjoj Could you please take care of this suggestion?

If you mean documenting dependecies of the user, I don't think there will be any need: with this method users don't have to worry about them. All a package author has to do is to specify the the dependencies like in any other derivation (buildInputs, patching shebangs, whatever..). The only special case I can think of is urxvt-bidi, which requires setting a special value in the .passthru to signal it depends on the perl module it self provides.

O.K, nice :) Feel free to mark this conversation and the others as resolved.

nixos-discourse · 2020-01-29T16:29:23Z

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/prs-ready-for-review-may-2019/3032/110

pkgs/applications/misc/rxvt-unicode-plugins/default.nix

rnhmjoj · 2020-02-10T12:27:06Z

So, @worldofpeace can this make it into 20.03 or it already too late?

doronbehar · 2020-02-10T14:06:29Z

@rnhmjoj I'd like to approve this PR. It's kind of hard for me to read the new documentation while it's in the PR's changed files :) Could please just show me an example of an override for the urxvt perhaps with bidi as a plugin so I could easily verify that it works and all?

rnhmjoj · 2020-02-10T14:37:43Z

I'd like to approve this PR. It's kind of hard for me to read the new documentation while it's in the PR's changed files :)

Yeah, docbook itsn't as nice as markdown to look at. Here's the compiled manual for nixpkgs: manual.zip. Look for the urxvt section.

rnhmjoj · 2020-02-10T14:41:26Z

Could please just show me an example of an override for the urxvt perhaps with bidi as a plugin so I could easily verify that it works and all?

Installing bidi should simply be:

rxvt-unicode.override { configure = { availablePlugins, ... }: {
    plugins = [ availablePlugins.bidi ];
  }
}

worldofpeace · 2020-02-10T15:42:07Z

@rnhmjoj I couldn't review for lack of time, but being you are a committer now you don't have to await for my approval. I have no rejections if you can try to merge this before https://discourse.nixos.org/t/nixos-20-03-feature-freeze/5655/31

rnhmjoj · 2020-02-10T16:20:31Z

I have no rejections if you can try to merge this before

I was asking you as a release manager. If it's all right I'll go on and merge this: I'm fairly confident in it as I tested the changes several times by now.

worldofpeace · 2020-02-10T16:24:24Z

I have no rejections if you can try to merge this before

I was asking you as a release manager. If it's all right I'll go on and merge this: I'm fairly confident in it as I tested the changes several times by now.

You opened it in Jan 10 so it does belong in 20.03 in my opinion. Thanks for doing this 👍

doronbehar · 2020-02-10T16:55:41Z

👍 Works.

Adapt to plugin system introduced in NixOS/nixpkgs#77347

rnhmjoj changed the title ~~Urxvt~~ rxvt-unicode: rewrite plugin system Jan 8, 2020

ofborg bot added 8.has: clean-up 8.has: package (new) This PR adds a new package 11.by: package-maintainer This PR was created by the maintainer of the package it changes 10.rebuild-darwin: 1-10 10.rebuild-linux: 1-10 labels Jan 8, 2020

rnhmjoj force-pushed the urxvt branch from d41225a to 16c22b0 Compare January 9, 2020 21:30

rnhmjoj marked this pull request as ready for review January 9, 2020 21:34

ofborg bot added the 8.has: documentation This PR adds or changes documentation label Jan 9, 2020

doronbehar reviewed Jan 10, 2020

View reviewed changes

rnhmjoj force-pushed the urxvt branch from 16c22b0 to 0228710 Compare January 15, 2020 09:01

worldofpeace reviewed Feb 2, 2020

View reviewed changes

pkgs/applications/misc/rxvt-unicode-plugins/default.nix Show resolved Hide resolved

rnhmjoj added 6 commits February 2, 2020 11:23

rxvt-unicode: cleanup

7a15db3

rxvt-unicode: rewrite plugin system

27b3df0

rxvt-unicode: support self-depending plugins in wrapper

dcfff7c

rxvt-unicode: add aliases for name change

1c38ce5

rxvt-unicode-plugins/urxvt-resize-font: init at 2019-10-05

4e15543

doc: document new urxvt plugin system

ef9a029

rnhmjoj force-pushed the urxvt branch from 0228710 to ef9a029 Compare February 2, 2020 11:01

worldofpeace mentioned this pull request Feb 6, 2020

New nixpkgs committers requests #50105

Closed

rnhmjoj merged commit 565724c into NixOS:master Feb 10, 2020

This was referenced Feb 11, 2020

NixOS 20.03 highlights #79180

Closed

rxvt-unicode: fix typo in aliases.nix #79998

Merged

arcnmx added a commit to arcnmx/nixexprs that referenced this pull request Feb 16, 2020

rxvt-unicode fixes

f3c9c40

Adapt to plugin system introduced in NixOS/nixpkgs#77347

arcnmx added a commit to arcnmx/nixexprs that referenced this pull request Feb 16, 2020

rxvt-unicode fixes

6db2596

Adapt to plugin system introduced in NixOS/nixpkgs#77347

doronbehar mentioned this pull request Mar 10, 2020

GNU radio 3.8 update meta issue #82263

Closed

rnhmjoj deleted the urxvt branch April 7, 2020 12:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rxvt-unicode: rewrite plugin system #77347

rxvt-unicode: rewrite plugin system #77347

rnhmjoj commented Jan 8, 2020 •

edited

Loading

nixos-discourse commented Jan 9, 2020

doronbehar left a comment

doronbehar Jan 10, 2020

rnhmjoj Jan 10, 2020

doronbehar Jan 11, 2020 •

edited

Loading

doronbehar Jan 10, 2020

rnhmjoj Jan 10, 2020

doronbehar Jan 11, 2020

rnhmjoj Jan 15, 2020

doronbehar Jan 10, 2020

doronbehar Feb 10, 2020

rnhmjoj Feb 10, 2020

doronbehar Feb 10, 2020

nixos-discourse commented Jan 29, 2020

rnhmjoj commented Feb 10, 2020

doronbehar commented Feb 10, 2020

rnhmjoj commented Feb 10, 2020

rnhmjoj commented Feb 10, 2020

worldofpeace commented Feb 10, 2020

rnhmjoj commented Feb 10, 2020

worldofpeace commented Feb 10, 2020

doronbehar commented Feb 10, 2020

rxvt-unicode: rewrite plugin system #77347

rxvt-unicode: rewrite plugin system #77347

Conversation

rnhmjoj commented Jan 8, 2020 • edited Loading

Motivation for this change

Things done

Notify maintainers

nixos-discourse commented Jan 9, 2020

doronbehar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

doronbehar Jan 11, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nixos-discourse commented Jan 29, 2020

rnhmjoj commented Feb 10, 2020

doronbehar commented Feb 10, 2020

rnhmjoj commented Feb 10, 2020

rnhmjoj commented Feb 10, 2020

worldofpeace commented Feb 10, 2020

rnhmjoj commented Feb 10, 2020

worldofpeace commented Feb 10, 2020

doronbehar commented Feb 10, 2020

rnhmjoj commented Jan 8, 2020 •

edited

Loading

doronbehar Jan 11, 2020 •

edited

Loading