1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-10-01 02:37:27 +02:00
home-manager/modules/programs/ripgrep.nix
Emily 36a53d9f26 treewide: convert all option docs to Markdown
This process was automated by [my fork of `nix-doc-munge`]. All
conversions were automatically checked to produce the same DocBook
result when converted back, modulo minor typographical/formatting
differences on the acceptable-to-desirable spectrum.

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 \
    {} +
  $ ./format

[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge/tree/home-manager
2023-07-17 18:40:56 +01:00

42 lines
1.1 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.programs.ripgrep;
configPath = "${config.xdg.configHome}/ripgrep/ripgreprc";
in {
meta.maintainers = [ hm.maintainers.pedorich-n ];
options = {
programs.ripgrep = {
enable = mkEnableOption (lib.mdDoc "Ripgrep");
package = mkPackageOptionMD pkgs "ripgrep" { };
arguments = mkOption {
type = with types; listOf str;
default = [ ];
example = [ "--max-columns-preview" "--colors=line:style:bold" ];
description = lib.mdDoc ''
List of arguments to pass to ripgrep. Each item is given to ripgrep as
a single command line argument verbatim.
See <https://github.com/BurntSushi/ripgrep/blob/master/GUIDE.md#configuration-file>
for an example configuration.
'';
};
};
};
config = mkIf cfg.enable {
home = {
packages = [ cfg.package ];
file."${configPath}" =
mkIf (cfg.arguments != [ ]) { text = lib.concatLines cfg.arguments; };
sessionVariables = { "RIPGREP_CONFIG_PATH" = configPath; };
};
};
}