xmonad: add libFiles option #1765
Conversation
| if [[ -v DISPLAY ]] ; then | ||
| echo "Restarting xmonad" | ||
| $DRY_RUN_CMD ${config.xsession.windowManager.command} --restart | ||
| fi |
There was a problem hiding this comment.
I would gate the auto restarting behind an option that defaults to false if it can have any unwanted behavior (closing applications, crashing, etc.).
| @@ -75,27 +75,57 @@ in { | |||
| by Home Manager. | |||
| ''; | |||
| }; | |||
|
|
|||
| libFiles = mkOption { | |||
| type = types.attrs; | |||
There was a problem hiding this comment.
| type = types.attrs; | |
| type = types.attrsOf (types.oneOf [ types.package types.path ]); |
More precise tying.
Would it make sense to allow the user to use a multiline string directly here?
In which case the oneOf should be changed to oneOf [ ..... types.lines ].
There was a problem hiding this comment.
The values in libFiles are (right now at least, see rycee's comment below) assigned to home.file.".xmonad/lib/Something.hs".source which means, if I understand the documentation correctly, that only path-values are allowed. So maybe the type should be types.attrsOf types.path; On the other hand: it would of course be nice to be able to use lines also (as the name of the files is anyway given in the key).
|
I think the better option would be to change the module to build an ready xmonad package and reference that binary in `.xsession`. Then it wouldn't be necessary to bother with it in the activation script or put files in `~/.xmonad`. Any error in `xmonad.hs` would then also be discovered during configuration build, not activation.
|
How would one go about this? Are there any other modules which do something similar? |
I think you could achieve this using something like the following as a basis (not tested): pkgs.runCommandLocal "xmonad-compile" {
inherit (cfg) libFiles;
passAsFile = [ "libFiles" ];
nativeBuildInputs = [ xmonad ];
} ''
mkdir -p $out/bin
export XMONAD_CONFIG_DIR="$(pwd)/xmonad-config"
export XMONAD_DATA_DIR="$(pwd)/data"
export XMONAD_CACHE_DIR="$(pwd)/cache"
mkdir -p "$XMONAD_CONFIG_DIR/lib" "$XMONAD_CACHE_DIR" "$XMONAD_DATA_DIR"
cp ${cfg.config} xmonad-config/xmonad.hs
# Copied from symlinkJoin, copies libFiles files to Xmonad's expected lib folder
for i in $(cat $libFilesPath); do
${pkgs.xlibs.lndir}/bin/lndir -silent $i xmonad-config/lib
done
xmonad --recompile
# The resulting binary name depends on the arch and os
# https://github.com/xmonad/xmonad/blob/56b0f850bc35200ec23f05c079eca8b0a1f90305/src/XMonad/Core.hs#L565-L572
mv "$XMONAD_DATA_DIR/xmonad-${pkgs.hostPlatform.system}" $out/bin/
''The result of this expression would need to be assigned to see: |
|
It might be possible to do something with `pkgs.writers.writeHaskellBin`, like in the NixOS xmonad module?
|
|
@berbiche I just tried your code and the and unfortunately it doesn't compile. The offending line seems to be Is this a trivial error? I wasn't able to find a to find a solution quickly, but anyway it should be possible to access |
|
I have now a solution that works but may need some adjustments to be more idiomatic: config = mkIf cfg.enable (mkMerge [
{
home.packages = [ (lowPrio xmonad) ];
xsession.windowManager.command = "xmonad";
}
(mkIf (cfg.config != null) {
home.file.".xmonad/xmonad-${pkgs.hostPlatform.system}" = {
source = "${
pkgs.runCommandLocal "xmonad-compile" {
nativeBuildInputs = [ xmonad ];
unpackPhase = "true";
installPhase = "true";
} ''
mkdir -p $out/bin
export XMONAD_CONFIG_DIR="$(pwd)/xmonad-config"
export XMONAD_DATA_DIR="$(pwd)/data"
export XMONAD_CACHE_DIR="$(pwd)/cache"
mkdir -p "$XMONAD_CONFIG_DIR/lib" "$XMONAD_CACHE_DIR" "$XMONAD_DATA_DIR"
cp ${cfg.config} xmonad-config/xmonad.hs
declare -A libFiles
libFiles=(${
lib.concatStringsSep " "
(lib.mapAttrsToList (name: value: "['${name}']='${value}'")
cfg.libFiles)
})
for key in "''${!libFiles[@]}"; do
cp "''${libFiles[$key]}" "xmonad-config/lib/$key";
done
xmonad --recompile
# The resulting binary name depends on the arch and os
# https://github.com/xmonad/xmonad/blob/56b0f850bc35200ec23f05c079eca8b0a1f90305/src/XMonad/Core.hs#L565-L572
mv "$XMONAD_DATA_DIR/xmonad-${pkgs.hostPlatform.system}" $out/bin/
''
}/bin/xmonad-${pkgs.hostPlatform.system}";
onChange = ''
# Attempt to restart xmonad if X is running.
if [[ -v DISPLAY ]] ; then
echo "Restarting xmonad"
$DRY_RUN_CMD ${config.xsession.windowManager.command} --restart
fi
'';
};
})
]);The solution is mostly @berbiche's suggestion but with a different way of passing the I also tried to set |
|
One last thing: please set the resulting binary obtained from the compilation step to |
Done! One thing I just recognized is that with this new approach |
We could always install the files in |
Yes, that works (although after Shall I link the xmonad-config files to The code would look like this: (mkIf (cfg.config != null) {
home.file.".xmonad/xmonad.hs".source = cfg.config;
home.file.".xmonad/xmonad-${pkgs.hostPlatform.system}" = {
source = xmonadBin;
onChange = ''
# Attempt to restart xmonad if X is running.
if [[ -v DISPLAY ]] ; then
echo "Restarting xmonad"
$DRY_RUN_CMD ${config.xsession.windowManager.command} --restart
fi
'';
};
})
{
home.file = lib.mapAttrs' (name: value:
lib.attrsets.nameValuePair (".xmonad/lib/" + name) {
source = value;
}) cfg.libFiles;
} |
|
@markusscherer For the sample code you don't need the |
|
@rycee I'd like to hear your thoughts before merging this. The PR looks good to me. The only thing that could potentially become an issue is https://github.com/nix-community/home-manager/pull/1765/files#diff-47cbc76991d0d9b568f0f62b0b31aee6f69652b7302a7e1836e7adbe65041cc5R131-R133 but even then it will be caught during the build phase. |
The `libFiles` option allows Home Manager to manage additional files for xmonad. Also compile xmonad during configuration build time. This avoids the need to compile the configuration during activation.
|
Had a chance to try it out and it worked just fine. Much nicer to do the compilation during configuration build time instead of activation time. Many thanks @markusscherer and @berbiche! |
This is expected breakage because of the shenanigans involved in reusing the home-manager xmonad configuration but trying to shoehorn it into something managed by xfce-session.
|
For some reason, if I use an overlay to update to the git version of xmonad and xmonad-contrib, I get the following error on rebuild: The overlay is: self: super:
{
haskellPackages = with self.haskell.lib; super.haskellPackages.extend (packageSourceOverrides {
X11 = builtins.fetchTarball {
url = "https://hackage.haskell.org/package/X11-1.10/X11-1.10.tar.gz";
};
xmonad = builtins.fetchTarball {
url = "https://github.com/xmonad/xmonad/archive/refs/heads/master.tar.gz";
};
xmonad-contrib = builtins.fetchTarball {
url = "https://github.com/xmonad/xmonad-contrib/archive/refs/heads/master.tar.gz";
};
});
}(yeah I know it's super lazy, but I'm hoping the next XMonad release is around the corner...) It seems like it diff --git a/modules/services/window-managers/xmonad.nix b/modules/services/window-managers/xmonad.nix
index 07ed284..de4945a 100644
--- a/modules/services/window-managers/xmonad.nix
+++ b/modules/services/window-managers/xmonad.nix
@@ -101,7 +101,7 @@ in {
xmonadBin = "${
pkgs.runCommandLocal "xmonad-compile" {
- nativeBuildInputs = [ xmonad ];
+ nativeBuildInputs = [ (pkgs.haskellPackages.ghcWithPackages (p: [p.X11 p.xmonad p.xmonad-contrib])) xmonad ];
} ''
mkdir -p $out/binbut this is probably a bit too heavy handed and I didn't have time to investigate further. My hypothesis is that between the released version of xmonad and the git version, the mechanism for |
|
Sooner the better! 😄 |
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/use-latest-version-of-xmonad-0-17-0/16191/11 |
The libFiles option allows home-manager to manage additional files for
xmonad in
.xmonad/lib. The advantage of doing it like this compared tojust using
home.file.".xmonad/lib/File.hs".sourceis, that we candetect file changes and recompile xmonad accordingly.
Description
This commit adds an option
libFilesthat allows to add additional files to.xmonad/libs/.The xmonad recompilation process can access files stored in this directory as modules, therefore they can influence the configuration. When we would add these files via
home.file.".xmonad/lib/File.hs".source, changes to them would not cause xmonad to be recompiled, thereby making it necessary to callxmonad --recompile && xmonad -- restartafterhome-manager switch.If such files are added via the new
libFilesoption, changes to them cause a recompilation.Right now, unfortunately, if both
xmonad.hsand the files inlibFileschange, xmonad is recompiled once for every changed file, as I don't know yet how one could implement this in an elegant way.Note, that right now there are no tests for xmonad but since only an option is added to an xmonad specific file, other components should not be affected (also, when running
nix-shell --pure tests -A run.allagainst the branch I'm tracking,release-20.09, all tests passed).Checklist
Change is backwards compatible.
Code formatted with
./format.Code tested through
nix-shell --pure tests -A run.all.Test cases updated/added. See example.
Commit messages are formatted like
See CONTRIBUTING for more information and recent commit messages for examples.