Merge pull request #233 from BurntSushi/clap

Switch from Docopt to Clap.

Author: BurntSushi

.travis.yml

@@ -30,13 +30,10 @@ matrix:
       env: TARGET=x86_64-apple-darwin
     # Minimum Rust supported channel.
     - os: linux
-      rust: 1.9.0
-      env: TARGET=x86_64-unknown-linux-musl
-    - os: linux
-      rust: 1.9.0
+      rust: 1.11.0
       env: TARGET=x86_64-unknown-linux-gnu
     - os: osx
-      rust: 1.9.0
+      rust: 1.11.0
       env: TARGET=x86_64-apple-darwin
 
 before_install:

Cargo.lock

@@ -13,6 +13,7 @@ readme = "README.md"
 keywords = ["regex", "grep", "egrep", "search", "pattern"]
 license = "Unlicense/MIT"
 exclude = ["HomebrewFormula"]
+build = "build.rs"
 
 [[bin]]
 bench = false
@@ -25,8 +26,8 @@ path = "tests/tests.rs"
 
 [dependencies]
 bytecount = "0.1.4"
+clap = "2.18"
 ctrlc = "2.0"
-docopt = "0.6"
 env_logger = "0.3"
 grep = { version = "0.1.4", path = "grep" }
 ignore = { version = "0.1.5", path = "ignore" }
@@ -37,13 +38,16 @@ memchr = "0.1"
 memmap = "0.5"
 num_cpus = "1"
 regex = "0.1.77"
-rustc-serialize = "=0.3.19"
 term = "0.4"
 
 [target.'cfg(windows)'.dependencies]
 kernel32-sys = "0.2"
 winapi = "0.2"
 
+[build-dependencies]
+clap = "2.18"
+lazy_static = "0.2"
+
 [features]
 avx-accel = ["bytecount/avx-accel"]
 simd-accel = ["bytecount/simd-accel", "regex/simd-accel"]

Cargo.toml

@@ -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"));
+}

build.rs

@@ -19,6 +19,7 @@ mk_tarball() {
 
     cp target/$TARGET/release/rg "$td/$name/"
     cp {doc/rg.1,README.md,UNLICENSE,COPYING,LICENSE-MIT} "$td/$name/"
+    cp target/$TARGET/release/build/ripgrep-*/out/{_rg.,rg.}* "$td/$name/"
 
     pushd $td
     tar czf "$out_dir/$name.tar.gz" *

ci/before_deploy.sh

@@ -7,11 +7,11 @@
 rg \- recursively search current directory for lines matching a pattern
 .SH SYNOPSIS
 .PP
-rg [\f[I]options\f[]] \-e PATTERN ...
-[\f[I]<\f[]path\f[I]> ...\f[]]
-.PP
 rg [\f[I]options\f[]] <\f[I]pattern\f[]> [\f[I]<\f[]path\f[I]> ...\f[]]
 .PP
+rg [\f[I]options\f[]] (\-e PATTERN | \-f FILE) ...
+[\f[I]<\f[]path\f[I]> ...\f[]]
+.PP
 rg [\f[I]options\f[]] \-\-files [\f[I]<\f[]path\f[I]> ...\f[]]
 .PP
 rg [\f[I]options\f[]] \-\-type\-list
@@ -163,6 +163,15 @@ Show debug messages.
 .RS
 .RE
 .TP
+.B \-f, \-\-file 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.
+.RS
+.RE
+.TP
 .B \-\-files
 Print each file that would be searched (but don\[aq]t search).
 .RS
@@ -202,6 +211,16 @@ Search hidden directories and files.
 .RS
 .RE
 .TP
+.B \-\-ignore\-file FILE ...
+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.
+.RS
+.RE
+.TP
 .B \-L, \-\-follow
 Follow symlinks.
 .RS

doc/rg.1

@@ -4,10 +4,10 @@ rg - recursively search current directory for lines matching a pattern
 
 # SYNOPSIS
 
-rg [*options*] -e PATTERN ... [*<*path*> ...*]
-
 rg [*options*] <*pattern*> [*<*path*> ...*]
 
+rg [*options*] (-e PATTERN | -f FILE) ... [*<*path*> ...*]
+
 rg [*options*] --files [*<*path*> ...*]
 
 rg [*options*] --type-list
@@ -107,6 +107,12 @@ Project home page: https://github.com/BurntSushi/ripgrep
 --debug
 : Show debug messages.
 
+-f, --file 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.
+
 --files
 : Print each file that would be searched (but don't search).
 
@@ -132,6 +138,14 @@ Project home page: https://github.com/BurntSushi/ripgrep
 : Search hidden directories and files. (Hidden directories and files are
   skipped by default.)
 
+--ignore-file FILE ...
+: 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.
+
 -L, --follow
 : Follow symlinks.