nathan/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager.git synced 2026-06-05 21:02:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

obsidian: no IFD, use RFC42 settings

Browse Source 
The current communityPlugins and themes implementations do IFD, slowing down evaluation of user configurations. Instead of reading the plugin IDs and theme names from the package outputs' manifest.json, I have made it so the plugin ID / theme name is read from the package's passthru if possible.

Using (pkgs.formats.json { }).type gives better type checking than nullOr (attrsOf anything).
This commit is contained in:
Alex Epelde
2026-04-22 11:56:48 -04:00
committed by GitHub
parent 875f2fcbb1
commit 936d579f53
1 changed files with 21 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
modules/programs/obsidian.nix
View File

@@ -14,6 +14,8 @@ let
types
;
settingsFormat = pkgs.formats.json { };
cfg = config.programs.obsidian;
corePluginsList = [
@@ -50,10 +52,6 @@ let
"zk-prefixer"
];
appSettingsType = with types; nullOr (attrsOf anything);
appearanceSettingsType = with types; nullOr (attrsOf anything);
corePluginsOptions = {
options = {
enable = mkOption {
@@ -68,7 +66,7 @@ let
};
settings = mkOption {
type = with types; nullOr (attrsOf anything);
inherit (settingsFormat) type;
description = "Plugin settings to include.";
default = null;
};
@@ -94,7 +92,7 @@ let
};
settings = mkOption {
type = with types; nullOr (attrsOf anything);
inherit (settingsFormat) type;
description = "Settings to include in the plugin's `data.json`.";
default = null;
};
@@ -224,7 +222,7 @@ in
Vault-specific settings take priority and will override these, if set.
'';
type = appSettingsType;
inherit (settingsFormat) type;
default = null;
};
@@ -234,7 +232,7 @@ in
Vault-specific settings take priority and will override these, if set.
'';
type = appearanceSettingsType;
inherit (settingsFormat) type;
default = null;
};
@@ -321,14 +319,14 @@ in
settings = {
app = mkOption {
description = "Settings to write to app.json.";
type = appSettingsType;
inherit (settingsFormat) type;
default = cfg.defaultSettings.app;
defaultText = literalExpression "config.programs.obsidian.defaultSettings.app";
};
appearance = mkOption {
description = "Settings to write to appearance.json.";
type = appearanceSettingsType;
inherit (settingsFormat) type;
default = cfg.defaultSettings.appearance;
defaultText = literalExpression "config.programs.obsidian.defaultSettings.appearance";
};
@@ -393,7 +391,7 @@ in
let
manifest = builtins.fromJSON (builtins.readFile "${item.pkg}/manifest.json");
in
manifest.id or manifest.name;
item.pkg.manifestId or manifest.id or manifest.name;
in
lib.mkIf cfg.enable {
home = {
@@ -406,7 +404,7 @@ in
lib.lists.optionals (vault.settings.app != null) [
{
name = "${vault.target}/.obsidian/app.json";
value.source = (pkgs.formats.json { }).generate "app.json" vault.settings.app;
value.source = settingsFormat.generate "app.json" vault.settings.app;
}
];
@@ -422,7 +420,7 @@ in
{
name = "${vault.target}/.obsidian/appearance.json";
value = {
source = (pkgs.formats.json { }).generate "appearance.json" (
source = settingsFormat.generate "appearance.json" (
(lib.attrsets.optionalAttrs (vault.settings.appearance != null) vault.settings.appearance)
// (lib.attrsets.optionalAttrs (vault.settings.cssSnippets != null) {
enabledCssSnippets = map (snippet: snippet.name) (
@@ -450,7 +448,7 @@ in
[
{
name = "${vault.target}/.obsidian/core-plugins.json";
value.source = (pkgs.formats.json { }).generate "core-plugins.json" (
value.source = settingsFormat.generate "core-plugins.json" (
builtins.listToAttrs (
map (name: {
inherit name;
@@ -462,7 +460,7 @@ in
]
++ map (plugin: {
name = "${vault.target}/.obsidian/${plugin.name}.json";
value.source = (pkgs.formats.json { }).generate "${plugin.name}.json" plugin.settings;
value.source = settingsFormat.generate "${plugin.name}.json" plugin.settings;
}) (builtins.filter (plugin: plugin.settings != null) vault.settings.corePlugins)
);
@@ -472,7 +470,7 @@ in
[
{
name = "${vault.target}/.obsidian/community-plugins.json";
value.source = (pkgs.formats.json { }).generate "community-plugins.json" (
value.source = settingsFormat.generate "community-plugins.json" (
map getManifest (builtins.filter (plugin: plugin.enable) vault.settings.communityPlugins)
);
}
@@ -486,7 +484,7 @@ in
}) vault.settings.communityPlugins
++ map (plugin: {
name = "${vault.target}/.obsidian/plugins/${getManifest plugin}/data.json";
value.source = (pkgs.formats.json { }).generate "data.json" plugin.settings;
value.source = settingsFormat.generate "data.json" plugin.settings;
}) (builtins.filter (plugin: plugin.settings != null) vault.settings.communityPlugins)
);
@@ -521,7 +519,7 @@ in
lib.lists.optionals (vault.settings.hotkeys != null) [
{
name = "${vault.target}/.obsidian/hotkeys.json";
value.source = (pkgs.formats.json { }).generate "hotkeys.json" vault.settings.hotkeys;
value.source = settingsFormat.generate "hotkeys.json" vault.settings.hotkeys;
}
];
@@ -565,7 +563,7 @@ in
else
"${config.xdg.configHome}/obsidian";
template = (pkgs.formats.json { }).generate "obsidian.json" {
template = settingsFormat.generate "obsidian.json" {
vaults = builtins.listToAttrs (
map (vault: {
name = builtins.substring 0 16 (builtins.hashString "md5" vault.target);
@@ -599,23 +597,23 @@ in
vault:
builtins.all (
snippet:
(snippet.source == null || snippet.text == null) && (snippet.source != null || snippet.text != null)
(snippet.source != null && snippet.text == null) || (snippet.source == null && snippet.text != null)
) (lib.lists.optionals (vault.settings.cssSnippets != null) vault.settings.cssSnippets)
) (builtins.attrValues cfg.vaults);
message = "Each CSS snippet must have one of 'source' or 'text' set";
message = "Each CSS snippet must have exactly one of 'source' or 'text' set";
}
{
assertion = builtins.all (
vault:
builtins.all
(file: (file.source == null || file.text == null) && (file.source != null || file.text != null))
(file: (file.source != null && file.text == null) || (file.source == null && file.text != null))
(
lib.lists.optionals (vault.settings.extraFiles != null) (
builtins.attrValues vault.settings.extraFiles
)
)
) (builtins.attrValues cfg.vaults);
message = "Each extra file must have one of 'source' or 'text' set";
message = "Each extra file must have exactly one of 'source' or 'text' set";
}
];
};