mirror of
https://github.com/nix-community/home-manager
synced 2024-11-18 00:59:44 +01:00
9f9e277b60
These (and the `*MD` functions apart from `literalMD`) are now no-ops
in nixpkgs and serve no purpose other than to add additional noise and
potentially mislead people into thinking unmarked DocBook documentation
will still be accepted.
Note that if backporting changes including documentation to 23.05,
the `mdDoc` calls will need to be re-added.
To reproduce this commit, run:
$ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
nix shell nixpkgs#coreutils \
-c find . -name '*.nix' \
-exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
--strip {} +
$ ./format
104 lines
3 KiB
Nix
104 lines
3 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
|
|
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;
|
|
packageRequires = packages;
|
|
};
|
|
in packages ++ optional (cfg.extraConfig != "") userConfig;
|
|
|
|
in {
|
|
meta.maintainers = [ maintainers.rycee ];
|
|
|
|
options = {
|
|
programs.emacs = {
|
|
enable = mkEnableOption "Emacs";
|
|
|
|
package = mkOption {
|
|
type = types.package;
|
|
default = pkgs.emacs;
|
|
defaultText = literalExpression "pkgs.emacs";
|
|
example = literalExpression "pkgs.emacs25-nox";
|
|
description = "The Emacs package to use.";
|
|
};
|
|
|
|
# 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 = 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 = 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;
|
|
};
|
|
}
|