mirror of
https://github.com/nix-community/home-manager
synced 2024-06-25 07:58:31 +02: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
111 lines
2.6 KiB
Nix
111 lines
2.6 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
with lib;
|
|
let
|
|
cfg = config.programs.boxxy;
|
|
|
|
configPath = "${config.xdg.configHome}/boxxy/boxxy.yaml";
|
|
settingsFormat = pkgs.formats.yaml { };
|
|
|
|
boxxyRulesOpts = types.submodule {
|
|
freeformType = settingsFormat.type;
|
|
|
|
options = {
|
|
name = mkOption {
|
|
type = types.str;
|
|
description = ''
|
|
Unique identifier of the boxxy rule. This can be any single-line string.
|
|
'';
|
|
};
|
|
|
|
target = mkOption {
|
|
type = types.str;
|
|
default = "";
|
|
example = "~/.ssh";
|
|
description = ''
|
|
What directory/file to redirect.
|
|
'';
|
|
};
|
|
|
|
rewrite = mkOption {
|
|
type = types.str;
|
|
default = "";
|
|
example = literalExpression ''"''${config.xdg.configHome}/ssh"'';
|
|
description = ''
|
|
Where that file/directory should be rewritten to.
|
|
'';
|
|
};
|
|
|
|
mode = mkOption {
|
|
type = types.enum [ "file" "directory" ];
|
|
default = "directory";
|
|
description = ''
|
|
Does the current path redirect a file or a directory?
|
|
'';
|
|
};
|
|
|
|
only = mkOption {
|
|
type = types.listOf types.str;
|
|
default = [ ];
|
|
example = literalExpression ''
|
|
[
|
|
"bash"
|
|
"/usr/bin/sh"
|
|
]
|
|
'';
|
|
description = ''
|
|
Apply redirection ONLY to specified executable names.
|
|
'';
|
|
};
|
|
|
|
context = mkOption {
|
|
type = types.listOf types.str;
|
|
default = [ ];
|
|
example = [ "/home/example/Projects/my-project" ];
|
|
description = ''
|
|
Apply redirection ONLY when in a certain directory.
|
|
'';
|
|
};
|
|
|
|
env = mkOption {
|
|
type = types.attrsOf types.str;
|
|
default = { };
|
|
example = literalExpression ''
|
|
{
|
|
MY_ENV_VAR = "my_env_var_value";
|
|
}
|
|
'';
|
|
description = ''
|
|
Give certain environment variables for said match.
|
|
'';
|
|
};
|
|
};
|
|
};
|
|
in {
|
|
options.programs.boxxy = {
|
|
enable = mkEnableOption "boxxy: Boxes in badly behaving applications";
|
|
|
|
package = mkPackageOption pkgs "boxxy" { };
|
|
|
|
rules = mkOption {
|
|
type = types.listOf boxxyRulesOpts;
|
|
default = [ ];
|
|
description = "List of boxxy rules";
|
|
};
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
assertions =
|
|
[ (hm.assertions.assertPlatform "programs.boxxy" pkgs platforms.linux) ];
|
|
|
|
home.file = mkIf (cfg.rules != [ ]) {
|
|
"${configPath}".source =
|
|
settingsFormat.generate "boxxy-config.yaml" { rules = cfg.rules; };
|
|
};
|
|
|
|
home.packages = [ cfg.package ];
|
|
};
|
|
|
|
meta.maintainers = with lib.hm.maintainers; [ nikp123 ];
|
|
}
|
|
|