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.

Sign up for GitHub

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 3 commits into
base: master
Choose a base branch
from
Open

ghostty: allow darwin users to manager their config #6300

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cbb6ba5
ghostty: allow darwin users to manager their config
anund Jan 7, 2025
b948bae
ghostty: guard all package access with isLinux
anund Jan 10, 2025
6be244f
ghostty: allow nullable
anund Jan 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 34 additions & 8 deletions modules/programs/ghostty.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@ in {
options.programs.ghostty = {
enable = lib.mkEnableOption "Ghostty";

package = lib.mkPackageOption pkgs "ghostty" { };
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 •
edited
Loading

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.

Copy link
Contributor Author

@anund anund Jan 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Turns out this trying to avoid installing only on linux brings in different complications. When we just gate on isLinux we add a synchronization point with nixpkgs. If nixpkgs gains a darwin version of ghostty (as some are working on) this module will have to change at the ~same as it's introduced into nixpkgs. Addtionally, to a lesser degree, it also interferes with users ability to set their own package if they figure out some work around for themselves. If, say, a *bsd or darwin user gets a package working for themselves before it lands in nixpkgs they would not be able to use the module as is.

There's a bit of weirdness around a transition from broken -> working for macos users too. If a nixpkgs copy exists some users will want that copy and some will want the macos managed version instead. (technically this could also be the case for nix on Arch)

To me this suggests setting nullable: true and handling the null case. Trying to default to the 'right' value for darwin users runs into that point above around choosing darwin or nix hosted packages. My user facing suggestion for that is adding an assertion: (!lib.meta.availableOn stdenv.hostPlatform cfg.package) -> (cfg.package == null) with the message "programs.ghostty.package is marked as broken on your platform, set the value to null to manage your configuration without installing the package" While it's possible ghostty darwin becomes a package there isn't an easy option to avoid setting the package to null, as far as I can see.

Copy link
Member

Choose a reason for hiding this comment

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

Handling null for package is exactly the path I have chosen for my private Ghostty module. I support that route.


settings = lib.mkOption {
inherit (keyValue) type;
Expand Down Expand Up @@ -78,7 +82,9 @@ in {
installBatSyntax =
lib.mkEnableOption "installation of Ghostty configuration syntax for bat"
// {
default = true;
default = cfg.package != null;
defaultText =
"Enabled by default when programs.ghostty.package is not null.";
anund marked this conversation as resolved.
Show resolved Hide resolved
};

enableBashIntegration = lib.mkEnableOption ''
Expand Down Expand Up @@ -108,35 +114,55 @@ in {

config = lib.mkIf cfg.enable (lib.mkMerge [
{
home.packages = [ cfg.package ];
home.packages = lib.mkIf (cfg.package != null) [ cfg.package ];
anund marked this conversation as resolved.
Show resolved Hide resolved

programs.ghostty.settings = lib.mkIf cfg.clearDefaultKeybinds {
keybind = lib.mkBefore [ "clear" ];
};

# MacOS also supports XDG configuration directory, so we use it for both
# Linux and macOS to reduce complexity
xdg.configFile = lib.mkMerge [
xdg.configFile = let
validate = file:
lib.mkIf (cfg.package != null) "${
lib.getExe cfg.package
} +validate-config --config-file=${config.xdg.configHome}/ghostty/${file}";
in lib.mkMerge [
{
"ghostty/config" = lib.mkIf (cfg.settings != { }) {
source = keyValue.generate "ghostty-config" cfg.settings;
onChange = "${lib.getExe cfg.package} +validate-config";
onChange = validate "config";
};
}

(lib.mkIf (cfg.themes != { }) (lib.mapAttrs' (name: value: {
name = "ghostty/themes/${name}";
value.source = keyValue.generate "ghostty-${name}-theme" value;
value = {
source = keyValue.generate "ghostty-${name}-theme" value;
onChange = validate "themes/${name}";
};
}) cfg.themes))
];
}

(lib.mkIf cfg.installVimSyntax {
programs.vim.plugins = [ cfg.package.vim ];
assertions = [{
assertion = lib.elem "vim" cfg.package.outputs or [ ];
message =
"programs.ghostty.package does not have a vim output or is null.";
}];

programs.vim.plugins = lib.mkIf (cfg.package != null) [ cfg.package.vim ];
anund marked this conversation as resolved.
Show resolved Hide resolved
})

(lib.mkIf cfg.installBatSyntax {
programs.bat = {
assertions = [{
assertion = cfg.package != null;
message =
"Cannot install bat syntax when programs.ghostty.package is null.";
}];

programs.bat = lib.mkIf (cfg.package != null) {
anund marked this conversation as resolved.
Show resolved Hide resolved
syntaxes.ghostty = {
src = cfg.package;
file = "share/bat/syntaxes/ghostty.sublime-syntax";
Expand Down
Loading