nixpkgs/pkgs/by-name/dm/dmenu-rs/package.nix
Ben Webb 79dd55af66
dmenu-rs: refactor to add variant with enabled plugins
Add the dmenu-rs-enable-plugins package.

The dmenu-rs-enable-plugins package is identical the dmenu-rs, except
that it is built with all plugins available in the dmenu-rs respository
(whereas the dmenu-rs package is built with none). The same underlying
derivation is use, except a boolean flag is passed to indicate whether
or not to enable plugins.

See https://github.com/NixOS/nixpkgs/issues/333733
and https://github.com/Shizcow/dmenu-rs
2024-10-28 23:50:16 -05:00

115 lines
3.3 KiB
Nix

{
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, 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 = "refs/tags/${version}";
hash = "sha256-05Ia+GHeL8PzOwR7H+NEVhKJVMPhlIaQLwGfvwOAl0g=";
};
nativeBuildInputs = [
cargo
m4
pkg-config
python3
rustPlatform.bindgenHook
rustPlatform.cargoSetupHook
];
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
# dynamic build and plugin support. Generating it with make and checking it
# 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 = cargoLockFile;
};
# Copy the Cargo.lock stored here in nixpkgs into the build directory.
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";
installFlags = [ "PREFIX=$(out)" ];
# Running make test requires an X11 server. It also runs dmenu, which then
# hangs on user input. It was too hard to figure out how to run these tests
# deterministically. See the original PR for some discussion on this.
doCheck = false;
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 lib.licenses; [ gpl3Only ];
maintainers = with lib.maintainers; [ benjaminedwardwebb ];
platforms = lib.platforms.linux;
broken = stdenv.hostPlatform.isLinux && stdenv.hostPlatform.isAarch64;
};
}