dmenu-rs: refactor to add variant with enabled plugins (#333837)

{ stdenv

, rustPlatform

, lib

, fetchFromGitHub

, cargo

, expat

, fontconfig

, libXft

, libXinerama

, m4

, pkg-config

, python3

{

  lib,

  stdenv,

  fetchFromGitHub,

  # nativeBuildInputs

  cargo,

  m4,

  pkg-config,

  python3,

  rustPlatform,

  # buildInputs

  expat,

  fontconfig,

  libXft,

  libXinerama,

  aspell,

  xclip,

  xdg-utils,

  enablePlugins ? false,

}:

# The dmenu-rs package has extensive plugin support. However, this derivation

# only builds the package with the default set of plugins. If you'd like to

# further customize dmenu-rs you can build it from the source.

# The dmenu-rs package has extensive plugin support. However, only two

# variants of the package are presented here: one with no plugins and one with

# all of the plugins that have been checked into the upstream repository. This

# is because the set of plugins is defined at compile time and the dmenu-rs

# build uses this set to dynamically generate a corresponding Cargo.lock file.

# To work around this dynamic generation in nixpkgs, each variant's Cargo.lock

# file has been generated in advance and then checked in here. If you'd like

# to further customize dmenu-rs, either disabling specific plugins or enabling

# additional plugins from outside of the dmenu-rs repository, you'll have to

# build it from the source.

# See: https://github.com/Shizcow/dmenu-rs#plugins

let

  cargoLockFile = if enablePlugins then ./enablePlugins.Cargo.lock else ./Cargo.lock;

in

stdenv.mkDerivation rec {

  pname = "dmenu-rs";

  version = "5.5.4";

  src = fetchFromGitHub {

    owner = "Shizcow";

    repo = "dmenu-rs";

    rev = version;

    hash = "sha256-LdbTvuq1IbzWEoASscIh3j3VAHm+W3UekJNiMHTxSQI=";

    rev = "refs/tags/${version}";

    hash = "sha256-05Ia+GHeL8PzOwR7H+NEVhKJVMPhlIaQLwGfvwOAl0g=";

  };

  nativeBuildInputs = [

    rustPlatform.cargoSetupHook

  ];

  buildInputs = [

  buildInputs =

    [

      expat

      fontconfig

      libXft

      libXinerama

    ]

    ++ lib.optionals enablePlugins [

      aspell

      xclip

      xdg-utils

    ];

  # The dmenu-rs repository does not include a Cargo.lock because of its

  # in to nixpkgs here was the easiest way to supply it to rustPlatform.

  # See: https://github.com/Shizcow/dmenu-rs/issues/34#issuecomment-757415584

  cargoDeps = rustPlatform.importCargoLock {

    lockFile = ./Cargo.lock;

    lockFile = cargoLockFile;

  };

  # Copy the Cargo.lock stored here in nixpkgs into the build directory.

  postPatch = ''

    cp ${./Cargo.lock} src/Cargo.lock

  postPatch =

    ''

      cp ${cargoLockFile} src/Cargo.lock

    ''

    + lib.optionalString enablePlugins ''

      chmod +w src/Cargo.lock

    '';

  # Include all plugins in the dmenu-rs repository under src/plugins.

  # See https://github.com/Shizcow/dmenu-rs/tree/master/src/plugins

  preBuild = lib.optionalString enablePlugins ''

    sed -i -E "s/PLUGINS =/PLUGINS = $(find src/plugins/ -mindepth 1 -maxdepth 1 -type d -printf "%f\n" | tr "\n" " ")/" config.mk

  '';

  cargoRoot = "src";

  # deterministically. See the original PR for some discussion on this.

  doCheck = false;

  meta = with lib; {

    description = "Pixel perfect port of dmenu, rewritten in Rust with extensive plugin support";

  meta = {

    description =

      "Pixel perfect port of dmenu, rewritten in Rust with extensive plugin support"

      + lib.optionalString enablePlugins ", with all upstream plugins enabled";

    homepage = "https://github.com/Shizcow/dmenu-rs";

    license = with licenses; [ gpl3Only ];

    maintainers = with maintainers; [ benjaminedwardwebb ];

    platforms = platforms.linux;

    broken = (stdenv.hostPlatform.isLinux && stdenv.hostPlatform.isAarch64);

    license = with lib.licenses; [ gpl3Only ];

    maintainers = with lib.maintainers; [ benjaminedwardwebb ];

    platforms = lib.platforms.linux;

    broken = stdenv.hostPlatform.isLinux && stdenv.hostPlatform.isAarch64;

  };

}

  dmenu = callPackage ../applications/misc/dmenu { };

  dmenu-wayland = callPackage ../applications/misc/dmenu/wayland.nix { };

  dmenu-rs = callPackage ../applications/misc/dmenu-rs { };

  dmenu-rs-enable-plugins = dmenu-rs.override { enablePlugins = true; };

  dmensamenu = callPackage ../applications/misc/dmensamenu {

    inherit (python3Packages) buildPythonApplication requests;