swayimg: init

[sand4rt]

---

• I certify that I have the right to submit this contribution under the MIT license
• Commit messages adhere to Stylix commit conventions
• Theming changes adhere to the Stylix style guide
• Changes have been tested locally
• Changes have been tested in testbeds
• Each commit in this PR is suitable for backport to the current stable branch

[sand4rt]

Any idea why ci fails?

[0xda157]

Any idea why ci fails?

the pre-commit hooks are failing. you can avoid this happening in the future by running nix develop which will install the pre-commit hooks on your local git repo.

---

adding a testbed for this module is highly recommended, so pr reviews can test it themselves and the ci will reflect any configurations issues in the nixpkgs' module system.

[0xda157]

ideally colors and opacity would function independently of each other. the helix and ncspot modules are good examples of this.

[sand4rt]

thanks for the pointers I'm not sure about how i should implement this, im fairly new to nix/stylix. should i add a extra option like;

  extraOptions = {
    background = lib.mkOption {
      type = lib.types.nullOr lib.types.str;
      description = "Used to set bg even if `opacity` or `colors` is null.";
      internal = true;
      default = null;
    };
  };

and then adjust the bg's like?;

gallery = {
    background = lib.mkIf (opacity.applications != 1.0) "#00000000";
}

[trueNAHO]

The pattern is basically that internal options are used to share context across configElements function boundaries.

I suppose the base00 + swayimgOpacity expression should behave as follows:

colors	opacity	Expression
disabled	disabled	undeclared
disabled	enabled	undeclared
enabled	disabled	base00
enabled	enabled	base00 + swayimgOpacity

In that case, you would have something like:

extraOptions.opacity = lib.mkOption {
  type = lib.types.str;
  description = /* ... */;
  internal = true;
  default = "";
};

configElements = [
  (
    { cfg, colors }: {
      programs.swayimg.settings.viewer.window = base00 + cfg.opacity;
    }
  )

  ({ cfg, opacity }: { cfg.opacity = /* swayimgOpacity */; })
];

[trueNAHO]

If you do not wish to publish your email, it might be simpler to not include this optional field:

Suggested change

email = "[email protected]";

This line would also have to be removed in /generated/all-maintainers.nix.

[trueNAHO]

I suppose the following declarations are black for the same reason we have commit ccb411c ("mpv: set background to black (#1008)"):

• stylix/modules/swayimg/hm.nix

  Line 25 in dc3c7b9

  transparency = "#000000ff";

• stylix/modules/swayimg/hm.nix

  Line 29 in dc3c7b9

  background = "#00000000";

• stylix/modules/swayimg/hm.nix

  Line 32 in dc3c7b9

  shadow = "#00000000";

• stylix/modules/swayimg/hm.nix

  Lines 41 to 42 in dc3c7b9

  	shadow = "#000000d0";
  	background = "#00000000";

Why is the transparency once 00 and once ff?

Unsure how I feel about hard-coding #000000d0. Would it not be better to set this one to base00?

[trueNAHO]

Opening a Nix file with an image viewer is probably wrong. What about opening an actual image:

text = "swayimg ${
  (pkgs.callPackages ../../../stylix/testbed/images.nix {}).${
    config.stylix.polarity
  }
}";

[trueNAHO]

The testbed should enable the underlying Home Manager module of our /modules/swayimg/hm.nix module. Take a look at how other testbeds achieve this.

[trueNAHO]

These parentheses should be optional:

Suggested change

	((builtins.floor (opacity.applications * 100 + 0.5)) * 255) / 100
	builtins.floor (opacity.applications * 100 + 0.5) * 255 / 100

[trueNAHO]

This should go into a new configElements function that takes fonts as argument.

[trueNAHO]

The pattern is basically that internal options are used to share context across configElements function boundaries.

I suppose the base00 + swayimgOpacity expression should behave as follows:

colors	opacity	Expression
disabled	disabled	undeclared
disabled	enabled	undeclared
enabled	disabled	base00
enabled	enabled	base00 + swayimgOpacity

In that case, you would have something like:

extraOptions.opacity = lib.mkOption {
  type = lib.types.str;
  description = /* ... */;
  internal = true;
  default = "";
};

configElements = [
  (
    { cfg, colors }: {
      programs.swayimg.settings.viewer.window = base00 + cfg.opacity;
    }
  )

  ({ cfg, opacity }: { cfg.opacity = /* swayimgOpacity */; })
];