nix/2.home-manager
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

sherlock: init module

Browse source 
Creating a sherlock module for the sherlock launcher. Prefer a file be
controlled by a single option and using settings for the main config
file.

Signed-off-by: Austin Horstman <khaneliman12@gmail.com>
This commit is contained in:
Austin Horstman 2025-08-05 18:56:15 -05:00
parent f0d81a415d
commit a379077675
14 changed files with 586 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
tests/modules/programs/sherlock/basic-configuration.json Normal file
View file

@ -0,0 +1,5 @@
{
"max_results": 8,
"theme": "dark",
"width": 500
}

19
tests/modules/programs/sherlock/basic-configuration.nix Normal file
View file

@ -0,0 +1,19 @@
{
programs.sherlock = {
enable = true;
settings = {
theme = "dark";
width = 500;
max_results = 8;
};
};
nmt.script =
let
configFile = "home-files/.config/sherlock/config.toml";
in
''
assertFileExists "${configFile}"
assertFileContent "${configFile}" ${./basic-configuration.toml}
'';
}

3
tests/modules/programs/sherlock/basic-configuration.toml Normal file
View file

@ -0,0 +1,3 @@
max_results = 8
theme = "dark"
width = 500

11
tests/modules/programs/sherlock/default-configuration.nix Normal file
View file

@ -0,0 +1,11 @@
{
programs.sherlock.enable = true;
nmt.script = ''
assertPathNotExists home-files/.config/sherlock/config.toml
assertPathNotExists home-files/.config/sherlock/sherlock_alias.json
assertPathNotExists home-files/.config/sherlock/fallback.json
assertPathNotExists home-files/.config/sherlock/sherlockignore
assertPathNotExists home-files/.config/sherlock/main.css
'';
}

7
tests/modules/programs/sherlock/default.nix Normal file
View file

@ -0,0 +1,7 @@
{ lib, pkgs, ... }:
lib.optionalAttrs pkgs.stdenv.hostPlatform.isLinux {
sherlock-default-configuration = ./default-configuration.nix;
sherlock-basic-configuration = ./basic-configuration.nix;
sherlock-full-configuration = ./full-configuration.nix;
sherlock-empty-settings = ./empty-settings.nix;
}

18
tests/modules/programs/sherlock/empty-settings.nix Normal file
View file

@ -0,0 +1,18 @@
{
programs.sherlock = {
enable = true;
package = null;
};
nmt.script = ''
# With null package, no package should be installed
assertPathNotExists home-path/bin/sherlock-launcher
# With empty settings, no config files should be generated
assertPathNotExists home-files/.config/sherlock/config.toml
assertPathNotExists home-files/.config/sherlock/sherlock_alias.json
assertPathNotExists home-files/.config/sherlock/fallback.json
assertPathNotExists home-files/.config/sherlock/sherlockignore
assertPathNotExists home-files/.config/sherlock/main.css
'';
}

8
tests/modules/programs/sherlock/full-configuration-aliases.json Normal file
View file

@ -0,0 +1,8 @@
{
"DuckDuckGo": {
"exec": "firefox https://duckduckgo.com/?q=%s",
"icon": "duckduckgo",
"keywords": "search web ddg",
"name": "DuckDuckGo"
}
}

114
tests/modules/programs/sherlock/full-configuration-fallback.json Normal file
View file

@ -0,0 +1,114 @@
[
{
"args": {
"location": "Appleton",
"update_interval": 60
},
"async": true,
"home": "OnlyHome",
"name": "Weather",
"priority": 1,
"shortcut": false,
"spawn_focus": false,
"type": "weather"
},
{
"alias": "app",
"args": {},
"home": "Home",
"name": "App Launcher",
"priority": 2,
"type": "app_launcher"
},
{
"alias": "ddg",
"args": {
"icon": "duckduckgo",
"search_engine": "duckduckgo"
},
"display_name": "DuckDuckGo Search",
"name": "Web Search",
"priority": 100,
"tag_end": "{keyword}",
"tag_start": "{keyword}",
"type": "web_launcher"
},
{
"args": {
"capabilities": [
"calc.math",
"calc.units"
]
},
"name": "Calculator",
"priority": 1,
"type": "calculation"
},
{
"args": {
"capabilities": [
"url",
"colors.all",
"calc.math",
"calc.units"
]
},
"home": "Home",
"name": "Clipboard",
"priority": 1,
"type": "clipboard-execution"
},
{
"alias": "nix",
"args": {
"commands": {
"Nix Search TV": {
"exec": "kitty -e nix-search-tv",
"icon": "nix-snowflake",
"search_string": "interactive;search;tv"
},
"NixOS Wiki": {
"exec": "firefox https://wiki.nixos.org/w/index.php?search={keyword}",
"icon": "nix-snowflake",
"search_string": "wiki;docs;documentation",
"tag_end": "",
"tag_start": "wiki:"
},
"Search Options": {
"exec": "firefox https://search.nixos.org/options?query={keyword}",
"icon": "nix-snowflake",
"search_string": "options;config;nixos",
"tag_end": "",
"tag_start": "options:"
},
"Search Packages": {
"exec": "firefox https://search.nixos.org/packages?query={keyword}",
"icon": "nix-snowflake",
"search_string": "packages;search;nixpkgs",
"tag_end": "",
"tag_start": "search:"
}
}
},
"name": "Nix Commands",
"priority": 5,
"type": "command"
},
{
"args": {
"default_skin_tone": "Simpsons"
},
"home": "Search",
"name": "Emoji Picker",
"priority": 4,
"type": "emoji_picker"
},
{
"alias": "kill",
"args": {},
"home": "Search",
"name": "Kill Process",
"priority": 6,
"type": "process"
}
]

5
tests/modules/programs/sherlock/full-configuration-ignore Normal file
View file

@ -0,0 +1,5 @@
hicolor-icon-theme.desktop
user-dirs.desktop
mimeinfo.cache.desktop
org.freedesktop.IBus.Setup.desktop
ca.desrt.dconf-editor.desktop

8
tests/modules/programs/sherlock/full-configuration-style.css Normal file
View file

@ -0,0 +1,8 @@
window {
background-color: #2E3440;
border-radius: 8px;
}
entry {
background-color: #3B4252;
color: #ECEFF4;
}

200
tests/modules/programs/sherlock/full-configuration.nix Normal file
View file

@ -0,0 +1,200 @@
{
programs.sherlock = {
enable = true;
settings = {
appearance = {
width = 1000;
height = 600;
gsk_renderer = "cairo";
icon_size = 32;
opacity = 0.95;
};
caching = {
enable = true;
};
default_apps = {
browser = "firefox";
calendar_client = "thunderbird";
teams = "teams-for-linux --enable-features=UseOzonePlatform --ozone-platform=wayland --url {meeting_url}";
terminal = "kitty";
};
search_bar_icon = {
enable = true;
};
status_bar.enable = true;
units = {
lengths = "feet";
weights = "lb";
volumes = "oz";
temperatures = "F";
currency = "usd";
};
};
launchers = [
{
name = "Weather";
type = "weather";
args = {
location = "Appleton";
update_interval = 60;
};
priority = 1;
home = "OnlyHome";
async = true;
shortcut = false;
spawn_focus = false;
}
{
name = "App Launcher";
alias = "app";
type = "app_launcher";
args = { };
priority = 2;
home = "Home";
}
{
name = "Web Search";
display_name = "DuckDuckGo Search";
alias = "ddg";
type = "web_launcher";
tag_start = "{keyword}";
tag_end = "{keyword}";
args = {
search_engine = "duckduckgo";
icon = "duckduckgo";
};
priority = 100;
}
{
name = "Calculator";
type = "calculation";
args = {
capabilities = [
"calc.math"
"calc.units"
];
};
priority = 1;
}
{
name = "Clipboard";
type = "clipboard-execution";
args = {
capabilities = [
"url"
"colors.all"
"calc.math"
"calc.units"
];
};
priority = 1;
home = "Home";
}
{
name = "Nix Commands";
alias = "nix";
type = "command";
args = {
commands = {
"Search Packages" = {
icon = "nix-snowflake";
exec = "firefox https://search.nixos.org/packages?query={keyword}";
search_string = "packages;search;nixpkgs";
tag_start = "search:";
tag_end = "";
};
"Search Options" = {
icon = "nix-snowflake";
exec = "firefox https://search.nixos.org/options?query={keyword}";
search_string = "options;config;nixos";
tag_start = "options:";
tag_end = "";
};
"NixOS Wiki" = {
icon = "nix-snowflake";
exec = "firefox https://wiki.nixos.org/w/index.php?search={keyword}";
search_string = "wiki;docs;documentation";
tag_start = "wiki:";
tag_end = "";
};
"Nix Search TV" = {
icon = "nix-snowflake";
exec = "kitty -e nix-search-tv";
search_string = "interactive;search;tv";
};
};
};
priority = 5;
}
{
name = "Emoji Picker";
type = "emoji_picker";
args = {
default_skin_tone = "Simpsons";
};
priority = 4;
home = "Search";
}
{
name = "Kill Process";
alias = "kill";
type = "process";
args = { };
priority = 6;
home = "Search";
}
];
aliases = {
"DuckDuckGo" = {
name = "DuckDuckGo";
icon = "duckduckgo";
exec = "firefox https://duckduckgo.com/?q=%s";
keywords = "search web ddg";
};
};
ignore = ''
hicolor-icon-theme.desktop
user-dirs.desktop
mimeinfo.cache.desktop
org.freedesktop.IBus.Setup.desktop
ca.desrt.dconf-editor.desktop
'';
style = ''
window {
background-color: #2E3440;
border-radius: 8px;
}
entry {
background-color: #3B4252;
color: #ECEFF4;
}
'';
};
nmt.script = ''
assertFileExists home-files/.config/sherlock/config.toml
assertFileContent home-files/.config/sherlock/config.toml ${./full-configuration.toml}
assertFileExists home-files/.config/sherlock/sherlock_alias.json
assertFileContent home-files/.config/sherlock/sherlock_alias.json ${./full-configuration-aliases.json}
assertFileExists home-files/.config/sherlock/fallback.json
assertFileContent home-files/.config/sherlock/fallback.json ${./full-configuration-fallback.json}
assertFileExists home-files/.config/sherlock/sherlockignore
assertFileContent home-files/.config/sherlock/sherlockignore ${./full-configuration-ignore}
assertFileExists home-files/.config/sherlock/main.css
assertFileContent home-files/.config/sherlock/main.css ${./full-configuration-style.css}
'';
}

28
tests/modules/programs/sherlock/full-configuration.toml Normal file
View file

@ -0,0 +1,28 @@
[appearance]
gsk_renderer = "cairo"
height = 600
icon_size = 32
opacity = 0.95
width = 1000
[caching]
enable = true
[default_apps]
browser = "firefox"
calendar_client = "thunderbird"
teams = "teams-for-linux --enable-features=UseOzonePlatform --ozone-platform=wayland --url {meeting_url}"
terminal = "kitty"
[search_bar_icon]
enable = true
[status_bar]
enable = true
[units]
currency = "usd"
lengths = "feet"
temperatures = "F"
volumes = "oz"
weights = "lb"