260603.1 · c28ce760dfbb16e284c1aa09d848cc016ae3fe88
docs: update GUIDE to use `lexopt`
... we migrated off of `clap` long ago.
reading declarations
Changes to GUIDE.md. All files
@@ -269,24 +269,23 @@ patterns while the next section covers file type filtering. In our ripgrep source code (see [Basics](#basics) for instructions on how to get a source archive to search), let's say we wanted to see which things depend-on `clap`, our argument parser.+on `lexopt`, our argument parser. We could do this: ```-$ rg clap+$ rg lexopt [lots of results] ``` But this shows us many things, and we're only interested in where we wrote-`clap` as a dependency. Instead, we could limit ourselves to TOML files, which-is how dependencies are communicated to Rust's build tool, Cargo:+`lexopt` as a dependency. Instead, we could limit ourselves to TOML files,+which is how dependencies are communicated to Rust's build tool, Cargo: ```-$ rg clap -g '*.toml'+$ rg lexopt -g '*.toml' Cargo.toml-35:clap = "2.26"-51:clap = "2.26"+57:lexopt = "0.3.0" ``` The `-g '*.toml'` syntax says, "make sure every file searched matches this@@ -296,7 +295,7 @@ shell from expanding the `*`. If we wanted, we could tell ripgrep to search anything *but* `*.toml` files: ```-$ rg clap -g '!*.toml'+$ rg lexopt -g '!*.toml' [lots of results] ``` @@ -312,7 +311,7 @@ is, later globs will override earlier globs. For example, the following command will search only `*.toml` files: ```-$ rg clap -g '!*.toml' -g '*.toml'+$ rg lexopt -g '!*.toml' -g '*.toml' ``` Interestingly, reversing the order of the globs in this case will match@@ -364,13 +363,13 @@ $ rg 'int main' -tc Just as you can write blacklist globs, you can blacklist file types too: ```-$ rg clap --type-not rust+$ rg lexopt --type-not rust ``` or, more succinctly, ```-$ rg clap -Trust+$ rg lexopt -Trust ``` That is, `-t` means "include files of this type" where as `-T` means "exclude