mirror of
https://github.com/nix-community/home-manager
synced 2024-11-30 06:59:45 +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
126 lines
4 KiB
Nix
126 lines
4 KiB
Nix
{ homeDirectory, lib, pkgs }:
|
|
|
|
let
|
|
inherit (lib) hasPrefix hm literalExpression mkDefault mkIf mkOption removePrefix types;
|
|
in
|
|
{
|
|
# Constructs a type suitable for a `home.file` like option. The
|
|
# target path may be either absolute or relative, in which case it
|
|
# is relative the `basePath` argument (which itself must be an
|
|
# absolute path).
|
|
#
|
|
# Arguments:
|
|
# - opt the name of the option, for self-references
|
|
# - basePathDesc docbook compatible description of the base path
|
|
# - basePath the file base path
|
|
fileType = opt: basePathDesc: basePath: types.attrsOf (types.submodule (
|
|
{ name, config, ... }: {
|
|
options = {
|
|
enable = mkOption {
|
|
type = types.bool;
|
|
default = true;
|
|
description = ''
|
|
Whether this file should be generated. This option allows specific
|
|
files to be disabled.
|
|
'';
|
|
};
|
|
target = mkOption {
|
|
type = types.str;
|
|
apply = p:
|
|
let
|
|
absPath = if hasPrefix "/" p then p else "${basePath}/${p}";
|
|
in
|
|
removePrefix (homeDirectory + "/") absPath;
|
|
defaultText = literalExpression "name";
|
|
description = ''
|
|
Path to target file relative to ${basePathDesc}.
|
|
'';
|
|
};
|
|
|
|
text = mkOption {
|
|
default = null;
|
|
type = types.nullOr types.lines;
|
|
description = ''
|
|
Text of the file. If this option is null then
|
|
[](#opt-${opt}._name_.source)
|
|
must be set.
|
|
'';
|
|
};
|
|
|
|
source = mkOption {
|
|
type = types.path;
|
|
description = ''
|
|
Path of the source file or directory. If
|
|
[](#opt-${opt}._name_.text)
|
|
is non-null then this option will automatically point to a file
|
|
containing that text.
|
|
'';
|
|
};
|
|
|
|
executable = mkOption {
|
|
type = types.nullOr types.bool;
|
|
default = null;
|
|
description = ''
|
|
Set the execute bit. If `null`, defaults to the mode
|
|
of the {var}`source` file or to `false`
|
|
for files created through the {var}`text` option.
|
|
'';
|
|
};
|
|
|
|
recursive = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = ''
|
|
If the file source is a directory, then this option
|
|
determines whether the directory should be recursively
|
|
linked to the target location. This option has no effect
|
|
if the source is a file.
|
|
|
|
If `false` (the default) then the target
|
|
will be a symbolic link to the source directory. If
|
|
`true` then the target will be a
|
|
directory structure matching the source's but whose leafs
|
|
are symbolic links to the files of the source directory.
|
|
'';
|
|
};
|
|
|
|
onChange = mkOption {
|
|
type = types.lines;
|
|
default = "";
|
|
description = ''
|
|
Shell commands to run when file has changed between
|
|
generations. The script will be run
|
|
*after* the new files have been linked
|
|
into place.
|
|
|
|
Note, this code is always run when `recursive` is
|
|
enabled.
|
|
'';
|
|
};
|
|
|
|
force = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
visible = false;
|
|
description = ''
|
|
Whether the target path should be unconditionally replaced
|
|
by the managed file source. Warning, this will silently
|
|
delete the target regardless of whether it is a file or
|
|
link.
|
|
'';
|
|
};
|
|
};
|
|
|
|
config = {
|
|
target = mkDefault name;
|
|
source = mkIf (config.text != null) (
|
|
mkDefault (pkgs.writeTextFile {
|
|
inherit (config) text;
|
|
executable = config.executable == true; # can be null
|
|
name = hm.strings.storeFileName name;
|
|
})
|
|
);
|
|
};
|
|
}
|
|
));
|
|
}
|