summaryrefslogtreecommitdiffstats
path: root/build.rs
diff options
context:
space:
mode:
authorAndrew Gallant <jamslam@gmail.com>2016-11-12 21:48:11 -0500
committerAndrew Gallant <jamslam@gmail.com>2016-11-17 19:53:41 -0500
commit92dc402f7f598c3d0045f94df9988bbe1c0c79cf (patch)
tree1ef3aef6c86ecb41bcf4d72c4d97bfd720f6fa52 /build.rs
parenta3f5e0c3d5f5c5088979a768765f988bf73dbf69 (diff)
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
Diffstat (limited to 'build.rs')
-rw-r--r--build.rs23
1 files changed, 23 insertions, 0 deletions
diff --git a/build.rs b/build.rs
new file mode 100644
index 00000000..b2522708
--- /dev/null
+++ b/build.rs
@@ -0,0 +1,23 @@
+#[macro_use]
+extern crate clap;
+#[macro_use]
+extern crate lazy_static;
+
+use std::fs;
+
+use clap::Shell;
+
+#[allow(dead_code)]
+#[path = "src/app.rs"]
+mod app;
+
+fn main() {
+ fs::create_dir_all(env!("OUT_DIR")).unwrap();
+
+ let mut app = app::app_short();
+ app.gen_completions("rg", Shell::Bash, env!("OUT_DIR"));
+ app.gen_completions("rg", Shell::Fish, env!("OUT_DIR"));
+ // Zsh seems to fail with a panic.
+ // app.gen_completions("rg", Shell::Zsh, env!("OUT_DIR"));
+ app.gen_completions("rg", Shell::PowerShell, env!("OUT_DIR"));
+}