docs

Cargo.toml

@@ -16,50 +16,50 @@ version = "1.0.0-alpha.2"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-anyhow = {version = "1.0.32", features = ["backtrace"]}
+anyhow = {version = "1.0.71", features = ["backtrace"]}
 async-compression = { version = "0.4.0", features = ["all", "all-algorithms", "tokio"] }
-async-stream = "0.3.3"
-async-trait = "0.1.64"
+async-stream = "0.3.5"
+async-trait = "0.1.68"
 async_zip = {version = "0.0.12", features = ["full"]}
-bincode = "1.3.1"
-bytes = "1.2.1"
-clap = {version = "4.0.18", features = ["wrap_help"]}
-crossbeam = "0.8.1"
-crossbeam-channel = "0.5.1"
-derive_more = "0.99.9"
+bincode = "1.3.3"
+bytes = "1.4.0"
+clap = {version = "4.3.0", features = ["wrap_help"]}
+crossbeam = "0.8.2"
+crossbeam-channel = "0.5.8"
+derive_more = "0.99.17"
 directories-next = "2.0.0"
 dyn-clonable = "0.9.0"
-dyn-clone = "1.0.2"
-encoding_rs = "0.8.24"
+dyn-clone = "1.0.11"
+encoding_rs = "0.8.32"
 encoding_rs_io = "0.1.7"
 env_logger = "0.10.0"
-glob = "0.3.0"
+glob = "0.3.1"
 json_comments = "0.2.1"
 lazy_static = "1.4.0"
-log = "0.4.11"
-memchr = "2.3.3"
-paste = "1.0.0"
+log = "0.4.17"
+memchr = "2.5.0"
+paste = "1.0.12"
 path-clean = "1.0.1"
 pretty-bytes = "0.2.2"
-regex = "1.3.9"
+regex = "1.8.2"
 rkv = "0.17" # 0.18 removes lmdb backend
 rusqlite = {version = "0.29.0", features = ["vtab", "bundled"]}
-schemars = {version = "0.8.0-alpha-4", features = ["preserve_order"]}
-serde = {version = "1.0.115", features = ["derive"]}
-serde_json = "1.0.57"
+schemars = {version = "0.8.12", features = ["preserve_order"]}
+serde = {version = "1.0.163", features = ["derive"]}
+serde_json = "1.0.96"
 size_format = "1.0.2"
-structopt = "0.3.17"
-tempfile = "3.1.0"
-tokio = {version = "1.21.2", features = ["full"]}
+structopt = "0.3.26"
+tempfile = "3.5.0"
+tokio = {version = "1.28.1", features = ["full"]}
 tokio-rusqlite = "0.4.0"
-tokio-stream = {version = "0.1.11", features = ["io-util", "tokio-util"]}
+tokio-stream = {version = "0.1.14", features = ["io-util", "tokio-util"]}
 tokio-tar = { git = "https://github.com/vorot93/tokio-tar", version = "0.3.0" }
-tokio-util = {version = "0.7.4", features = ["io", "full"]}
-tree_magic = {package = "tree_magic_mini", version = "3.0.0"}
+tokio-util = {version = "0.7.8", features = ["io", "full"]}
+tree_magic = {package = "tree_magic_mini", version = "3.0.3"}
 
 [dev-dependencies]
-async-recursion = "1.0.0"
+async-recursion = "1.0.4"
 ctor = "0.2.0"
 pretty_assertions = "1.3.0"
-tempfile = "3.1.0"
+tempfile = "3.5.0"
 tokio-test = "0.4.2"

doc/config.default.jsonc

@@ -7,7 +7,7 @@
   // https://github.com/phiresky/ripgrep-all/blob/master/doc/config.default.jsonc
 
   // The config options are the same as the command line options,
-  // but with --rga- prefix removed and - replaced with _.
+  // but with --rga- prefix removed and - and . replaced with _.
   // e.g. --rga-no-cache becomes `"no_cache": true.
   // The only exception is the `custom_adapters` option, which can only be set in this file.
 

src/adapters/custom.rs

@@ -49,8 +49,9 @@ pub struct CustomAdapterConfig {
     pub args: Vec<String>,
     /// The output path hint. The placeholders are the same as for `.args`
     ///
-    /// If not set, defaults to ${input_virtual_path}.txt
+    /// If not set, defaults to "${input_virtual_path}.txt"
     ///
+    /// 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
     pub output_path_hint: Option<String>,
 }
 
@@ -128,7 +129,6 @@ lazy_static! {
             disabled_by_default: None,
             match_only_by_mime: None,
             output_path_hint: Some("${input_virtual_path}.txt.asciipagebreaks".into())
-            // postprocessors: [{name: "add_page_numbers_by_pagebreaks"}]
         }
     ];
 }

src/config.rs

@@ -209,7 +209,9 @@ pub struct CacheConfig {
 
     /// Max compressed size to cache
     ///
-    /// Longest byte length (after compression) to store in cache. Longer adapter outputs will not be cached and recomputed every time. Allowed suffixes: k M G
+    /// Longest byte length (after compression) to store in cache. Longer adapter outputs will not be cached and recomputed every time.
+    ///
+    /// Allowed suffixes on command line: k M G
     #[serde(default, skip_serializing_if = "is_default")]
     #[structopt(
         default_value,

src/preproc_cache.rs

@@ -1,6 +1,5 @@
 use crate::{adapters::FileAdapter, preproc::ActiveAdapters};
 use anyhow::{Context, Result};
-use log::*;
 use path_clean::PathClean;
 use rusqlite::{named_params, OptionalExtension};
 use std::{path::Path, time::UNIX_EPOCH};