tmuxPlugins.tmux-which-key: init at unstable-2024-06-08

[NovaViper]

Fixes #367462

A plugin for tmux that allows users to select actions from a customizable popup menu. Inspired by the likes of vscode-which-key, emacs-which-key, and which-key.nvim, this plugin aims to make users more effective at using tmux by reducing keyboard shortcut memorization and increasing feature discoverability.
homepage: https://github.com/alexwforsythe/tmux-which-key

Additionally, I add myself as maintainer of the package. I tested basic functionality in my flake (as well built it with nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD") and found that it works correctly.
flake info:

❯ nix-info -m
 - system: `"x86_64-linux"`
 - host os: `Linux 6.12.8, NixOS, 25.05 (Warbler), 25.05.20250104.8f3e1f8`
 - multi-user?: `yes`
 - sandbox: `yes`
 - version: `nix-env (Nix) 2.25.3`
 - nixpkgs: `/nix/store/khbvilmsrv4l69nwd52h27j1mp44a0xi-source`

Things done

• Built on platform(s)
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
  • sandbox = relaxed
  • sandbox = true
• Tested, as applicable:
  • NixOS test(s) (look inside nixos/tests)
  • and/or package tests
  • or, for functions and "core" functionality, tests in lib/tests or pkgs/test
  • made sure NixOS tests are linked to the relevant packages
• Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
• Tested basic functionality of all binary files (usually in ./result/bin/)
• 25.05 Release Notes (or backporting 24.11 and 25.05 Release notes)
  • (Package updates) Added a release notes entry if the change is major or breaking
  • (Module updates) Added a release notes entry if the change is significant
  • (Module addition) Added a release notes entry if adding a new NixOS module
• Fits CONTRIBUTING.md.

---

Add a 👍 reaction to pull requests you find important.

[NovaViper]

Hmm.. currently running into an issue with getting the plugin to recognize the configuration files (upstream issue); whatever the default configuration it uses works fine but any changes made seems to be ignored by the plugin.

alexwforsythe/tmux-which-key#15

[NovaViper]

Hmm.. currently running into an issue with getting the plugin to recognize the configuration files (upstream issue); whatever the default configuration it uses works fine but any changes made seems to be ignored by the plugin.

alexwforsythe/tmux-which-key#15

Ah so it turned out a home-manager module is needed in order to make changes via the nix way because the package's python script converts the yaml config file into tmux commands during derivation. See: alexwforsythe/tmux-which-key#15 (comment)

Also I went and renamed it to match the name of the repository.

[FliegendeWurst]

Suggested change

...

[FliegendeWurst]

Suggested change

	version = "unstable-2024-06-08";
	version = "0-unstable-2024-06-08";

Version must start with a digit.

[FliegendeWurst]

Suggested change

	description = "A plugin for tmux that allows users to select actions from a customizable popup menu. Inspired by vscode-which-key, emacs-which-key, and which-key.nvim";
	description = "Tmux plugin that allows users to select actions from a customizable popup menu";

[FliegendeWurst]

If the plugin is a python script it might be better to patch it to use this python instead of propagating it everywhere.

[FliegendeWurst]

You could try using patchShebangs in postInstall and have the python env in buildInputs.