Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
use std::collections::HashMap;
|
|
|
|
|
|
2016-12-07 00:29:34 +02:00
|
|
|
use clap::{App, AppSettings, Arg, ArgSettings};
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
|
|
|
|
|
const ABOUT: &'static str = "
|
|
|
|
|
ripgrep (rg) recursively searches your current directory for a regex pattern.
|
|
|
|
|
|
2016-12-12 14:03:37 +02:00
|
|
|
ripgrep's regex engine uses finite automata and guarantees linear time
|
|
|
|
|
searching. Because of this, features like backreferences and arbitrary
|
|
|
|
|
lookaround are not supported.
|
|
|
|
|
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
Project home page: https://github.com/BurntSushi/ripgrep
|
|
|
|
|
|
|
|
|
|
Use -h for short descriptions and --help for more details.";
|
|
|
|
|
|
|
|
|
|
const USAGE: &'static str = "
|
2017-05-26 22:24:49 +02:00
|
|
|
rg [options] PATTERN [path ...]
|
2017-06-02 01:02:38 +02:00
|
|
|
rg [options] [-e PATTERN ...] [-f FILE ...] [path ...]
|
2017-05-26 22:24:49 +02:00
|
|
|
rg [options] --files [path ...]
|
|
|
|
|
rg [options] --type-list";
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
|
|
|
|
|
const TEMPLATE: &'static str = "\
|
|
|
|
|
{bin} {version}
|
|
|
|
|
{author}
|
|
|
|
|
{about}
|
|
|
|
|
|
|
|
|
|
USAGE:{usage}
|
|
|
|
|
|
|
|
|
|
ARGS:
|
|
|
|
|
{positionals}
|
|
|
|
|
|
|
|
|
|
OPTIONS:
|
|
|
|
|
{unified}";
|
|
|
|
|
|
|
|
|
|
/// Build a clap application parameterized by usage strings.
|
|
|
|
|
///
|
|
|
|
|
/// The function given should take a clap argument name and return a help
|
|
|
|
|
/// string. `app` will panic if a usage string is not defined.
|
|
|
|
|
///
|
|
|
|
|
/// This is an intentionally stand-alone module so that it can be used easily
|
|
|
|
|
/// in a `build.rs` script to build shell completion files.
|
2017-04-05 07:14:55 +02:00
|
|
|
pub fn app() -> App<'static, 'static> {
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
let arg = |name| {
|
2017-04-01 23:55:58 +02:00
|
|
|
Arg::with_name(name)
|
|
|
|
|
.help(USAGES[name].short)
|
|
|
|
|
.long_help(USAGES[name].long)
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
};
|
|
|
|
|
let flag = |name| arg(name).long(name);
|
|
|
|
|
|
|
|
|
|
App::new("ripgrep")
|
|
|
|
|
.author(crate_authors!())
|
|
|
|
|
.version(crate_version!())
|
2017-07-07 17:30:59 +02:00
|
|
|
.long_version(LONG_VERSION.as_str())
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
.about(ABOUT)
|
|
|
|
|
.max_term_width(100)
|
|
|
|
|
.setting(AppSettings::UnifiedHelpMessage)
|
|
|
|
|
.usage(USAGE)
|
|
|
|
|
.template(TEMPLATE)
|
2017-04-01 23:55:58 +02:00
|
|
|
.help_message("Prints help information. Use --help for more details.")
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
// First, set up primary positional/flag arguments.
|
2017-06-02 01:02:38 +02:00
|
|
|
.arg(arg("PATTERN")
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
.required_unless_one(&[
|
|
|
|
|
"file", "files", "help-short", "help", "regexp", "type-list",
|
2017-03-13 04:30:54 +02:00
|
|
|
"ripgrep-version",
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
]))
|
|
|
|
|
.arg(arg("path").multiple(true))
|
|
|
|
|
.arg(flag("regexp").short("e")
|
|
|
|
|
.takes_value(true).multiple(true).number_of_values(1)
|
2016-12-07 00:29:34 +02:00
|
|
|
.set(ArgSettings::AllowLeadingHyphen)
|
2017-06-02 01:02:38 +02:00
|
|
|
.value_name("PATTERN"))
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
.arg(flag("files")
|
2017-06-02 01:02:38 +02:00
|
|
|
// This should also conflict with `PATTERN`, but the first file
|
|
|
|
|
// path will actually be in `PATTERN`.
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
.conflicts_with_all(&["file", "regexp", "type-list"]))
|
|
|
|
|
.arg(flag("type-list")
|
2017-06-02 01:02:38 +02:00
|
|
|
.conflicts_with_all(&["file", "files", "PATTERN", "regexp"]))
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
// Second, set up common flags.
|
|
|
|
|
.arg(flag("text").short("a"))
|
|
|
|
|
.arg(flag("count").short("c"))
|
|
|
|
|
.arg(flag("color")
|
|
|
|
|
.value_name("WHEN")
|
|
|
|
|
.takes_value(true)
|
|
|
|
|
.hide_possible_values(true)
|
Use clap's overrides_with and default_value_if
to better organize options. These are the changes:
- color will have default value of "never" if --vimgrep is given,
and only if no --color option is given
- last overrides previous: --line-number and --no-line-number, --heading
and --no-heading, --with-filename and --no-filename, and --vimgrep and
--count
- no heading will be show if --vimgrep is defined. This worked inside
vim actually because heading is also only shown if tty is stdout
(which is not the case when rg is called from vim).
Unfortunately, clap does not behave like a usual GNU/POSIX in some
cases, as reported in https://github.com/kbknapp/clap-rs/issues/970
and https://github.com/kbknapp/clap-rs/issues/976 (having all the bells
and whistles, on the other hand). So we still have issues like rg
failing when same argument is given more than once (unless for the few
ones marked with `multiple(true)`), or having unintuitive precedence
rules (and probably non-intentional, just there because of clap's
limitations) like:
- --no-filename over --vimgrep
- --no-line-number over --column, --pretty or --vimgrep
- --no-heading over --pretty
regardless of the order in which options where given, where the desired
behavior would be that the last option would override the previous ones
given.
2017-06-02 01:13:43 +02:00
|
|
|
.possible_values(&["never", "auto", "always", "ansi"])
|
|
|
|
|
.default_value_if("vimgrep", None, "never"))
|
Completely re-work colored output and tty handling.
This commit completely guts all of the color handling code and replaces
most of it with two new crates: wincolor and termcolor. wincolor
provides a simple API to coloring using the Windows console and
termcolor provides a platform independent coloring API tuned for
multithreaded command line programs. This required a lot more
flexibility than what the `term` crate provided, so it was dropped.
We instead switch to writing ANSI escape sequences directly and ignore
the TERMINFO database.
In addition to fixing several bugs, this commit also permits end users
to customize colors to a certain extent. For example, this command will
set the match color to magenta and the line number background to yellow:
rg --colors 'match:fg:magenta' --colors 'line:bg:yellow' foo
For tty handling, we've adopted a hack from `git` to do tty detection in
MSYS/mintty terminals. As a result, ripgrep should get both color
detection and piping correct on Windows regardless of which terminal you
use.
Finally, switch to line buffering. Performance doesn't seem to be
impacted and it's an otherwise more user friendly option.
Fixes #37, Fixes #51, Fixes #94, Fixes #117, Fixes #182, Fixes #231
2016-11-20 18:14:52 +02:00
|
|
|
.arg(flag("colors").value_name("SPEC")
|
|
|
|
|
.takes_value(true).multiple(true).number_of_values(1))
|
Add support for additional text encodings.
This includes, but is not limited to, UTF-16, latin-1, GBK, EUC-JP and
Shift_JIS. (Courtesy of the `encoding_rs` crate.)
Specifically, this feature enables ripgrep to search files that are
encoded in an encoding other than UTF-8. The list of available encodings
is tied directly to what the `encoding_rs` crate supports, which is in
turn tied to the Encoding Standard. The full list of available encodings
can be found here: https://encoding.spec.whatwg.org/#concept-encoding-get
This pull request also introduces the notion that text encodings can be
automatically detected on a best effort basis. Currently, the only
support for this is checking for a UTF-16 bom. In all other cases, a
text encoding of `auto` (the default) implies a UTF-8 or ASCII
compatible source encoding. When a text encoding is otherwise specified,
it is unconditionally used for all files searched.
Since ripgrep's regex engine is fundamentally built on top of UTF-8,
this feature works by transcoding the files to be searched from their
source encoding to UTF-8. This transcoding only happens when:
1. `auto` is specified and a non-UTF-8 encoding is detected.
2. A specific encoding is given by end users (including UTF-8).
When transcoding occurs, errors are handled by automatically inserting
the Unicode replacement character. In this case, ripgrep's output is
guaranteed to be valid UTF-8 (excluding non-UTF-8 file paths, if they
are printed).
In all other cases, the source text is searched directly, which implies
an assumption that it is at least ASCII compatible, but where UTF-8 is
most useful. In this scenario, encoding errors are not detected. In this
case, ripgrep's output will match the input exactly, byte-for-byte.
This design may not be optimal in all cases, but it has some advantages:
1. In the happy path ("UTF-8 everywhere") remains happy. I have not been
able to witness any performance regressions.
2. In the non-UTF-8 path, implementation complexity is kept relatively
low. The cost here is transcoding itself. A potentially superior
implementation might build decoding of any encoding into the regex
engine itself. In particular, the fundamental problem with
transcoding everything first is that literal optimizations are nearly
negated.
Future work should entail improving the user experience. For example, we
might want to auto-detect more text encodings. A more elaborate UX
experience might permit end users to specify multiple text encodings,
although this seems hard to pull off in an ergonomic way.
Fixes #1
2017-03-09 03:22:48 +02:00
|
|
|
.arg(flag("encoding").short("E").value_name("ENCODING")
|
|
|
|
|
.takes_value(true).number_of_values(1))
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
.arg(flag("fixed-strings").short("F"))
|
|
|
|
|
.arg(flag("glob").short("g")
|
|
|
|
|
.takes_value(true).multiple(true).number_of_values(1)
|
2017-07-29 17:54:10 +02:00
|
|
|
.set(ArgSettings::AllowLeadingHyphen)
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
.value_name("GLOB"))
|
2017-06-29 02:57:33 +02:00
|
|
|
.arg(flag("iglob")
|
|
|
|
|
.takes_value(true).multiple(true).number_of_values(1)
|
2017-07-29 17:54:10 +02:00
|
|
|
.set(ArgSettings::AllowLeadingHyphen)
|
2017-06-29 02:57:33 +02:00
|
|
|
.value_name("GLOB"))
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
.arg(flag("ignore-case").short("i"))
|
|
|
|
|
.arg(flag("line-number").short("n"))
|
Use clap's overrides_with and default_value_if
to better organize options. These are the changes:
- color will have default value of "never" if --vimgrep is given,
and only if no --color option is given
- last overrides previous: --line-number and --no-line-number, --heading
and --no-heading, --with-filename and --no-filename, and --vimgrep and
--count
- no heading will be show if --vimgrep is defined. This worked inside
vim actually because heading is also only shown if tty is stdout
(which is not the case when rg is called from vim).
Unfortunately, clap does not behave like a usual GNU/POSIX in some
cases, as reported in https://github.com/kbknapp/clap-rs/issues/970
and https://github.com/kbknapp/clap-rs/issues/976 (having all the bells
and whistles, on the other hand). So we still have issues like rg
failing when same argument is given more than once (unless for the few
ones marked with `multiple(true)`), or having unintuitive precedence
rules (and probably non-intentional, just there because of clap's
limitations) like:
- --no-filename over --vimgrep
- --no-line-number over --column, --pretty or --vimgrep
- --no-heading over --pretty
regardless of the order in which options where given, where the desired
behavior would be that the last option would override the previous ones
given.
2017-06-02 01:13:43 +02:00
|
|
|
.arg(flag("no-line-number").short("N").overrides_with("line-number"))
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
.arg(flag("quiet").short("q"))
|
|
|
|
|
.arg(flag("type").short("t")
|
|
|
|
|
.takes_value(true).multiple(true).number_of_values(1)
|
|
|
|
|
.value_name("TYPE"))
|
|
|
|
|
.arg(flag("type-not").short("T")
|
|
|
|
|
.takes_value(true).multiple(true).number_of_values(1)
|
|
|
|
|
.value_name("TYPE"))
|
|
|
|
|
.arg(flag("unrestricted").short("u")
|
|
|
|
|
.multiple(true))
|
|
|
|
|
.arg(flag("invert-match").short("v"))
|
2017-08-09 12:53:35 +02:00
|
|
|
.arg(flag("word-regexp").short("w").overrides_with("line-regexp"))
|
|
|
|
|
.arg(flag("line-regexp").short("x"))
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
// Third, set up less common flags.
|
|
|
|
|
.arg(flag("after-context").short("A")
|
|
|
|
|
.value_name("NUM").takes_value(true)
|
|
|
|
|
.validator(validate_number))
|
|
|
|
|
.arg(flag("before-context").short("B")
|
|
|
|
|
.value_name("NUM").takes_value(true)
|
|
|
|
|
.validator(validate_number))
|
|
|
|
|
.arg(flag("context").short("C")
|
|
|
|
|
.value_name("NUM").takes_value(true)
|
|
|
|
|
.validator(validate_number))
|
|
|
|
|
.arg(flag("column"))
|
2017-01-11 01:16:15 +02:00
|
|
|
.arg(flag("context-separator")
|
|
|
|
|
.value_name("SEPARATOR").takes_value(true))
|
2017-04-01 23:55:58 +02:00
|
|
|
.arg(flag("dfa-size-limit")
|
|
|
|
|
.value_name("NUM+SUFFIX?").takes_value(true))
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
.arg(flag("debug"))
|
|
|
|
|
.arg(flag("file").short("f")
|
|
|
|
|
.value_name("FILE").takes_value(true)
|
2017-07-29 17:54:10 +02:00
|
|
|
.set(ArgSettings::AllowLeadingHyphen)
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
.multiple(true).number_of_values(1))
|
|
|
|
|
.arg(flag("files-with-matches").short("l"))
|
2016-11-20 03:15:41 +02:00
|
|
|
.arg(flag("files-without-match"))
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
.arg(flag("with-filename").short("H"))
|
Use clap's overrides_with and default_value_if
to better organize options. These are the changes:
- color will have default value of "never" if --vimgrep is given,
and only if no --color option is given
- last overrides previous: --line-number and --no-line-number, --heading
and --no-heading, --with-filename and --no-filename, and --vimgrep and
--count
- no heading will be show if --vimgrep is defined. This worked inside
vim actually because heading is also only shown if tty is stdout
(which is not the case when rg is called from vim).
Unfortunately, clap does not behave like a usual GNU/POSIX in some
cases, as reported in https://github.com/kbknapp/clap-rs/issues/970
and https://github.com/kbknapp/clap-rs/issues/976 (having all the bells
and whistles, on the other hand). So we still have issues like rg
failing when same argument is given more than once (unless for the few
ones marked with `multiple(true)`), or having unintuitive precedence
rules (and probably non-intentional, just there because of clap's
limitations) like:
- --no-filename over --vimgrep
- --no-line-number over --column, --pretty or --vimgrep
- --no-heading over --pretty
regardless of the order in which options where given, where the desired
behavior would be that the last option would override the previous ones
given.
2017-06-02 01:13:43 +02:00
|
|
|
.arg(flag("no-filename").overrides_with("with-filename"))
|
|
|
|
|
.arg(flag("heading"))
|
2017-02-18 22:25:08 +02:00
|
|
|
.arg(flag("no-heading").overrides_with("heading"))
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
.arg(flag("hidden"))
|
|
|
|
|
.arg(flag("ignore-file")
|
|
|
|
|
.value_name("FILE").takes_value(true)
|
2017-07-29 17:54:10 +02:00
|
|
|
.set(ArgSettings::AllowLeadingHyphen)
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
.multiple(true).number_of_values(1))
|
|
|
|
|
.arg(flag("follow").short("L"))
|
|
|
|
|
.arg(flag("max-count")
|
|
|
|
|
.short("m").value_name("NUM").takes_value(true)
|
|
|
|
|
.validator(validate_number))
|
2017-02-28 06:53:52 +02:00
|
|
|
.arg(flag("max-filesize")
|
2017-03-01 07:38:06 +02:00
|
|
|
.value_name("NUM+SUFFIX?").takes_value(true))
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
.arg(flag("maxdepth")
|
|
|
|
|
.value_name("NUM").takes_value(true)
|
|
|
|
|
.validator(validate_number))
|
|
|
|
|
.arg(flag("mmap"))
|
|
|
|
|
.arg(flag("no-messages"))
|
|
|
|
|
.arg(flag("no-mmap"))
|
|
|
|
|
.arg(flag("no-ignore"))
|
|
|
|
|
.arg(flag("no-ignore-parent"))
|
|
|
|
|
.arg(flag("no-ignore-vcs"))
|
2017-03-28 18:06:30 +02:00
|
|
|
.arg(flag("null").short("0"))
|
2017-03-28 20:14:32 +02:00
|
|
|
.arg(flag("only-matching").short("o").conflicts_with("replace"))
|
2017-01-11 01:16:15 +02:00
|
|
|
.arg(flag("path-separator").value_name("SEPARATOR").takes_value(true))
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
.arg(flag("pretty").short("p"))
|
2017-07-29 17:54:10 +02:00
|
|
|
.arg(flag("replace").short("r")
|
|
|
|
|
.set(ArgSettings::AllowLeadingHyphen)
|
|
|
|
|
.value_name("ARG").takes_value(true))
|
2017-04-01 23:55:58 +02:00
|
|
|
.arg(flag("regex-size-limit")
|
|
|
|
|
.value_name("NUM+SUFFIX?").takes_value(true))
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
.arg(flag("case-sensitive").short("s"))
|
|
|
|
|
.arg(flag("smart-case").short("S"))
|
2017-01-07 05:43:59 +02:00
|
|
|
.arg(flag("sort-files"))
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
.arg(flag("threads")
|
|
|
|
|
.short("j").value_name("ARG").takes_value(true)
|
|
|
|
|
.validator(validate_number))
|
Use clap's overrides_with and default_value_if
to better organize options. These are the changes:
- color will have default value of "never" if --vimgrep is given,
and only if no --color option is given
- last overrides previous: --line-number and --no-line-number, --heading
and --no-heading, --with-filename and --no-filename, and --vimgrep and
--count
- no heading will be show if --vimgrep is defined. This worked inside
vim actually because heading is also only shown if tty is stdout
(which is not the case when rg is called from vim).
Unfortunately, clap does not behave like a usual GNU/POSIX in some
cases, as reported in https://github.com/kbknapp/clap-rs/issues/970
and https://github.com/kbknapp/clap-rs/issues/976 (having all the bells
and whistles, on the other hand). So we still have issues like rg
failing when same argument is given more than once (unless for the few
ones marked with `multiple(true)`), or having unintuitive precedence
rules (and probably non-intentional, just there because of clap's
limitations) like:
- --no-filename over --vimgrep
- --no-line-number over --column, --pretty or --vimgrep
- --no-heading over --pretty
regardless of the order in which options where given, where the desired
behavior would be that the last option would override the previous ones
given.
2017-06-02 01:13:43 +02:00
|
|
|
.arg(flag("vimgrep").overrides_with("count"))
|
2017-02-02 16:29:50 +02:00
|
|
|
.arg(flag("max-columns").short("M")
|
|
|
|
|
.value_name("NUM").takes_value(true)
|
|
|
|
|
.validator(validate_number))
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
.arg(flag("type-add")
|
|
|
|
|
.value_name("TYPE").takes_value(true)
|
|
|
|
|
.multiple(true).number_of_values(1))
|
|
|
|
|
.arg(flag("type-clear")
|
|
|
|
|
.value_name("TYPE").takes_value(true)
|
|
|
|
|
.multiple(true).number_of_values(1))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
struct Usage {
|
|
|
|
|
short: &'static str,
|
|
|
|
|
long: &'static str,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
macro_rules! doc {
|
|
|
|
|
($map:expr, $name:expr, $short:expr) => {
|
|
|
|
|
doc!($map, $name, $short, $short)
|
|
|
|
|
};
|
|
|
|
|
($map:expr, $name:expr, $short:expr, $long:expr) => {
|
|
|
|
|
$map.insert($name, Usage {
|
|
|
|
|
short: $short,
|
|
|
|
|
long: concat!($long, "\n "),
|
|
|
|
|
});
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
lazy_static! {
|
2017-07-07 17:30:59 +02:00
|
|
|
static ref LONG_VERSION: String = {
|
|
|
|
|
let mut features: Vec<&str> = vec![];
|
|
|
|
|
|
|
|
|
|
if cfg!(feature = "avx-accel") {
|
2017-07-07 17:44:26 +02:00
|
|
|
features.push("+AVX");
|
2017-07-07 17:30:59 +02:00
|
|
|
} else {
|
2017-07-07 17:44:26 +02:00
|
|
|
features.push("-AVX");
|
2017-07-07 17:30:59 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if cfg!(feature = "simd-accel") {
|
2017-07-07 17:44:26 +02:00
|
|
|
features.push("+SIMD");
|
2017-07-07 17:30:59 +02:00
|
|
|
} else {
|
2017-07-07 17:44:26 +02:00
|
|
|
features.push("-SIMD");
|
2017-07-07 17:30:59 +02:00
|
|
|
}
|
|
|
|
|
|
2017-07-07 17:44:26 +02:00
|
|
|
format!("{}\n{}", crate_version!(), features.join(" "))
|
2017-07-07 17:30:59 +02:00
|
|
|
};
|
|
|
|
|
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
static ref USAGES: HashMap<&'static str, Usage> = {
|
|
|
|
|
let mut h = HashMap::new();
|
|
|
|
|
doc!(h, "help-short",
|
|
|
|
|
"Show short help output.",
|
|
|
|
|
"Show short help output. Use --help to show more details.");
|
|
|
|
|
doc!(h, "help",
|
|
|
|
|
"Show verbose help output.",
|
|
|
|
|
"When given, more details about flags are provided.");
|
2017-03-13 04:30:54 +02:00
|
|
|
doc!(h, "ripgrep-version",
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
"Prints version information.");
|
|
|
|
|
|
2017-06-02 01:02:38 +02:00
|
|
|
doc!(h, "PATTERN",
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
"A regular expression used for searching.",
|
2017-05-26 22:24:49 +02:00
|
|
|
"A regular expression used for searching. To match a pattern \
|
|
|
|
|
beginning with a dash, use the -e/--regexp option.");
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
doc!(h, "regexp",
|
2017-05-26 22:24:49 +02:00
|
|
|
"Use pattern to search.",
|
|
|
|
|
"Use pattern to search. This option can be provided multiple \
|
|
|
|
|
times, where all patterns given are searched. This is also \
|
|
|
|
|
useful when searching for patterns that start with a dash.");
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
doc!(h, "path",
|
|
|
|
|
"A file or directory to search.",
|
|
|
|
|
"A file or directory to search. Directories are searched \
|
|
|
|
|
recursively.");
|
|
|
|
|
doc!(h, "files",
|
|
|
|
|
"Print each file that would be searched.",
|
|
|
|
|
"Print each file that would be searched without actually \
|
|
|
|
|
performing the search. This is useful to determine whether a \
|
|
|
|
|
particular file is being searched or not.");
|
|
|
|
|
doc!(h, "type-list",
|
|
|
|
|
"Show all supported file types.",
|
|
|
|
|
"Show all supported file types and their corresponding globs.");
|
|
|
|
|
|
|
|
|
|
doc!(h, "text",
|
|
|
|
|
"Search binary files as if they were text.");
|
|
|
|
|
doc!(h, "count",
|
|
|
|
|
"Only show count of matches for each file.");
|
|
|
|
|
doc!(h, "color",
|
|
|
|
|
"When to use color. [default: auto]",
|
2017-05-26 00:04:45 +02:00
|
|
|
"When to use color in the output. The possible values are never, \
|
|
|
|
|
auto, always or ansi. The default is auto. When always is used, \
|
|
|
|
|
coloring is attempted based on your environment. When ansi is \
|
|
|
|
|
used, coloring is forcefully done using ANSI escape color \
|
|
|
|
|
codes.");
|
Completely re-work colored output and tty handling.
This commit completely guts all of the color handling code and replaces
most of it with two new crates: wincolor and termcolor. wincolor
provides a simple API to coloring using the Windows console and
termcolor provides a platform independent coloring API tuned for
multithreaded command line programs. This required a lot more
flexibility than what the `term` crate provided, so it was dropped.
We instead switch to writing ANSI escape sequences directly and ignore
the TERMINFO database.
In addition to fixing several bugs, this commit also permits end users
to customize colors to a certain extent. For example, this command will
set the match color to magenta and the line number background to yellow:
rg --colors 'match:fg:magenta' --colors 'line:bg:yellow' foo
For tty handling, we've adopted a hack from `git` to do tty detection in
MSYS/mintty terminals. As a result, ripgrep should get both color
detection and piping correct on Windows regardless of which terminal you
use.
Finally, switch to line buffering. Performance doesn't seem to be
impacted and it's an otherwise more user friendly option.
Fixes #37, Fixes #51, Fixes #94, Fixes #117, Fixes #182, Fixes #231
2016-11-20 18:14:52 +02:00
|
|
|
doc!(h, "colors",
|
|
|
|
|
"Configure color settings and styles.",
|
|
|
|
|
"This flag specifies color settings for use in the output. \
|
|
|
|
|
This flag may be provided multiple times. Settings are applied \
|
|
|
|
|
iteratively. Colors are limited to one of eight choices: \
|
|
|
|
|
red, blue, green, cyan, magenta, yellow, white and black. \
|
2017-01-07 05:44:25 +02:00
|
|
|
Styles are limited to nobold, bold, nointense or intense.\n\n\
|
2017-01-07 03:07:29 +02:00
|
|
|
The format of the flag is {type}:{attribute}:{value}. {type} \
|
2017-04-09 15:08:49 +02:00
|
|
|
should be one of path, line, column or match. {attribute} can \
|
|
|
|
|
be fg, bg or style. {value} is either a color (for fg and bg) \
|
|
|
|
|
or a text style. A special format, {type}:none, will clear all \
|
|
|
|
|
color settings for {type}.\n\nFor example, the following \
|
|
|
|
|
command will change the match color to magenta and the \
|
|
|
|
|
background color for line numbers to yellow:\n\n\
|
Completely re-work colored output and tty handling.
This commit completely guts all of the color handling code and replaces
most of it with two new crates: wincolor and termcolor. wincolor
provides a simple API to coloring using the Windows console and
termcolor provides a platform independent coloring API tuned for
multithreaded command line programs. This required a lot more
flexibility than what the `term` crate provided, so it was dropped.
We instead switch to writing ANSI escape sequences directly and ignore
the TERMINFO database.
In addition to fixing several bugs, this commit also permits end users
to customize colors to a certain extent. For example, this command will
set the match color to magenta and the line number background to yellow:
rg --colors 'match:fg:magenta' --colors 'line:bg:yellow' foo
For tty handling, we've adopted a hack from `git` to do tty detection in
MSYS/mintty terminals. As a result, ripgrep should get both color
detection and piping correct on Windows regardless of which terminal you
use.
Finally, switch to line buffering. Performance doesn't seem to be
impacted and it's an otherwise more user friendly option.
Fixes #37, Fixes #51, Fixes #94, Fixes #117, Fixes #182, Fixes #231
2016-11-20 18:14:52 +02:00
|
|
|
rg --colors 'match:fg:magenta' --colors 'line:bg:yellow' foo.");
|
Add support for additional text encodings.
This includes, but is not limited to, UTF-16, latin-1, GBK, EUC-JP and
Shift_JIS. (Courtesy of the `encoding_rs` crate.)
Specifically, this feature enables ripgrep to search files that are
encoded in an encoding other than UTF-8. The list of available encodings
is tied directly to what the `encoding_rs` crate supports, which is in
turn tied to the Encoding Standard. The full list of available encodings
can be found here: https://encoding.spec.whatwg.org/#concept-encoding-get
This pull request also introduces the notion that text encodings can be
automatically detected on a best effort basis. Currently, the only
support for this is checking for a UTF-16 bom. In all other cases, a
text encoding of `auto` (the default) implies a UTF-8 or ASCII
compatible source encoding. When a text encoding is otherwise specified,
it is unconditionally used for all files searched.
Since ripgrep's regex engine is fundamentally built on top of UTF-8,
this feature works by transcoding the files to be searched from their
source encoding to UTF-8. This transcoding only happens when:
1. `auto` is specified and a non-UTF-8 encoding is detected.
2. A specific encoding is given by end users (including UTF-8).
When transcoding occurs, errors are handled by automatically inserting
the Unicode replacement character. In this case, ripgrep's output is
guaranteed to be valid UTF-8 (excluding non-UTF-8 file paths, if they
are printed).
In all other cases, the source text is searched directly, which implies
an assumption that it is at least ASCII compatible, but where UTF-8 is
most useful. In this scenario, encoding errors are not detected. In this
case, ripgrep's output will match the input exactly, byte-for-byte.
This design may not be optimal in all cases, but it has some advantages:
1. In the happy path ("UTF-8 everywhere") remains happy. I have not been
able to witness any performance regressions.
2. In the non-UTF-8 path, implementation complexity is kept relatively
low. The cost here is transcoding itself. A potentially superior
implementation might build decoding of any encoding into the regex
engine itself. In particular, the fundamental problem with
transcoding everything first is that literal optimizations are nearly
negated.
Future work should entail improving the user experience. For example, we
might want to auto-detect more text encodings. A more elaborate UX
experience might permit end users to specify multiple text encodings,
although this seems hard to pull off in an ergonomic way.
Fixes #1
2017-03-09 03:22:48 +02:00
|
|
|
doc!(h, "encoding",
|
|
|
|
|
"Specify the text encoding of files to search.",
|
|
|
|
|
"Specify the text encoding that ripgrep will use on all files \
|
|
|
|
|
searched. The default value is 'auto', which will cause ripgrep \
|
|
|
|
|
to do a best effort automatic detection of encoding on a \
|
|
|
|
|
per-file basis. Other supported values can be found in the list \
|
|
|
|
|
of labels here: \
|
|
|
|
|
https://encoding.spec.whatwg.org/#concept-encoding-get");
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
doc!(h, "fixed-strings",
|
|
|
|
|
"Treat the pattern as a literal string.",
|
|
|
|
|
"Treat the pattern as a literal string instead of a regular \
|
|
|
|
|
expression. When this flag is used, special regular expression \
|
|
|
|
|
meta characters such as (){}*+. do not need to be escaped.");
|
|
|
|
|
doc!(h, "glob",
|
|
|
|
|
"Include or exclude files/directories.",
|
|
|
|
|
"Include or exclude files/directories for searching that \
|
|
|
|
|
match the given glob. This always overrides any other \
|
|
|
|
|
ignore logic. Multiple glob flags may be used. Globbing \
|
|
|
|
|
rules match .gitignore globs. Precede a glob with a ! \
|
|
|
|
|
to exclude it.");
|
2017-06-29 02:57:33 +02:00
|
|
|
doc!(h, "iglob",
|
|
|
|
|
"Include or exclude files/directories case insensitively.",
|
|
|
|
|
"Include or exclude files/directories for searching that \
|
|
|
|
|
match the given glob. This always overrides any other \
|
|
|
|
|
ignore logic. Multiple glob flags may be used. Globbing \
|
|
|
|
|
rules match .gitignore globs. Precede a glob with a ! \
|
|
|
|
|
to exclude it. Globs are matched case insensitively.");
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
doc!(h, "ignore-case",
|
|
|
|
|
"Case insensitive search.",
|
|
|
|
|
"Case insensitive search. This is overridden by \
|
|
|
|
|
--case-sensitive.");
|
|
|
|
|
doc!(h, "line-number",
|
|
|
|
|
"Show line numbers.",
|
|
|
|
|
"Show line numbers (1-based). This is enabled by default when \
|
|
|
|
|
searching in a tty.");
|
|
|
|
|
doc!(h, "no-line-number",
|
|
|
|
|
"Suppress line numbers.",
|
|
|
|
|
"Suppress line numbers. This is enabled by default when NOT \
|
|
|
|
|
searching in a tty.");
|
|
|
|
|
doc!(h, "quiet",
|
|
|
|
|
"Do not print anything to stdout.",
|
|
|
|
|
"Do not print anything to stdout. If a match is found in a file, \
|
|
|
|
|
stop searching. This is useful when ripgrep is used only for \
|
|
|
|
|
its exit code.");
|
|
|
|
|
doc!(h, "type",
|
|
|
|
|
"Only search files matching TYPE.",
|
|
|
|
|
"Only search files matching TYPE. Multiple type flags may be \
|
|
|
|
|
provided. Use the --type-list flag to list all available \
|
|
|
|
|
types.");
|
|
|
|
|
doc!(h, "type-not",
|
|
|
|
|
"Do not search files matching TYPE.",
|
|
|
|
|
"Do not search files matching TYPE. Multiple type-not flags may \
|
|
|
|
|
be provided. Use the --type-list flag to list all available \
|
|
|
|
|
types.");
|
|
|
|
|
doc!(h, "unrestricted",
|
|
|
|
|
"Reduce the level of \"smart\" searching.",
|
|
|
|
|
"Reduce the level of \"smart\" searching. A single -u \
|
|
|
|
|
won't respect .gitignore (etc.) files. Two -u flags will \
|
|
|
|
|
additionally search hidden files and directories. Three \
|
|
|
|
|
-u flags will additionally search binary files. -uu is \
|
|
|
|
|
roughly equivalent to grep -r and -uuu is roughly \
|
|
|
|
|
equivalent to grep -a -r.");
|
|
|
|
|
doc!(h, "invert-match",
|
|
|
|
|
"Invert matching.",
|
|
|
|
|
"Invert matching. Show lines that don't match given patterns.");
|
|
|
|
|
doc!(h, "word-regexp",
|
|
|
|
|
"Only show matches surrounded by word boundaries.",
|
|
|
|
|
"Only show matches surrounded by word boundaries. This is \
|
|
|
|
|
equivalent to putting \\b before and after all of the search \
|
|
|
|
|
patterns.");
|
2017-08-09 12:53:35 +02:00
|
|
|
doc!(h, "line-regexp",
|
|
|
|
|
"Only show matches surrounded by line boundaries.",
|
|
|
|
|
"Only show matches surrounded by line boundaries. This is \
|
|
|
|
|
equivalent to putting ^...$ around all of the search patterns.");
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
|
|
|
|
|
doc!(h, "after-context",
|
|
|
|
|
"Show NUM lines after each match.");
|
|
|
|
|
doc!(h, "before-context",
|
|
|
|
|
"Show NUM lines before each match.");
|
|
|
|
|
doc!(h, "context",
|
|
|
|
|
"Show NUM lines before and after each match.");
|
|
|
|
|
doc!(h, "column",
|
|
|
|
|
"Show column numbers",
|
|
|
|
|
"Show column numbers (1-based). This only shows the column \
|
|
|
|
|
numbers for the first match on each line. This does not try \
|
2017-01-12 01:53:35 +02:00
|
|
|
to account for Unicode. One byte is equal to one column. This \
|
|
|
|
|
implies --line-number.");
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
doc!(h, "context-separator",
|
|
|
|
|
"Set the context separator string. [default: --]",
|
|
|
|
|
"The string used to separate non-contiguous context lines in the \
|
|
|
|
|
output. Escape sequences like \\x7F or \\t may be used. The \
|
|
|
|
|
default value is --.");
|
|
|
|
|
doc!(h, "debug",
|
|
|
|
|
"Show debug messages.",
|
|
|
|
|
"Show debug messages. Please use this when filing a bug report.");
|
2017-04-01 23:55:58 +02:00
|
|
|
doc!(h, "dfa-size-limit",
|
|
|
|
|
"The upper size limit of the generated dfa.",
|
|
|
|
|
"The upper size limit of the generated dfa. The default limit is \
|
|
|
|
|
10M. This should only be changed on very large regex inputs \
|
|
|
|
|
where the (slower) fallback regex engine may otherwise be used. \
|
|
|
|
|
\n\nThe argument accepts the same size suffixes as allowed in \
|
|
|
|
|
the 'max-filesize' argument.");
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
doc!(h, "file",
|
|
|
|
|
"Search for patterns from the given file.",
|
|
|
|
|
"Search for patterns from the given file, with one pattern per \
|
|
|
|
|
line. When this flag is used or multiple times or in \
|
|
|
|
|
combination with the -e/--regexp flag, then all patterns \
|
|
|
|
|
provided are searched. Empty pattern lines will match all input \
|
|
|
|
|
lines, and the newline is not counted as part of the pattern.");
|
|
|
|
|
doc!(h, "files-with-matches",
|
Add support for additional text encodings.
This includes, but is not limited to, UTF-16, latin-1, GBK, EUC-JP and
Shift_JIS. (Courtesy of the `encoding_rs` crate.)
Specifically, this feature enables ripgrep to search files that are
encoded in an encoding other than UTF-8. The list of available encodings
is tied directly to what the `encoding_rs` crate supports, which is in
turn tied to the Encoding Standard. The full list of available encodings
can be found here: https://encoding.spec.whatwg.org/#concept-encoding-get
This pull request also introduces the notion that text encodings can be
automatically detected on a best effort basis. Currently, the only
support for this is checking for a UTF-16 bom. In all other cases, a
text encoding of `auto` (the default) implies a UTF-8 or ASCII
compatible source encoding. When a text encoding is otherwise specified,
it is unconditionally used for all files searched.
Since ripgrep's regex engine is fundamentally built on top of UTF-8,
this feature works by transcoding the files to be searched from their
source encoding to UTF-8. This transcoding only happens when:
1. `auto` is specified and a non-UTF-8 encoding is detected.
2. A specific encoding is given by end users (including UTF-8).
When transcoding occurs, errors are handled by automatically inserting
the Unicode replacement character. In this case, ripgrep's output is
guaranteed to be valid UTF-8 (excluding non-UTF-8 file paths, if they
are printed).
In all other cases, the source text is searched directly, which implies
an assumption that it is at least ASCII compatible, but where UTF-8 is
most useful. In this scenario, encoding errors are not detected. In this
case, ripgrep's output will match the input exactly, byte-for-byte.
This design may not be optimal in all cases, but it has some advantages:
1. In the happy path ("UTF-8 everywhere") remains happy. I have not been
able to witness any performance regressions.
2. In the non-UTF-8 path, implementation complexity is kept relatively
low. The cost here is transcoding itself. A potentially superior
implementation might build decoding of any encoding into the regex
engine itself. In particular, the fundamental problem with
transcoding everything first is that literal optimizations are nearly
negated.
Future work should entail improving the user experience. For example, we
might want to auto-detect more text encodings. A more elaborate UX
experience might permit end users to specify multiple text encodings,
although this seems hard to pull off in an ergonomic way.
Fixes #1
2017-03-09 03:22:48 +02:00
|
|
|
"Only show the paths with at least one match.");
|
2016-11-20 03:15:41 +02:00
|
|
|
doc!(h, "files-without-match",
|
Add support for additional text encodings.
This includes, but is not limited to, UTF-16, latin-1, GBK, EUC-JP and
Shift_JIS. (Courtesy of the `encoding_rs` crate.)
Specifically, this feature enables ripgrep to search files that are
encoded in an encoding other than UTF-8. The list of available encodings
is tied directly to what the `encoding_rs` crate supports, which is in
turn tied to the Encoding Standard. The full list of available encodings
can be found here: https://encoding.spec.whatwg.org/#concept-encoding-get
This pull request also introduces the notion that text encodings can be
automatically detected on a best effort basis. Currently, the only
support for this is checking for a UTF-16 bom. In all other cases, a
text encoding of `auto` (the default) implies a UTF-8 or ASCII
compatible source encoding. When a text encoding is otherwise specified,
it is unconditionally used for all files searched.
Since ripgrep's regex engine is fundamentally built on top of UTF-8,
this feature works by transcoding the files to be searched from their
source encoding to UTF-8. This transcoding only happens when:
1. `auto` is specified and a non-UTF-8 encoding is detected.
2. A specific encoding is given by end users (including UTF-8).
When transcoding occurs, errors are handled by automatically inserting
the Unicode replacement character. In this case, ripgrep's output is
guaranteed to be valid UTF-8 (excluding non-UTF-8 file paths, if they
are printed).
In all other cases, the source text is searched directly, which implies
an assumption that it is at least ASCII compatible, but where UTF-8 is
most useful. In this scenario, encoding errors are not detected. In this
case, ripgrep's output will match the input exactly, byte-for-byte.
This design may not be optimal in all cases, but it has some advantages:
1. In the happy path ("UTF-8 everywhere") remains happy. I have not been
able to witness any performance regressions.
2. In the non-UTF-8 path, implementation complexity is kept relatively
low. The cost here is transcoding itself. A potentially superior
implementation might build decoding of any encoding into the regex
engine itself. In particular, the fundamental problem with
transcoding everything first is that literal optimizations are nearly
negated.
Future work should entail improving the user experience. For example, we
might want to auto-detect more text encodings. A more elaborate UX
experience might permit end users to specify multiple text encodings,
although this seems hard to pull off in an ergonomic way.
Fixes #1
2017-03-09 03:22:48 +02:00
|
|
|
"Only show the paths that contains zero matches.");
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
doc!(h, "with-filename",
|
|
|
|
|
"Show file name for each match.",
|
|
|
|
|
"Prefix each match with the file name that contains it. This is \
|
|
|
|
|
the default when more than one file is searched.");
|
|
|
|
|
doc!(h, "no-filename",
|
|
|
|
|
"Never show the file name for a match.",
|
|
|
|
|
"Never show the file name for a match. This is the default when \
|
|
|
|
|
one file is searched.");
|
|
|
|
|
doc!(h, "heading",
|
|
|
|
|
"Show matches grouped by each file.",
|
|
|
|
|
"This shows the file name above clusters of matches from each \
|
2016-11-29 00:39:45 +02:00
|
|
|
file instead of showing the file name for every match. This is \
|
|
|
|
|
the default mode at a tty.");
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
doc!(h, "no-heading",
|
|
|
|
|
"Don't group matches by each file.",
|
2016-11-29 00:39:45 +02:00
|
|
|
"Don't group matches by each file. If -H/--with-filename is \
|
|
|
|
|
enabled, then file names will be shown for every line matched. \
|
|
|
|
|
This is the default mode when not at a tty.");
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
doc!(h, "hidden",
|
|
|
|
|
"Search hidden files and directories.",
|
|
|
|
|
"Search hidden files and directories. By default, hidden files \
|
|
|
|
|
and directories are skipped.");
|
|
|
|
|
doc!(h, "ignore-file",
|
|
|
|
|
"Specify additional ignore files.",
|
|
|
|
|
"Specify additional ignore files for filtering file paths. \
|
|
|
|
|
Ignore files should be in the gitignore format and are matched \
|
|
|
|
|
relative to the current working directory. These ignore files \
|
|
|
|
|
have lower precedence than all other ignore files. When \
|
|
|
|
|
specifying multiple ignore files, earlier files have lower \
|
|
|
|
|
precedence than later files.");
|
|
|
|
|
doc!(h, "follow",
|
|
|
|
|
"Follow symbolic links.");
|
|
|
|
|
doc!(h, "max-count",
|
|
|
|
|
"Limit the number of matches.",
|
|
|
|
|
"Limit the number of matching lines per file searched to NUM.");
|
2017-02-28 06:53:52 +02:00
|
|
|
doc!(h, "max-filesize",
|
|
|
|
|
"Ignore files larger than NUM in size.",
|
2017-03-31 21:59:04 +02:00
|
|
|
"Ignore files larger than NUM in size. Does not ignore \
|
|
|
|
|
directories. \
|
2017-02-28 06:53:52 +02:00
|
|
|
\n\nThe input format accepts suffixes of K, M or G which \
|
2017-03-31 21:59:04 +02:00
|
|
|
correspond to kilobytes, megabytes and gigabytes. If no suffix \
|
|
|
|
|
is provided the input is treated as bytes. \
|
2017-02-28 06:53:52 +02:00
|
|
|
\n\nExample: --max-filesize 50K or --max-filesize 80M");
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
doc!(h, "maxdepth",
|
|
|
|
|
"Descend at most NUM directories.",
|
|
|
|
|
"Limit the depth of directory traversal to NUM levels beyond \
|
|
|
|
|
the paths given. A value of zero only searches the \
|
|
|
|
|
starting-points themselves.\n\nFor example, \
|
|
|
|
|
'rg --maxdepth 0 dir/' is a no-op because dir/ will not be \
|
|
|
|
|
descended into. 'rg --maxdepth 1 dir/' will search only the \
|
|
|
|
|
direct children of dir/.");
|
|
|
|
|
doc!(h, "mmap",
|
|
|
|
|
"Searching using memory maps when possible.",
|
|
|
|
|
"Search using memory maps when possible. This is enabled by \
|
|
|
|
|
default when ripgrep thinks it will be faster. Note that memory \
|
|
|
|
|
map searching doesn't currently support all options, so if an \
|
|
|
|
|
incompatible option (e.g., --context) is given with --mmap, \
|
|
|
|
|
then memory maps will not be used.");
|
|
|
|
|
doc!(h, "no-messages",
|
|
|
|
|
"Suppress all error messages.",
|
|
|
|
|
"Suppress all error messages. This is equivalent to redirecting \
|
|
|
|
|
stderr to /dev/null.");
|
|
|
|
|
doc!(h, "no-mmap",
|
|
|
|
|
"Never use memory maps.",
|
|
|
|
|
"Never use memory maps, even when they might be faster.");
|
|
|
|
|
doc!(h, "no-ignore",
|
|
|
|
|
"Don't respect ignore files.",
|
|
|
|
|
"Don't respect ignore files (.gitignore, .ignore, etc.). This \
|
|
|
|
|
implies --no-ignore-parent and --no-ignore-vcs.");
|
|
|
|
|
doc!(h, "no-ignore-parent",
|
|
|
|
|
"Don't respect ignore files in parent directories.",
|
|
|
|
|
"Don't respect ignore files (.gitignore, .ignore, etc.) in \
|
|
|
|
|
parent directories.");
|
|
|
|
|
doc!(h, "no-ignore-vcs",
|
|
|
|
|
"Don't respect VCS ignore files",
|
|
|
|
|
"Don't respect version control ignore files (.gitignore, etc.). \
|
|
|
|
|
This implies --no-ignore-parent. Note that .ignore files will \
|
|
|
|
|
continue to be respected.");
|
|
|
|
|
doc!(h, "null",
|
|
|
|
|
"Print NUL byte after file names",
|
|
|
|
|
"Whenever a file name is printed, follow it with a NUL byte. \
|
|
|
|
|
This includes printing file names before matches, and when \
|
|
|
|
|
printing a list of matching files such as with --count, \
|
|
|
|
|
--files-with-matches and --files. This option is useful for use \
|
|
|
|
|
with xargs.");
|
2017-03-28 20:14:32 +02:00
|
|
|
doc!(h, "only-matching",
|
|
|
|
|
"Print only matched parts of a line.",
|
|
|
|
|
"Print only the matched (non-empty) parts of a matching line, \
|
|
|
|
|
with each such part on a separate output line.");
|
2017-01-11 01:16:15 +02:00
|
|
|
doc!(h, "path-separator",
|
|
|
|
|
"Path separator to use when printing file paths.",
|
|
|
|
|
"The path separator to use when printing file paths. This \
|
|
|
|
|
defaults to your platform's path separator, which is / on Unix \
|
|
|
|
|
and \\ on Windows. This flag is intended for overriding the \
|
|
|
|
|
default when the environment demands it (e.g., cygwin). A path \
|
|
|
|
|
separator is limited to a single byte.");
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
doc!(h, "pretty",
|
2017-05-26 22:24:49 +02:00
|
|
|
"Alias for --color always --heading --line-number.");
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
doc!(h, "replace",
|
|
|
|
|
"Replace matches with string given.",
|
|
|
|
|
"Replace every match with the string given when printing \
|
|
|
|
|
results. Neither this flag nor any other flag will modify your \
|
|
|
|
|
files.\n\nCapture group indices (e.g., $5) and names \
|
2017-01-10 23:43:28 +02:00
|
|
|
(e.g., $foo) are supported in the replacement string.\n\n\
|
|
|
|
|
Note that the replacement by default replaces each match, and \
|
|
|
|
|
NOT the entire line. To replace the entire line, you should \
|
|
|
|
|
match the entire line.");
|
2017-04-01 23:55:58 +02:00
|
|
|
doc!(h, "regex-size-limit",
|
|
|
|
|
"The upper size limit of the compiled regex.",
|
|
|
|
|
"The upper size limit of the compiled regex. The default limit \
|
|
|
|
|
is 10M. \n\nThe argument accepts the same size suffixes as \
|
|
|
|
|
allowed in the 'max-filesize' argument.");
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
doc!(h, "case-sensitive",
|
|
|
|
|
"Search case sensitively.",
|
|
|
|
|
"Search case sensitively. This overrides -i/--ignore-case and \
|
|
|
|
|
-S/--smart-case.");
|
|
|
|
|
doc!(h, "smart-case",
|
|
|
|
|
"Smart case search.",
|
|
|
|
|
"Searches case insensitively if the pattern is all lowercase. \
|
|
|
|
|
Search case sensitively otherwise. This is overridden by \
|
|
|
|
|
either -s/--case-sensitive or -i/--ignore-case.");
|
2017-01-07 05:43:59 +02:00
|
|
|
doc!(h, "sort-files",
|
|
|
|
|
"Sort results by file path. Implies --threads=1.",
|
|
|
|
|
"Sort results by file path. Note that this currently \
|
|
|
|
|
disables all parallelism and runs search in a single thread.");
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
doc!(h, "threads",
|
|
|
|
|
"The approximate number of threads to use.",
|
|
|
|
|
"The approximate number of threads to use. A value of 0 (which \
|
|
|
|
|
is the default) causes ripgrep to choose the thread count \
|
|
|
|
|
using heuristics.");
|
|
|
|
|
doc!(h, "vimgrep",
|
|
|
|
|
"Show results in vim compatible format.",
|
|
|
|
|
"Show results with every match on its own line, including \
|
|
|
|
|
line numbers and column numbers. With this option, a line with \
|
|
|
|
|
more than one match will be printed more than once.");
|
2017-02-02 16:29:50 +02:00
|
|
|
doc!(h, "max-columns",
|
|
|
|
|
"Don't print lines longer than this limit in bytes.",
|
|
|
|
|
"Don't print lines longer than this limit in bytes. Longer lines \
|
|
|
|
|
are omitted, and only the number of matches in that line is \
|
|
|
|
|
printed.");
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
|
|
|
|
|
doc!(h, "type-add",
|
|
|
|
|
"Add a new glob for a file type.",
|
|
|
|
|
"Add a new glob for a particular file type. Only one glob can be \
|
|
|
|
|
added at a time. Multiple --type-add flags can be provided. \
|
|
|
|
|
Unless --type-clear is used, globs are added to any existing \
|
|
|
|
|
globs defined inside of ripgrep.\n\nNote that this MUST be \
|
|
|
|
|
passed to every invocation of ripgrep. Type settings are NOT \
|
|
|
|
|
persisted.\n\nExample: \
|
2017-01-02 02:32:46 +02:00
|
|
|
rg --type-add 'foo:*.foo' -tfoo PATTERN.\n\n\
|
|
|
|
|
--type-add can also be used to include rules from other types \
|
|
|
|
|
with the special include directive. The include directive \
|
|
|
|
|
permits specifying one or more other type names (separated by a \
|
|
|
|
|
comma) that have been defined and its rules will automatically \
|
|
|
|
|
be imported into the type specified. For example, to create a \
|
2017-03-31 21:59:04 +02:00
|
|
|
type called src that matches C++, Python and Markdown files, \
|
|
|
|
|
one can use:\n\n\
|
2017-01-02 02:32:46 +02:00
|
|
|
--type-add 'src:include:cpp,py,md'\n\n\
|
|
|
|
|
Additional glob rules can still be added to the src type by \
|
|
|
|
|
using the --type-add flag again:\n\n\
|
|
|
|
|
--type-add 'src:include:cpp,py,md' --type-add 'src:*.foo'\n\n\
|
|
|
|
|
Note that type names must consist only of Unicode letters or \
|
|
|
|
|
numbers. Punctuation characters are not allowed.");
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
doc!(h, "type-clear",
|
|
|
|
|
"Clear globs for given file type.",
|
|
|
|
|
"Clear the file type globs previously defined for TYPE. This \
|
2017-01-02 02:32:46 +02:00
|
|
|
only clears the default type definitions that are found inside \
|
Switch from Docopt to Clap.
There were two important reasons for the switch:
1. Performance. Docopt does poorly when the argv becomes large, which is
a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
argv might be invalid, and can therefore provide much clearer error
messages.
While both were important, (1) made it urgent.
Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.
There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:
rg -e -foo
Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: https://github.com/kbknapp/clap-rs/issues/742),
but it can be worked around by using this instead:
rg -e [-]foo
or even
rg [-]foo
and this still works:
rg -- -foo
This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.
Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
|
|
|
of ripgrep.\n\nNote that this MUST be passed to every \
|
|
|
|
|
invocation of ripgrep. Type settings are NOT persisted.");
|
|
|
|
|
|
|
|
|
|
h
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
fn validate_number(s: String) -> Result<(), String> {
|
|
|
|
|
s.parse::<usize>().map(|_|()).map_err(|err| err.to_string())
|
|
|
|
|
}
|
