diff options
Diffstat (limited to 'nixos/modules/services/editors/emacs.nix')
-rw-r--r-- | nixos/modules/services/editors/emacs.nix | 103 |
1 files changed, 103 insertions, 0 deletions
diff --git a/nixos/modules/services/editors/emacs.nix b/nixos/modules/services/editors/emacs.nix new file mode 100644 index 00000000000..e2bbd27f6e5 --- /dev/null +++ b/nixos/modules/services/editors/emacs.nix @@ -0,0 +1,103 @@ +{ config, lib, pkgs, ... }: + +with lib; + +let + + cfg = config.services.emacs; + + editorScript = pkgs.writeScriptBin "emacseditor" '' + #!${pkgs.runtimeShell} + if [ -z "$1" ]; then + exec ${cfg.package}/bin/emacsclient --create-frame --alternate-editor ${cfg.package}/bin/emacs + else + exec ${cfg.package}/bin/emacsclient --alternate-editor ${cfg.package}/bin/emacs "$@" + fi + ''; + + desktopApplicationFile = pkgs.writeTextFile { + name = "emacsclient.desktop"; + destination = "/share/applications/emacsclient.desktop"; + text = '' + [Desktop Entry] + Name=Emacsclient + GenericName=Text Editor + Comment=Edit text + MimeType=text/english;text/plain;text/x-makefile;text/x-c++hdr;text/x-c++src;text/x-chdr;text/x-csrc;text/x-java;text/x-moc;text/x-pascal;text/x-tcl;text/x-tex;application/x-shellscript;text/x-c;text/x-c++; + Exec=emacseditor %F + Icon=emacs + Type=Application + Terminal=false + Categories=Development;TextEditor; + StartupWMClass=Emacs + Keywords=Text;Editor; + ''; + }; + +in +{ + + options.services.emacs = { + enable = mkOption { + type = types.bool; + default = false; + description = '' + Whether to enable a user service for the Emacs daemon. Use <literal>emacsclient</literal> to connect to the + daemon. If <literal>true</literal>, <varname>services.emacs.install</varname> is + considered <literal>true</literal>, whatever its value. + ''; + }; + + install = mkOption { + type = types.bool; + default = false; + description = '' + Whether to install a user service for the Emacs daemon. Once + the service is started, use emacsclient to connect to the + daemon. + + The service must be manually started for each user with + "systemctl --user start emacs" or globally through + <varname>services.emacs.enable</varname>. + ''; + }; + + + package = mkOption { + type = types.package; + default = pkgs.emacs; + defaultText = literalExpression "pkgs.emacs"; + description = '' + emacs derivation to use. + ''; + }; + + defaultEditor = mkOption { + type = types.bool; + default = false; + description = '' + When enabled, configures emacsclient to be the default editor + using the EDITOR environment variable. + ''; + }; + }; + + config = mkIf (cfg.enable || cfg.install) { + systemd.user.services.emacs = { + description = "Emacs: the extensible, self-documenting text editor"; + + serviceConfig = { + Type = "forking"; + ExecStart = "${pkgs.bash}/bin/bash -c 'source ${config.system.build.setEnvironment}; exec ${cfg.package}/bin/emacs --daemon'"; + ExecStop = "${cfg.package}/bin/emacsclient --eval (kill-emacs)"; + Restart = "always"; + }; + } // optionalAttrs cfg.enable { wantedBy = [ "default.target" ]; }; + + environment.systemPackages = [ cfg.package editorScript desktopApplicationFile ]; + + environment.variables.EDITOR = mkIf cfg.defaultEditor (mkOverride 900 "${editorScript}/bin/emacseditor"); + }; + + meta.doc = ./emacs.xml; +} |