mirror of
https://github.com/nix-community/home-manager.git
synced 2026-01-11 17:39:37 +08:00
anyrun: init module (#6804)
This commit is contained in:
Austin Horstman
@@ -61,6 +61,7 @@ let
|
||||
./programs/alacritty.nix
|
||||
./programs/alot.nix
|
||||
./programs/antidote.nix
|
||||
./programs/anyrun.nix
|
||||
./programs/aria2.nix
|
||||
./programs/astroid.nix
|
||||
./programs/atuin.nix
|
||||
|
||||
284
modules/programs/anyrun.nix
Normal file
284
modules/programs/anyrun.nix
Normal file
@@ -0,0 +1,284 @@
|
||||
{
|
||||
config,
|
||||
pkgs,
|
||||
lib,
|
||||
...
|
||||
}:
|
||||
let
|
||||
inherit (builtins)
|
||||
map
|
||||
toJSON
|
||||
toString
|
||||
substring
|
||||
stringLength
|
||||
;
|
||||
inherit (lib.modules) mkIf mkMerge;
|
||||
inherit (lib.options) mkOption mkEnableOption;
|
||||
inherit (lib.lists) optional;
|
||||
inherit (lib.attrsets) mapAttrs' nameValuePair;
|
||||
inherit (lib.strings) toLower toUpper replaceStrings;
|
||||
inherit (lib.trivial) boolToString;
|
||||
inherit (lib.types)
|
||||
nullOr
|
||||
package
|
||||
submodule
|
||||
int
|
||||
float
|
||||
listOf
|
||||
either
|
||||
str
|
||||
enum
|
||||
lines
|
||||
bool
|
||||
attrs
|
||||
;
|
||||
|
||||
cfg = config.programs.anyrun;
|
||||
in
|
||||
{
|
||||
meta.maintainers = with lib.maintainers; [
|
||||
khaneliman
|
||||
];
|
||||
|
||||
options.programs.anyrun = {
|
||||
enable = mkEnableOption "anyrun";
|
||||
|
||||
package = lib.mkPackageOption pkgs "anyrun" { nullable = true; };
|
||||
|
||||
config =
|
||||
let
|
||||
mkNumericOption =
|
||||
{
|
||||
default,
|
||||
description,
|
||||
...
|
||||
}:
|
||||
mkOption {
|
||||
inherit default description;
|
||||
example = ''
|
||||
{ absolute = 200; };
|
||||
or
|
||||
{ fraction = 0.4; };
|
||||
'';
|
||||
type = submodule {
|
||||
options = {
|
||||
absolute = mkOption {
|
||||
type = nullOr int;
|
||||
default = null;
|
||||
description = "Absolute value in pixels.";
|
||||
};
|
||||
fraction = mkOption {
|
||||
type = nullOr float;
|
||||
default = null;
|
||||
description = "Fraction of the screen.";
|
||||
};
|
||||
};
|
||||
};
|
||||
};
|
||||
|
||||
numericInfo = ''
|
||||
This is a numeric option - pass either `{ absolute = int; };` or `{ fraction = float; };`.
|
||||
when using `absolute` it sets the absolute value in pixels,
|
||||
when using `fraction`, it sets a fraction of the width or height of the full screen (depends on exclusive zones and the settings related to them) window
|
||||
'';
|
||||
in
|
||||
{
|
||||
plugins = mkOption {
|
||||
type = nullOr (listOf (either package str));
|
||||
default = null;
|
||||
description = ''
|
||||
List of anyrun plugins to use. Can either be packages, absolute plugin paths, or strings.
|
||||
'';
|
||||
};
|
||||
|
||||
x = mkNumericOption {
|
||||
default.fraction = 0.5;
|
||||
description = ''
|
||||
The horizontal position, adjusted so that { relative = 0.5; } always centers the runner.
|
||||
|
||||
${numericInfo}
|
||||
'';
|
||||
};
|
||||
|
||||
y = mkNumericOption {
|
||||
default.fraction = 0.0;
|
||||
description = ''
|
||||
The vertical position, works the same as x.
|
||||
|
||||
${numericInfo}
|
||||
'';
|
||||
};
|
||||
|
||||
width = mkNumericOption {
|
||||
default.absolute = 800;
|
||||
description = ''
|
||||
The width of the runner.
|
||||
|
||||
${numericInfo}
|
||||
'';
|
||||
};
|
||||
|
||||
height = mkNumericOption {
|
||||
default.absolute = 0;
|
||||
description = ''
|
||||
The minimum height of the runner, the runner will expand to fit all the entries.
|
||||
|
||||
${numericInfo}
|
||||
'';
|
||||
};
|
||||
|
||||
hideIcons = mkOption {
|
||||
type = bool;
|
||||
default = false;
|
||||
description = "Hide match and plugin info icons.";
|
||||
};
|
||||
|
||||
ignoreExclusiveZones = mkOption {
|
||||
type = bool;
|
||||
default = false;
|
||||
description = "Ignore exclusive zones, eg. Waybar.";
|
||||
};
|
||||
|
||||
layer = mkOption {
|
||||
type = enum [
|
||||
"background"
|
||||
"bottom"
|
||||
"top"
|
||||
"overlay"
|
||||
];
|
||||
default = "overlay";
|
||||
description = "Layer shell layer (background, bottom, top or overlay).";
|
||||
};
|
||||
|
||||
hidePluginInfo = mkOption {
|
||||
type = bool;
|
||||
default = false;
|
||||
description = "Hide the plugin info panel.";
|
||||
};
|
||||
|
||||
closeOnClick = mkOption {
|
||||
type = bool;
|
||||
default = false;
|
||||
description = "Close window when a click outside the main box is received.";
|
||||
};
|
||||
|
||||
showResultsImmediately = mkOption {
|
||||
type = bool;
|
||||
default = false;
|
||||
description = "Show search results immediately when Anyrun starts.";
|
||||
};
|
||||
|
||||
maxEntries = mkOption {
|
||||
type = nullOr int;
|
||||
default = null;
|
||||
description = "Limit amount of entries shown in total.";
|
||||
};
|
||||
};
|
||||
|
||||
extraCss = mkOption {
|
||||
type = nullOr lines;
|
||||
default = "";
|
||||
description = ''
|
||||
Extra CSS lines to add to {file}`~/.config/anyrun/style.css`.
|
||||
'';
|
||||
};
|
||||
|
||||
extraConfigFiles = mkOption {
|
||||
type = attrs;
|
||||
default = { };
|
||||
description = ''
|
||||
Extra files to put in {file}`~/.config/anyrun`, a wrapper over {option}`xdg.configFile`.
|
||||
'';
|
||||
example = ''
|
||||
programs.anyrun.extraConfigFiles."plugin-name.ron".text = '''
|
||||
Config(
|
||||
some_option: true,
|
||||
)
|
||||
'''
|
||||
'';
|
||||
};
|
||||
};
|
||||
|
||||
config = mkIf cfg.enable (
|
||||
let
|
||||
stringifyNumeric =
|
||||
numeric:
|
||||
if (numeric ? absolute && numeric.absolute != null) then
|
||||
"Absolute(${toString numeric.absolute})"
|
||||
else
|
||||
"Fraction(${toString numeric.fraction})";
|
||||
|
||||
capitalize =
|
||||
string: toUpper (substring 0 1 string) + toLower (substring 1 ((stringLength string) - 1) string);
|
||||
|
||||
parsedPlugins =
|
||||
if cfg.config.plugins == null then
|
||||
[ ]
|
||||
else
|
||||
map (
|
||||
entry:
|
||||
if lib.types.package.check entry then
|
||||
"${entry}/lib/lib${replaceStrings [ "-" ] [ "_" ] entry.pname}.so"
|
||||
else
|
||||
entry
|
||||
) cfg.config.plugins;
|
||||
in
|
||||
{
|
||||
assertions =
|
||||
let
|
||||
assertNumeric = numeric: {
|
||||
assertion =
|
||||
!(
|
||||
(numeric ? absolute && numeric.absolute != null) && (numeric ? fraction && numeric.fraction != null)
|
||||
);
|
||||
message = "Invalid numeric definition, you can only specify one of absolute or fraction.";
|
||||
};
|
||||
in
|
||||
[
|
||||
(lib.hm.assertions.assertPlatform "programs.anyrun" pkgs lib.platforms.linux)
|
||||
(assertNumeric cfg.config.width)
|
||||
(assertNumeric cfg.config.height)
|
||||
(assertNumeric cfg.config.x)
|
||||
(assertNumeric cfg.config.y)
|
||||
];
|
||||
|
||||
warnings = optional (cfg.config.plugins == null) ''
|
||||
You haven't enabled any plugins. Anyrun will not show any results, unless you specify plugins with the --override-plugins flag.
|
||||
Add plugins to programs.anyrun.config.plugins, or set it to [] to silence the warning.
|
||||
'';
|
||||
|
||||
home.packages = optional (cfg.package != null) cfg.package;
|
||||
|
||||
xdg.configFile = mkMerge [
|
||||
(mapAttrs' (name: value: nameValuePair ("anyrun/" + name) value) cfg.extraConfigFiles)
|
||||
|
||||
{
|
||||
"anyrun/config.ron".text = ''
|
||||
Config(
|
||||
x: ${stringifyNumeric cfg.config.x},
|
||||
y: ${stringifyNumeric cfg.config.y},
|
||||
width: ${stringifyNumeric cfg.config.width},
|
||||
height: ${stringifyNumeric cfg.config.height},
|
||||
hide_icons: ${boolToString cfg.config.hideIcons},
|
||||
ignore_exclusive_zones: ${boolToString cfg.config.ignoreExclusiveZones},
|
||||
layer: ${capitalize cfg.config.layer},
|
||||
hide_plugin_info: ${boolToString cfg.config.hidePluginInfo},
|
||||
close_on_click: ${boolToString cfg.config.closeOnClick},
|
||||
show_results_immediately: ${boolToString cfg.config.showResultsImmediately},
|
||||
max_entries: ${
|
||||
if cfg.config.maxEntries == null then "None" else "Some(${toString cfg.config.maxEntries})"
|
||||
},
|
||||
plugins: ${toJSON parsedPlugins},
|
||||
)
|
||||
'';
|
||||
}
|
||||
|
||||
{
|
||||
"anyrun/style.css" = mkIf (cfg.extraCss != null) {
|
||||
text = cfg.extraCss;
|
||||
};
|
||||
}
|
||||
];
|
||||
}
|
||||
);
|
||||
}
|
||||
@@ -505,6 +505,7 @@ import nmtSrc {
|
||||
./modules/misc/qt
|
||||
./modules/misc/xsession
|
||||
./modules/programs/abook
|
||||
./modules/programs/anyrun
|
||||
./modules/programs/autorandr
|
||||
./modules/programs/awscli
|
||||
./modules/programs/beets # One test relies on services.mpd
|
||||
|
||||
86
tests/modules/programs/anyrun/basic-config.nix
Normal file
86
tests/modules/programs/anyrun/basic-config.nix
Normal file
@@ -0,0 +1,86 @@
|
||||
{ config, ... }:
|
||||
{
|
||||
programs.anyrun = {
|
||||
enable = true;
|
||||
config = {
|
||||
plugins = [
|
||||
(config.lib.test.mkStubPackage {
|
||||
name = "applications";
|
||||
outPath = "@applications@";
|
||||
})
|
||||
];
|
||||
y.fraction = 2.0e-2;
|
||||
hideIcons = false;
|
||||
ignoreExclusiveZones = false;
|
||||
layer = "overlay";
|
||||
hidePluginInfo = false;
|
||||
closeOnClick = false;
|
||||
showResultsImmediately = false;
|
||||
maxEntries = 10;
|
||||
};
|
||||
|
||||
extraConfigFiles = {
|
||||
"applications.ron".text = ''
|
||||
Config(
|
||||
desktop_actions: true,
|
||||
max_entries: 10,
|
||||
terminal: Some("foot"),
|
||||
)
|
||||
'';
|
||||
};
|
||||
|
||||
extraCss = # CSS
|
||||
''
|
||||
box#main {
|
||||
background: rgba(30, 30, 46, 1);
|
||||
border: 2px solid #494d64;
|
||||
border-radius: 16px;
|
||||
padding: 8px;
|
||||
}
|
||||
'';
|
||||
};
|
||||
|
||||
nmt.script = ''
|
||||
assertFileExists home-files/.config/anyrun/applications.ron
|
||||
assertFileContent home-files/.config/anyrun/applications.ron \
|
||||
${builtins.toFile "applications.ron" ''
|
||||
Config(
|
||||
desktop_actions: true,
|
||||
max_entries: 10,
|
||||
terminal: Some("foot"),
|
||||
)
|
||||
''}
|
||||
|
||||
|
||||
assertFileExists home-files/.config/anyrun/style.css
|
||||
assertFileContent home-files/.config/anyrun/style.css \
|
||||
${builtins.toFile "style.css" ''
|
||||
box#main {
|
||||
background: rgba(30, 30, 46, 1);
|
||||
border: 2px solid #494d64;
|
||||
border-radius: 16px;
|
||||
padding: 8px;
|
||||
}
|
||||
''}
|
||||
|
||||
assertFileExists home-files/.config/anyrun/config.ron
|
||||
assertFileContent \
|
||||
home-files/.config/anyrun/config.ron \
|
||||
${builtins.toFile "config.ron" ''
|
||||
Config(
|
||||
x: Fraction(0.500000),
|
||||
y: Fraction(0.020000),
|
||||
width: Absolute(800),
|
||||
height: Absolute(0),
|
||||
hide_icons: false,
|
||||
ignore_exclusive_zones: false,
|
||||
layer: Overlay,
|
||||
hide_plugin_info: false,
|
||||
close_on_click: false,
|
||||
show_results_immediately: false,
|
||||
max_entries: Some(10),
|
||||
plugins: ["@applications@/lib/libapplications.so"],
|
||||
)
|
||||
''}
|
||||
'';
|
||||
}
|
||||
1
tests/modules/programs/anyrun/default.nix
Normal file
1
tests/modules/programs/anyrun/default.nix
Normal file
@@ -0,0 +1 @@
|
||||
{ anyrun = ./basic-config.nix; }
|
||||
Reference in New Issue
Block a user