Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ghostty: allow darwin users to manager their config #6300

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

anund
Copy link
Contributor

@anund anund commented Jan 10, 2025

Description

Currently nixpkgs does not contain a package defintion for ghostty compatible with Darwin. Darwin users may still want to use this module to manage their config or share config between systems. This carries over behaviour from the beta period where this same technique was used.

see: https://github.com/clo4/ghostty-hm-module/blob/887e13a6e7acf5ffaab0119d96e476d84db90904/module.nix#L167-L173

Also improves validation to cover theme files.

Requested via ghostty discord. Testing included building against a local copy of nixpkgs with the ghostty package deleted and marked as broken.

Checklist

  • Change is backwards compatible.

  • Code formatted with ./format.

  • Code tested through nix-shell --pure tests -A run.all or nix develop --ignore-environment .#all using Flakes.

  • Test cases updated/added. See example.

  • Commit messages are formatted correctly

Maintainer CC

cc @HeitorAugustoLN

modules/programs/ghostty.nix Outdated Show resolved Hide resolved
programs.bat = {
assertions = [{
assertion = cfg.package != null;
message = "cannot install bat syntax while .package is null";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
message = "cannot install bat syntax while .package is null";
message = "Cannot install bat syntax when programs.ghostty.package is null.";

programs.vim.plugins = [ cfg.package.vim ];
assertions = [{
assertion = lib.elem "vim" cfg.package.outputs or [ ];
message = "ghostty.package does not have a vim output or is null";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
message = "ghostty.package does not have a vim output or is null";
message = "programs.ghostty.package does not have a vim output or is null.";

@rycee
Copy link
Member

rycee commented Jan 10, 2025

Seems like a duplicate of #6298?

@HeitorAugustoLN
Copy link
Member

HeitorAugustoLN commented Jan 10, 2025

This is more complete than my PR in #6298. But i'd prefer to make things conditionally if the hostPlaform is darwin.
As @teto commented on #6298 (comment)

@anund
Copy link
Contributor Author

anund commented Jan 10, 2025

I think default = null if the host is darwin might cover the user comment. Nullable was suggested for users managing config across multiple nixos/darwin systems as a ~least worst option.

@anund anund force-pushed the ghostty_darwin_support branch from 60ccfa9 to f61c272 Compare January 10, 2025 10:27
Currently nixpkgs does not contain a package defintion for ghostty
compatible with Darwin. Darwin users may still want to use this module
to manage their config or share config between systems. This carries
over behaviour from the beta period where this same technique was used.

see: https://github.com/clo4/ghostty-hm-module/blob/887e13a6e7acf5ffaab0119d96e476d84db90904/module.nix#L167-L173

Also improves validation to cover theme files.
@anund anund force-pushed the ghostty_darwin_support branch from f61c272 to cbb6ba5 Compare January 10, 2025 10:33
Copy link
Member

@HeitorAugustoLN HeitorAugustoLN left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is how I think this should be handled:

Comment on lines 16 to 20
package = lib.mkPackageOption pkgs "ghostty" {
nullable = true;
extraDescription =
"On darwin set this to null to manage ghostty config while ghostty is not present in nixpkgs.";
};
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to capitalize ghostty in the description

Suggested change
package = lib.mkPackageOption pkgs "ghostty" {
nullable = true;
extraDescription =
"On darwin set this to null to manage ghostty config while ghostty is not present in nixpkgs.";
};
package = lib.mkPackageOption pkgs "Ghostty" { default = [ "ghostty" ]; };

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That doesn't appear to work when nixpkgs is marking the package as broken. Setting the package to null in config isn't allowed (not nullable) and nixpkgs evaluates the default since it is present. This does work when the package isn't present at all.

Copy link
Member

@HeitorAugustoLN HeitorAugustoLN Jan 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It won't be present look at: #6300 (comment)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Testing.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, my mistake on where the actual eval was coming from. "Ghostty" isn't needed if we're guarding all the package sites. mkPackageOption currently only checks for presence not whether or not the package is broken.

I considered checking if the package is broken instead and looked at ~hostPlatform. I think Linux is the only supported output from hostPlatform so that doesn't seem to buy much generality.

modules/programs/ghostty.nix Outdated Show resolved Hide resolved
modules/programs/ghostty.nix Outdated Show resolved Hide resolved
modules/programs/ghostty.nix Outdated Show resolved Hide resolved
modules/programs/ghostty.nix Outdated Show resolved Hide resolved
ghostty is currently marked as broken in nixpkgs. Darwin users still
want to manage ghostty config via home-manager. Avoiding installing the
package and any extra files that depend on the package outside Linux
allows this.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants