treewide: add stylix.enable option

[jalil-salame]

About

Add a stylix.enable option to enable or disable all Stylix modules in order to resolve issues similar to #216.

To align with the default lib.mkEnableOption behavior, stylix.enable defaults to false.

Breaking Change

Stylix is disabled by default. To enable it, use:

stylix.enable = true;

Closes

• stylix: add an enable option #216

Steps

• Manually integration test in NixOS setup 2
• Manually integration test in Home Manager setup 1
• gnome: use internal mkEnableTarget function #397
• stylix: standardize autoEnable and mkEnableTarget documentation #398
• stylix: simplify mkEnableTarget documentation #399

Unresolved Questions

• Can docs/settings.nix be removed due to the new stylix.enable option: treewide: add stylix.enable option #244 (comment)?

[jalil-salame]

I don't have the bandwidth to test this PR, seeing that it has been stale for ~3 months I'll mark it as ready, and if someone tests it and finds some problems I'll happily fix them.

[jalil-salame]

Ci is failing, I think we need to set sylix.enable = true in CI.

[trueNAHO]

Ci is failing, I think we need to set sylix.enable = true in CI.

CI is successful now: https://github.com/danth/stylix/actions/runs/8958380642.

I tested stylix.enable = false; and stylix.enable = true; in my Home Manger configuration, and so far everything works as expected.

@jalil-salame, could you maybe double check this PR on your setup?

[jalil-salame]

My setup relies on #201 so it would be a mess to use this PR sadly.

[jalil-salame]

I was nerd sniped into trying it out anyways, both true and false work (with some minor modifications). By work I mean compile, my styling relies on #201 so it is broken in this PR.

[trueNAHO]

I tested stylix.enable = false; and stylix.enable = true; in my Home Manger configuration, and so far everything works as expected.

[jalil-salame]

I'm adding this PR to my config (here if you are curious), so I'll be able to test the Linux modules a bit more thoroughly soon c:

[trueNAHO]

Considering that stylix.enable defaults to false, why does f957c28 cause the following error:

$ nix build .#docs
error:
       … while calling the 'derivationStrict' builtin

         at /builtin/derivation.nix:9:12: (source not available)

       … while evaluating derivation 'stylix-book'
         whose name attribute is located at /nix/store/3lllcglr2ip90mkxs5q4asl98r305mia-source/pkgs/stdenv/generic/make-derivation.nix:331:7

       … while evaluating attribute 'patchPhase' of derivation 'stylix-book'

         at /nix/store/blw4ppvzwz08gw7dxbc41pxv83qgr6pi-source/docs/default.nix:44:3:

           43|
           44|   patchPhase = ''
             |   ^
           45|     cp ${../README.md} src/README.md

       (stack trace truncated; use '--show-trace' to show the full trace)

       error: A definition for option `stylix.image' is not of type `path or package convertible to it'. Definition values:
       - In `/nix/store/3lllcglr2ip90mkxs5q4asl98r305mia-source/flake.nix': null

Ideally, it should be possible to revert e8e3304.

[trueNAHO]

For reference, I would use the following commit message when merging this PR:

stylix: add 'stylix.enable' option

Add a 'stylix.enable' option to enable or disable all Stylix modules in
order to resolve issues similar to [2].

To align with the default 'lib.mkEnableOption' [1] behavior,
'stylix.enable' defaults to 'false'.

BREAKING CHANGE: Stylix is disabled by default. To enable it, use:

    stylix.enable = true;

[1]: https://github.com/NixOS/nixpkgs/blob/23.11/lib/options.nix#L91-L105
[2]: https://github.com/danth/stylix/issues/216

[jalil-salame]

Considering that stylix.enable defaults to false, why does f957c28 cause the following error:

$ nix build .#docs
error:
       … while calling the 'derivationStrict' builtin

         at /builtin/derivation.nix:9:12: (source not available)

       … while evaluating derivation 'stylix-book'
         whose name attribute is located at /nix/store/3lllcglr2ip90mkxs5q4asl98r305mia-source/pkgs/stdenv/generic/make-derivation.nix:331:7

       … while evaluating attribute 'patchPhase' of derivation 'stylix-book'

         at /nix/store/blw4ppvzwz08gw7dxbc41pxv83qgr6pi-source/docs/default.nix:44:3:

           43|
           44|   patchPhase = ''
             |   ^
           45|     cp ${../README.md} src/README.md

       (stack trace truncated; use '--show-trace' to show the full trace)

       error: A definition for option `stylix.image' is not of type `path or package convertible to it'. Definition values:
       - In `/nix/store/3lllcglr2ip90mkxs5q4asl98r305mia-source/flake.nix': null

Ideally, it should be possible to revert e8e3304.

I'd need to look at the code carefully, but if a lib.mkIf removes imports or options then you'd expect that behavior.

[trueNAHO]

Considering that stylix.enable defaults to false, why does f957c28 cause the following error:

$ nix build .#docs
error:
       … while calling the 'derivationStrict' builtin

         at /builtin/derivation.nix:9:12: (source not available)

       … while evaluating derivation 'stylix-book'
         whose name attribute is located at /nix/store/3lllcglr2ip90mkxs5q4asl98r305mia-source/pkgs/stdenv/generic/make-derivation.nix:331:7

       … while evaluating attribute 'patchPhase' of derivation 'stylix-book'

         at /nix/store/blw4ppvzwz08gw7dxbc41pxv83qgr6pi-source/docs/default.nix:44:3:

           43|
           44|   patchPhase = ''
             |   ^
           45|     cp ${../README.md} src/README.md

       (stack trace truncated; use '--show-trace' to show the full trace)

       error: A definition for option `stylix.image' is not of type `path or package convertible to it'. Definition values:
       - In `/nix/store/3lllcglr2ip90mkxs5q4asl98r305mia-source/flake.nix': null

Ideally, it should be possible to revert e8e3304.

I'd need to look at the code carefully, but if a lib.mkIf removes imports or options then you'd expect that behavior.

Considering this merely cleans up the code, this should probably be addressed in a followup-PR.

NOTE: I added a list of things that should be verified right before merging, to the first PR message.

@danth, could you review this PR?

[trueNAHO]

I rebased this PR on top of master and added an additional breaking change note to the top-level README.

I tested stylix.enable = false; and stylix.enable = true; in my Home Manger configuration once again, and so far everything works as expected.

Could someone test this in a NixOS setup?

[jalil-salame]

I am testing in in my configuration, but setting stylix.enable = false; on my nixos configuration does nothing, the styling is still applied.

Edit: I had autoEnable = true set. The behavior of autoEnable is similar to enable, we might want to consider changing this.

[jalil-salame]

Works on my configuration now that I fixed the autoEnable thing c:

[danth]

I managed to do the first part with some sed magic, just need to go through and fix the second issue by hand now.

[danth]

I think this is ready to merge.

[danth]

Can docs/settings.nix be removed due to the new stylix.enable option?

Not yet: although the option is not required any more, the default value for stylix.image is still of an incorrect type, so it needs to be overridden. This will be fixed in #407, after which it should be possible to remove the file.

[trueNAHO]

Is the following commit message good:

stylix: add 'stylix.enable' option

Add a 'stylix.enable' option to enable or disable all Stylix modules in
order to resolve issues similar to [2].

To align with the default 'lib.mkEnableOption' [1] behavior,
'stylix.enable' defaults to 'false'.

BREAKING CHANGE: Stylix is disabled by default. To enable it, use:

    stylix.enable = true;

[1]: https://github.com/NixOS/nixpkgs/blob/23.11/lib/options.nix#L91-L105
[2]: https://github.com/danth/stylix/issues/216

Co-authored-by: Daniel Thwaites <[email protected]>
Co-authored-by: Jalil David Salamé Messina <[email protected]>
Co-authored-by: NAHO <[email protected]>

[danth]

Yep, I had already set that for auto-merge, just using ` rather than '