mirror of
https://github.com/BurntSushi/ripgrep.git
synced 2025-03-17 20:28:03 +02:00
ebb986e767
When one does not provide any paths to ripgrep to search, it has to guess between searching stdin and the current working directory. It is possible for this guess to be wrong, and having the heuristics and the choice in the debug logs is useful for diagnosing this. The failure mode here is still pretty bad because you need to know to reach for the `--debug` flag in the first place. Namely, the typical failure mode is that ripgrep tries to search stdin while the intent is for it to search the current working directory, and thus likely blocking forever waiting for data on stdin. (Arguably this is a problem with the process architecture that invokes ripgrep. It shouldn't give ripgrep an open stdin handle that isn't closed.) Closes #2524
ripgrep core
This is the core ripgrep crate. In particular, main.rs is where the main
function lives.
Most of ripgrep core consists of two things:
- The definition of the CLI interface, including docs for every flag.
- Glue code that brings the
grep-matcher,grep-regex,grep-searcherandgrep-printercrates together to actually execute the search.
Currently, there are no plans to make ripgrep core available as an independent library. However, much of the heavy lifting of ripgrep is done via its constituent crates, which can be reused independent of ripgrep. Unfortunately, there is no guide or tutorial to teach folks how to do this yet.