ranger: add video and pdf preview options #70432

schonfinkel · 2019-10-05T01:20:25Z

Motivation for this change

An attempt to add video & pdf previews to ranger via the nix derivation out of the box

Things done

Notify maintainers

cc @

teto · 2019-10-05T09:21:10Z

I would love to see it installable out of the box. Have you checked the impact on closure size though ? It might be best to provide a module or a wrapper in charge of generating the scope.sh. Would prevent useless rebuilds/caching.

toonn

One necessary change, the other more a request pending addition to scope.sh, all that'd have to change is to allow either poppler or mupdf as dependency.

toonn · 2019-10-05T09:39:54Z

pkgs/applications/misc/ranger/default.nix

@@ -1,9 +1,13 @@
 { stdenv, lib, fetchFromGitHub, python3Packages, file, less, highlight
-, imagePreviewSupport ? true, w3m ? null}:
+, imagePreviewSupport ? true, w3m ? null
+, pdfPreviewSupport ? true, poppler_utils ? null


It'd be great if you could add support for mutool too, we already do this for text previews. I'll open an issue on this over at ranger/ranger.

toonn · 2019-10-05T09:41:18Z

pkgs/applications/misc/ranger/default.nix

@@ -52,6 +58,12 @@ python3Packages.buildPythonApplication rec {
    # give image previews out of the box when building with w3m
    substituteInPlace ranger/config/rc.conf \
      --replace "set preview_images false" "set preview_images true"
+  '' + optionalString pdfPreviewSupport ''
+    # edits scope.sh and enables video previews via ffmpegthumbnailer


You swapped the comments around it seems.

Ma27

Diff seems fine overall. If the closure size impact is too high, we could also add two packages (e.g. ranger and ranger-full).

Apart from that I agree with @teto, the optional features should be moved to a wrapper for less rebuilds :)

teto

Makes more sense to go for a module straightaway. Maybe even in home-manager if that's what you use ?

schonfinkel · 2019-10-05T20:58:41Z

Makes more sense to go for a module straightaway. Maybe even in home-manager if that's what you use ?

A pure nix way to config ranger would be awesome, but how would a module for it look like?

Something like this?

programs.ranger = {
  enable = true;
  imagePreviewSupport = true;
  pdfPreviewSupport = true;
  videoPreviewSupport = true;
  extraConfig = {
    commands = <...>;
    rc = <...>;
    rifle = <...>;
    scope = <...>;
  };
};

teto · 2019-10-06T03:25:13Z

You don't have to cover all the configurations items from the start. Just enable and maybe preview= { image .... video ... pdf }; would be enough for a start. Looking at ranger
s manpage, seems like the configuration could be implemented as a plugin (this way no need to patch the default files).

schonfinkel · 2019-10-06T21:45:05Z

You don't have to cover all the configurations items from the start. Just enable and maybe preview= { image .... video ... pdf }; would be enough for a start. Looking at ranger
s manpage, seems like the configuration could be implemented as a plugin (this way no need to patch the default files).

I'll take a look at this and other reviews an try to write a wrapper as to improve my nix-fu.

Ma27 · 2019-10-06T22:12:04Z

Tbh I'm not sure if that's a good idea: programs.x modules are perfectly fine for system-wide configuration but in this case we only use those options to configure the package itself. In this case it might be even harmful as this makes it hard for non-NixOS users (e.g. folks using Nix on Ubuntu) to actually use those features from ranger.

teto · 2019-10-07T03:01:16Z

the changes modify the configuration, we shouldn't have to reinstall the package just to modify the config.
Maybe a wrapper would be better but they are not amazingly user friendly (compared to modules that appear in man configuration.nix for instance).

@mtrsk you can look at neovim for a wrapper example.
@Ma27 Regarding your remark, maybe it would be best to prepare a home-manager module then ? @mtrsk do you use home-manager (https://github.com/rycee/home-manager/) ? I so wish both projects could converge.

schonfinkel · 2019-10-07T23:40:05Z

@mtrsk you can look at neovim for a wrapper example.

Thanks, I'll take a look at the neovim wrapper (for learning purposes).

the changes modify the configuration, we shouldn't have to reinstall the package just to modify the config.
Maybe a wrapper would be better but they are not amazingly user friendly (compared to modules that appear in man configuration.nix for instance).
@Ma27 Regarding your remark, maybe it would be best to prepare a home-manager module then ? @mtrsk do you use home-manager (https://github.com/rycee/home-manager/) ? I so wish both projects could converge.

It seems it's best to close this PR, as adding more options seems to bring more harm than benefits (once we take into account user friendliness). Making a home-manager module for ranger makes more sense.

teto · 2019-10-08T12:13:04Z

You can ping me on irc or at home-manager should you have any question, I would really like such a module ;)

JohnAZoidberg · 2020-01-03T20:03:41Z

Has any progress of the home-manager configuration been made?

schonfinkel · 2020-01-03T21:13:19Z

@JohnAZoidberg I've never had the time to tackle this

ranger: add video and pdf preview options

a801446

ofborg bot requested a review from toonn October 5, 2019 01:32

ofborg bot added 10.rebuild-darwin: 1-10 10.rebuild-linux: 1-10 labels Oct 5, 2019

toonn requested changes Oct 5, 2019

View reviewed changes

Ma27 reviewed Oct 5, 2019

View reviewed changes

teto requested changes Oct 5, 2019

View reviewed changes

schonfinkel closed this Oct 7, 2019

schonfinkel deleted the ranger-add-options branch October 10, 2019 21:39

teto mentioned this pull request Jul 30, 2020

WIP: Ranger module (program) nix-community/home-manager#1408

Closed

9 tasks

teto mentioned this pull request Oct 14, 2021

ranger: Add clipboard managers as runtime deps #141466

Closed

12 tasks

teto mentioned this pull request Oct 14, 2022

ranger: add module nix-community/home-manager#3264

Open

7 tasks

leoperegrino mentioned this pull request Jun 8, 2024

ranger: add module nix-community/home-manager#4377

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ranger: add video and pdf preview options #70432

ranger: add video and pdf preview options #70432

schonfinkel commented Oct 5, 2019

teto commented Oct 5, 2019

toonn left a comment

toonn Oct 5, 2019

toonn Oct 5, 2019

Ma27 left a comment

teto left a comment

schonfinkel commented Oct 5, 2019

teto commented Oct 6, 2019

schonfinkel commented Oct 6, 2019

Ma27 commented Oct 6, 2019

teto commented Oct 7, 2019

schonfinkel commented Oct 7, 2019

teto commented Oct 8, 2019

JohnAZoidberg commented Jan 3, 2020

schonfinkel commented Jan 3, 2020

ranger: add video and pdf preview options #70432

ranger: add video and pdf preview options #70432

Conversation

schonfinkel commented Oct 5, 2019

Motivation for this change

Things done

Notify maintainers

teto commented Oct 5, 2019

toonn left a comment

Choose a reason for hiding this comment

toonn Oct 5, 2019

Choose a reason for hiding this comment

toonn Oct 5, 2019

Choose a reason for hiding this comment

Ma27 left a comment

Choose a reason for hiding this comment

teto left a comment

Choose a reason for hiding this comment

schonfinkel commented Oct 5, 2019

teto commented Oct 6, 2019

schonfinkel commented Oct 6, 2019

Ma27 commented Oct 6, 2019

teto commented Oct 7, 2019

schonfinkel commented Oct 7, 2019

teto commented Oct 8, 2019

JohnAZoidberg commented Jan 3, 2020

schonfinkel commented Jan 3, 2020