arnekeller/ripgrep-all
1
0
Fork 0
mirror of https://github.com/FliegendeWurst/ripgrep-all.git synced 2024-11-09 14:30:37 +00:00
Code Issues Projects Releases Wiki Activity

auto update readme

Browse Source
This commit is contained in:
phiresky 2020-06-06 15:01:53 +02:00
parent 26509c6ff3
commit 32021c3567
3 changed files with 33 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -147,13 +147,12 @@ The following adapters are disabled by default, and can be enabled using '--rga-
Extensions: .jpg, .png Extensions: .jpg, .png
update-readme.sh <!-- this part generated by update-readme.sh -->
## USAGE:
## USAGE > rga \[RGA OPTIONS\] \[RG OPTIONS\] PATTERN \[PATH \...\]
> rga \[FLAGS\] \[OPTIONS\] PATTERN \[PATH ...\] ## FLAGS:
## FLAGS
**\--rga-accurate** **\--rga-accurate**
@ -179,13 +178,11 @@ update-readme.sh
> Disable caching of results > Disable caching of results
> >
> By default, rga caches the extracted text, if it is small enough, > By default, rga caches the extracted text, if it is small enough, to a
> to a database in `~/Library/Caches/rga` on macOS, > database in \~/.cache/rga on Linux, *\~/Library/Caches/rga* on macOS,
> `~/.cache/rga` (on other Unixes), > or C:\\Users\\username\\AppData\\Local\\rga on Windows. This way,
> or `C:\Users\username\AppData\Local\rga` (on Windows). > repeated searches on the same set of files will be much faster. If you
> This way, repeated searches on > pass this flag, all caching will be disabled.
> the same set of files will be much faster. If you pass this flag, all
> caching will be disabled.
**\--rg-help** **\--rg-help**
@ -211,15 +208,18 @@ update-readme.sh
**\--rga-cache-compression-level=**\<cache-compression-level\> **\--rga-cache-compression-level=**\<cache-compression-level\>
> \[default: 12\] > ZSTD compression level to apply to adapter outputs before storing in
> cache db
>
> Ranges from 1 - 22 \[default: 12\]
**\--rga-cache-max-blob-len**=\<cache-max-blob-len\> **\--rga-cache-max-blob-len=**\<cache-max-blob-len\>
> Max compressed size to cache > Max compressed size to cache
> >
> Longest byte length (after compression) to store in cache. Longer > Longest byte length (after compression) to store in cache. Longer
> adapter outputs will not be cached and recomputed every time. > adapter outputs will not be cached and recomputed every time. Allowed
> \[default: 2000000\] > suffixes: k M G \[default: 2000000\]
**\--rga-max-archive-recursion=**\<max-archive-recursion\> **\--rga-max-archive-recursion=**\<max-archive-recursion\>
@ -230,10 +230,7 @@ advanced options.
All other options not shown here are passed directly to rg, especially All other options not shown here are passed directly to rg, especially
\[PATTERN\] and \[PATH \...\] \[PATTERN\] and \[PATH \...\]
<!-- end of part generated by update-readme.sh -->
[ripgrep]: https://github.com/BurntSushi/ripgrep
update-readme.sh
## Development ## Development

9
src/args.rs
View File

@ -61,7 +61,8 @@ set_default!(max_archive_recursion, 4, i32);
about = env!("CARGO_PKG_DESCRIPTION"), about = env!("CARGO_PKG_DESCRIPTION"),
author = env!("CARGO_PKG_HOMEPAGE"), author = env!("CARGO_PKG_HOMEPAGE"),
// TODO: long_about does not seem to work to only show this on short help // TODO: long_about does not seem to work to only show this on short help
after_help = "-h shows a concise overview, --help shows more detail and advanced options.\n\nAll other options not shown here are passed directly to rg, especially [PATTERN] and [PATH ...]" after_help = "-h shows a concise overview, --help shows more detail and advanced options.\n\nAll other options not shown here are passed directly to rg, especially [PATTERN] and [PATH ...]",
usage = "rga [RGA OPTIONS] [RG OPTIONS] PATTERN [PATH ...]"
)] )]
pub struct RgaArgs { pub struct RgaArgs {
#[serde(default, skip_serializing_if = "is_default")] #[serde(default, skip_serializing_if = "is_default")]
@ -69,9 +70,9 @@ pub struct RgaArgs {
/// Disable caching of results /// Disable caching of results
/// ///
/// By default, rga caches the extracted text, if it is small enough, /// By default, rga caches the extracted text, if it is small enough,
/// to a database in ~/Library/Caches/rga on macOS, /// to a database in ~/.cache/rga on Linux,
/// ~/.cache/rga on other Unixes, /// ~/Library/Caches/rga on macOS,
/// or C:\Users\username\AppData\Local\rga` on Windows. /// or C:\Users\username\AppData\Local\rga on Windows.
/// This way, repeated searches on the same set of files will be much faster. /// This way, repeated searches on the same set of files will be much faster.
/// If you pass this flag, all caching will be disabled. /// If you pass this flag, all caching will be disabled.
pub no_cache: bool, pub no_cache: bool,

11
update-readme.sh Executable file
View File

@ -0,0 +1,11 @@
#!/bin/bash
content=$(
cat <<END
<!-- this part generated by update-readme.sh -->
$(help2man -N "cargo run --bin rga --" | pandoc -f man -t markdown --atx-headers | rg --multiline "## USAGE:(.|\n)*")
<!-- end of part generated by update-readme.sh -->
END
)
rg --passthrough --multiline '.*update-readme.sh(.|\n)*update-readme.sh.*' README.md --replace "$content" | sponge README.md