From f50b04b00fc5c0b2667b7fdaae2113c5cd1ddac6 Mon Sep 17 00:00:00 2001 From: Joseph LaFreniere Date: Mon, 3 Jul 2023 15:14:25 -0500 Subject: [PATCH] ripgrep-all: Add module --- modules/modules.nix | 1 + modules/programs/ripgrep-all.nix | 111 +++++++++++++++++++++++++++++++ 2 files changed, 112 insertions(+) create mode 100644 modules/programs/ripgrep-all.nix diff --git a/modules/modules.nix b/modules/modules.nix index 4e1f0e201..9df863883 100644 --- a/modules/modules.nix +++ b/modules/modules.nix @@ -203,6 +203,7 @@ let ./programs/readline.nix ./programs/rio.nix ./programs/ripgrep.nix + ./programs/ripgrep-all.nix ./programs/rofi-pass.nix ./programs/rofi.nix ./programs/rtorrent.nix diff --git a/modules/programs/ripgrep-all.nix b/modules/programs/ripgrep-all.nix new file mode 100644 index 000000000..03ff74d43 --- /dev/null +++ b/modules/programs/ripgrep-all.nix @@ -0,0 +1,111 @@ +{ config, lib, pkgs, ... }: + +with lib; + +let + cfg = config.programs.ripgrep-all; + configPath = if pkgs.stdenv.hostPlatform.isDarwin then + "Library/Application Support/ripgrep-all/config.jsonc" + else + "${config.xdg.configHome}/ripgrep-all/config.jsonc"; + customAdapter = types.submodule { + # Descriptions are largely copied from https://github.com/phiresky/ripgrep-all/blob/v1.0.0-alpha.5/src/adapters/custom.rs + options = { + name = mkOption { + type = types.str; + description = + "The unique identifier and name of this adapter; must only include a-z, 0-9, _"; + }; + version = mkOption { + type = types.int; + default = 1; + description = + "The version identifier used to key cache entries; change if the configuration or program changes"; + }; + description = mkOption { + type = types.str; + description = "A description of this adapter; shown in rga's help"; + }; + extensions = mkOption { + type = types.listOf types.str; + description = "The file extensions this adapter supports"; + example = [ "pdf" ]; + }; + mimetypes = mkOption { + type = types.nullOr (types.listOf types.str); + default = null; + description = + "If not null and --rga-accurate is enabled, mime type matching is used instead of file name matching"; + example = [ "application/pdf" ]; + }; + binary = mkOption { + type = types.path; + description = "The path of the binary to run"; + }; + args = mkOption { + type = types.listOf types.str; + default = [ ]; + description = + "The output path hint; the placeholders are the same as for rga's `args`"; + }; + disabledByDefault = mkOption { + type = types.nullOr types.bool; + default = null; + description = "If true, the adapter will be disabled by default"; + }; + matchOnlyByMime = mkOption { + type = types.nullOr types.bool; + default = null; + description = + "if --rga-accurate, only match by mime types, ignore extensions completely"; + }; + outputPathHint = mkOption { + type = types.nullOr types.str; + default = null; + description = + "Setting this is useful if the output format is not plain text (.txt) but instead some other format that should be passed to another adapter"; + example = "$${input_virtual_path}.txt.asciipagebreaks"; + }; + }; + }; + formatCustomAdapter = customAdapter: + filterAttrs (n: v: v != null) { + inherit (customAdapter) + args binary description extensions mimetypes name version; + match_only_by_mime = customAdapter.matchOnlyByMime; + disabled_by_default = customAdapter.disabledByDefault; + output_path_hint = customAdapter.outputPathHint; + }; +in { + meta.maintainers = [ maintainers.lafrenierejm ]; + + options = { + programs.ripgrep-all = { + enable = mkEnableOption "ripgrep-all (rga)"; + + package = mkPackageOption pkgs "ripgrep-all" { }; + + customAdapters = mkOption { + type = types.listOf customAdapter; + default = [ ]; + description = '' + Custom adapters that invoke external preprocessing scripts. + See . + ''; + }; + }; + }; + + config = mkIf cfg.enable { + home = { + packages = [ cfg.package ]; + + file."${configPath}" = mkIf (cfg.customAdapters != [ ]) { + source = (pkgs.formats.json { }).generate "ripgrep-all" { + "$schema" = "./config.schema.json"; + custom_adapters = map formatCustomAdapter cfg.customAdapters; + }; + }; + }; + }; +}