eeva
/
home-manager
mirror of https://github.com/nix-community/home-manager
1
0
Fork 0
Code Issues Releases Wiki Activity

spotify-player: add module

This commit is contained in:
diniamo 2024-04-19 12:39:30 +02:00 committed by GitHub
parent b5b2b1ac63
commit b62cad68b7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 359 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
modules/lib/maintainers.nix
View File

@ -71,6 +71,12 @@
github = "Dines97";
githubId = 19364873;
};
diniamo = {
name = "diniamo";
email = "diniamo69@gmail.com";
github = "diniamo";
githubId = 55629891;
};
dwagenk = {
email = "dwagenk@mailbox.org";
github = "dwagenk";

7
modules/misc/news.nix
View File

@ -1491,6 +1491,13 @@ in {
A new module is available: 'programs.tofi'.
'';
}
{
time = "2024-04-19T10:01:55+00:00";
message = ''
A new module is available: 'programs.spotify-player'.
'';
}
];
};
}

1
modules/modules.nix
View File

@ -211,6 +211,7 @@ let
./programs/sioyek.nix
./programs/skim.nix
./programs/sm64ex.nix
./programs/spotify-player.nix
./programs/sqls.nix
./programs/ssh.nix
./programs/starship.nix

154
modules/programs/spotify-player.nix Normal file
View File

@ -0,0 +1,154 @@
{ config, lib, pkgs, ... }:
let
inherit (lib)
mkEnableOption mkPackageOption mkOption types literalExpression mkIf;
cfg = config.programs.spotify-player;
tomlFormat = pkgs.formats.toml { };
in {
meta.maintainers = with lib.hm.maintainers; [ diniamo ];
options.programs.spotify-player = {
enable = mkEnableOption "spotify-player";
package = mkPackageOption pkgs "spotify-player" { };
settings = mkOption {
type = tomlFormat.type;
default = { };
example = literalExpression ''
{
theme = "default";
playback_window_position = "Top";
copy_command = {
command = "wl-copy";
args = [];
};
device = {
audio_cache = false;
normalization = false;
};
}
'';
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/spotify-player/app.toml`.
See
<https://github.com/aome510/spotify-player/blob/master/docs/config.md#general>
for the full list of options.
'';
};
themes = mkOption {
type = types.listOf tomlFormat.type;
default = [ ];
example = literalExpression ''
[
{
name = "default2";
palette = {
black = "black";
red = "red";
green = "green";
yellow = "yellow";
blue = "blue";
magenta = "magenta";
cyan = "cyan";
white = "white";
bright_black = "bright_black";
bright_red = "bright_red";
bright_green = "bright_green";
bright_yellow = "bright_yellow";
bright_blue = "bright_blue";
bright_magenta = "bright_magenta";
bright_cyan = "bright_cyan";
bright_white = "bright_white";
};
component_style = {
block_title = { fg = "Magenta"; };
border = {};
playback_track = { fg = "Cyan"; modifiers = ["Bold"]; };
playback_artists = { fg = "Cyan"; modifiers = ["Bold"]; };
playback_album = { fg = "Yellow"; };
playback_metadata = { fg = "BrightBlack"; };
playback_progress_bar = { bg = "BrightBlack"; fg = "Green"; };
current_playing = { fg = "Green"; modifiers = ["Bold"]; };
page_desc = { fg = "Cyan"; modifiers = ["Bold"]; };
table_header = { fg = "Blue"; };
selection = { modifiers = ["Bold" "Reversed"]; };
};
}
]
'';
description = ''
Configuration written to the `themes` field of
{file}`$XDG_CONFIG_HOME/spotify-player/theme.toml`.
See
<https://github.com/aome510/spotify-player/blob/master/docs/config.md#themes>
for the full list of options.
'';
};
keymaps = mkOption {
type = types.listOf tomlFormat.type;
default = [ ];
example = literalExpression ''
[
{
command = "NextTrack";
key_sequence = "g n";
}
{
command = "PreviousTrack";
key_sequence = "g p";
}
{
command = "Search";
key_sequence = "C-c C-x /";
}
{
command = "ResumePause";
key_sequence = "M-enter";
}
{
command = "None";
key_sequence = "q";
}
]
'';
description = ''
Configuration written to the `keymaps` field of
{file}`$XDG_CONFIG_HOME/spotify-player/keymap.toml`.
See
<https://github.com/aome510/spotify-player/blob/master/docs/config.md#keymaps>
for the full list of options.
'';
};
};
config = mkIf cfg.enable {
home.packages = [ cfg.package ];
xdg.configFile = {
"spotify-player/app.toml" = mkIf (cfg.settings != { }) {
source = tomlFormat.generate "spotify-player-app" cfg.settings;
};
"spotify-player/theme.toml" = mkIf (cfg.themes != [ ]) {
source =
tomlFormat.generate "spotify-player-theme" { inherit (cfg) themes; };
};
"spotify-player/keymap.toml" = mkIf (cfg.keymaps != [ ]) {
source = tomlFormat.generate "spotify-player-keymap" {
inherit (cfg) keymaps;
};
};
};
};
}

1
tests/default.nix
View File

@ -140,6 +140,7 @@ in import nmtSrc {
./modules/programs/sftpman
./modules/programs/sioyek
./modules/programs/sm64ex
./modules/programs/spotify-player
./modules/programs/ssh
./modules/programs/starship
./modules/programs/taskwarrior

9
tests/modules/programs/spotify-player/app.toml Normal file
View File

@ -0,0 +1,9 @@
playback_window_position = "Top"
theme = "default"
[copy_command]
args = []
command = "wl-copy"
[device]
audio_cache = false
normalization = false

1
tests/modules/programs/spotify-player/default.nix Normal file
View File

@ -0,0 +1 @@
{ spotify-player-settings = ./settings.nix; }

19
tests/modules/programs/spotify-player/keymap.toml Normal file
View File

@ -0,0 +1,19 @@
[[keymaps]]
command = "NextTrack"
key_sequence = "g n"
[[keymaps]]
command = "PreviousTrack"
key_sequence = "g p"
[[keymaps]]
command = "Search"
key_sequence = "C-c C-x /"
[[keymaps]]
command = "ResumePause"
key_sequence = "M-enter"
[[keymaps]]
command = "None"
key_sequence = "q"

103
tests/modules/programs/spotify-player/settings.nix Normal file
View File

@ -0,0 +1,103 @@
{
programs.spotify-player = {
enable = true;
settings = {
theme = "default";
playback_window_position = "Top";
copy_command = {
command = "wl-copy";
args = [ ];
};
device = {
audio_cache = false;
normalization = false;
};
};
themes = [{
name = "default2";
palette = {
black = "black";
red = "red";
green = "green";
yellow = "yellow";
blue = "blue";
magenta = "magenta";
cyan = "cyan";
white = "white";
bright_black = "bright_black";
bright_red = "bright_red";
bright_green = "bright_green";
bright_yellow = "bright_yellow";
bright_blue = "bright_blue";
bright_magenta = "bright_magenta";
bright_cyan = "bright_cyan";
bright_white = "bright_white";
};
component_style = {
block_title = { fg = "Magenta"; };
border = { };
playback_track = {
fg = "Cyan";
modifiers = [ "Bold" ];
};
playback_artists = {
fg = "Cyan";
modifiers = [ "Bold" ];
};
playback_album = { fg = "Yellow"; };
playback_metadata = { fg = "BrightBlack"; };
playback_progress_bar = {
bg = "BrightBlack";
fg = "Green";
};
current_playing = {
fg = "Green";
modifiers = [ "Bold" ];
};
page_desc = {
fg = "Cyan";
modifiers = [ "Bold" ];
};
table_header = { fg = "Blue"; };
selection = { modifiers = [ "Bold" "Reversed" ]; };
};
}];
keymaps = [
{
command = "NextTrack";
key_sequence = "g n";
}
{
command = "PreviousTrack";
key_sequence = "g p";
}
{
command = "Search";
key_sequence = "C-c C-x /";
}
{
command = "ResumePause";
key_sequence = "M-enter";
}
{
command = "None";
key_sequence = "q";
}
];
};
test.stubs.spotify-player = { };
nmt.script = ''
assertFileContent home-files/.config/spotify-player/app.toml ${./app.toml}
assertFileContent home-files/.config/spotify-player/theme.toml ${
./theme.toml
}
assertFileContent home-files/.config/spotify-player/keymap.toml ${
./keymap.toml
}
'';
}

58
tests/modules/programs/spotify-player/theme.toml Normal file
View File

@ -0,0 +1,58 @@
[[themes]]
name = "default2"
[themes.component_style]
[themes.component_style.block_title]
fg = "Magenta"
[themes.component_style.border]
[themes.component_style.current_playing]
fg = "Green"
modifiers = ["Bold"]
[themes.component_style.page_desc]
fg = "Cyan"
modifiers = ["Bold"]
[themes.component_style.playback_album]
fg = "Yellow"
[themes.component_style.playback_artists]
fg = "Cyan"
modifiers = ["Bold"]
[themes.component_style.playback_metadata]
fg = "BrightBlack"
[themes.component_style.playback_progress_bar]
bg = "BrightBlack"
fg = "Green"
[themes.component_style.playback_track]
fg = "Cyan"
modifiers = ["Bold"]
[themes.component_style.selection]
modifiers = ["Bold", "Reversed"]
[themes.component_style.table_header]
fg = "Blue"
[themes.palette]
black = "black"
blue = "blue"
bright_black = "bright_black"
bright_blue = "bright_blue"
bright_cyan = "bright_cyan"
bright_green = "bright_green"
bright_magenta = "bright_magenta"
bright_red = "bright_red"
bright_white = "bright_white"
bright_yellow = "bright_yellow"
cyan = "cyan"
green = "green"
magenta = "magenta"
red = "red"
white = "white"
yellow = "yellow"