eeva/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-11-30 06:59:45 +01:00
Code Issues Releases Wiki Activity

firefox: support passing any json value to settings (#3580)

Browse source 
Firefox internally only supports bool, int, and string types for
preferences, but often stores objects, arrays and floats as strings.

This change makes it nicer to specify those type of preferences in
Nix, and it also makes it possible to merge objects & arrays across
multiple modules.
This commit is contained in:
Kira Bruneau 2023-02-05 05:23:22 -05:00 committed by GitHub
parent e3f28ddb0d
commit 9f4268e6b6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 30 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
modules/programs/firefox.nix
View file

@ -42,6 +42,12 @@ let
profilesIni = generators.toINI { } profiles; profilesIni = generators.toINI { } profiles;
userPrefValue = pref:
builtins.toJSON (if isBool pref || isInt pref || isString pref then
pref
else
builtins.toJSON pref);
mkUserJs = prefs: extraPrefs: bookmarks: mkUserJs = prefs: extraPrefs: bookmarks:
let let
prefs' = lib.optionalAttrs ([ ] != bookmarks) { prefs' = lib.optionalAttrs ([ ] != bookmarks) {
@ -52,7 +58,7 @@ let
// Generated by Home Manager. // Generated by Home Manager.
${concatStrings (mapAttrsToList (name: value: '' ${concatStrings (mapAttrsToList (name: value: ''
user_pref("${name}", ${builtins.toJSON value}); user_pref("${name}", ${userPrefValue value});
'') prefs')} '') prefs')}
${extraPrefs} ${extraPrefs}
@ -201,7 +207,10 @@ in {
}; };
settings = mkOption { settings = mkOption {
type = with types; attrsOf (either bool (either int str)); type = types.attrsOf (jsonFormat.type // {
description =
"Firefox preference (int, bool, string, and also attrs, list, float as a JSON string)";
});
default = { }; default = { };
example = literalExpression '' example = literalExpression ''
{ {
@ -211,9 +220,19 @@ in {
"distribution.searchplugins.defaultLocale" = "en-GB"; "distribution.searchplugins.defaultLocale" = "en-GB";
"general.useragent.locale" = "en-GB"; "general.useragent.locale" = "en-GB";
"browser.bookmarks.showMobileBookmarks" = true; "browser.bookmarks.showMobileBookmarks" = true;
"browser.newtabpage.pinned" = [{
title = "NixOS";
url = "https://nixos.org";
}];
} }
''; '';
description = "Attribute set of Firefox preferences."; description = ''
Attribute set of Firefox preferences.
Firefox only supports int, bool, and string types for
preferences, but home-manager will automatically
convert all other JSON-compatible values into strings.
'';
}; };
extraConfig = mkOption { extraConfig = mkOption {

1
tests/modules/programs/firefox/profile-settings-expected-user.js
View file

@ -1,5 +1,6 @@
// Generated by Home Manager. // Generated by Home Manager.
user_pref("browser.newtabpage.pinned", "[{\"title\":\"NixOS\",\"url\":\"https://nixos.org\"}]");
user_pref("general.smoothScroll", false); user_pref("general.smoothScroll", false);

8
tests/modules/programs/firefox/profile-settings.nix
View file

@ -9,7 +9,13 @@ lib.mkIf config.test.enableBig {
profiles.test = { profiles.test = {
id = 1; id = 1;
settings = { "general.smoothScroll" = false; }; settings = {
"general.smoothScroll" = false;
"browser.newtabpage.pinned" = [{
title = "NixOS";
url = "https://nixos.org";
}];
};
}; };
profiles.bookmarks = { profiles.bookmarks = {