home-manager/tests/modules/services/emacs/default.nix

{
  emacs-service-27 = ./emacs-service-27.nix;
  emacs-service-28 = ./emacs-service-28.nix;
  emacs-service-28-after-graphical-session-target =
    ./emacs-service-28-after-graphical-session-target.nix;
  emacs-socket-27 = ./emacs-socket-27.nix;
  emacs-socket-28 = ./emacs-socket-28.nix;
  emacs-default-editor = ./emacs-default-editor.nix;
  emacs-socket-and-startWithUserSession =
    ./emacs-socket-and-startWithUserSession.nix;
}
emacs: Support socket activation via systemd Add 'services.emacs.socketActivation.enable' for generating an 'emacs.socket' systemd unit. Emacs since version 26 has supported socket activation, whereby an external process manager such as systemd listens on a socket and passes it to the Emacs daemon when the manager launches it. This improves startup time of the user session and avoids launching the daemon when not needed, for example when launching the user session via SSH. This implementation hard-codes the socket path to the default for the version of 'programs.emacs.finalPackage', because systemd does not perform shell expansion in the socket unit's 'ListenStream' parameter and it seems like an advanced use-case to change the socket path. Shell expansion would be desirable as the socket path usually resides in directories such as $XDG_RUNTIME_DIR or $TMPDIR. Tests were added to verify behavior in the following cases: - Emacs service with socket activation disabled - Emacs 26 with socket activation enabled - Emacs 27 with socket activation enabled PR #1314 2020-06-08 21:01:17 +00:00			`{`
services/emacs: Update systemd definitions, drop Emacs 26 support Emacs 27 added Type=notify support and updated the service definition to remove the use of `emacsclient' to kill the service. Emacs 28 changes the `StartupWMClass' in emacsclient.desktop to `Emacsd'. Update our emacs.service and emacsclient.desktop definitions to match upstream changes. When killing emacs.service, the socket is removed, and subsequently starting the service manually results in a service without a socket. Prevent this by adding `RefuseManualStart=true' to the service's Unit definition. Drop Emacs 26 support as it is no longer shipped in nixpkgs. Update the tests to verify the following configuration scenarios: - Emacs version: 27, 28 - Socket activation: disabled, enabled 2021-05-23 20:24:30 +00:00			`emacs-service-27 = ./emacs-service-27.nix;`
			`emacs-service-28 = ./emacs-service-28.nix;`
emacs: extend startWithUserSession to start after graphical session (#3010) 2023-05-11 11:58:37 +00:00			`emacs-service-28-after-graphical-session-target =`
			`./emacs-service-28-after-graphical-session-target.nix;`
emacs: Support socket activation via systemd Add 'services.emacs.socketActivation.enable' for generating an 'emacs.socket' systemd unit. Emacs since version 26 has supported socket activation, whereby an external process manager such as systemd listens on a socket and passes it to the Emacs daemon when the manager launches it. This improves startup time of the user session and avoids launching the daemon when not needed, for example when launching the user session via SSH. This implementation hard-codes the socket path to the default for the version of 'programs.emacs.finalPackage', because systemd does not perform shell expansion in the socket unit's 'ListenStream' parameter and it seems like an advanced use-case to change the socket path. Shell expansion would be desirable as the socket path usually resides in directories such as $XDG_RUNTIME_DIR or $TMPDIR. Tests were added to verify behavior in the following cases: - Emacs service with socket activation disabled - Emacs 26 with socket activation enabled - Emacs 27 with socket activation enabled PR #1314 2020-06-08 21:01:17 +00:00			`emacs-socket-27 = ./emacs-socket-27.nix;`
services/emacs: Update systemd definitions, drop Emacs 26 support Emacs 27 added Type=notify support and updated the service definition to remove the use of `emacsclient' to kill the service. Emacs 28 changes the `StartupWMClass' in emacsclient.desktop to `Emacsd'. Update our emacs.service and emacsclient.desktop definitions to match upstream changes. When killing emacs.service, the socket is removed, and subsequently starting the service manually results in a service without a socket. Prevent this by adding `RefuseManualStart=true' to the service's Unit definition. Drop Emacs 26 support as it is no longer shipped in nixpkgs. Update the tests to verify the following configuration scenarios: - Emacs version: 27, 28 - Socket activation: disabled, enabled 2021-05-23 20:24:30 +00:00			`emacs-socket-28 = ./emacs-socket-28.nix;`
services/emacs: add option to set `emacsclient` as the default editor (#2545) * services/emacs: add `defaultEditor` option Sets `emacsclient` as the default editor using the `EDITOR` environment variable. 2022-01-10 07:17:13 +00:00			`emacs-default-editor = ./emacs-default-editor.nix;`
emacs: optionally start service with the session Add services.emacs.startWithUserSession boolean to indicate that Emacs must be started with the systemd user session. This is true by default unless socket activation is also true. In the past, the user had to choose between socket activation (to get the Emacs service started when the user uses emacsclient) and immediate start with the user session. When choosing immediate start over socket activation and if the Emacs service is stopped at some point, using emacsclient would start a new Emacs daemon but the service would still be turned off. This situation would prevent `home-manager switch` from completing successfully because it wouldn't be able to start the Emacs service as Emacs is already running. This new setting makes it possible to have both socket activation and immediate start at the same time. In this scenario, Emacs is started with the user session and, after the Emacs service is stopped, using emacsclient starts the service again. This new settings also makes it possible to have neither socket activation nor immediate start. 2022-05-06 05:13:20 +00:00			`emacs-socket-and-startWithUserSession =`
			`./emacs-socket-and-startWithUserSession.nix;`
emacs: Support socket activation via systemd Add 'services.emacs.socketActivation.enable' for generating an 'emacs.socket' systemd unit. Emacs since version 26 has supported socket activation, whereby an external process manager such as systemd listens on a socket and passes it to the Emacs daemon when the manager launches it. This improves startup time of the user session and avoids launching the daemon when not needed, for example when launching the user session via SSH. This implementation hard-codes the socket path to the default for the version of 'programs.emacs.finalPackage', because systemd does not perform shell expansion in the socket unit's 'ListenStream' parameter and it seems like an advanced use-case to change the socket path. Shell expansion would be desirable as the socket path usually resides in directories such as $XDG_RUNTIME_DIR or $TMPDIR. Tests were added to verify behavior in the following cases: - Emacs service with socket activation disabled - Emacs 26 with socket activation enabled - Emacs 27 with socket activation enabled PR #1314 2020-06-08 21:01:17 +00:00			`}`