1
0
Fork 0
mirror of https://github.com/nix-community/home-manager.git synced 2025-11-08 11:36:05 +01:00
home-manager/modules/programs/emacs.nix
Austin Horstman 86402a17b6 treewide: flatten single file modules
Some files don't need nesting and can be root level again to reduce
conflicts with other PRs.

Signed-off-by: Austin Horstman <khaneliman12@gmail.com>
2025-06-23 16:20:26 -05:00

113 lines
3 KiB
Nix

{
config,
lib,
pkgs,
...
}:
let
inherit (lib)
literalExpression
mkIf
mkOption
types
;
cfg = config.programs.emacs;
# Copied from all-packages.nix, with modifications to support
# overrides.
emacsPackages =
let
epkgs = pkgs.emacsPackagesFor cfg.package;
in
epkgs.overrideScope cfg.overrides;
emacsWithPackages = emacsPackages.emacsWithPackages;
extraPackages =
epkgs:
let
packages = cfg.extraPackages epkgs;
userConfig = epkgs.trivialBuild {
pname = "default";
src = pkgs.writeText "default.el" cfg.extraConfig;
version = "0.1.0";
packageRequires = packages;
};
in
packages ++ lib.optional (cfg.extraConfig != "") userConfig;
in
{
meta.maintainers = [ lib.maintainers.rycee ];
options = {
programs.emacs = {
enable = lib.mkEnableOption "Emacs";
package = lib.mkPackageOption pkgs "emacs" { example = "pkgs.emacs25-nox"; };
# NOTE: The config is placed in default.el instead of ~/.emacs.d so that
# it won't conflict with Emacs configuration frameworks. Users of these
# frameworks would still benefit from this option as it would easily allow
# them to have Nix-computed paths in their configuration.
extraConfig = mkOption {
type = types.lines;
default = "";
example = ''
(setq standard-indent 2)
'';
description = ''
Configuration to include in the Emacs default init file. See
<https://www.gnu.org/software/emacs/manual/html_node/elisp/Init-File.html>
for more.
Note, the `inhibit-startup-message` Emacs option
cannot be set here since Emacs disallows setting it from the default
initialization file.
'';
};
extraPackages = mkOption {
default = self: [ ];
type = lib.hm.types.selectorFunction;
defaultText = "epkgs: []";
example = literalExpression "epkgs: [ epkgs.emms epkgs.magit ]";
description = ''
Extra packages available to Emacs. To get a list of
available packages run:
{command}`nix-env -f '<nixpkgs>' -qaP -A emacsPackages`.
'';
};
overrides = mkOption {
default = self: super: { };
type = lib.hm.types.overlayFunction;
defaultText = "self: super: {}";
example = literalExpression ''
self: super: rec {
haskell-mode = self.melpaPackages.haskell-mode;
# ...
};
'';
description = ''
Allows overriding packages within the Emacs package set.
'';
};
finalPackage = mkOption {
type = types.package;
visible = false;
readOnly = true;
description = ''
The Emacs package including any overrides and extra packages.
'';
};
};
};
config = mkIf cfg.enable {
home.packages = [ cfg.finalPackage ];
programs.emacs.finalPackage = emacsWithPackages extraPackages;
};
}